WCC Advanced V13 SP1 enUS en-US PDF
WCC Advanced V13 SP1 enUS en-US PDF
WCC Advanced V13 SP1 enUS en-US PDF
and WinCC 1
What's new in WinCC
Advanced? 2
Readme 4
WinCC Advanced V13.0 SP1
Installation 5
Migrating projects and
System Manual
programs 6
First steps 7
Editing projects 9
Visualize processes 12
Hardware documentation 16
12/2014
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 AG. 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.
12.15.2.1 Basics.................................................................................................................................7083
12.15.2.2 Remote control via Sm@rtServer......................................................................................7115
12.15.2.3 E-mail notification from runtime..........................................................................................7127
12.15.2.4 Display integrated Service-Pages......................................................................................7131
12.15.2.5 Access via SIMATIC HMI HTTP Protocol..........................................................................7142
12.15.2.6 Connection to the Office-world...........................................................................................7151
12.16 Interfaces...........................................................................................................................7155
12.16.1 OPC...................................................................................................................................7155
12.16.1.1 Basics.................................................................................................................................7155
12.16.1.2 Configuring an OPC server................................................................................................7158
12.16.1.3 Configuring an OPC client..................................................................................................7161
12.16.1.4 Security concept of OPC UA..............................................................................................7166
12.16.1.5 Reference...........................................................................................................................7168
12.17 Migrating to WinCC in the TIA Portal.................................................................................7171
12.17.1 Overview of the migration to WinCC in the TIA Portal.......................................................7171
12.17.2 WinCC flexible....................................................................................................................7172
12.17.2.1 Libraries.............................................................................................................................7172
12.17.2.2 Screens and templates......................................................................................................7174
12.17.2.3 Scripts in faceplates...........................................................................................................7176
12.17.2.4 Synchronization of recipes.................................................................................................7177
12.17.2.5 Special considerations for converting................................................................................7178
13 Using technology functions.....................................................................................................................7179
13.1 PID control.........................................................................................................................7179
13.1.1 Principles for control...........................................................................................................7179
13.1.1.1 Controlled system and actuators........................................................................................7179
13.1.1.2 Controlled systems.............................................................................................................7180
13.1.1.3 Characteristic values of the control section........................................................................7182
13.1.1.4 Pulse controller..................................................................................................................7184
13.1.1.5 Response to setpoint changes and disturbances..............................................................7188
13.1.1.6 Control Response at Different Feedback Structures..........................................................7189
13.1.1.7 Selection of the controller structure for specified controlled systems................................7197
13.1.1.8 PID parameter settings......................................................................................................7198
13.1.2 Configuring a software controller.......................................................................................7198
13.1.2.1 Overview of software controller..........................................................................................7198
13.1.2.2 Steps for the configuration of a software controller............................................................7200
13.1.2.3 Add technology objects......................................................................................................7201
13.1.2.4 Configure technology objects.............................................................................................7202
13.1.2.5 Call instruction in the user program...................................................................................7203
13.1.2.6 Downloading technology objects to device........................................................................7204
13.1.2.7 Commissioning software controller....................................................................................7205
13.1.2.8 Save optimized PID parameter in the project.....................................................................7205
13.1.2.9 Comparing values..............................................................................................................7206
13.1.2.10 Parameter view..................................................................................................................7209
13.1.2.11 Display instance DB of a technology object.......................................................................7226
13.1.3 Using PID_Compact...........................................................................................................7226
13.1.3.1 Technology object PID_Compact.......................................................................................7226
13.1.3.2 PID_Compact V2................................................................................................................7227
13.1.3.3 PID_Compact V1................................................................................................................7243
13.1.4 Using PID_3Step................................................................................................................7258
13.1.4.1 Technology object PID_3Step............................................................................................7258
6,0$7,&67(3 6,0$7,&:LQ&&
3URJUDPPLQJODQJXDJHV 0DFKLQHOHYHORSHUDWRUFRQWURO
/$')%'6&/67/
6*5$3+
DQGPRQLWRULQJ
2SWLRQDOSDFNDJH67(36DIHW\ 6&$'$DSSOLFDWLRQV
&RPIRUW3DQHOVDQG[
6 3URIHVVLRQDO
3URIHVVLRQDO
ZLWKRXW0LFUR0RELOH
$GYDQFHG
&RPIRUW
%DVLF
%DVLF
6 %DVLF3DQHOV
&RPPXQLFDWLRQ
352),%86352),1(7$6L,2/LQN(7QHWZRUNWRSRORJ\
352),VDIHYLD352),%86DQG352),1(7
&RPPRQIXQFWLRQV
6\VWHPGLDJQRVWLFVLPSRUWH[SRUWWR([FHOUHXVHRIHOHPHQWVZLWKKHOSRIOLEUDULHVDQGPXFKPRUH
STEP 7
STEP 7 (TIA Portal) is the engineering software for configuring the SIMATIC S7-1200,
S7-1500, S7-300/400 and WinAC controller families. STEP 7 (TIA Portal) is available in two
editions, depending on the configurable controller families:
STEP 7 Basic for configuring the S7-1200
STEP 7 Professional for configuring S7-1200, S7-1500, S7-300/400 and WinAC
WinCC
WinCC (TIA Portal) is an engineering software for configuring SIMATIC Panels, SIMATIC
Industrial PCs, and Standard PCs with the WinCC Runtime Advanced or the SCADA System
WinCC Runtime Professional visualization software.
WinCC (TIA Portal) is available in four editions, depending on the configurable operator control
systems:
WinCC Basic for configuring Basic Panels
WinCC Basic is included with every STEP 7 Basic and STEP 7 Professional product.
WinCC Comfort for configuring all panels (including Comfort Panels, Mobile Panels)
WinCC Advanced for configuring all panels and PCs with the WinCC Runtime Advanced
visualization software
WinCC Runtime Advanced is a visualization software for PC-based single-station systems.
WinCC Runtime Advanced can be purchased with licenses for 128, 512, 2k, 4k as well as
8k PowerTags (tags with a process interface).
WinCC Professional for configuring panels and PCs with WinCC Runtime Advanced or
SCADA System WinCC Runtime Professional. WinCC Professional is available in the
following editions: WinCC Professional for 512 and 4096 PowerTags as well as "WinCC
Professional max. PowerTags".
WinCC Runtime Professional is a SCADA system for structuring a configuration ranging
from single-station systems to multi-station systems including standard clients or web
clients. WinCC Runtime Professional can be purchased with licenses for 128, 512, 2k, 4k,
8k, and 64k PowerTags (tags with a process interface).
With WinCC (TIA Portal), it is also possible to configure a SINUMERIK PC with WinCC Runtime
Advanced or WinCC Runtime Professional and HMI devices with SINUMERIK HMI Pro sl RT
or SINUMERIK Operate WinCC RT Basic.
Note
In contrast to WinCC flexible 2008, functions from the WinCC flexible /Sm@rtService, WinCC
flexible /Sm@rtAccess options as well as the WinCC flexible /OPC Server option are
incorporated into the basic functionality.
Note
In contrast to WinCC flexible 2008, functions from the WinCC flexible /Sm@rtService, WinCC
flexible /Sm@rtAccess options as well as the WinCC flexible /OPC Server option are
incorporated into the basic functionality.
Note
In contrast to WinCC V7, functions from the WinCC /OPC-Server and WinCC /
ConnectivityPack options are incorporated into the basic functionality. Likewise, the basic
functionality includes the Runtime API from WinCC /ODK.
See also
Overview of versions (Page 7349)
Notes on handling
If a project in the list of projects last used is located on a network drive that is not connected,
you may experience delays when opening the "Project" menu.
When you insert a CPU, you may need to wait for some time if the project editor is open at
the same time. This generally takes longer when you insert the first CPU in a newly created
project. To be able to continue working more quickly, you should close the project editor
before inserting a CPU.
The alarm "Application is not responding" may appear in Windows 7 with functions that
take a long time to run (loading the CPU for example). If this occurs, wait until the function
has correctly finished.
If you have installed a Microsoft mouse with IntelliPoint, you may find that it superimposes
components over the buttons of the title bar. If this is the case, uninstall the IntelliPoint
software from Microsoft.
Enabling the "Virtual Desktop" options with NVIDIA graphics cards can cause problems. In
this case, disable the "nView virtual desktop manager" of your NVIDIA graphics driver.
Here, you can also subscribe to the newsletter that provides you with latest information relating
to your products.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Note
This restriction is not related to online access to devices or the know-how protection of program
blocks.
Content
Information that could not be included in the online help and important information about
product characteristics.
Please note that the CP 5512 can be used with a maximum of Windows 7 32-bit. As of Windows
8 or with 64-bit operating systems, the CP 5512 is not compatible.
Note
Since 2009, the functional successor the USB 2.0 module CP 5711 has been available.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Security information
Siemens provides products and solutions with industrial security functions that support the
secure operation of plants, solutions, machines, equipment and/or networks. They are
important components in a holistic industrial security concept. With this in mind, Siemens
products and solutions undergo continuous development. Siemens recommends strongly that
you regularly check for product updates.
For the secure operation of Siemens products and solutions, it is necessary to take suitable
preventive action (e.g. cell protection concept) and integrate each component into a holistic,
state-of-the-art industrial security concept. Any third-party products that may be in use must
also be taken into account. For more information about industrial security, visit
http://www.siemens.com/industrialsecurity (http://www.industry.siemens.com/topics/global/
en/industrial-security/Pages/Default.aspx)
To stay informed about product updates as they occur, sign up for a product-specific
newsletter. For more information, visit
http://support.automation.siemens.com (http://support.automation.siemens.com)
Passwords
Various passwords are set by default in WinCC. For security reasons, you should change
these passwords.
On HMI devices with version V11 or V12, the password "100" is preset for the Sm@rtServer
and for the integrated Web server. A default password is not preset for HMI devices with
version V13.
For the user "Administrator", the default password is "administrator".
Network settings
The following tables show the network settings of each product which you need in order to
analyze the network security and for the configuration of external firewalls:
4.2.2 News
Contents
Information that could no longer be included in the online help and important information about
product features.
On-screen keyboard
Once you have opened the TIA Portal, you can no longer call the on-screen keyboard.
To call the on-screen keyboard in Windows, use the following command: Start > All Programs
> Accessories > Ease of Access > On-screen keyboard.
Device replacement
After an HMI device has been replaced, you should check the appearance of the configured
screens. Changing the size of the display may result in changes to the position and appearance
of screen objects, e.g. recipe view and alarm view.
This project must be copied to a local directory with full access before it can be used. For more
information on this, refer to FAQ ID 66027369.
4.2.4 Migration
Contents
Information that could no longer be included in the online help and important information about
product features.
Progress bar
As long as the progress bar still shows a value of 100%, the software is still busy running
remaining tasks such as the closing of references. The software will not respond to user input
while this status is given.
Migration log
As of TIA Portal V13.0 alarms are sorted into a tree structure in the migration log. This means
all alarms that are part of a specific subsystem are stored in one folder. The result is an increase
in the number of folders in the tree structure. Press the shortcut <NUM+ X> to expand the
currently selected folder and all subfolders in one single step.
See also
Object support during migration (Page 172)
Object support during migration
Contents
Information that could no longer be included in the online help and important information about
product features.
Event names in case of alarms in the "Info" tab of the Inspector window
In some alarms of the Inspector window the event names in the "Info" tab will deviate from the
names in the "Properties" tab.
Name in the "Properties" tab of the Inspector win Name in the "Info" tab of the Inspector window
dow
Cleared ClearScreen
Loaded GenerateScreen
Enable Activate
Change Change
When a dialog is opened ONMODALBEGIN
When a dialog is closed ONMODALEND
User change PASSWORD
Screen change SCREEN
Disable Deactivate
Press Press
Outgoing Going
Incoming Coming
Limit "high limit error" violated AboveUpperLimit
Limit "low limit error" violated BelowLowerLimit
Click Click
Loop-in alarm LoopInAlarm
Release Release
Alarm buffer overflow OVERFLOW
Acknowledge Acknowledgement
Runtime stop Shutdown
Press key KeyDown
Release key KeyUp
Toggle ON SwitchOn
Toggle OFF SwitchOff
Value change Change value
Faceplates
Faceplates cannot be rotated or mirrored.
I/O field with "decimal" display format and format pattern without "s" prefix
You have linked a process tag to an I/O field. The I/O field is assigned the "decimal" display
format.
You may select a signed or an unsigned display format.
A "Format pattern" setting without "s", e.g., "999" has the following effects:
1. You cannot set negative values using the I/O field in Runtime.
2. If the tag assumes a negative value, the I/O field generates a two's complement and a
corrupted positive value is output.
Panels and RT Advanced with device version V13: many visually different screen objects
The use of screen objects with very many visually different properties (e.g., very many different
styles) can reduce the performance of the user interface in Runtime and can increase the
amount of available memory space used. Avoid using, for example, very many different corner
radii: 0 pixel, 1 pixel, 2 pixels, 3 pixels, etc.
The use of many differently sized Gauge objects can have the same effect. Avoid Gauge
of height 48 pixels, 49 pixels, 51 pixels, etc. Instead, use sizes such as: 50 pixels, 70 pixels,
100 pixels.
Characters that can be used in the property name of the screen blocks with RT Professional
Note the following rules when entering property names of the faceplates:
The name must start with a letter.
The name can contain alphanumeric characters and the underscore.
The name may not contain more than 255 characters.
Do not use any UNICODE characters (for example, Chinese characters).
Display differences between the configuration and the display on the HMI device
The display of the text configured in a screen object may be different on the HMI device due
to the display configuration. If you are using the options for automatic size adjustment in the
configuration, check the display on your HMI device in every language.
If texts that were configured with the "Fit object to contents" option cannot be displayed in full,
they are reduced slightly on the HMI device. If this reduction leads to a distorted display of
texts, disable the "Fit object to contents" option and expand the text with additional blanks.
Optionally, you can increase the width of the object or use a shorter formulation for the text.
Contents
Information that could not be included in the online help and important information about
product features.
Runtime Advanced and Panels: Importing array elements and structure elements
Array tags and structure tags are always imported in full with all elements. The elements of
the array tags and structure tags are not filled further during import.
A new tag is created if the name of a tag corresponds to the name of an array or structure
element in the import file.
Example:
The import file contains an array tag called "Otto" with 10 array elements. The array elements
are then called Otto[1], Otto[2], for example.
If the import file contains a tag named "Otto[1]", the first element of the array tag will not be
filled. Instead, a new tag will be created in the engineering system.
RT Professional: Tags with symbolic addressing and "Char Array" data type
Tags with symbolic addressing and the "Char Array" data type are not released for
communication of RT Professional and SIMATIC S7-1200 V3.
Contents
Information that could not be included in the online help and important information about
product properties.
Contents
Information that could no longer be included in the online help and important information about
product features.
This error is triggered on devices with the Windows CE 3.0 operating system by user functions
of the following type:
Sub VBFunction_1()
With HmiRuntime.Screens("Screen_1").ScreenItems("Button_1")
.backcolor = vbred
.visible = not .visible
End With
End Sub
If the error occurs, you need to re-program the user function as follows:
Sub VBFunction_1()
HmiRuntime.Screens("Screen_1").ScreenItems("Button_1").backcolor = vbred
HmiRuntime.Screens("Screen_1").ScreenItems("Button_1").visible = not .visible
End Sub
Graphics in faceplates
You have added a graphic view in a faceplate and defined the "Graphic" property as the
interface of the faceplate. The "Graphic" property can be made dynamic using the interface of
the faceplate instance.
Use the following notation to address the graphic property via a script: "..\\..\\Graphic name".
Note
The "FrameColor" property is not displayed in the Script Editor via IntelliSense, but is accepted
during compilation of the project.
In the device versions before 13.1.0, these parameters must be assigned other data types:
Use "SInt" instead of "Char"
Use "Int" instead of "Word"
Otherwise, undesirable effects may occur, for example, incorrect or unexpected behavior of
the configured system functions.
4.2.5.5 Reports
Contents
Information that could not be included in the online help and important information about
product features.
4.2.5.6 Recipes
Contents
Information that could not be included in the online help and important information about
product features.
Contents
Information that could no longer be included in the online help and important information about
product features.
Dynamic logon
In Runtime Professional, an automatic log-off time does not affect users that log on via a logon
tag.
4.2.5.8 Communication
Contents
Information that could no longer be included in the online help and important information about
product features.
Enable the "Addresses" tab in the "Object properties" dialog. Configure the offset for the inputs
under "Inputs > Start". Configure the offset for the outputs under "Outputs > Start".
"Set the IP suite (address) of the PLC in the Control Panel" with SIMATIC S7-1200 V1
The function "Set the IP suite (address) of the PLC in the Control Panel" has not been approved
for the following PLCs:
SIMATIC S7-1200 V1
Switching a connection
A connection may be interrupted when it is switched from an HMI device to a SIMATIC
S7-300/400, to a SIMATIC S7-1500 or to a SIMATIC S7-1200 PLC.
Note the following settings in the SIMATIC S7-1500 or SIMATIC S7-1200 controllers:
Absolute addressing of tags
The "Disable PUT-GET communication" option must be selected
The "Complete protection" protection level may not be set
Transfer areas of the operating mode IO device and DP slave of the HMI devices
If you have activated the operating mode "IO device" or "DP slave" for HMI devices, no transfer
areas should be added or deleted in the properties of the HMI device. If you have inadvertently
deleted or added a transfer area, disconnect and reconnect the controller.
Contents
Information that could no longer be included in the online help and important information about
product features.
Contents
Information that could no longer be included in the online help and important information about
product features.
Error message when PLC is loaded with a newer version of the TIA Portal
PLC code display shows the current program status of PLC programs.
An error message is output if the PLC code display from an older version of WinCC accesses
a program on the PLC loaded with a new version. Make sure that the PLC and the HMI are
loaded with the same version of the TIA Portal.
Comfort panels as of device version 13.0: Backing up data while loading projects
If the transfer is interrupted for Comfort Panels with a device version 13.0 or higher, WinCC
automatically ensures that no data is lost and that existing data is only deleted on the HMI
device after complete transmission.
4.2.8 Runtime
Contents
Information that could no longer be included in the online help and important information about
product features.
Focus in Runtime
If you have configured a low-contrast combination of focus color and border color in a V12
project, the focus may no longer be identifiable after changing the HMI device version in
Runtime. Change one of the two colors.
Starting Runtime
Only WinCC Runtime V13 can be started in TIA Portal V13. WinCC Runtime V11.02, V12 or
V13 can be simulated in TIA Portal V13.
Contents
Information that could no longer be included in the online help and important information about
product features.
Contents
Information that could not be included in the online help and important information about
product features.
.Net-Controls in Runtime
If you have incorporated a .Net Control in your project as "Specific .Net-Control", you have to
copy the files belonging to these controls to the installation directory of WinCC Runtime, e.g.
"C:\ProgramFiles\Siemens\Automation\WinCC RT Advanced". Otherwise, the control cannot
be loaded in Runtime.
Starting Runtime
Only WinCC Runtime V13 can be started in TIA Portal V13. WinCC Runtime V11.02, V12 or
V13 can be simulated in TIA Portal V13.
Contents
Information that could no longer be included in the online help and important information about
product features.
If the PC goes into standby or hibernate mode while the transfer is in progress, the panel status
after interruption of the transfer is not defined.
Multi-key operation
Unintentional actions can be triggered by multi-key operation:
When you are using a key device, you cannot press more than two function keys at the
same time.
When you are using a touch device, a standard PC or a panel PC, you can only press one
function key or button at the same time.
Mobile Panels V2
If you use Mobile Panels V2 in a project, it is not possible to open the project with WinCC V11
SP1. This affects projects with the following devices:
Mobile Panel 277F IWLAN (RFID Tag)
Mobile Panel 277F IWLAN V2
Mobile Panel 277 IWLAN V2
Restrictions for the HMI device, MP 377 15" Touch daylight readable
The following functions are not supported in WinCC V12 for the MP 377 15" Touch daylight
readable HMI device:
Option: Sm@rtServer
System function: SetAndGetBrightness
Direct keys
KTP400F Mobile
KTP400F Mobile is available as Hardware Support Package (HSP) for version V13 SP1.
Mobile Panels 277F IWLAN are not released for use with CPUs of the type S7-1500F with
WinCC V13 SP1.
Mobile Panels 277F IWLAN are not released for use with CPs in connection with CPUs of the
type S7-400F with WinCC V13 SP1.
To stay informed about product updates as they occur, sign up for a product-specific
newsletter. For more information, visit
http://support.automation.siemens.com (http://support.automation.siemens.com/WW/
llisapi.dll?aktprim=99&lang=en&referer=%2fWW
%2f&func=cslib.csinfo2&siteid=csius&extranet=standard&viewreg=WW&groupid=4000002)
Network settings
The following tables show the network settings of each product you need to analyze the
network security and to configure external firewalls:
STEP 7 Basic
Name Port number Transport pro Direction Function Description
tocol
ALM 4410* TCP Inbound/out License serv This service provides the complete function
bound ice ality for software licenses and is used by
both the Automation License Manager as
well as all license-related software products.
RFC 1006 102 TCP Outbound S7 communi Communication to the S7 controller via
cation Ethernet/PROFINET for programming and
diagnostic purposes.
DCP --- Ethernet Outbound PROFINET The DCP protocol (Discovery and Basic
Configuration Protocol) is used by PROFI
NET and provides the basic functionality for
locating and configuring PROFINET devi
ces.
SNMP 161 UDP Outbound PROFINET The SNMP client functionality is used by
STEP 7 to read status information from
PROFINET devices.
* Default port that can be changed by user configuration
Simulation RT Basic
Name Port number Transport pro Direction Function Description
tocol
HMI Load 1033 TCP Inbound HMI Load (RT This service is used to transmit images and
Basic) configuration data to Basic Panels.
Simulation RT Basic
Ethernet/ 44818 TCP Outbound Ethernet/IP The Ethernet/IP protocol is used for connec
IP channel tions to Allen Bradley PLCs.
2222 UDP Inbound Ethernet/IP The Ethernet/IP protocol is used for connec
channel tions to Allen Bradley PLCs.
Modbus 502 TCP Outbound Modbus TCP The Modbus TCP protocol is used for con
TCP channel nections to Schneider PLCs.
RFC 1006 102 TCP Outbound S7 channel Communication to the S7 controller via
Ethernet/PROFINET
Mitsubishi 5002 TCP Outbound Mitsubishi MC The Mitsubishi protocol is used for connec
MC channel tions to Mitsubishi PLCs.
Content
Information that could not be included in the online help and important information about
product characteristics.
Online operation
The simultaneous online operation of STEP 7 V5.5 or earlier and STEP 7 Basic V13 has not
been approved.
Loading project data with TIA Portal V12 and V13 (S7-1200)
If you load the project data of an S7-1200 CPU with the TIA Portal V13, you can no longer use
TIA Portal V12 to access this data. To do this, first restore the factory settings of the CPU.
Read the additional information on this in the online help under "How to reset a CPU to factory
settings".
Using project data of distributed IO-Link master modules from TIA Portal V12 in V13
The following procedure applies if you are using distributed IO-Link master modules in TIA
Portal V12 that are not GSD devices and were configured with PCT: To continue using your
project data from TIA Portal V12.0 in TIA Portal V13.0, you have to export them to PCT before
you upgrade the project. After the upgrade, you must import the project data once again using
the PCT.
Compatibility
The device configuration and program of an S7-1200 CPU must always be configured with the
same STEP 7 version. Usually, the TIA Portal makes sure that no version conflicts occur by
outputting appropriate notifications during loading to the device.
This automatic verification is not possible with S7-1200 CPUs with firmware version V1.x. In
this case, users themselves must ensure that no version conflicts occur.
See also
TIA-Portal_Link (http://support.automation.siemens.com/WW/view/en/28919804/133000)
Contents
Information that could not be included in the online help and important information about
product characteristics.
S7 PCT IO-Link
The S7 Port Configuration Tool is available for free download at the following link.
http://support.automation.siemens.com/WW/view/37936752 (http://
support.automation.siemens.com/WW/llisapi.dll?aktprim=0&lang=en&referer=%2fWW
%2f&func=cslib.csinfo&siteid=csius&groupid=4000002&extranet=standard&viewreg=WW&n
odeid0=33102519&objaction=csopen)
Content
Information that could not be included in the online help and important information about
product characteristics.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Content
Information that could not be included in the online help and important information about
product characteristics.
Content
Information that could not be included in the online help and important information about
product characteristics.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Changing the project number or station number for the entire STEP 7 project
If you change the project number or the station number in the "CP identification" parameter
group for a telecontrol CP, this parameter is changed for all CPs in the STEP 7 project.
Download to device
Only use the "Download to device" function with the mobile wireless CP via a TeleService
connection as follows:
1. Select the CP in STEP 7.
2. Select the "Online" > "Download to device" menu.
3. In the "Extended download" dialog that appears, select the TeleService interface.
4. Download the project data from the "Extended download" dialog.
Security modules
IKE mode
When negotiating the key in phase 1 the IKE mode "Main" should be preferred. This mode
normally provides a reliable procedure compared with the "Aggressive" mode. One reason for
using the "Aggressive" setting is when you have VPN groups with different pre-shared keys
since only one pre-shared key is supported with the "Main" setting.
The IKE "Aggressive" mode should not be used in conjunction with certificates. In the IKE
"Aggressive" mode, only use pre-shared keys.
The SOFTNET Security Client only supports the IKE "Main" mode.
A security module must not be used in VPN groups that use different IKE modes.
Media converters
When you migrate a project, you need to reconfigure the media converters.
Content
Information that could not be included in the online help and important information about
product characteristics.
The PLC data type now has the new number and can be used. The assigned number is retained
even if the type of the PLC data type is revoked.
If you load an inconsistent program from a device, you will not be able to load the program
unchanged to the device afterwards, because a consistency check always takes place during
the loading process and existing inconsistencies are corrected.
Content
Information that could not be included in the online help and important information about
product characteristics.
Compatibility
You can continue to use in V13 SP1 all programs that were created with TIA Portal V12 SP1
or V13. However, because improvements were made to the compiler and errors corrected
there in V13 SP1, it can occur in rare cases that the program reacts differently after the upgrade
or that you have to adjust the program code manually. These cases are described in detail
below.
In addition, you have the option of editing the project in compatibility mode. Compatibility mode
is available for projects that were created with TIA Portal V12 SP1 and V13.
You can find additional information on the compatibility under "Compatibility of projects".
Up to and including TIA Portal V13, no value was output at the OUTELSE output parameter if
the value of the K parameter was < 0. In contrast, the value of the IN input parameter was
output at the OUTELSE output parameter if the value of the K parameter was > available
outputs. This behavior has changed in TIA Portal V13 SP1.
In the TIA Portal V13 SP1, if you specify at the K parameter a value that is outside the available
outputs (K < 0 or K > available outputs), then the value of the IN input parameter is output at
the OUTELSE output parameter.
SCL
IF #MyIn1 = #MyIn2 THEN
#Block_3 := #MyIn1 + 1;
END_IF;
In this example, the function value of "Block_3" is not written if the condition of the IF instruction
is not fulfilled. The function value then contains an undefined value.
SCL
#Block_3 := #MyIn1;
IF #MyIn1 = #MyIn2 THEN
#Block_3 := #MyIn1 + 1;
END_IF;
In this example the function valve of "Block_3" is definitely written in the program, since "MyIn1"
is set as default before the IF loop is completed.
Conversion Description
Strg_TO_Chars: Convert character string to Array The ENO enable output returns the signal state "0"
of CHAR even if you have deactivated the ENO enable out
put:
For an invalid character at the CHARS
parameter
For an invalid ARRAY index at the PCHARS
parameter
If the sum of the PCHARS and STRG
parameters exceeds the length of the target
ARRAY.
Chars_TO_Strg: Convert Array of CHAR to char The ENO enable output returns the signal state "0"
acter string even if you have deactivated the ENO enable out
put:
If the sum of the PCHARS and CNT
parameters exceeds the length of the source
ARRAY.
4.3.4.3 Instructions
Content
Information that could not be included in the online help and important information about
product characteristics.
Content
Information that could not be included in the online help and important information about
product characteristics.
Note
Loading changed data blocks during an active control job can result in unforeseen operating
states. The control job continues to control the specified address, although the address
assignment may have changed in the data block. Complete active control jobs before loading
data blocks.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Restricted functionality
In the TIA-Portal V13, the "S7 GRAPH overview" and "PLC code display" functionality cannot
be used in conjunction with the IPE device proxy.
The SINAMICS G120 drive updates the drive process image every 4 ms. To improve control,
set the application cycle of the MC-Servo [OB91] to 4 ms or to a multiple of 4 ms.
Contents
Information that could not be included in the online help and important information about
product characteristics.
Automated Installation
A description of automated installation is available on the product DVD in the directory
"Documents\Readme\<Language directory>".
Availability of licenses
The licenses for the products of the TIA Portal are usually supplied on an installation data
medium and transferred automatically by the Automation Licence Manager during the
installation process of the TIA Portal.
Before you uninstall the TIA Portal, you must transfer and back up the licenses still required.
Use the Automation License Manager for this purpose.
Note
For additional information on how to manage your licenses with the Automation License
Manager , refer to the documentation supplied with the Automation License Manager .
See also
Notes on the system requirements (Page 113)
Starting installation (Page 137)
See also
Notes on licenses (Page 112)
Starting installation (Page 137)
Displaying the installed software (Page 142)
Modifying or updating installed products (Page 143)
Repairing installed products (Page 144)
Starting to uninstall (Page 146)
Introduction
You require a License Key to license the following STEP 7 editions:
STEP 7 Basic
STEP 7 Professional
You can install the corresponding License Key when you are installing STEP 7 or transfer it
using the Automation License Manager after the installation has been completed.
See also
Handling licenses and license keys (Page 116)
Introduction
In each case, you require a valid License Key to use STEP 7 Basic and STEP 7 Professional.
Notice
Destruction of license keys by copying
It is not possible to copy a License Key. The copy protection prevents the license keys from
being copied. If you attempt to copy a License Key this will be destroyed.
Data backup
When backing up data on the HMI device or creating a backup during device replacement,
remove the License Keys on the HMI device. To do this, open the Automation License Manager
and back up the uninstalled license key to another storage location.
Notice
Destruction of license keys on PCs
Start by removing all license keys in the following situations:
Before you format the hard disk.
Before you compress the hard disk.
Before you restore the hard disk.
Before you start an optimization program that moves fixed blocks.
Before you install a new operating system.
Read the description of Automation License Manager ("Start > Siemens Automation >
Documentation"). Observe all warnings and notices.
On PC-based HMI devices and on non-PC-based HMI devices where Automation License
Manager is used, the license key storage location may contain multiple license keys. This
capability means you can store multiple licenses of the same type at one location. Save all
license keys of an HMI device to the same storage location.
Notice
Always keep the original storage location of the license keys.
Defective license
A license is defective in the following cases:
If the license key is no longer accessible at the storage location.
If the license key disappears during its transfer to the destination drive.
You can use the Automation License Manager to repair the defective license. To do this, use
the "Restore" function or the "Restore wizard" of the Automation License Manager. To perform
this restore operation you must contact Customer Support.
See also
Licensing of STEP 7 (Page 114)
Hardware/software Requirement
Processor Intel Celeron Dual Core 2.2 GHz (Ivy/Sandy Bridge)
RAM 4 GB
Available hard disk space 8 GB
Operating systems * Windows 7 (32-bit)
Windows 7 Home Premium SP1
Windows 7 Professional SP1
Windows 7 Enterprise SP1
Windows 7 Ultimate SP1
Windows 7 (64-bit)
Windows 7 Home Premium SP1
Windows 7 Professional SP1
Windows 7 Enterprise SP1
Windows 7 Ultimate SP1
Windows 8.1 (64-bit)
Windows 8.1
Windows 8.1 Professional
Windows 8.1 Enterprise
Windows Server (64-bit)
Windows Server 2012 R2 StdE (full installation)
Screen resolution 15.6" wide screen display (1024 x 768)
* For more detailed information on operating systems, refer to the help on Microsoft Windows
or the Microsoft homepage.
Hardware/software Requirement
Computer From SIMATIC FIELD PG M4 PREMIUM (or similar PC)
Processor From Intel Core i5-3320M 3.3 GHz
RAM 8 GB or more
Hard disk 300 GB SSD
Monitor 15.6" Wide Screen Display (1920 x 1080)
Operating systems * Windows 7 (64-bit)
Windows 7 Home Premium SP1
Windows 7 Professional SP1
Windows 7 Enterprise SP1
Windows 7 Ultimate SP1
Windows 8.1 (64-bit)
Windows 8.1
Windows 8.1 Professional
Windows 8.1 Enterprise
Windows Server (64-bit)
Windows Server 2012 R2 StdE (full installation)
* For more detailed information on operating systems, refer to the help on Microsoft Windows
or the Microsoft homepage
You can use the following host operating systems to install "SIMATIC STEP 7 Basic" within
the selected virtualization platform:
Windows 7 Professional/Ultimate/Enterprise (64-bit)
Windows 8.1 Professional/Enterprise (64-bit)
Note
The same hardware requirements apply to the host operating system as for the respective
TIA products.
The plant operator must ensure that sufficient system resources are available for the host
operating systems.
The hardware certified by the manufacturers is recommended for the use of HyperV server
and ESXi.
When you use Microsoft Hyper-V, accessible stations cannot be displayed.
Introduction
Specific requirements for the operating system and software configuration must be met for the
installation.
Note
WinCC is generally authorized for use in a domain or workgroup.
However, be aware that domain group policies and restrictions of the domain may hinder the
installation. In this happens, remove the computer from the domain prior to installing Microsoft
Message Queuing, Microsoft SQL Server and WinCC. Log onto the computer in question
locally with administrative rights. Then perform the installation. After successful installation,
you can enter the WinCC computer back into the domain. If the domain group policies and
restrictions of the domain do not impede the installation, the computer need not be removed
from the domain during the installation.
Be aware that domain group policies and restrictions of the domain may also hinder operation.
If you cannot avoid these restrictions, run the WinCC computer in a workgroup.
Consult with the domain administrator if needed.
Installation requirements
The following table shows the minimum software and hardware requirements that have to be
met for the installation of the "SIMATIC WinCC Comfort/Advanced" software package:
Hardware/software Requirement
Processor type Intel Celeron Dual Core 2.2 GHz (Ivy/Sandy Bridge)
RAM 4 GB
Free hard disk space 8 GB
Hardware/software Requirement
Operating systems * Windows 7 (32 bit)
Windows 7 Professional SP1
Windows 7 Enterprise SP1
Windows 7 Ultimate SP1
Windows 7 (64 bit)
Windows 7 Professional SP1
Windows 7 Enterprise SP1
Windows 7 Ultimate SP1
Windows 8 (64 bit)
Windows 8.1 Professional
Windows 8.1 Enterprise
Windows Server (64 bit)
Windows Server 2008 R2 Standard Edition SP1
Windows Server 2012 R2 Standard Edition
Screen resolution 1024 x 768
Network Ethernet 10 Mbps or faster
Optical drive DVD-ROM
Software Microsoft .Net Framework 4.5
* For additional information on the operating systems, refer to the Microsoft Windows help or
the Microsoft homepage.
Simultaneously opening multiple instances of WinCC on a configuration PC can also increase
the hardware capacity required.
Note
"Aero Glass Style" of Microsoft Windows 7
A powerful graphics card is required for "Aero Glass Style". It requires DirectX9 capabilities
and 128 MB of dedicated graphics memory.
The performance of the architecture of the graphics system can significantly influence the
performance of WinCC.
Recommended hardware
The following table shows the recommended hardware for the operation of SIMATIC WinCC.
Hardware Requirement
Computer SIMATIC FIELD PG M4 PREMIUM or higher (or comparable PC)
Processor Intel Core i5-3320M 3.3 GHz or higher
RAM 8 GB or more
Hard disk 300 GB SSD
Monitor 15.6" Wide Screen Display (1024 x 768)
Optical drive DL MULTISTANDARD DVD RW
Note
The same hardware requirements apply to the guest operating system as to the respective
TIA products.
The plant operator must provide sufficient system resources for the guest operating
systems.
The hardware certified by the manufacturers is recommended for the use of HyperV server
and ESXi.
If you make changes to your operating system after the installation, the changes to the security
settings made by the installation of the TIA Portal could be changed.
You can restore the changes to the security settings made by the installation of the TIA Portal:
"Start > All Programs > Siemens Automation > Security Controller > Restore settings".
See also
Options for WinCC Engineering and Runtime systems (Page 126)
Licensing of WinCC Engineering System (Page 128)
A dialog opens during installation to inform you of any inconsistencies in your parallel
installation. The following parallel installations are permitted:
WinCC V13 and RT Advanced V13
WinCC V13 and RT Professional V13
The engineering system and Runtime must always be of the same version after an installation.
Parallel use
If the term "Combo" appears in the name or license key of the software after installation, the
use of the following products/versions is permitted in accordance with paragraph 1.6 of the
General Terms and Conditions (see also setup text):
With license for "WinCC V13 Comfort Combo": WinCC flexible 2008 Standard
With license for "WinCC V13 Advanced Combo": WinCC flexible 2008 Advanced
5.2.4.3 Add-ons
Note
In contrast to WinCC flexible 2008, functions from the WinCC flexible /Sm@rtService,
WinCC flexible /Sm@rtAccess add-ons as well as the WinCC flexible /OPC Server add-on
are incorporated into the basic functionality.
Note
In contrast to WinCC V7, functions from the WinCC / OPC Server add-on have been
incorporated into the basic functionality. Likewise, the basic functionality includes the
Runtime API from WinCC /ODK.
In addition to the Runtime add-ons, you can also expand WinCC Runtime Professional with
customized controls. The WinCC ControlDevelopment add-on is required to develop controls.
See also
Software and hardware requirements (Page 121)
Installing and uninstalling options (Page 127)
Introduction
Some add-ons are included in standard WinCC installation and are installed automatically.
During the installation of WinCC Engineering System, the following add-ons are available for
you to select for installation:
Simulation for WinCC Runtime Advanced
During the installation of WinCC Runtime Advanced, the following add-ons are available for
you to select for installation:
OPC XML Gateway
WinCC Audit Viewer
Note
When no valid license key is installed on a PC with WinCC Runtime, Runtime runs in Demo
mode.
See also
Options for WinCC Engineering and Runtime systems (Page 126)
When the trial license has expired, the following scenarios may occur:
WinCC was never licensed on the PC in question.
Operations requiring a license can no longer be performed in WinCC.
WinCC was already licensed on the PC in question.
Non-licensed mode is indicated every 10 minutes and at every action requiring a license
by a window, which you must acknowledge.
See also
Software and hardware requirements (Page 121)
Licensing WinCC Runtime on PC-based HMI devices (Page 129)
Licensing of HMI devices (Page 132)
Working with license keys (Page 132)
Powerpack (Page 135)
Installing a Powerpack (Page 136)
Note
Only the Certificate of License for WinCC Runtime V13 authorizes operation of WinCC Runtime
V13 SP1.
You can upgrade the runtime licenses of WinCC flexible 2008 and WinCC V7 with an upgrade
to WinCC Runtime V13.
Productive operation of the software is only allowed with a valid Certificate of License that
matches the version listed on it.
Non-licensed mode
WinCC Runtime and the Runtime add-ons can be used freely without license. Non-licensed
mode is indicated every 10 minutes by a window, which you must acknowledge.
See also
Licensing of WinCC Engineering System (Page 128)
License key
In order to license non-PC-based HMI devices with license keys, the
"SIMATIC HMI License Manager Panel Plugin" add-on is needed.
WinCC Setup installs this add-on by default. You open the License Manager Panel Plugin in
the Automation License Manager with the "Edit > Connect Target System > Connect HMI
Device" menu command.
If WinCC is not installed, an installation of ProSave 7.2 or higher is required.
Note
Further information on license handling can be found in the Automation License Manager help.
Note
Verify that the current version of the operating system (or higher) is installed on the HMI device
before you start licensing. If necessary, update the operating system using ProSave.
Non-licensed mode
Runtime add-ons can be used for a short time without restrictions without a valid license. Non-
licensed mode is indicated every 10 minutes by a window, which you must acknowledge.
See also
Licensing of WinCC Engineering System (Page 128)
Introduction
You transfer a license key to the HMI device in the following cases:
To use the WinCC engineering system
To operate WinCC Runtime
To use add-ons for WinCC Runtime on PC-based HMI devices
To use add-ons on non-PC-based HMI devices
You transfer a license key from the HMI device in the following cases:
When backing up data
If you no longer require the license
You can then use this license on another PC or HMI device.
When you transfer a license to an HMI device, the associated license key is removed from the
license key storage location.
Note
A license key cannot be copied. The copy protection employed prevents the license keys from
being copied.
Data backup
You transfer the license keys from the HMI device for data backup on the HMI device or as a
backup for device replacement.
You use the Automation License Manager to back up license keys from an HMI device to the
storage area of the license keys.
Notice
Destruction of license keys on non-PC-based HMI devices
License keys transferred as a result of backup/restore operations are destroyed in the case of
the following HMI devices:
270 series
370 series
Carry out the following before beginning restoring:
Use the Automation License Manager and ProSave to check whether license keys are on
the HMI device.
Transfer the license keys present from the HMI device
After restoring has been carried out, transfer the license keys back to the HMI device.
Note
Destruction of license keys on PCs
Transfer all license keys to a storage location in the following cases:
Before you format the hard disk
Before you compress the hard disk
Before you restore the hard disk
Starting an optimization program that moves fixed blocks
Installing a new operating system
Read the description of Automation License Manager ("Start > Simatic Automation >
Documentation"). Observe all warnings and notices.
The license key storage location on PC-based HMI devices and on non-PC-based HMI devices
where Automation License Manager is used may contain multiple license keys. This capability
means you can store multiple licenses of the same type at one location. For the backup, use
a single storage location for all license keys present on an HMI device.
Note
Always keep the original storage location of the license keys.
Defective license
A license is defective in the following cases:
If the license key is no longer accessible at the storage area.
If the license key disappears during its transfer to the destination drive.
Note
Resetting of the system date to an earlier time causes all licenses to be become defective.
You can use the Automation License Manager to repair the defective license. Use the "Restore"
function or the "Restore Wizard" of the Automation License Manager for this purpose. You
must contact Customer Support in order to restore the license. For additional information see:
http://support.automation.siemens.com (http://support.automation.siemens.com)
Note
The Runtime software can also be operated without errors if the license is missing or defective.
The system alerts you at brief intervals that you are working in non-licensed mode.
Note
If you start the WinCC Engineering System without a valid license key, the system alerts you
that you are working in non-licensed mode. You have the one-time option of activating a trial
license. The trial license expires after 21 days.
When the trial license has expired, the following scenarios may occur:
WinCC was never licensed on the PC in question.
WinCC can no longer be started.
WinCC was already licensed on the PC in question.
WinCC can be started. Non-licensed mode is indicated every 10 minutes by a window,
which you must acknowledge.
See also
Licensing of WinCC Engineering System (Page 128)
Powerpack
Introduction
The following upgrades are possible with a Powerpack:
From a smaller to a larger edition of WinCC Engineering System
To a runtime system with a larger tag volume
A Powerpack also includes a special license that you can use at any time to activate a higher
level of WinCC for use.
Engineering system
You own WinCC Comfort, for example. You can use the "SIMATIC WinCC Advanced
Powerpack WinCC Comfort -> WinCC Advanced V13" Powerpack to activate
WinCC Advanced for use.
Runtime
You own WinCC Runtime Advanced with 128 tags, for example. You use the "SIMATIC WinCC
Runtime Advanced Powerpack 128 PowerTags -> 512 PowerTags V13" Powerpack to
increase the tag volume from 128 to 512 tags.
You own WinCC Runtime Advanced with 128 tags, for example. You use the "SIMATIC WinCC
Runtime Professional Powerpack Runtime Advanced 128 PowerTags -> Runtime Professional
128 PowerTags V13" Powerpack to activate WinCC Runtime Professional with 128 tags for
use.
See also
Licensing of WinCC Engineering System (Page 128)
Installing a Powerpack
Introduction
Install a Powerpack by transferring the corresponding license key. The Powerpack license key
replaces the license key of an existing installation.
Requirement
The conditions described in the "System requirements" section must be fulfilled.
The license key for the license for which you have purchased a Powerpack is available on
the PC.
Installing a Powerpack
1. Open the Automation License Manager.
2. Select the license key.
3. Select "License Key > Upgrade" in the menu.
Result
The Powerpack license key replaces the former license key. You cannot reverse this process.
See also
Licensing of WinCC Engineering System (Page 128)
The location of the log file is stored in the environment variable "%autinstlog%". You can enter
this environment variable in the address bar of Windows Explorer to open the folder with the
log files. Alternatively, you can navigate to the corresponding directory by entering "CD
%autinstlog%" in the command line.
The storage location is dependent on the operating system, e.g. "C:\ProgramData\Siemens
\Automation\Logfiles\Setup" in English-language Windows.
See also
Notes on licenses (Page 112)
Starting installation (Page 137)
Checking availability of updates and support packages and installing them (Page 139)
Displaying the installed software (Page 142)
Modifying or updating installed products (Page 143)
Repairing installed products (Page 144)
Starting to uninstall (Page 146)
Introduction
Software packages are installed automatically by the setup program. The setup program starts
once the installation medium has been inserted in the drive.
Requirement
Hardware and software of the programming device or PC meet the system requirements.
You have administrator privileges on your computer.
All running programs are closed.
Procedure
To install the software packages, follow these steps:
1. Insert the installation medium in the relevant drive.
The setup program starts automatically unless you have disabled Autostart on the
programming device or PC.
2. If the setup program does not start up automatically, start it manually by double-clicking
the "Start.exe" file.
The dialog for selecting the setup language opens.
3. Choose the language in which you want the setup program dialogs to be displayed.
4. To read the information on the product and installation, click the "Read Notes" or
"Installation Notes" button.
The help file containing the notes opens.
5. Once you have read the notes, close the help file and click the "Next" button.
The dialog for selecting the product languages opens.
6. Select the languages for the product user interface, and click the "Next" button.
Note
"English" is always installed as the basic product language.
The dialog for selecting the product configuration opens.
7. Select the products you want to install:
If you wish to install the program in a minimal configuration, click on the "Minimal" button.
If you wish to install the program in a typical configuration, click on the "Typical" button.
If you wish to personally select the products to be installed, click on the "User-defined"
button. Then select the check boxes for the products you wish to install.
8. If you want to create a shortcut on the desktop, select the "Create desktop shortcut" check
box.
9. Click the "Browse" button if you want to change the target directory for the installation. Note
that the length of the installation path must not exceed 89 characters.
10.Click the "Next" button.
The dialog for the license terms opens.
11.To continue the installation, read and accept all license agreements and click "Next".
If changes to the security and permission settings are required in order to install the TIA
Portal, the security settings dialog opens.
12.To continue the installation, accept the changes to the security and permissions settings,
and click the "Next" button.
The next dialog displays an overview of the installation settings.
13.Check the selected installation settings. If you want to make any changes, click the "Back"
button until you reach the point in the dialog where you want to make changes. Once you
have completed the desired changes, return to the overview by clicking on "Next".
15.It may be necessary to restart the computer. If this is the case, select the "Yes, restart my
computer now." option button. Then click "Restart".
16.If the computer does not reboot, click "Exit".
Result
The TIA Portal along with the products and licenses you have ordered and the Automation
License Manager have been installed on your computer.
See also
Installation log (Page 136)
Notes on the system requirements (Page 113)
Notes on licenses (Page 112)
Displaying the installed software (Page 142)
Modifying or updating installed products (Page 143)
Repairing installed products (Page 144)
Starting to uninstall (Page 146)
Note
Updates and support packages from TIA Portal V13 or higher are supported.
5. Click "Next".
The selected product is installed.
See also
Installation log (Page 136)
Procedure
To display an overview of the software installed, follow these steps:
1. Click "Installed software" in the "Help" menu.
The "Installed software" dialog opens. You will see the installed software products in the
dialog. Expand the entries to see which version is installed in each case.
2. If you would like to display additional information on the installed automation software, click
the link on the "Detailed information about installed software" dialog.
The "Detailed information" dialog opens.
3. Chose the topic you want more information about in the area navigation.
See also
Notes on the system requirements (Page 113)
Notes on licenses (Page 112)
Starting installation (Page 137)
Requirement
Hardware and software of the programming device or PC meet the system requirements.
You have administrator privileges on your computer.
All running programs are closed.
Procedure
To modify or update installed products, follow these steps:
1. Insert the installation medium in the relevant drive.
The setup program starts automatically unless you have disabled Autostart on the
programming device or PC.
2. If the setup program does not start up automatically, start it manually by double-clicking
the "Start.exe" file.
The dialog for selecting the setup language opens.
3. Choose the language in which you want the setup program dialogs to be displayed.
4. To read the information on the product and installation, click the "Read Notes" or
"Installation Notes" button.
The help file containing the notes opens.
5. Once you have read the notes, close the help file and click the "Next" button.
The dialog for selecting the installation variant opens.
6. Select the "Modify/Upgrade" option button and click the "Next" button.
The dialog for selecting the product languages opens.
7. Select the check boxes of the product languages that you want to install. You can remove
previously installed product languages by clearing the corresponding check boxes.
Note
Note that the product language "English" cannot be removed.
13.It may be necessary to restart the computer. If this is the case, select the "Yes, restart my
computer now." option button. Then click "Restart".
14.If the computer does not reboot, click "Exit".
Result
The existing installation has been modified on your computer.
See also
Notes on the system requirements (Page 113)
Notes on licenses (Page 112)
Starting installation (Page 137)
Displaying the installed software (Page 142)
Repairing installed products (Page 144)
Starting to uninstall (Page 146)
Installation log (Page 136)
Requirement
Hardware and software of the programming device or PC meet the system requirements.
You have administrator privileges on your computer.
All running programs are closed.
Procedure
To repair installed products, follow these steps:
1. Insert the installation medium in the relevant drive.
The setup program starts automatically unless you have disabled Autostart on the
programming device or PC.
2. If the setup program does not start up automatically, start it manually by double-clicking
the "Start.exe" file.
The dialog for selecting the setup language opens.
3. Choose the language in which you want the setup program dialogs to be displayed.
4. To read the information on the product and installation, click the "Read Notes" or
"Installation Notes" button.
The help file containing the notes opens.
5. Once you have read the notes, close the help file and click the "Next" button.
The dialog for selecting the installation variant opens.
6. Select the "Repair" option button, and click the "Next" button.
The next dialog displays an overview of the installation settings.
7. Click the "Repair" button.
This starts the repair of the existing installation.
Note
Following installation, you will receive a message indicating whether the existing installation
was successfully repaired.
8. It may be necessary to restart the computer. If this is the case, select the "Yes, restart my
computer now." option button. Then click "Restart".
9. If the computer does not reboot, click "Exit".
Result
The installed products have been reinstalled.
See also
Notes on the system requirements (Page 113)
Notes on licenses (Page 112)
Starting installation (Page 137)
Displaying the installed software (Page 142)
Introduction
Software packages are removed automatically by the setup program. Once started, the setup
program guides you step-by-step through the entire removal procedure.
You have two options for removing:
Removing selected components via the Control Panel
Removing a product using the installation medium
Note
The Automation License Manager will not be removed automatically when you remove the
software packages, because it is used for the administration of several license keys for
products supplied by Siemens AG.
See also
Installation log (Page 136)
Notes on the system requirements (Page 113)
Notes on licenses (Page 112)
Starting installation (Page 137)
Displaying the installed software (Page 142)
Modifying or updating installed products (Page 143)
Repairing installed products (Page 144)
Procedure
To install the migration tool, proceed as follows:
1. Download the installation file from the Siemens Industry Online Support, or use the
installation file from the "Support" directory of the installation DVD of the TIA Portal to
perform the installation.
2. Run the installation file.
The setup program for the migration tool will open.
3. First, select the language in which the setup should be displayed and click the "Next" button.
The page for selecting the software language is displayed.
4. Since the migration tool is provided exclusively in English, you cannot choose any other
language for the installation. Therefore, click "Next" to proceed to the next step.
The page for selecting the product is displayed.
5. The migration tool consists solely of a software component. Therefore, the migration tool
is already selected.
To create a Desktop icon for starting the migration tool, select the check box "Create
Desktop icon". Then click the "Next" button.
The page for confirming the licensing terms is shown.
6. Click on an entry in the list of license terms to read the selected license term. If you agree
with all license terms, select the check box "I accept the terms of the displayed license
agreement". Then click the "Next" button.
An overview of the installation is displayed.
7. Click the "Install" button.
The installation is performed with the displayed settings.
Procedure
To remove the migration tool, follow these steps:
1. Open the Control Panel.
2. Double click on "Add or Remove Programs" in the Control Panel.
The "Add or Remove Programs" dialog opens.
3. Select the entry for the migration tool in the "Add or Remove Programs" dialog, and click
the "Remove" button.
A security prompt appears.
4. Click the "Uninstall" button to confirm this prompt.
The migration tool will be removed.
Migration paths
If you want to continue to use existing projects or programs with the latest version of the TIA
Portal and the S7-1500, you have several options for migrating projects.
The following graphic provides an overview of the migration options:
0LJUDWH3/&
0LJUDWHSURMHFW SURJUDPWR
6
6 6
6 6 6
Upgrading projects
You can also continue to use projects from previous versions of the TIA Portal. However, these
projects do not need to be migrated. You upgrade projects from previous versions to the current
version of the product or use projects from TIA Portal V12 SP1 in compatibility mode. You can
find additional information on compatibility and upgrading projects in the section "Upgrading
projects (Page 380)".
Note
Additional support for migration
You can find the latest information about migration in the Siemens Industry Online Support.
Migration of entire systems (http://support.automation.siemens.com/WW/view/en/83558085)
If you need further support, contact SIMATIC Customer Support.
See also
Compatibility of projects (Page 377)
Upgrading projects (Page 380)
Migration of controllers (http://support.automation.siemens.com/WW/view/en/83557459)
Migration of visualization (http://support.automation.siemens.com/WW/view/en/76878921)
Migration of communication (http://support.automation.siemens.com/WW/view/en/83558087)
Migration of I/O (http://support.automation.siemens.com/WW/view/en/83558994)
The migration is then displayed in the table of the project history. From there, you have access
to the migration log that is created automatically for the migration.
See also
Display migration log (Page 160)
Scaling of STEP 7 and WinCC in the TIA Portal (Page 33)
Introduction
Siemens offers a tool that can be used to check whether the hardware configuration used in
an initial project is ready for migration to the TIA Portal.
Components integrated via GSD or GSDML files cannot be checked. For such modules, check
manually in the TIA Portal whether the modules are available in the hardware catalog. If the
modules are not available there, install the required GSD or GSDML files in the TIA Portal.
You can obtain the required files from the manufacturer of the components.
In the result you can also see which software products and licenses have to be available on
the programming device/PC with the installation of the TIA Portal to perform a migration. You
can also see as of which firmware version the individual modules of the initial project are
supported in TIA Portal. The result of the check can be output in a Microsoft Excel file or in
PDF format.
Download
The tool for checking the migration readiness is available for download in the FAQs of the
Siemens Industry Online Support under entry number 60162195 (http://
support.automation.siemens.com/WW/view/en/60162195).
See also
Tool for checking migration readiness (http://support.automation.siemens.com/WW/view/en/
60162195)
See also
Migration of projects with the TIA Portal (Page 152)
Migrating projects (Page 158)
Calling the migration tool (Page 157)
Creating a migration file (Page 157)
See also
Creating a migration file (Page 157)
Requirement
The suitable, original software with a valid license is installed for all configurations used in
the initial project.
The initial project is not provided with access protection.
The initial project must be consistent, otherwise problem-free migration cannot be assured.
Procedure
To create the migration file, proceed as follows:
1. Select the path of the source file for the migration in the "Storage Location (Path)" field.
2. Specify the project parts that are to be migrated:
Select the "Include HW and Network data during the migration" check box to migrate
not only the software but also the complete hardware parts and the network configuration
of the project.
Select the "Copy SCADA runtime data" check box if you also want to migrate the runtime
data, such as alarm archives, tag archives and user archives, in addition to the data of
the engineering system.
3. Select the path and the file name for the migration file in the "Intermediate file" field.
4. Click the "Migrate" button.
Result:
A migration file is created. You now copy this file to the target system and migrate this file in
the TIA Portal.
See also
Migrating projects (Page 158)
Calling the migration tool (Page 157)
Migrating projects with the migration tool (Page 155)
Requirement
A converted file in the format ".am13" is already available or the original software with a
valid license is installed for all configurations used in the initial project.
The initial project is not provided with access protection.
The initial project must be consistent, otherwise problem-free migration cannot be assured.
Read the additional information on the requirements in the help for the respective products
installed.
Note
System hibernation during the migration
While a migration is running, the system should not be changed to the standby or hibernate
mode. Otherwise the migration will be aborted.
Procedure
To migrate a project, follow these steps:
1. Select the "Migrate project" command in the "Project" menu.
The "Migrate project" dialog opens.
2. Specify the path and the file name for the project to be migrated in the "Source path" field.
Select either a project in the ".am13" migration format or in the format of the initial project.
3. To include the hardware configuration in the migration, select the "Include hardware
configuration" check box.
If you have selected a migration file that was created with the migration tool, the check box
cannot be selected. In this case, you must specify if you wish to include the hardware
configuration in the migration before the conversion with the migration tool .
4. Select the "Copy WinCC Runtime Professional data" check box, if you also want to migrate
the runtime data, such as alarm archives, tag archives and user archives, in addition to the
data of the engineering system.
If you have selected a migration file that was created with the migration tool, the check box
cannot be selected. In this case, you must specify if you wish to include the SCADA runtime
data in the migration before the conversion with the migration tool .
5. Select a name for the new project in the "Project name" box.
6. Select a path in the "Target path" box where the new project is to be created.
7. Enter your name or the name of another person responsible for the project in the "Author"
field.
8. Enter a comment in the "Comment" box, if you require one.
9. Click "Migrate".
Result
The initial project is converted and a message appears after conversion is complete. The newly
created project is then opened in the project view, and the migration log is opened in the TIA
Portal.
Even if the migration failed, a project directory is created and a migration log in the form of an
XML file is generated in this directory. The completion message that appears after the migration
contains a link to this XML file. Click the link to open the XML file. Alternatively, you can find
the XML file in the project directory under "\Logs".
See also
Post-editing integrated projects (Page 211)
Display migration log (Page 160)
Using logs (Page 376)
Migrating projects with the migration tool (Page 155)
Creating a migration file (Page 157)
Procedure
To display the migration in an overview table, follow these steps:
1. Select the open project in the project tree.
2. Select "Properties" in the shortcut menu of the project.
The dialog with the properties of the project opens.
3. Select the "Project history" group in the area navigation.
The overview table is displayed.
See also
Displaying properties of the project (Page 382)
Procedure
To display the log file of the migration, follow these steps:
1. Open the "Common data > Logs" folder in the project tree.
2. Double-click the desired log in the list.
The contents of the log are displayed in the work area.
See also
Migration of projects with the TIA Portal (Page 152)
Using logs (Page 376)
Introduction
You can continue to use projects in WinCC from WinCC flexible. The following versions of
WinCC flexible are supported:
WinCC flexible 2008 SP2
WinCC flexible 2008 SP3
The following sections describe the HMI devices that are supported and the required basic
conditions for a successful migration.
Projects from ProTool Pro and earlier WinCC flexible versions cannot be migrated directly to
WinCC. If you want to continue using such projects in WinCC, you have to migrate these to a
supported version of WinCC flexible first and change the HMI device type.
If the project to be migrated contains components of a supported option package, the option
package must be installed for successful migration to WinCC. If the option package is not
installed, migration is canceled. This concerns the following option packages:
SINUMERIK
The following option packages are not supported by the migration:
ProAgent
Open Platform Program - OPP
See also
Migrating projects from WinCC flexible (Page 164)
Compiling and loading a migrated project (WinCC flexible) (Page 166)
Supported HMI devices (Page 167)
Migration of connections (WinCC flexible) (Page 176)
Migration of tags (WinCC flexible) (Page 179)
Migration of runtime data (WinCC flexible) (Page 188)
Migration of integrated projects (WinCC flexible) (Page 191)
Introduction
In the migration the project data are converted from a WinCC flexible project into the new data
format of WinCC. The data will not be evaluated to see if they are consistent in the project you
want to migrate. If errors or warnings are output in a source project during compilation, these
will not be resolved as part of the migration. This means you should be able to compile the
project without errors prior to migration. Note the scope of a project during migration. The
features of WinCC apply for migration. For additional information refer to the online help in
section "Process visualization > Performance features > Engineering System".
Note
Changed OPC DA server name
If you have configured an OPC-DA server in the WinCC flexible project, the OPC-DA server
is no longer available under the old name after migration.
In the migrated project, change the name of the OPC-DA server to the following value for the
OPC clients concerned: "OPC.SimaticHMI.CoRtHmiRTm".
Affected objects
The following objects are renamed if necessary:
Screens
Faceplates
Screen objects
Graphics
Recipes
Structures
Structural elements
Alarm logs
Tags
Data logs
Connections
Canceling migration
The migration is canceled in the following cases:
If the project to be migrated is opened in the engineering system or in Runtime.
If not enough memory space is available on the hard disk to create a copy for migration of
the project.
If the migration cannot address the project database due to problems with the installed SQL-
Server.
If the migration cannot address the project database due to missing user authorization.
If you select the "*.hmi" file for the migration in an integrated project. You must select the
"*.s7" file for the migration in an integrated project.
If the project was created with a version not supported by the migration.
Introduction
When you migrate a project, data from a WinCC flexible project is loaded into a new project
for WinCC. A new project is therefore created automatically for project migration. You cannot
migrate to an existing project.
The migration can be started in both the Portal view and the Project view.
You should only migrate a project to a re-started TIA Portal.
Information on the migration of an integrated project can be found in the section Migration of
integrated projects (WinCC flexible) (Page 191).
If you only want to save the project in migration format, you can use the migration tool. See
Migration principles (WinCC flexible) (Page 162) for additional information.
Note
Further support for migration
You find current information on migration in the Siemens Industry Online Support:
Migration of visualization
If you need further assistance, please contact the SIMATIC Customer Support.
Requirement
A project from WinCC flexible is available.
The project is not open in WinCC flexible.
Procedure
Migrate a project in the Portal view as follows:
1. Select the action "Start > Migrate Project".
2. In the "Source path" box, navigate to the project you want to migrate.
When migration is complete, you will find a newly created device for each migrated HMI device
in the project tree. These devices contain the migrated data, such as screens, alarms and tags.
See also
Migration (WinCC flexible) (Page 161)
Migration of integrated projects (WinCC flexible) (Page 191)
Migration principles (WinCC flexible) (Page 162)
See also
Migration (WinCC flexible) (Page 161)
Introduction
When migrating projects from WinCC flexible you must bear in mind that WinCC does not
support all HMI devices. You have to distinguish between the following cases:
HMI device is supported by WinCC.
The project is migrated 1:1 and gets the same HMI device after migration as before
migration.
The HMI device is replaced by a compatible successor model.
The project is migrated. The migration replaces the HMI device with a compatible successor
model. See HMI device change as a result of migration (WinCC flexible) (Page 169) for
additional information.
HMI device is not supported.
If your WinCC flexible project contains an HMI device that is not supported by WinCC, the
migration process is cancelled. To migrate the project, you must change the HMI device in
WinCC flexible to a HMI device type supported by WinCC.
The following HMI device types are supported both by WinCC flexible and WinCC:
Basic Panels
KTP400 Basic mono PN
KTP400 Basic mono PN Portrait
KTP600 Basic DP
KTP600 Basic DP Portrait
KTP600 Basic PN
KTP600 Basic PN Portrait
KTP600 Basic mono PN
KTP600 Basic mono PN Portrait
KTP1000 Basic DP
KTP1000 Basic PN
TP1500 Basic PN
Mobile Panels
Mobile Panel 177 6'' DP
Mobile Panel 177 6'' PN
Mobile Panel 277 8''
Mobile Panel 277 8'' IWLAN V2
Mobile Panel 277F 8'' IWLAN V2
Mobile Panel 277F 8'' IWLAN (RFID Tag)
Mobile Panel 277 10''
Panels
OP 73
OP 77A
OP 77B
OP 177B 6'' mono
OP 177B 6'' color PN/DP
TP 177B 4'' color PN/DP
TP 177A
TP 177A Portrait
TP 177B 6'' mono DP
TP 177B 6'' color PN/DP
OP 277 6''
TP 277 6''
Multi Panels
MP 177 6'' Touch
MP 277 8'' Key
MP 277 8'' Touch
MP 277 10'' Key
MP 277 10'' Touch
MP 377 12'' Key
MP 377 12'' Touch
MP 377 15'' Touch
MP 377 15" Touch daylight readable
MP 377 19'' Touch
Sinumerik PC
OP 010 Key
OP 012 Key
OP 015 Key
OP 015A Key
TP 015A Touch+Key
HMI applications
WinCC flexible Runtime
WinCC only supports the functions provided by these HMI device types.
Other functions which are not migrated because of the restricted device selection are
documented in the following sections.
See also
Migration (WinCC flexible) (Page 161)
HMI device change as a result of migration (WinCC flexible) (Page 169)
Configuration change after HMI device change (WinCC flexible) (Page 172)
Migration of connections (WinCC flexible) (Page 176)
Introduction
WinCC flexible supports some HMI devices which are discontinued in the future. These HMI
devices are no longer supported by WinCC. When migrating a WinCC flexible project, an HMI
device that is not supported is replaced by a compatible successor device.
Only the HMI device type is changed during the migration. HMI device-specific data are not
changed by the migration.
Inconsistencies in the project may occur due to a change in the HMI device. In a project which
was compilable before the migration, errors may occur in the project compilation after changing
the HMI device. E.g. because the changed HMI device supports different memory media to
the previous HMI device.
See also
Supported HMI devices (Page 167)
Note
If you migrate a project with embedded screens, this can result in the project file becoming
larger than the old project file.
See also
Supported HMI devices (Page 167)
Introduction
When migrating projects from WinCC flexible, all configuration data involving an HMI device
supported by WinCC will be migrated. Basically, all object types and functions that are available
and can be mapped to the new project environment will be fully migrated.
Some global object types are not migrated, for example, dictionaries and global libraries.
Area pointers
Faceplates
Screens
Screen template
Data types
Function lists
Graphics lists
Display and operating elements
All display and operating elements that are available on the supported HMI devices are
supported for migration.
Alarms
Alarm classes
Alarm groups
Project library
Project languages
Reports
Recipes
Runtime languages
Runtime scripting
Sm@rtAccess/Sm@rtService
Structures
System events
System functions
Texts
Text lists
Tags
Connections
Effective ranges
Zones
Cycles
Project versions
Change log
See also
Changes of values of object properties by the migration (WinCC flexible) (Page 175)
Introduction
The standardization of object properties from WinCC V7 and WinCC flexible requires changes
to the object properties during the migration process. The migration calculates the changes in
such a way that the representation of the objects after migration is the same as prior to
migration. Changes made during migration result in different units of measurements and values
in the configuration for some object properties.
See also
Object support during migration (Page 172)
Introduction
If you migrate a project in which a supported communication driver is used, this driver is used
further in WinCC. Objects which communicate via this driver are migrated 1:1. No rework is
necessary.
Not all communication drivers which are available in WinCC flexible are supported in WinCC.
If an unsupported driver is used in the project to be migrated, there are two possible scenarios:
1. A compatible spare driver is available for the used driver.
2. No compatible spare driver is available for the used driver.
See also
Migration (WinCC flexible) (Page 161)
Supported HMI devices (Page 167)
Adapting configuration for non-migrated connection (WinCC flexible) (Page 178)
Migration of area pointers (WinCC flexible) (Page 179)
Migration of tags (WinCC flexible) (Page 179)
Introduction
If a connection cannot be migrated you have the following options:
Change the configuration in WinCC flexible before the migration
Change the configuration after the migration
See also
Migrating projects from WinCC flexible (Page 164)
Migration of connections (WinCC flexible) (Page 176)
Introduction
The migration of area pointers depends on the used communication driver.
If the used communication driver is supported by the migration, area pointers from WinCC
flexible are taken over unchanged in the migration.
if the used communication driver is not supported by the migration, area pointers are not
migrated.
See also
Adapting configuration for non-migrated connection (WinCC flexible) (Page 178)
Migration of connections (WinCC flexible) (Page 176)
Introduction
You need to make some special considerations when migrating tags. The following aspects
should be distinguished:
Migrating data types of tags
Migrating internal tags
Migrating external tags
Tag names
Tag limits
See also
Migration of data types (WinCC flexible) (Page 195)
Migration of connections (WinCC flexible) (Page 176)
Migration principles (WinCC flexible) (Page 162)
Migration (WinCC flexible) (Page 161)
Migration of alarm classes and alarm groups (WinCC flexible) (Page 181)
Migrating scripts (Page 184)
Migration of language-specific content (WinCC flexible) (Page 185)
Migration of libraries (WinCC flexible) (Page 187)
Migration of structures
The "StringChar" data type is not supported in HMI user data types in WinCC.
If you have used this data type in a structure in a WinCC flexible project, an invalid element is
created by the migration in the HMI user data type.
After migration , you must re-work this user data type in WinCC and enable the user data type.
At the same time, check the offset of the following elements and any existing interconnections
between a faceplate and the elements of the user data type. Adapt the elements if required.
Migration of logs
The names of the alarm classes can be changed as necessary after migration.
Also note:
When migrating alarm groups that supposedly have the same group name, the migration
adapts the name. This occurs, for example, when a group name contains a space at the end
of the name. The migration deletes all existing spaces at the end of names. If two groups
obtained the same group names due to this deletion, the migration adds the suffix "# Mign" to
the group name of the following alarm groups, where "n" stands for a sequential number.
Example:
The following alarm groups exist in WinCC flexible:
"AlarmGroup_18"
"AlarmGroup_18 " - group name contains one space
"AlarmGroup_18 " - group name contains two spaces
"AlarmGroup_18" is the alarm group with the highest number.
Result after migration:
"AlarmGroup_18"
"AlarmGroup_18#Mig1"
"AlarmGroup_18#Mig1.1"
The names of the alarm classes can be changed as necessary after migration.
The changed concept may cause the display of messages to change following migration.
If all the display classes for ALARM_S messages are activated and the display of
SIMATIC SFM messages is deactivated in the WinCC flexible project , ALARM_S messages
and SIMATIC SFM messages are displayed following migration.
To ensure that only ALARM_S messages are displayed following migration, you have to assign
the SIMATIC SFM messages to an unused display class after migration to STEP 7. You then
have to deactivate this display class in WinCC.
If all the display classes for ALARM_S messages are deactivated and the display of
SIMATIC SFM messages is activated in the WinCC flexible project , ALARM_S messages and
SIMATIC SFM messages are not displayed following migration.
To ensure that only SIMATIC SFM messages are displayed following migration, you have to
assign the SIMATIC SFM messages to an unused display class after migration to STEP 7.
You then have to activate this display class in WinCC.
The display class is dependent on the settings in STEP 7. The default setting for SIMATIC SFM
messages in Step 7 is the display class "0". To activate the display in WinCC, the display class
"0" must be activated.
You activate the display class in WinCC in the Runtime settings of the respective HMI device
in the "Messages" category.
See also
Migration of tags (WinCC flexible) (Page 179)
Migrating scripts
Introduction
The migration supports VB-scripts which were created in WinCC flexible. For a VB-script to
be migrated successfully it must be functionable in WinCC flexible first.
Note
Script errors
The most efficient way to locate scripting errors in the course of the initial test run after migration
is to use an installed Script Debugger and the diagnostics controls.
Migration of a VB script
A script is analyzed in the migration and adapted to the system behavior of WinCC if necessary.
The following is adapted:
System functions which have changed their names are renamed.
This concerns the following system functions:
The access to tags as parameters of system functions is adapted to the system behavior
of WinCC. In WinCC scripts are no longer transfromed as in WinCC flexible. The scripts
are executed directly as a source code. Therefore the stricter rules for the VBS syntax
apply. A tag call is always migrated with inverted commas. If several parameter types are
allowed for a system function, these are migrated with the keyword "SmartTags".
Example 1:
The value of the "temperature" tag should be incremented by the value "1".
Valid expressions in WinCC flexible:
IncreaseValue temperature, 1
IncreaseValue "temperature", 1
IncreaseValue SmartTags("temperature"), 1
Valid expression in WinCC:
IncreaseTag "temperature", 1
Example 2:
You use a system function on which several parameters are allowed. The value of the
"temperature" tag should be incremented by the value of the "heatcontrol" tag.
Valid expression for WinCC flexible:
IncreaseValue "temperature", "heatcontrol"
Valid expression for WinCC:
IncreaseTag "temperature", SmartTags("heatcontrol")
Objects renamed by the migration are also renamed in the script when using in a script.
See the section Migration principles (WinCC flexible) for further information about the
renaming objects. You only have to observe the following rules when renaming objects:
If you address objects whose names are dynamically generated by the script with the help
of a script, the object names in the script can not be automatically changed by the migration.
In such a case, you have to correct the generation of the object names in the script after
migration.
See also
Migration of tags (WinCC flexible) (Page 179)
Introduction
WinCC offers the same options for configuring projects in different languages as those
available in WinCC flexible. All languages supported by WinCC are included in the migration
of a project.
Unsupported languages
The migration of language-dependent content depends on whether or not WinCC supports the
respective language.
If a project only contains project languages not supported by WinCC, the project will not be
migrated.
If a project contains supported and unsupported project languages, only the supported
languages will be migrated. The editing language and reference language are set to a
supported language.
The following languages are not supported by WinCC:
Arabic
Hebrew
Dhivehi
Gujarati
Kannada
Tamil
Telugu
Urdu
Punjabi
Persian
Syrian
See also
Migration of tags (WinCC flexible) (Page 179)
Introduction
You need to consider two different cases when migrating from libraries:
1. Migrating a project library
2. Migrating a global library
See also
Migration of tags (WinCC flexible) (Page 179)
Introduction
Only the configuration data are migrated by the migration when migrating a project. The runtime
data are not affected. You need to update the runtime data following migration.
The runtime data consists of the following:
Runtime project
The runtime project contains the compiled project data.
Recipe data and user administration
The recipe data and user administration are data that can be changed in runtime.
Log data
The data of tag logs and alarm logs are acquired and logged in runtime.
appropriate system functions in your project, use the system functions. The following system
functions are available for the recipe data:
"ExportDataRecords" for the backup
"ImportDataRecords" for the restore
You update the runtime project by compiling the project in WinCC again and loading it to the
HMI device.
After you have loaded the migrated project on the HMI device, restore the recipe data and the
user administration to the HMI device.
See also
Migration (WinCC flexible) (Page 161)
Backing up recipe data and user administration (WinCC flexible) (Page 189)
Restoring recipe data and user administration (WinCC flexible) (Page 190)
Introduction
To continue using the recipe data and user administration in a migrated project, you first need
to back up this data from the HMI device. Then load the data into the migrated WinCC project.
Use ProSave to back up the data.
Requirement
The WinCC flexible project is running on the HMI device in Runtime.
The HMI device is connected to a PC on which ProSave is installed.
Procedure
Proceed as follows to back up the recipe data and user administration:
1. Start ProSave.
2. Select the device type and the connection parameters in the "General" tab.
3. Open the "Backup" tab.
4. Select the "Recipes from the device memory" entry in the "Data type" box.
Do not select "Complete backup" because otherwise you will not be able to select separately
when restoring the recipe data.
5. Navigate to the desired location in the "Save as" box and click "Start Backup".
The recipe data are saved.
6. Select "User administration" in the "Data type" box and click "Start Backup".
The user administration is saved.
For additional information refer to the online help for ProSave.
Alternative procedure
ProSave is automatically installed with WinCC flexible. The entire functional range of ProSave
is available on the configuration PC within WinCC flexible via the menu command "Project >
Transfer".
Alternatively, you can back up the recipe data and user administration via the ProSave
integrated in WinCC flexible. Start WinCC flexible and select the menu command "Project >
Transfer > Backup". Back up the recipe data and user administration as described in steps 4-6.
See also
Migration of runtime data (WinCC flexible) (Page 188)
Introduction
To continue using saved recipe data and user administration after the migration, you first need
to compile the migrated project and load it to the HMI device. You can then transfer the saved
data to the HMI device. Use ProSave to restore the data.
Requirement
The migrated project has been transferred to the HMI device and is running in runtime.
The HMI device is connected to a PC on which ProSave is installed.
Procedure
Proceed as follows to load the saved recipe data and user administration to the HMI device:
1. Start ProSave.
2. Select the device type and the connection parameters in the "General" tab.
3. Open the "Restore" tab.
4. Navigate to the location of the saved recipe data in the "Opening..." box and select the file.
5. Click "Start Restore".
The recipe data will be transferred to the HMI device..
6. Repeat steps 4-5 to restore the user administration.
The user administration will be transferred to the HMI device.
For additional information refer to the online help for ProSave.
Alternative procedure
ProSave is automatically installed with WinCC. The entire functional range of ProSave is
available on the configuration PC within WinCC flexible via the menu command "Project >
Transfer".
You can also restore the recipe data and user administration via the ProSave integrated in
WinCC. Start WinCC and select the menu command "Online > Device maintenance >
Restore". Restore the recipe data and user administration as described in steps 4-6.
See also
Migration of runtime data (WinCC flexible) (Page 188)
Introduction
If an HMI device supports external memory media and the log data are saved there, the data
remain on the memory medium. External memory media are for example StorageCard or a
network drive. If a log is saved on an external memory medium, the migrated project accesses
this storage location again after the migration. In this case the log data must not be backed up.
See also
Migration of runtime data (WinCC flexible) (Page 188)
Introduction
The controllers and HMI devices contained in a project integrated in STEP 7 are linked together
by the configuration. The configuration data of WinCC flexible and STEP 7 are also connected.
When an integrated project is migrated, the complete project will be migrated with components
from WinCC flexible and STEP 7. The connections remain intact.
Note
It is advisable to compile and save an integrated project in WinCC flexible before you migrate
it. You can be sure that the data in WinCC flexible and STEP 7 is synchronized if compilation
was completed without errors.
See also
Migration (WinCC flexible) (Page 161)
Migrating an integrated project (Page 193)
Migration principles (WinCC flexible) (Page 162)
Introduction
When migrating an integrated project, the components from both the WinCC flexible project
and the STEP 7 project will be migrated. This means you need to select the project file with
the file extension "*.s7p" for migration. During migration, the data is copied from the existing
project and migrated to a new project. You cannot migrate to an existing project.
The migration can be started in both the Portal view and the Project view.
You should only migrate a project to a re-started TIA Portal.
If you only want to save the project in migration format, you can use the migration tool. For
more information, refer to basics of migration (WinCC flexible).
Requirement
STEP 7 V5.4 SP5 or STEP 7 V5.5 and all option packages used are installed.
STEP 7 and all option packages used are installed.
The TIA Portal is restarted.
No project is open in WinCC.
An integrated project is available.
The integrated project is not open.
Procedure
To migrate an integrated project in the portal view, follow these steps:
1. Select the action "Start > Migrate Project".
2. In the "Source path" box, navigate to the project you want to migrate.
6. Click "Migrate".
A new project is created and migration of the data is started:
The Project view opens.
The progress of the migration is shown in a migration window.
Warnings and errors about the migration process are displayed in the Inspector window
under "Info > General".
All information about the migration is saved in a log file.
A message is displayed upon completion of the migration. The message contains a link
that you can use to open the log file.
7. Once migration is completed, save the project.
Once the migration is complete, you will find a newly created device for each migrated HMI
device and controller in the project tree. These devices include the migrated data.
See also
Migration of integrated projects (WinCC flexible) (Page 191)
Migration principles (WinCC flexible) (Page 162)
Introduction
To harmonize the data types used by PLCs and HMI systems, some data types of the internal
HMI tags are renamed. The naming takes place in accordance with IEC conventions. Because
only the names change, there are no changes to the internal tags for the configuration.
The following table describes the mapping of the internal data types from WinCC flexible to
the data types in WinCC.
See also
Migrating data types of Allen-Bradley DF1 (WinCC flexible) (Page 197)
Migrating data types of Allen-Bradley DF485 (WinCC flexible) (Page 197)
Migrating data types of Allen-Bradley Ethernet IP (WinCC flexible) (Page 198)
Migrating data types of GE Fanuc SNP (WinCC flexible) (Page 198)
Migrating data types of LG GLOFA GM (WinCC flexible) (Page 199)
Migrating data types of Mitsubishi FX (WinCC flexible) (Page 199)
Migrating data types of Mitsubishi Protocol 4 (WinCC flexible) (Page 200)
Migrating data types of Modicon Modbus (WinCC flexible) (Page 201)
Migrating data types of Modicon Modbus TCP/IP (WinCC flexible) (Page 201)
Migrating data types of Omron Hostlink/Multilink (WinCC flexible) (Page 202)
Migrating data types of OPC (WinCC flexible) (Page 202)
Migrating data types of SIMATIC 500/505 DP (WinCC flexible) (Page 203)
Migrating data types of SIMATIC 500/505 serial (WinCC flexible) (Page 203)
Migrating data types of SIMATIC HMI HTTP Protocol (WinCC flexible) (Page 204)
Migrating data types of SIMATIC S5 AS511 (WinCC flexible) (Page 204)
Migrating data types of SIMATIC S5 DP (WinCC flexible) (Page 205)
Migrating data types of SIMATIC S7 200 (WinCC flexible) (Page 205)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
If the S7 data type "Char" is used for numerical values and negative numbers were configured
at the point of use, the result is an error in mapping to the S7 data type "Byte". The S7 data
type "Byte" cannot map any negative numbers. You have to adapt the configuration accordingly
to correct the error. Use a signed data type, such as the data type "Int", for processing positive
and negative numerical values.
If the S7 data type "Char" is used for mapping characters, you must change the configuration
after migration. To represent characters, use the data type "String".
When an integrated project is migrated, the data type "Char" in WinCC is also migrated to the
data type "Byte". With a connected PLC tag, the data type "Char" remains "Char". As a result
of changing the data type of the HMI tag, symbolic addressing of the tags in question is not
migrated. After migration. the tags are interconnected by absolute addresses and continue to
work. If you want to restore symbolic addressing, you have to change the configuration
accordingly after the migration.
WinCC
WinCC
See also
Migration of data types (WinCC flexible) (Page 195)
See also
Migration of data types (WinCC flexible) (Page 195)
Introduction
In integrated projects, you use SIMATIC controllers and WinCC components together in a
project. When an integrated project is migrated, the complete project will be migrated with
components from WinCC and STEP 7. Configured connections between control and
visualization remain intact.
Additional migration requirements for integrated projects can be found in the documentation
for WinCC.
Also note that the initial project must be compiled before the migration.
In order to fully migrate an integrated project, the following components must be installed on
the programming device/PC for the migration:
STEP 7 V5.4 SP5 or STEP 7 V5.5
WinCC V7.2 with the latest update or WinCC flexible 2008 SP2 and SP3
To be able to fully post-edit an integrated project, the latest version of the following components
must be installed on the PC for post-editing:
STEP 7 Professional
WinCC Basic, WinCC Comfort/Advanced or WinCC Professional, depending on the
components used
Unsupported objects
The following components are not supported for migration:
STEP 7 multiproject
A STEP 7 multiproject cannot be migrated. Migration will be canceled.
Central Archive Server - CAS
If a CAS is part of an integrated project, then the migration will be carried out but the CAS
data will not be migrated.
See also
Post-editing integrated projects (Page 211)
The original CPU 317-2 PN/DP was replaced with an unspecified CPU during migration.
The link between the CPU and HMI device is also unspecified and must be renewed.
Procedure
To continue to use an integrated project after the migration, follow these steps:
1. Convert the unspecified devices into suitable devices again.
2. Restore the integrated HMI connection between the HMI device and the PLC.
3. Connect all HMI tags to the newly created integrated connection.
4. Restore the connection between HMI tags and PLC tags.
5. Delete the non-integrated HMI connection.
In the following chapters a sample project is used to describe the individual steps in more detail.
See also
Converting unspecified CPUs into specified CPUs (Page 213)
Creating an integrated HMI connection (Page 214)
Re-linking HMI tags (Page 216)
Deleting an unspecified connection (Page 217)
3. Under "New device" in the tree structure, select the module with which you want to replace
the unspecified CPU. (Area 1)
"Compatibility information" provides you with information on the extent to which the selected
CPU is compatible with the configuration in source project. (Area 2)
4. Click "OK".
5. Perform the above-described steps for all unspecified CPUs.
See also
Creating an integrated HMI connection (Page 214)
Procedure
To create a connection graphically, follow these steps:
1. On the toolbar, click the "Connections" icon. This activates connection mode.
2. Select the connection type "HMI connection" in the adjacent drop-down list.
The network view highlights in color all CPUs and HMI devices that can be used for an HMI
connection.
3. You can now have the connection path automatically determined, or explicitly select a
connection path via specific interfaces:
Allow connection path to be automatically determined
Select the source CPU for a connection. Drag the mouse to the target components.
Confirm the connection endpoint with another mouse click.
Alternatively: While holding down the shift button, select the target components and with
the right mouse button select the "Add new connection" command.
Selecting an explicit connection path from interface to interface
Click on the subnet interface in the device for which you want to create a connection.
Hold down the mouse button, drag the cursor to the relevant interface in the target device
and then release the mouse button.
Result
The following figure shows the state after the integrated connection has been created:
See also
Re-linking HMI tags (Page 216)
Procedure
To re-link HMI tags, follow these steps:
1. In the project tree, navigate to the HMI tags and double-click the relevant tag table to show
this in the work area.
The tag table opens.
See also
Deleting an unspecified connection (Page 217)
Procedure
To delete unspecified connections, follow these steps:
1. In the project tree, open the HMI device and double-click the "Connections" entry.
The connection table opens.
Introduction
If you have used a CPU with firmware version V3 in your project and want to upgrade to a
CPU with firmware V4.0 or later, you can easily replace the device.
The TIA Portal offers the "Change device" function for this purpose. The project remains
unchanged when the device is replaced. You can continue using the programs that you created
with firmware version V3.
Rules
The following basic rules apply when replacing a device:
Replacing a device is only possible if the project was created based on a CPU with firmware
version V3.0. If your project was created based on firmware version V1.0 or V2.0, create
a new CPU with firmware version V3.0 offline in the project, and copy your program to this
CPU.
It is not possible to replace a V4 CPU with a V3 CPU. If you want to continue using the
existing V3 CPU, create a copy of this CPU before replacing the device.
The program cannot be transferred to the new CPU via a memory card. Instead, use the
"Change device" function, which is described in the following sections.
HMI panels
Configured HMI panels are treated differently during device replacement depending on the
firmware version of the panel and the communication mode.
The following table shows the HMI connections that are supported with the migration:
During compilation of the program, you receive specific information on migrating the HMI panel.
Note
HMI TP 177B 4"
The HMI TP 177B 4" with firmware version V11.0.2 cannot be operated with S7-1200 V4.
Replace the panel with a new device, if necessary.
Protected blocks
Blocks equipped with know-how protection or copy protection cannot be converted to V4. If
the project contains protected blocks, you must remove the protection prior to migration.
If these are supplied blocks and you do not know the password, ask your supplier either for
the password or for a V4-compatible block.
Warning
Preventing personal injury and material damage
Changes are made to the program during device replacement in some cases. Therefore,
thoroughly check the program in a test environment after replacing the device and before
putting it in operation.
Note
Additional support
You can find the latest FAQs about migrating to S7-1200 V4 (http://
support.automation.siemens.com/WW/view/en/82140966) in Siemens Industry Online
Support.
If you need further assistance with migrating to S7-1200 V4, please contact SIMATIC Customer
Support.
See also
Migrating to V4 (Page 220)
Special considerations after migrating to V4 (Page 221)
6.3.2 Migrating to V4
Requirement
A CPU with firmware version V3 is available in the project.
The project contains no protected blocks.
Procedure
Proceed as follows to replace a CPU:
1. Select the V3 CPU you want to replace.
2. Select the "Change device" command in the shortcut menu.
The "Change device" dialog box appears.
3. Under "New device" in the tree structure, select the V4 CPU with which you want to replace
your current V3 CPU.
4. Click "OK".
The existing CPU is replaced by the new one.
5. Select the new CPU and select the "Compile > Hardware and software (only changes)"
command in the shortcut menu.
The device configuration and the user program are compiled again.
6. Optional: If necessary, apply know-how protection or copy protection to individual blocks
in the program.
7. Select the new CPU and select the "Download to device > Hardware and software (only
changes)" command in the shortcut menu.
The device configuration and the user program are loaded into the new CPU.
This completes the device replacement.
Warning
Preventing personal injury and material damage
Changes are made to the program during device replacement in some cases. Therefore,
thoroughly check the program in a test environment after replacing the device and before
putting it in operation.
Note
Additional support
You can find the latest FAQs about migrating to S7-1200 V4 (http://
support.automation.siemens.com/WW/view/en/82140966) in Siemens Industry Online
Support.
If you need further assistance with migrating to S7-1200 V4, please contact SIMATIC Customer
Support.
See also
Basic information on upgrading to V4 (Page 217)
Special considerations after migrating to V4 (Page 221)
Functional changes in V4
S7-1200 V4 offers significantly enhanced functionality. The most important functional changes
that you need to consider after migrating from V3 are described briefly below.
You can find more information on S7-1200 in the "SIMATIC S7-1200 Programmable controller"
system manual.
See also:
TIA Portal in Siemens Industry Online Support (http://support.automation.siemens.com/WW/
view/en/65601780)
Organization blocks
With S7-1200 V4, you can specifically set the interruptibility of each organization block used.
When a device is replaced, all the organization blocks are configured as non-interruptible, to
ensure that the executability of your V3 program remains unchanged. The OB priorities from
the V3 program also remain unchanged. After migration, you can change the settings for
priority and interruptibility as needed.
The behavior of diagnostic interrupts in V4 has changed as follows:
In V3, the start information always contained information on the triggering module, including
the channel number. In V4, this information is only generated for a pending diagnostics event.
If no diagnostic event is pending, for example, because the fault has already been corrected,
only the triggering module is indicated.
Access levels
S7-1200 V4 offers an extended access level concept. The following table shows how the
protection levels of the V3 firmware are indicated in V4:
Instruction libraries
After migration to S7-1200 V4, instructions from the libraries of the firmware version V3 are
still available. This ensures that you can continue to use your program unchanged. In addition,
S7-1200 V4 offers many new instructions which are also compatible with the instructions of
the S7-1500.
You can find more information on the instruction libraries of S7-1200 in the "SIMATIC S7-1200
Programmable controller" system manual.
See also:
TIA Portal in Siemens Industry Online Support (http://support.automation.siemens.com/WW/
view/en/65601780)
Motion Control
When a device is replaced, the Motion Control objects from the libraries of the firmware
versions V1 and V2 are replaced with the corresponding objects from the V3 libraries. The
objects from V3 libraries are compatible so that you can continue to use the programs
unchanged.
The libraries of the S7-1200 V4 offer many new Motion Control functions, which are compatible
with the functions of the S7-1500. If you want to use V4 libraries, select them on the
"Instructions" task card after replacing the device.
You can find more information on the new Motion Control functions in the "SIMATIC S7-1200
Programmable controller" system manual.
See also:
Web server
The following settings for operation via a web server are transferred from the V3 CPU to the
V4 CPU during device replacement:
Activate web server on this module
Permit access only with HTTPS
If you want to operate the V4 CPU via a web server, you need to set up user accounts with
assigned user rights in the user management. Only the standard web pages are available to
standard users without any additional rights.
Note
Additional support
You can find the latest FAQs about migrating to S7-1200 V4 (http://
support.automation.siemens.com/WW/view/en/82140966) in Siemens Industry Online
Support.
If you need further assistance with migrating to S7-1200 V4, please contact SIMATIC Customer
Support.
See also
Basic information on upgrading to V4 (Page 217)
Migrating to V4 (Page 220)
Higher performance
The S7-1500 represents a CPU series that provides much higher performance than the CPUs
of the S7-300/400 series. When programming with STEP 7 V5.x, you were probably used to
working with programming methods such as absolute addressing to achieve higher
performance from the CPU and leaner program code.
Due to the high performance that the S7-1500 provides, these programming methods are made
obsolete.
In the paragraphs below we would like to introduce some new programming options of the
S7-1500.
Universal symbolism
The S7-1500 allows you to use the symbolism throughout the entire project. Using the auto-
complete function, you are given context-dependent support for programming with symbols
within the programming editors. The data elements, for example those in a data block, are
assigned only a symbolic name in the declaration but no fixed address within the data block.
This allows you to fully exploit the high performance of the S7-1500 when accessing these
data elements. The absolute addresses of operands need not be known and access errors
are avoided.
Your program code will be clearer due to the symbolism and you have to comment less. All
points of use are automatically updated when a correction is made to the symbolism.
An example of the use of universal symbols is available at: Symbolic addressing (Page 249)
&RPSDULVRQRIEORFNDFFHVVHV 6,(0(16
6WDQGDUG!2SWLPL]HG
6WDQGDUGEORFNDFFHVV 2SWLPL]HGEORFNDFFHVV
6FRPSDWLEOH 6RQO\
ZLWK6
5HFRPPHQGDWLRQ
7RDFKLHYHWKHEHVWSRVVLEOHSHUIRUPDQFHWKHFRPELQLQJRIGLIIHUHQWEORFNDFFHVVW\SHVZLWKLQ\RXUSURJUDPLVQRW
UHFRPPHQGHG
You can find additional information on blocks with optimized access under "See also".
Slice access
Slice access gives you the option of specifically addressing areas within declared tags. You
can implement symbolic access to a single bit up to the level of the tag. The single bit is then
addressed absolutely.
You can find additional information on slice access under "See also".
Indirect addressing
Indirect addressing offers you the option of addressing operands whose address is not
calculated until runtime. All programming languages provide general methods for indirect
addressing, for example, via POINTER. In the SCL programming language, you can also use
PEEK and POKE instructions.
You can find additional information on indirect addressing under "See also".
See also
PLC data types (Page 1954)
Advantages
You can to detect runtime errors and avoid program termination using the EN/ENO mechanism
for each instruction and block call. Overflow, for example, is reported via the ENO enable
output for mathematical functions.
In STEP 7 TIA Portal, the ENO enable output is disabled by default in the programming
languages LAD and FBD. If needed, you can activate the enable output and thereby
deliberately target the instructions for which you want to have error evaluation.
This gives you the following advantages:
The performance increases with ENO disabled.
Runtime errors do not cause the CPU to go to STOP when ENO is enabled.
Basic instructions
Math functions ADD, SUB, MUL, DIV, MOD, INC, DEC, ABS, NEG, SQR, SQRT, LN,
EXP, SIN, COS, TAN, ASIN, ACOS, ATAN, FRAC, EXPT, MIN, MAX,
LIMIT, CALCULATE
Move operations MOVE, SWAP, MOVE_BLK, UMOVE_BLK, FILL_BLK, UFILL_BLK,
MOVE_BLK_VARIANT
Conversion operations CONVERT, ROUND, CEIL, TRUNC, FLOOR, NORM_X, SCALE_X
Word logic operations AND, OR, XOR, INV, DECO, ENCO
Shift and rotate SHR, SHL, ROR, ROL
Extended instructions
String + Char CONCAT, LEFT, RIGHT, MID, DELETE, INSERT, REPLACE, FIND,
LEN, S_CONV
Date and time T_CONV
You can find additional information on the EN/ENO mechanism in each programming language
under "See also".
Programming example
The following example shows you how to use instructions with the ENO enable output enabled
and disabled:
If you have activated the ENO enable output, for example with the SUB instruction, all
subsequent instructions are also applied with an activated enable output. If an arithmetic error
occurs during the execution of the SUB instruction, the ADD instruction is not executed.
The ENO enable output is disabled for the DIV instruction in the second branch. If a runtime
error occurs during execution, the MUL instruction is executed anyway.
To be able to respond appropriately to possible errors, in addition to global error handling (for
example, the use of the organization blocks "Programming error OB" or "I/O access error OB"),
we recommend that you implement local error handling in your program (for example, use an
EN/ENO mechanism, the parameters RET_VAL, STATUS and ERROR, or the instructions
"GET_ERROR"/"GET_ERR_ID").
Note
STL programming language
In STL, you use the BR bit of the status word instead of the EN/ENO mechanism.
Global error handling intervenes at the end of each program cycle, while local error handling
is capable of intervening immediately after an error occurs.
Note
BR bit and EN/ENO mechanism as first indicator
A first indicator for an error can be either the BR bit of the status word or the ENO enable
output. If these return signal state "0", there is an error in the execution of the instruction. Signal
state "1" indicates that there is no error and no further error analysis is necessary.
Warning
Output parameter RET_VAL
When errors occur in the supply of the input parameters during the execution of the instruction
that contains the RET_VAL parameter, an invalid error code is output at the RET_VAL
parameter and the output parameters of the instruction cannot be evaluated.
Example
The above-mentioned local error handling options can be programmed individually or in
combination with one another. To ensure that each error scenario that can occur within your
program is recognized, we recommend a combination of local error handling options, as shown
in the example below.
For a more precise error analysis, in addition to the RET_VAL output parameter you can also
use the instructions "GET_ERROR" or "GET_ERR_ID". These options provide you with error
codes, the detailed explanations of which are available in the descriptions of the respective
instructions.
There are also error scenarios in which the RET_VAL output parameter does not output a valid
error code. If an access error occurs while reading an input parameter, for example, the outputs
of the instruction are no longer written, because the execution of the instruction is interrupted.
In this case, we recommend that you integrate the two instructions "GET_ERROR" and
"GET_ERR_ID" in your program because they provide reliable error information even when
this type of error occurs.
Warning
Access error when reading an input parameter
The RET_VAL parameter does not return a valid error code and no detailed error information
is output to the diagnostics buffer.
The following example shows you how you can recognize an access error when reading an
input parameter:
Exceptions
There are some instructions, however, for which you cannot program the error handling as
described in the example above. This includes the following instructions:
Instructions which generally do not have an EN/ENO mechanism
Instructions in which the ENO was disabled
S_COMP and T_COMP
PEEK, PEEK_BOOL, POKE, POKE_BOOL and POKE_BLK
The BR bit or the ENO enable output is set to TRUE in these instructions even if it may result
in an access error.
The following example shows you how to program reliable error handling in the STL
programming language:
STL Explanation
SET // The operand #Tag_ErrorID is initial-
L 0 ized with "0".
T #Tag_ErrorID
STL Explanation
String EQ
IN1 := #StringArray.[#index] // Variable access to the ARRAY component.
IN2 := 'STRING' // The two values are compared with each
other.
OUT := #TagResult // If both values are identical, the op-
erand #TagResult receives the signal
state "1".
Even if the RLO bit has signal state "1", the access error is detected. You can query the error
code with the evaluation of the #Tag_ErrorID operand of the "GER_ERR_ID instruction: Get
error ID locally".
See also
GET_ERROR: Get error locally (Page 2414)
GET_ERR_ID: Get error ID locally (Page 2417)
Evaluating errors with output parameter RET_VAL (Page 2195)
Parameter STATUS (Page 3078)
Possible applications
You can now program with MOVE instructions in STL on an S7-1500 CPU.
This gives you the following advantages:
The program structure is easier to create.
The performance of the CPU increases.
Programming example
The following example shows you how the "MOVE_BLK instruction works: Move block". An
ARRAY block is copied into another ARRAY block:
Using the MOVE_BLK instruction, ten elements from "Array_1" of the "Data_DB" data block
are copied into "Array_2" of the same data block.
The data of the TON IEC timer and the CTU IEC counter is stored as a local tag (multi-instance)
in the block interface.
In the LAD and FBD programming languages, you also have the option of creating timers in
a global data block and of using these as instances in your program code.
1. To do this, for example, create a global data block with an ARRAY of TON. The data type
TON does not appear in the drop-down list, but can be entered manually:
2. Create a LAD or FBD function block and drag the instruction "TON: Generate on-delay" to
a network. Call the instance of timer TON as follows:
STL Explanation
Q "Tag_Output" // When the "Tag_Output" output receives
the signal state 1,
= #Timer_1.IN // the IN parameter of the multi-instance
timer #Timer_1 is initialized with a pos-
itive signal edge.
STL Explanation
CALL #Timer_1 // When the multi-instance timer is now
??? called and the IN parameter queried
again, the timer is not started because
IN := "Tag_Output"
there is no new positive signal edge.
PT := T#30s
Q := "Tag_4"
// Enter TIME as data type of the instruc-
ET := "Tag_ElapsedTime" tion.
This is why you must program the initialization of the multi-instance timer within the call.
STL Explanation
CALL #Timer_1 // The timer is called and started.
???
IN := "Tag_Output" // Enter TIME as data type of the instruc-
PT := T#30s tion.
Q := "Tag_4"
ET := "Tag_ElapsedTime"
See also
Timers (Page 1929)
in specifying the value to be read or written. The ARRAY data block is transferred only during
runtime in order to then access the values in the program block. The data type of the ARRAY
elements and the data type of the value that is to be read or written are determined. You can
determine the number of objects and the fill level of the ARRAY data block using the ARRAY
elements.
Note
When you create an ARRAY data block, specify the data type and the number of ARRAY
elements. The data type of the value which is to be written to the ARRAY data block, for
example, must match the data type of the ARRAY elements of the data block. In each case,
connect a source area (PLC data type) with a destination area (ARRAY data block).
The advantage of this procedure is that the program code can already be created before you
know which ARRAY data block and which value will be processed.
Programming example
The following example shows you how to use an ARRAY data block:
Individual pieces of material are transported on a conveyor belt. These pieces of material pass
a scanner which can read out the information that a piece of material carries with it. The
information is read out and transmitted to a panel. Because the scanner and the panel have
different clock cycles/speeds, the material information must be cached in each case.
In the following programming example, we show you how to program the program code for
passing on material information. For this purpose, you use a PLC data type (UDT) and an
ARRAY data block.
Procedure
Create the PLC data type "UDT_Queue". You use this PLC data type as an instance which
can be accessed by both functions ("FC_Enqueue" and "FC_Dequeue"). This is important, for
example, for accessing the tag #Queue.Used, as the function "FC_Enqueue" increments the
tag by one and the function "FC_Dequeue" decrements the tag by one.
1. Double-click the "Add new data type" command in the "PLC data types" folder in the project
tree.
A new declaration table for creating a PLC data type will be created and opened.
2. Declare the following lines within the PLC data type:
DB > Data type: DB_ANY
Size > Data type: DINT
Used > Data type: DINT
ReadPos > Data type: DINT
WritePos > Data type: DINT
Program the instruction "FC_Enqueue", which writes the values from a PLC data type into an
ARRAY data block. The PLC data type and the ARRAY data block must be still unknown at
this time, as the interfaces with the data types VARIANT and DB_ANY are programmed:
1. Create an SCL function and name it "FC_Enqueue".
2. Declare the block interface as follows:
With this function, you check whether there is still space free in the data block. If so, write
the value that is specified at the parameter value into the data block at the parameter db.
With each new item of material information that is written, the tag #Queue.Used and the
pointer tag #Queue.WritePos are incremented by one. As soon as the cursor reaches the
end of the data block, it is reset to 0. If the data block is full, the error code #4711 is returned.
Program the instruction "FC_Dequeue", which reads the material information from an ARRAY
data block and writes it into a PLC data type. The PLC data type and the ARRAY data block
must be still unknown at this time, as the interfaces are programmed with the data types
VARIANT and DB_ANY. The material information can then be displayed on a panel, for
example:
1. Create an SCL function and name it "FC_Dequeue".
2. Declare the block interface as follows:
With this function, you check whether material information is available in the data block. If
so, read the value to which the pointer #Queue.ReadPos points, and write it to the tag
#Value. With each item of material information that is read, the tag #Queue.Used is
decremented by one and the pointer tag #Queue.ReadPos is incremented by one. As soon
as the cursor reaches the end of the data block, it is reset to 0. If the data block is empty,
the error code #4712 is returned.
In order to be able to write or read data, you require a specific PLC data type and an ARRAY
data block, each of which must have the same data type.
To do this, create the PLC data type "UDT_Material". The scanner writes the read-out material
information into this PLC data type.
1. Double-click the "Add new data type" command in the "PLC data types" folder in the project
tree.
A new declaration table for creating a PLC data type will be created and opened.
2. Declare the following lines within the PLC data type:
ArticleNumber > Data type: DINT
ArticleName > Data type: STRING
Amount > Data type: REAL
Unit > Data type: STRING
Create the ARRAY data block "DB_MaterialBuffer". The material information from the PLC
data type "UDT_Material" is sent to this ARRAY data block with the help of the function
"FC_Enqueue".
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Data block (DB)" button.
3. Specify the name "DB_MaterialBuffer".
4. Select the type of the data block "ARRAY DB".
5. Select the PLC data type "UDT_Material" as ARRAY data type.
6. Specify "1000" as high ARRAY limit.
7. Click "OK".
Create the start of the organization block (OB) "OB_MaterialQueue". In this organization block,
you initialize the tags DB and Size.
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Organization block (OB)" button.
3. Specify the name "OB_MaterialQueue".
4. Select the type "Startup".
5. Select SCL as the language of the organization block.
6. Click "OK".
7. Write the following program code:
By assigning the data block, you connect the ARRAY data block "DB_MaterialBuffer" with
the SCL functions "FC_Enqueue" and "FC_Dequeue". Enter the size of the ARRAY data
block at the Size parameter. The start value of the Used parameter is "0". The first item of
material information is thus written to the ARRAY element "0".
1. Select the folder "Program blocks" in the project tree and select the command "Compile >
Software (only changes)" from the shortcut menu.
2. Declare the following tags in the "Default tag table":
3. Call the SCL function "FC_Enqueue" within the function block in which the scanner reads
out the material information.
4. Declare the tag "ConnectionToUDT" in the section "Temp" in the block interface and link
this tag with the PLC data type "UDT_Material":
5. Link the function call with the following tags and, at the enable input EN, create the signal
edge "P: Scan operand for positive signal edge". Link the signal edge with the global tags
from the default tag table:
Result
As soon as a positive signal edge occurs, material information is written to an ARRAY data
block with the help of the instruction "WriteToArrayDB" and sent to the panel with the help of
the instruction "ReadFromArrayDB".
See also
ReadFromArrayDB: Read from array data block (Page 2357)
WriteToArrayDB: Write to array data block (Page 2359)
ReadFromArrayDBL: Read from array data block in load memory (Page 2361)
WriteToArrayDBL: Write to array data block in load memory (Page 2364)
ReadFromArrayDB: Read from array data block (Page 2635)
WriteToArrayDB: Write to array data block (Page 2637)
ReadFromArrayDBL: Read from array data block in load memory (Page 2639)
Programming example
The following example shows you how to symbolically access individual elements:
You can use the tag names that you have defined in the block interface directly at the
parameters of the TON instruction without knowing the absolute address of the tags.
Symbolically accessing tags of Bit string data type, bit by bit, byte by byte, word by word and double
word by double word
You have the option to specifically address areas within declared tags. You can access areas
of the 1-bit, 8-bit, 16-bit, or 32-bit width. The allocation of a memory area (e.g., BYTE or WORD)
to a small memory area (e.g., BOOL) is also referred to as "Slice".
You can find additional information on the syntax of slice access under "See also".
Programming example
You can find a detailed example in the Siemens Industry Online Support under the following
FAQ ID: 57374718 (http://support.automation.siemens.com/WW/llisapi.dll?
aktprim=0&lang=en&referer=%2fWW
%2f&func=cslib.csinfo&siteid=csius&Datakey=47071380&extranet=standard&groupid=4000
002&viewreg=WW&nodeid0=29156492&objaction=csopen)
STL Explanation
OPN "Data_classic" // The "Data_classic" data block is called.
L #index // The value of the local tag #index is loaded into ac-
cumulator 1.
SLD 3 // Move bits 0 to 31 of accumulator 1 by 3 positions to
the left.
// Fill the now empty bit places with zeros.
LAR1 // Load address register 1 with contents of accumulator
1.
L DBW [AR1, P#10.0] // Load the ARRAY element addressed with #index into ac-
cumulator 1.
// P#10.0 = Start address of the array
You need just one more program line for addressing an ARRAY element in the TIA Portal.
The value of the ARRAY element #index is loaded directly from the data block into
accumulator 1.
4. Call the "FB_Quantities" function block in OB1 and assign it an index between 0 - 10:
See also
Array (Page 1941)
1. Programming example
In the example below, you use the index to access three tags from different memory areas.
Access list of the three tags, each of which is assigned to an index:
Depending on which number (1, 2 or 3) you specify at the Index parameter, the first, second
or third case of the "FC_AccessGroupInt" instruction is executed.
2. Programming example
In the example below, you use the index to access three different optimized data blocks.
Since all data blocks should contain the same tags, you can use a PLC data type (UDT) in this
case.
1. To create a PLC data type, double-click the "Add new data type" command in the "PLC
data types" folder in the project tree.
A new declaration table for creating a PLC data type will be created and opened.
2. Rename the PLC data type to "UDT_SiloContents".
3. Declare the following lines within the PLC data type:
MyBool > Data type: BOOL
MyInt > Data type: INT
MyWord > Data type: WORD
4. Select the data blocks "UDT_SiloContents" as the type of the data blocks.
5. Click "OK".
Create a function to read the values of the data block tags and to write these to a PLC data
type.
1. Create an SCL function and name it "FC_AccessGroupSiloRead".
2. Declare the block interface as follows:
Depending on which number (1, 2 or 3) you specify at the Index parameter, the first, second
or third case of the "FC_AccessGroupSiloRead" instruction is executed.
Result
With this procedure, the programming is
comprehensible, as you can use cross-reference lists
reliable, as you use only the previously defined memory areas
applicable to both standard and optimized data areas
Introduction
The VARIANT data type is a pointer or a reference to another data object. The data type
VARIANT is typified, i.e., you can read out the data type of a referenced tag during program
runtime.
Using the data type VARIANT, you can above all create generic, standardized function blocks
(FB) or functions (FC) for various data types. Various instructions in all programming languages
are available to you for this purpose. During the creation of the program, you can specify which
data types the block should be able to process. The VARIANT data type supports you here by
allowing the interconnection of any tags. You can then react accordingly to their data types in
the block.
Each of the figures below shows you a section from the "Moving data" programming example.
You can find the detailed program code under "See also".
What is the purpose of the ANY pointer? Recommendations in the TIA Portal (S7-1200/
S7-1500)
Moving data of any source and destination data Definition of tags within a PLC data type. You can
type in the program using the instruction use the instructions "Serialize" and "Deserialize"
"BLKMOV: Move block". to move the tags.
Initializing an ARRAY structure Using the instruction "FILL_BLK: Fill block", you
initialize or fill an ARRAY structure.
Moving ARRAY elements Using the instruction "MOVE_BLK: Move block".
you move the content of multiple elements of an
ARRAY structure to another ARRAY structure.
What is the purpose of the ANY pointer? Recommendations in the TIA Portal (S7-1200/
S7-1500)
Memory and performance optimization using struc Use the InOut section in the block interface to op
tured data timize memory and performance.
You can find additional information in the "Pro
gramming Guideline for S7-1200/1500" under the
following link Programming Guideline for
S7-1200/1500 (http://
support.automation.siemens.com/WW/llisapi.dll?
aktprim=4&lang=en&referer=%2fWW
%2f&func=cslib.csinfo&siteid=csius&groupid=400
0002&extranet=standard&viewreg=WW&nodeid4
=20229695&objaction=csopen)
Access to individual bits/bytes of a WORD Use the "slice access"
Additional information is available here: Example
of a slice access (http://
support.automation.siemens.com/WW/llisapi.dll?
aktprim=0&lang=en&referer=%2fWW
%2f&func=cslib.csinfo&siteid=csius&groupid=400
0002&extranet=standard&viewreg=WW&nodeid0
=29156492&objaction=csopen)
Determination of the length of structures or data Use an ARRAY and read its length using the in
blocks struction "CountofElements: Get number of AR
RAY elements. The instruction only works in con
junction with the data type VARIANT.
Indirect addressing You can use the VARIANT pointer for the indirect
addressing of data types that will only be known
during runtime. You can use the data type
DB_ANY for indirect access to a data block.
Note
Direct passing of a tag to a VARIANT tag is not possible, such as myVARIANT := #Variable
The MOVE_BLK_VARIANT instruction is only executed if the data types of the ARRAY
elements are the same.
See also
ANY (Page 1948)
VARIANT (Page 1951)
TypeOf: Check data type of a VARIANT tag (Page 2798)
TypeOfElements: Check data type of an ARRAY element of a VARIANT tag (Page 2799)
IS_ARRAY: Check for ARRAY (Page 2800)
Programming example: Moving data (Page 267)
VARIANT instructions
VARIANT instructions
The following instructions for working with VARIANT are available to you in the TIA Portal:
Basic instructions
Category Instruction Description
Comparator operations EQ_Type Compare data type for EQUAL with the data type of a tag
NE_Type Compare data type for UNEQUAL with the data type of a tag
EQ_ElemType Compare data type of an ARRAY element for EQUAL with the data type
of a tag
NE_ElemType Compare data type of an ARRAY element for UNEQUAL with the data
type of a tag
IS_NULL Query for EQUALS ZERO pointer
NOT_NULL Query for UNEQUALS ZERO pointer
IS_ARRAY Check for ARRAY
TypeOf Check data type of a VARIANT tag
TypeOfElements Check element data type of a VARIANT tag
IS_ARRAY Check for ARRAY
Basic instructions
Category Instruction Description
Move operations MOVE_BLK_VAR Move block
IANT
VariantGet Read out VARIANT tag value
VariantPut Write VARIANT tag value
CountOfElements Get number of ARRAY elements
Conversion operations VAR Convert VARIANT to DB_ANY
IANT_TO_DB_AN
Y
DB_ANY_TO_VA Convert DB_ANY to VARIANT
RIANT
Note
Differences between MOVE, MOVE_BLK and MOVE_BLK_VARIANT
You can use the "MOVE" instruction to copy complete structures.
You can use the "MOVE_BLK" instruction to move parts of ARRAYs with known data type.
The MOVE_BLK_VARIANT instruction is only required if you want to move parts of ARRAYs
with a data type that is only known during program runtime.
You can find additional information on the individual instructions in the information system
under "Basic instructions > Respective programming language".
You can also find additional instructions which also work with the VARIANT data type under
the "Extended instructions".
See also
VARIANT (Page 1951)
Indirect addressing with the VARIANT data type (http://support.automation.siemens.com/WW/
llisapi.dll?aktprim=0&lang=en&referer=%2fWW
%2f&func=cslib.csinfo&siteid=csius&groupid=4000002&extranet=standard&viewreg=WW&n
odeid0=29156492&objaction=csopen)
Introduction
In the following chapter, you will learn which application options you have with VARIANT
instructions.
You can find additional information on the individual instructions in the information system
under "Basic instructions > Respective programming language".
To evaluate AR TypeOfElements(): Check data type of an AR You use this instruction to compare the data type to
RAY elements RAY element of a VARIANT tag which a VARIANT tag points with the data type of any
(This instruction is available only in SCL and other tag. You can also make the comparison with a
only in conjunction with an IF instruction.) PLC data type. If the data type of the VARIANT tag is
an ARRAY, the data type of the ARRAY elements is
compared.
IS_ARRAY: Check for ARRAY You use this instruction to check whether the data type
to which a VARIANT tag points is an ARRAY.
CountOfElements: Get number of ARRAY ele You use this instruction to read out how many ARRAY
ments elements the tag has to which the VARIANT tag points.
MOVE_BLK_VARIANT: Move block This instruction is used to move dynamic and type-safe
(integrated type test) ARRAYs. You can freely select
the limit values for the source and destination AR
RAYs. The data types of ARRAY elements must match.
Note
Differences between MOVE, MOVE_BLK and MOVE_BLK_VARIANT
You can use the "MOVE" instruction to copy complete structures.
You can use the "MOVE_BLK" instruction to move parts of ARRAYs with known data type.
The MOVE_BLK_VARIANT instruction is only required if you want to move parts of ARRAYs
with a data type that is only known during program runtime.
Additional information on the use of the MOVE_BLK_VARIANT instruction can be found in the
"Moving data" programming example.
See also
VARIANT (Page 1951)
Programming example: Moving data (Page 267)
Programming example
In this programming example, data values, which are collected for example during a production
shift, are moved for further processing. The data is collected in an ARRAY. Using the
"MOVE_BLK_VARIANT instruction: Move block", you can move either the entire ARRAY or
only individual ARRAY elements dynamically and type-safe. You can freely select the ARRAY
limits for the respective source and destination ARRAYs and these do not have to match.
However, the data type of the data values that are to be moved must match. This instruction
is available in all programming languages.
By using the VARIANT data type, you can use the created program code to move data for
other production shifts as well, by specifying a different source and destination area at the
block call.
Procedure
1. Create a function using the SCL programming language and give it the name
"FC_PartialArrayCopy".
2. Declare the block interface as follows:
6. Call the "FC_PartialArrayCopy" function in an organization block, for example OB1, and
initialize the parameters with the DB_WithArrays data block. Enter the named constants:
7. Instead of using the first two ARRAYs, which have the data type UDT_MyStruct, you can
also use the third and fourth ARRAY, which have the data type REAL:
Result
As soon as the "FC_PartialArrayCopy" block is called in the program cycle, two data values,
starting with the fourth element, are copied from the first ARRAY of the "DB_WithArrays" global
data block to the second ARRAY of the data block. The copied data values are inserted in the
second ARRAY, starting from the fourth element.
SCL
IF IS_ARRAY(#SourceArray) AND TypeOfElements(#SourceArray) =
TypeOfElements(#DestinationArray) THEN
#Error := MOVE_BLK_VARIANT(COUNT := #Count, SRC := #SourceArray, SRC_INDEX := #SourceIndex,
DEST => #DestinationArray, DEST_INDEX := #DestinationIndex);
END_IF;
#FC_PartialArrayCopy := #Error;
See also
VARIANT (Page 1951)
Programming example
In the following example, you program a ring buffer which consists of an ARRAY and is written
and read according to the FIFO principle. The program code has a read-VARIANT pointer and
a write-VARIANT pointer. Using the VARIANT instructions, you can program the program code
robustly and ensure reliable copying or deleting.
Using the VARIANT data type, program sections can be influenced during runtime. The
VARIANT pointer is a type-safe pointer, i.e. a type test is performed during runtime. For blocks
that have been created with the block property "optimized", sub-functions that were previously
programmed with an ANY pointer can now be resolved with a VARIANT pointer. The VARIANT
data type is used to transfer structures to system function blocks.
Procedure
1. Create an SCL function block and name it "FIFOQueue".
2. Declare the block interface as follows:
(* This program code section is only executed once after a positive signal
edge. If there is no change in the signal state of the result of logic
operation, the program processing of the "FIFOQueue" FB is terminated. *)
#edgeup := #request & NOT #edgeupm;
#edgeupm := #request;
IF NOT (#edgeup) THEN
RETURN;
END_IF;
(* This program code section checks whether the data type of the ARRAY
elements matches the data type of the entry (tag #item). If the data types
do not match, the program execution is terminated at this point and the
error code "-11" is output. *)
IF NOT (TypeOf(#item) = TypeOfElements(#buffer)) THEN
#error := -11;
RETURN;
END_IF;
(* This program code section checks whether the initial value of the ring
buffer matches the entry (tag #item). If the data types do not match, the
program execution is terminated at this point and the error code "-12" is
output. *)
IF NOT (TypeOf(#item) = TypeOf(#initialValue)) THEN
#error := -12;
RETURN;
END_IF;
(* This program code section checks whether the variable indices are within
the ARRAY limits. If they are not, the program execution is terminated at
this point and either error code "-20" or "-21" is output depending on the
index. *)
IF (#nextEmptyItemIndex >= #bufferSize) THEN
#error := -20;
RETURN;
END_IF;
IF (#firstItemIndex >= #bufferSize) THEN
#error := -21;
RETURN;
END_IF;
// If the Mode parameter has the signal state "0", the first entry from the
passed ring buffer is returned.
(* This program code section checks whether the ring buffer is empty. If
this is the case, program execution is terminated at this point and the
error code "-40" is output. *)
IF (#firstItemIndex = -1) THEN
#error := -40;
RETURN;
END_IF;
// This program code section returns the first entry of the ring buffer.
#internalError := MOVE_BLK_VARIANT(SRC := #buffer,
COUNT := 1,
SRC_INDEX := #firstItemIndex,
DEST_INDEX := 0,
DEST => #item);
IF (#internalError = 0) THEN
(* This program code section checks whether the ring buffer contains ARRAY
elements. If it does, the first entry is passed further on and the index is
incremented by 1. *)
#internalError := MOVE_BLK_VARIANT(SRC := #initialValue,
COUNT := 1,
SRC_INDEX := 0,
DEST_INDEX := #firstItemIndex,
DEST => #buffer);
// This program code section calculates the new index of the first entry.
#newFirstItemIndex := #firstItemIndex +1;
#newFirstItemIndex := #newFirstItemIndex MOD #bufferSize;
END_IF;
ELSE
// If the Mode parameter has the signal state "1", the entry is written to
the passed ring buffer.
(* This program code section checks whether the ring buffer is full. If this
is the case, program execution is terminated at this point and the error
code "-50" is output. *)
IF (#nextEmptyItemIndex = #firstItemIndex) THEN
#error := -50;
RETURN;
END_IF;
// This program code section writes the entry to the ring buffer.
#internalError := MOVE_BLK_VARIANT(SRC := #item,
COUNT := 1,
SRC_INDEX := 0,
DEST_INDEX := #nextEmptyItemIndex,
DEST => #buffer);
IF (#internalError = 0) THEN
// This program code section increments the index by 1 and calculates the
new empty entry index.
#newNextEmptyItemIndex := #nextEmptyItemIndex +1;
#newNextEmptyItemIndex := #newNextEmptyItemIndex MOD #bufferSize;
#nextEmptyItemIndex := #newNextEmptyItemIndex;
(* This program code section checks which index the "#firstItemIndex" tag
has. If the number = -1, the ring buffer is initialized and the entry is
written to the ring buffer. Therefore, "0" must be assigned to the tag. *)
IF (#firstItemIndex = -1) THEN
#firstItemIndex := 0;
END_IF;
END_IF;
END_IF;
Result
Call the SCL function block at the position in your program at which the FIFO queue is to run.
Programming example
The following example shows you how to use the DB_ANY data type:
A punching machine can punch out a variety of geometric shapes. The punching jobs are
transferred to the machine and there are specific job data for each individual job. The job data
differ in their job type as well as in their values.
8'7B+ROH
<
5DGLXV
0
Create the PLC data type "UDT_Hole" to transfer the job data:
1. Double-click the "Add new data type" command in the "PLC data types" folder in the project
tree.
A new declaration table for creating a PLC data type will be created and opened.
2. Declare the following lines within the PLC data type:
X-coordinate > REAL
Y-coordinate > REAL
Radius > REAL
A rectangle is to be punched out of a piece of sheet metal in the second job. For this job, you
need two coordinates which define the upper left-hand point and the bottom right-hand point
of the rectangle. You can transfer these job data to the punching machine collectively in the
PLC data type "UDT_RectangleWindowStatic".
< 8'7B5HFWDQJOH:LQGRZ6WDWLF
%
$
The job data of the "UDT_RectangleWindowStatic" can only be used to punch out rectangles
whose edges are aligned parallel to the x and y axis.
If you want to punch out a rectangle with different alignment, i.e., not parallel to the x and y
axis, you need an additional PLC data type. In it, you can specify the height and width, for
example, as well as the alignment of the rectangle to the x axis by means of an angle.
< 8'7B5HFWDQJOH:LQGRZ)OH[LEOH
:L
GW K
W
L JK
+H
0
Create the following tag in the data block and enter the corresponding start values:
To manufacture a specific sheet metal part such as the side panel of a control cabinet, for
example, the necessary geometric shapes are loaded to the punching machine. For this
purpose, you need to create another data block which includes a list of data blocks.
Create the data block "DB_OrderList":
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Data block (DB)" button.
3. Specify the name "DB_OrderList".
4. Select "Global-DB" as the type of the data block.
5. Click "OK".
The next job on the list is prepared by breaking down the current punch job into individual
punches. The punching machine must be able to recognize which punch job it is processing.
1. Create an SCL function.
2. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
3. Click the "Function (FC)" button.
4. Specify the name "FC_PrepareOrder".
6. Write the following program code. The calls of the three functions are not yet given a red
underline because they still have to be created.
The "VariantGet" instruction copies the information from the #a tag to the #Hole tag.
To prepare the punch job for a hole, create an SCL function and name it "FC_PrepareHole".
1. Declare the block interface as follows:
To prepare the punch job for a window, you need a function which combines four punch
sequences into the punch job. Create an SCL function and name it "FC_PrepareWindowStatic".
1. Declare the block interface as follows:
Call the SCL function block "FC_PrepareOrder" in the SCL function block "FB_PickNextOrder":
Result
This example shows you how to use the instruction "DB_ANY_TO_VARIANT: Convert
DB_ANY to VARIANT" to determine the PLC data type of a data block and how to select and
execute a suitable function based on this.
The use of PLC data types provides you with the following benefits:
The elements of a PLC data type can also be addressed indirectly, which means the
address is variable and is not calculated until during runtime.
Tags based on a PLC data type inherit all properties of the PLC data type. When there is
a change to the PLC data type, all tags based on this PLC data type are therefore adapted
automatically.
Using universal symbolism makes the program easier to read, because the names of the
individual elements of a PLC data type are displayed in the program.
Optimum utilization of the high performance of an S7-1500 CPU.
The PLC data type can be passed as a complete structure for a block call.
A simplified call interface due to a lower number of parameters to be supplied.
The following example shows the call and the parameter assignment of a function block (FB)
with two formal parameters:
1. To create a PLC data type, double-click the "Add new data type" command in the "PLC
data types" folder in the project tree.
A new declaration table for creating a PLC data type will be created and opened.
2. Rename the PLC data type to "UDT_Material".
3. Declare the following lines within the PLC data type:
ArticleNumber > Data type: DINT
ArticleName > Data type: STRING
Amount > Data type: REAL
Unit > Data type: STRING
Use the PLC data type within a global data block. You can specify the PLC data type either
directly as data type of the data block or within the data block as data type of a tag.
Create a global data block for this purpose:
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Data block (DB)" button.
3. Specify the name "DB_MaterialBuffer".
4. Select the type of the data block "ARRAY DB".
5. Select the PLC data type "UDT_Material" as ARRAY data type.
At the function block call, interconnect the formal parameters with tags from the global data
block "DB_MaterialBuffer".
1. Create an SCL function block and name it "FB_Material".
2. Declare the block interface as follows:
4. Call the "FB_Material" function block in OB1 and interconnect the formal parameters with
tags of the global data block "DB_MaterialBuffer":
The material data are moved within the global data block "DB_MaterialBuffer".
See also
PLC data types (Page 1954)
Programming example
In the following programming example, you are to perform a calculation in which two operands
of the data type REAL are to be added and one is to be subtracted. In the next step of the
calculation, the constant 1 is divided by the previous result. To do this, create a global data
block in which you declare your operands and a function in which you program the calculation
operations.
Calculation formulas
y = a + b - c
Z = 1/y
Procedure
Create the data block "DB_GlobalData":
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Data block (DB)" button.
3. Specify the name "DB_GlobalData".
4. Select "Global DB" as the type of the data block.
5. Click "OK".
6. Create the following tags in the data block and enter the corresponding start values:
The start value of both tags is 100000000.0 and is converted into 1.0E+8 according to the
data type REAL.
2. Write the following formulas in your program code and establish an online connection to
see the result:
SCL
#y := "DB_GlobalData".a + "DB_GlobalData".b - "DB_GlobalData".c;
#z := 1/#y;
As you can see, the result at the operand is #y = 0, even though the number 1 is actually
expected as result.
The incorrect result comes about as follows:
1. In the first step of the calculation, the operands a + b are added. The REAL values of the
two operands (a = 1.000000*108 and b = 1.000000*100) look as follows after the exponents
have been adjusted:
a = 1.000000*108 and b = 0.00000001*108. The last two places of the second number
(operand b) are truncated, as they can no longer be represented due to the accuracy of 6
decimal places. Therefore, a 0 instead of a 1 is added to the operand.
2. In the second calculation step, the operand C is subtracted from the result of the preceding
calculation step (intermediate result = 1.000000*108 - c = 1.000000*108 is 0.000000e0).
3. If you now calculate the operand z in the next calculation step, you try to divide by zero.
1. Possible solution
To work around such cases, you can simply adjust your calculation formula. Write the formula
as follows instead:
Calculation formulas
y = a - c + b
Z = 1/y
Since the result 0.000000e0 is available in this case after the first calculation step (operand a
- c), the addition of the REAL number in the second calculation step (intermediate result + b)
leads to the correct result (y = 0.000000*100+ 1.000000*100 = 1.000000*100).
We recommend that you check how the calculation can be made most effectively before you
program a calculation.
2. Possible solution
To calculate the above named formulas, use the LREAL data type instead of the REAL data
type. Since the data type is processed with an accuracy of 15 decimal places, this problem
does not even arise.
1. In the global data block "DB_GlobalData", create three new tags with the same values,
each with the data type LREAL.
2. In the block interface of the FC "FC_Calculate", also declare two new tags with the data
type LREAL.
3. Use the new LREAL tags for the formulas in your program code and establish an online
connection to see the result.
SCL
#y_LREAL := "DB_GlobalData".a_LREAL + "DB_GlobalData".b_LREAL -
"DB_GlobalData".c_LREAL;
#z_LREAL := 1/#y_LREAL;
See also
REAL (Page 1925)
LREAL (Page 1926)
Invalid floating-point numbers (Page 1927)
Programming example
In the following programming example, you see a calculation operation with a typed and a non-
typed constant.
1. Create an SCL function block and name it "FB_MathsFunctions".
2. Declare the "Variable_DINT" tag in the "Temp" section of the block interface.
The data type of the typed constant defines the data type of the addition. This means that
the addition is performed in the data type area INT. In the first step, the non-typed constant
50000 is implicitly converted into the data type INT. However, the conversion leads to a
negative value (-15536). This value is then added to the typed constant (INT#1). The result
is -15535. Since the tag to which the result of the addition is to be written is declared with
the data type DINT, the number -15535 is implicitly converted into the data type DINT and
written to the tag "Variable_DINT". However, the result remains negative.
1. Possible solution
One option for avoiding this undesired result is to type both constants. If you type both
constants, the longer data type determines the calculation operation.
1. Write the following program code in the "FB_MathsFunctions" SCL function block:
In this calculation operation, the typed constant INT#1 and the typed constant DINT#50000
are to be added.
The constant INT#1 is converted into the DINT data type and the addition of the two
constants is executed in the DINT data type area.
2. Possible solution
Another option for avoiding this undesired result is not to type both constants. If you do not
type both constants, these are then interpreted as the widest possible data type on the current
CPU. This means that on an S7-1500 series CPU, the two constants are interpreted as LINT
data type.
1. Write the following program code in the "FB_MathsFunctions" SCL function block:
In this calculation operation, the non-typed constant 1 and the non-typed constant 50000
are to be added.
The constants 1 and 50000 are interpreted as LINT data type and the result of the addition
is again converted into the DINT data type.
See also
Overview of the valid data types (Page 1908)
Contents
The Getting Started documents describe the creation of a single, continuous project for STEP 7
and WinCC that is extended with each chapter. You start with simple basic functions, and use
more complex ones as you continue with the creation of the project.
In addition to the step-by-step instructions, the Getting Started documents also give you
background information that explains the functions used and illustrate how they relate to each
other.
Target audience
The Getting Started documents are intended for beginners, but are also useful for users
migrating from a previous version of SIMATIC STEP 7 and WinCC.
salesmaterial-as/interactive-manuals/getting-started_simatic-s7-1500/_content/EN/
content_en.html)
Overview
The following table shows the application settings that you can make:
See also
Starting and exiting the TIA Portal (Page 301)
Resetting the user interface layout (Page 338)
Changing the settings (Page 306)
Configuring the display of tooltips and tooltip cascades (Page 358)
Overview
The following table shows the available settings for script and text editors:
See also
Changing the settings (Page 306)
Overview
The following table shows the available settings for printing:
See also
Changing the settings (Page 306)
Overview
The following table shows the settings that you can make for the online and diagnostic
functions:
Procedure
To change the settings, proceed as follows:
1. Select the "Settings" command in the "Options" menu.
The "Settings" window is displayed in the work area.
2. Select the "General" group in the area navigation to change the settings described in the
previous sections. Or click on one of the other entries in area navigation to make settings
for your installed products.
3. Change the settings.
Result
The change will be adopted immediately, there is no need to save it explicitly.
See also
Overview of the program settings (Page 302)
Overview of the script and text editor settings (Page 304)
Overview of the print settings (Page 305)
8.1.2.1 Views
Views
Three different views are available for your automation project:
The portal view is a task-oriented view of the project tasks.
The project view is a view of the components of the project, as well as the relevant work
areas and editors.
The library view (Page 311) shows the elements of the project library and the open global
libraries.
You can change over between the two views using a link.
Portals
The portals provide the basic functions for the individual task areas. The portals that are
provided in the portal view depends on the products that have been installed.
See also
Project tree (Page 312)
Basics of the work area (Page 316)
Inspector window (Page 324)
Basics on task cards (Page 326)
Details view (Page 330)
Title bar
Menu bar
Toolbar
Project tree (Page 312)
Reference projects (Page 328)
Details view (Page 330)
Work area (Page 326)
Dividers
Inspector window (Page 324)
Changing to the Portal view (Page 307)
Editor bar
Status bar with progress display
Task cards (Page 326)
Title bar
The name of the project is displayed in the title bar.
Menu bar
The menu bar contains all the commands that you require for your work.
Toolbar
The toolbar provides you with buttons for commands you will use frequently. This gives you
faster access to these commands.
Dividers
Dividers separate individual components of the program interface. The arrows on the dividers
allow you to display and hide the adjacent sections of the user interface.
Editor bar
The Editor bar displays the open editors. If you have opened a lot of editors, they are shown
grouped together. You can use the Editor bar to change quickly between the open elements.
See also
Basics of the work area (Page 316)
Project tree
Title bar
Toolbar
Table header
Project
Devices
Common data
Documentation settings
Languages & resources
Online access
Card Reader / USB memory
Title bar
The title bar of the project tree has a button for automatically and manually collapsing the
project tree. Once it is collapsed manually, the button is "Reduced" to the left-hand margin. It
changes from an arrow pointing left to one that is pointing right, and can now be used to reopen
the project tree. You can use the "Collapse automatically" button collapse to project tree
automatically when you do not need it.
See also: Maximizing and minimizing the work area (Page 318)
Toolbar
You can do the following tasks in the toolbar of the project tree:
Create a new user folder; for example, in order to group blocks in the "Program blocks"
folder.
Navigate forward to the source of a link and back to the link itself.
There are two buttons for links in the project tree. You can use these to navigate from the
link to the source and back.
Show an overview of the selected object in the work area.
When the overview is displayed, the lower-level objects and actions of the elements in the
project tree are hidden.
Table header
The "Name" column is shown by default. You can also show the columns "Type name" and
"Version". If you are showing the additional columns, you see the name of the respective type
as well as the version used for instances of types from the library.
Project
You will find all the objects and actions related to the project in the "Project" folder, e.g.:
Devices
Languages & resources
Online access
Device
There is a separate folder for each device in the project, which has an internal project name.
Objects and actions belonging to the device are arranged inside this folder.
Common data
This folder contains data that you can use across more than one device, such as common
message classes, logs, scripts and text lists.
Documentation settings
In this folder, you can specify the layout for project documentation to be printed at a later point.
Online access
This folder contains all the interfaces of the programming device / PC, even if they are not
used for communication with a module.
See also
Portal view (Page 307)
Project view (Page 309)
Basics of the work area (Page 316)
Inspector window (Page 324)
Basics on task cards (Page 326)
Details view (Page 330)
Showing and hiding columns (Page 316)
Procedure
To show or hide additional table columns for the associated type and its version number, follow
these steps:
1. Right-click on the table header of the project tree.
2. Select the "Show/Hide" command in the shortcut menu, and select the columns you want
to display.
The selected columns are displayed or hidden.
See also
Project tree (Page 312)
1 3
2 4
See also
Maximizing and minimizing the work area (Page 318)
Splitting the work area (Page 319)
Floating the work area elements (Page 320)
Using grouped elements of the work area (Page 321)
See also
Basics of the work area (Page 316)
Splitting the work area (Page 319)
Floating the work area elements (Page 320)
Using grouped elements of the work area (Page 321)
Minimizing and maximizing elements of the work area (Page 322)
Switching between the elements in the work area (Page 323)
Saving a layout of editors and tables (Page 337)
Procedure
To split the work area vertically or horizontally, follow these steps:
1. In the "Window" menu, select the "Split editor space vertically" or "Split editor space
horizontally" command.
The element you have clicked and the next element in the Editor bar will be displayed either
next to one another or one above the other.
Note
If no elements are open in the work area, the "Split editor space vertically" and "Split editor
space horizontally" functions will not be available.
See also
Basics of the work area (Page 316)
Maximizing and minimizing the work area (Page 318)
Floating the work area elements (Page 320)
Using grouped elements of the work area (Page 321)
Minimizing and maximizing elements of the work area (Page 322)
Switching between the elements in the work area (Page 323)
Saving a layout of editors and tables (Page 337)
Note
Properties of elements in a floating window
The properties of elements that you have selected in a floating window are only displayed in
the Inspector window if the Inspector window is floating as well.
See also
Basics of the work area (Page 316)
Maximizing and minimizing the work area (Page 318)
Splitting the work area (Page 319)
Using grouped elements of the work area (Page 321)
Minimizing and maximizing elements of the work area (Page 322)
Switching between the elements in the work area (Page 323)
Saving a layout of editors and tables (Page 337)
See also
Basics of the work area (Page 316)
Maximizing and minimizing the work area (Page 318)
Splitting the work area (Page 319)
Floating the work area elements (Page 320)
Minimizing and maximizing elements of the work area (Page 322)
Switching between the elements in the work area (Page 323)
Saving a layout of editors and tables (Page 337)
See also
Basics of the work area (Page 316)
Maximizing and minimizing the work area (Page 318)
Splitting the work area (Page 319)
Floating the work area elements (Page 320)
Using grouped elements of the work area (Page 321)
Switching between the elements in the work area (Page 323)
Saving a layout of editors and tables (Page 337)
See also
Basics of the work area (Page 316)
Maximizing and minimizing the work area (Page 318)
Splitting the work area (Page 319)
Floating the work area elements (Page 320)
Using grouped elements of the work area (Page 321)
Minimizing and maximizing elements of the work area (Page 322)
Saving a layout of editors and tables (Page 337)
"Properties" tab
"Info" tab
"Diagnostics" tab
Area navigation within the "Properties" tab
Content of the "Properties" tab
"Properties" tab
"Info" tab
"Diagnostics" tab
Navigation through additional tabs within a tab (only available in the "Info" and "Diagnostics"
tabs)
Toolbar (only available in the secondary "General" and "Compile" tabs of the "Info" tab)
Content of the "Compile" tab in the "Info" tab
"Properties" tab
This tab displays the properties of the object selected. You can change editable properties
here.
"Info" tab
This tab displays additional information on the object selected, as well as alarms on the actions
executed (such as compiling).
"Diagnostics" tab
This tab provides information on system diagnostics events, configured alarm events, and
connection diagnostics.
Toolbar
You can use the toolbar in the "General" and "Compile" tabs within the "Info" tab to specify
which types of alarms are to be displayed. You can enable or disable the display for the
following alarm types:
Errors
Warnings
Information
See also
Project tree (Page 312)
Basics of the work area (Page 316)
Portal view (Page 307)
Project view (Page 309)
Basics on task cards (Page 326)
Details view (Page 330)
See also
Changing the pane mode (Page 328)
Project tree (Page 312)
Basics of the work area (Page 316)
Inspector window (Page 324)
Portal view (Page 307)
Project view (Page 309)
Details view (Page 330)
Procedure
To change the pane mode, follow these steps:
1. Click the "Change pane mode" button above the panes inside a task card.
See also
Basics on task cards (Page 326)
1
2
Title bar
Toolbar
Opened reference projects
Title bar
The arrow for closing the palette is located in the title bar of the "Reference projects" palette.
Once it is closed, the direction in which the arrow is pointing changes from downwards to right.
It can now be used to reopen the palette.
Toolbar
The toolbar contains buttons for opening and closing reference projects.
See also
Basics of reference projects (Page 390)
Opening and closing a reference project (Page 390)
Title bar
Content of the selected object
Title bar
The arrow for closing the details view is located in the title bar of the details view. After it has
closed, the direction in which the arrow is pointing changes from left to right. It can now be
used to reopen the details view.
Objects
The displayed content varies depending on the selected object. You can move the content of
objects from the details view to the required location using drag-and-drop.
See also
Project tree (Page 312)
Basics of the work area (Page 316)
Inspector window (Page 324)
Basics on task cards (Page 326)
Portal view (Page 307)
Project view (Page 309)
Overview window
5 6 6 7
2 3 4
Overview window
Switch to the Details view
Switch to the List view
Switch to the Icon view
Move to higher level
Split the overview window in two. Either the right or left half of the overview window is synchronized. Clicking again
cancels the split.
All elements within a selected folder are displayed even if these are located in lower-level groups. This option is only
available in details view.
Contents of the object selected in the project tree.
See also
Comparing objects in the overview window (Page 333)
Sorting the details view of the overview window (Page 334)
Overview of the library view (Page 475)
Procedure
To split the Overview window in half or cancel the split, follow these steps:
1. In the toolbar, click on the "Synchronize left side" or "Synchronize right side" icon to split
the overview window. Either the left or the right side of the overview window synchronized
with the contents of the selected object in the project tree.
2. To cancel the split, click again on the previously selected icon.
See also
Overview window (Page 331)
See also
Overview window (Page 331)
See also
Save window layout (Page 335)
Load window layout (Page 336)
Managing window layouts (Page 337)
Saving a layout of editors and tables (Page 337)
Resetting the user interface layout (Page 338)
Basics of the work area (Page 316)
Procedure
To save a window layout, follow these steps:
1. Arrange all windows in the way in which you want to save them.
2. In the "Window" menu, select the "Save window layout as" command.
The "Save window layout" dialog box appears.
3. Enter a name for the window layout in the "Name" field.
4. Enter a description of the window layout in the "Description" field in order to be able to
identify the window layout more easily later.
5. Click "Save".
Result
The new window layout is saved in the last position after the existing saved window layouts.
The first five window layouts can be called using a key combination.
See also
Save user interface layout (Page 335)
See also
Save user interface layout (Page 335)
Procedure
To manage the existing window layouts, follow these steps:
1. In the "Window" menu, select the "Manage window layouts" command.
The "Manage window layouts" dialog box appears.
2. Select the window layout which you want to modify.
3. Click the "Up" or "Down" symbol to move the window layout up or down.
4. Click the "Delete" symbol to delete the selected window layout.
5. Click "OK".
The selected window layout is activated.
See also
Save user interface layout (Page 335)
Procedure
To save the layout of editors and tables in the work area, follow these steps:
1. Adapt the editor or table according to your requirements.
2. Click the "Remember Layout" button in the editor or table.
Result
The layout is saved. When you reopen the editor or table, this layout will be used.
See also
Basics of the work area (Page 316)
Maximizing and minimizing the work area (Page 318)
Splitting the work area (Page 319)
Floating the work area elements (Page 320)
Using grouped elements of the work area (Page 321)
Minimizing and maximizing elements of the work area (Page 322)
Switching between the elements in the work area (Page 323)
Save user interface layout (Page 335)
Procedure
To reset the user interface settings to the default, follow these steps:
1. Select the "Settings" command in the "Options" menu.
The "Settings" window is displayed in the work area.
2. Select the "General" group in the area navigation.
3. Click the "Reset to default" button under "Reset to default > Editor layout".
Result
The default settings for the user interface are restored.
See also
Overview of the program settings (Page 302)
Save user interface layout (Page 335)
See also
Displaying an overview of all keyboard shortcuts (Page 339)
Procedure
To display an overview of all available keyboard shortcuts, follow these steps:
1. Select the "Settings" command in the "Options" menu.
The settings of the TIA Portal are displayed.
2. Open the "Keyboard shortcuts" entry in the area navigation.
You can see an overview of all keyboard shortcuts, which are valid for the currently installed
products.
Using the basic functions of the TIA Portal with the keyboard
The following table shows how you can access basic functions of the TIA Portal with keyboard
shortcuts:
Operating menus
The following table shows how you can navigate through menus using the keyboard:
Editing a project
Selecting objects
The following table shows how to select individual objects, for example, devices in the project
tree:
Editing objects
The following table provides an overview of all the keyboard shortcuts required for editing
objects:
Editing text
The following table shows the basic editing functions for text:
Selecting text
The following table shows how to select text with the keyboard:
Navigate in tables
The following table shows how you can navigate within a table using the keyboard:
Introduction
When working with the TIA Portal, you also have the Microsoft on-screen keyboard available.
The function can be used but is regulated by the user account control.
A box is grayed out and cannot be accessed.
You require administrator privileges to access the box. In some operating system
environments, you can obtain administrator privileges by entering an administrator
password.
Note
A box being grayed out does not necessarily mean a lack of rights. You should also check the
additional information in the tooltip cascades to find out the conditions for editing the box.
The settings can be temporarily changed. When you call the dialog again, the procedure must
be repeated.
Note
This function is not supported by all operating systems. If no "Change settings" button is
present or the button is grayed out, you will need to log on to the operating system with
administrator privileges instead.
Help
The supplied help system describes concepts, instructions and functions. It also contains
reference information and examples. The help opens in a separate window.
A navigation pane appears on the left side of the help window. You can also hide the navigation
pane to make room on the screen. The navigation pane provides you with the following
functions:
Table of contents
Search in the index
Full text search of the entire help
Favorites
Roll-out
Certain text boxes offer information that rolls out and helps you to enter valid parameters and
values. The roll-out informs you about permitted value ranges and data types of the text boxes.
The following figure shows a roll-out (yellow) and a roll-out error message (red), which indicates
an invalid value:
The roll-out is closed as soon as you exit the window or click on the "x" in the upper right-hand
corner.
Tooltip
Interface elements offer you a tooltip for easier identification.
Tooltips, which have an arrow icon on the left, contain additional information in tooltip
cascades. If you position the mouse pointer briefly over the tooltip or click the arrow icon, this
information is displayed. The automatic display of tooltip cascades can be disabled.
If additional information is contained in the help system, a link to the corresponding help topic
appears in the cascade. If you click on the link, the corresponding topic opens in help.
The following figure shows a tooltip with opened cascade:
Help on alarms
Numerous actions are accompanied by alarms in the Inspector window of the TIA Portal. The
alarms give information about whether or not an action was successful. In addition, you see
which changes have been made in the project. Further help is available for some alarms. If
further help is available for an alarm, you access the help by clicking the question mark symbol.
The following figure shows the "Info" tab in the Inspector window with several alarms and a
question mark symbol:
See also
Configuring the display of tooltips and tooltip cascades (Page 358)
Using user-defined documentation (Page 361)
Procedure
To open the supplied help system, follow these steps:
1. In the "Help" menu, select the "Show help" command or press <F1> to display the help
matching the current context.
Or:
1. Click on the link in a tooltip cascade to go directly to a point in the help system that contains
more detailed information.
See also
Calling user-defined documentation (Page 370)
Full-text searches
To search the entire text for specific words, follow these steps:
1. Click the "Show/hide table of contents" button in the help toolbar to display the table of
contents.
The table of contents is displayed and the "Index", "Search" and "Favorites" tabs are visible.
2. Open the "Search" tab.
3. Type in your search term in the text box.
4. Refine your search if necessary using additional criteria:
Select "Search previous results" to start an additional search operation of your last
search results only.
Select "Search for similar words" to find words that differ only slightly from your search
term.
Select "Search titles only" to obtain only results that contain your search term in the title.
The contents of the Help topics are ignored during the search.
5. Click on the arrow button to the right of the search field to use logic operations. The following
logic operations are available:
Combine two or more search terms using the "AND" operator to find only Help topics
that contain all the search terms in the text.
Combine two or more search terms using the "OR" operator to find only Help topics that
contain one or more of the search terms in the text.
Combine two or more search terms using the "NEAR" operator to find only Help topics
that contain terms in close proximity to each other (eight words).
Precede a word with the "NOT" operator to exclude Help topics from the search that
contain this word.
6. Click on "List topics" to start the search.
The results are now listed with title, position and ranking. The "Position" column shows the
section in which the Help topic found is located. Sorting according to ranking is based on
the position of the Help topics found in the table of contents and based on the number of
hits in the Help topics.
Using favorites
You can save individual help topics as favorites. This saves you searching for the help topic
a second time.
Saving favorites:
To save a page as a favorite, follow these steps:
1. Open the help topic or the chapter you want to save as a favorite.
2. Click the "Show/hide table of contents" button in the help toolbar to display the table of
contents.
The table of contents is displayed and the "Index", "Search" and "Favorites" tabs are visible.
3. Open the "Favorites" tab.
4. Click the "Add" button.
The help topic or chapter is saved as a favorite and is available the next time you open the
help system.
Calling up favorites:
To call up a page from the favorites, follow these steps:
1. Click the "Show/hide table of contents" button in the help toolbar to display the table of
contents.
The table of contents is displayed and the "Index", "Search" and "Favorites" tabs are visible.
2. Open the "Favorites" tab.
3. Select the topic you want to open from the list.
4. Click the "Display" button.
Deleting favorites
To delete an entry from the favorites, proceed as follows:
1. Click the "Show/hide table of contents" button in the help toolbar to display the table of
contents.
The table of contents is displayed and the "Index", "Search" and "Favorites" tabs are visible.
2. Open the "Favorites" tab.
3. Select the topic you want to remove from the list.
4. Click the "Remove" button.
Printing information
You can either print all the contents of the Help system or individual topics only.
Procedure
To select the topics you would like to print, follow these steps:
1. Click the "Display printing dialog" button.
The table of contents opens in a separate window.
2. Select the check boxes for the folders and help topics to be printed in the "Print help topics"
dialog.
3. Click the "Print" button to print the selected information.
The "Print" dialog opens.
4. Select the printer on which you want print the help topics.
5. Click "Properties" if you want to make additional printer settings.
6. Confirm your entries with "OK".
The help topics are printed out on the selected printer.
Procedure
To configure the display of tooltips and tooltip cascades, follow these steps:
1. Select the "Settings" command in the "Options" menu.
2. Select the "General" group in the area navigation.
3. Select or clear the individual check boxes in the "Tooltips" area to suit your needs. The
"Open cascade automatically in tooltips" check box is only available if you have enabled
the display of tooltips.
See also
General remarks on the information system (Page 351)
Safety guidelines
This Help 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
with a safety alert symbol, indicates that minor personal injury can result if proper precautions
are not taken.
Notice
without a safety alert symbol, indicates that property damage can result if proper precautions
are not taken.
Note
indicates that an unintended result or situation can occur if the corresponding information is
not taken into account.
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 device/system may only be set up and used in conjunction with this documentation.
Commissioning and operation of a device/system may only be performed by qualified
personnel. Within the context of the safety notes in this documentation qualified persons are
defined as persons who are authorized to commission, ground and label devices, systems and
circuits in accordance with established safety practices and standards.
Prescribed Usage
Note the following:
Warning
This device may only be used for the applications described in the catalog or the technical
description and only in connection with devices or components from other manufacturers which
have been approved or recommended by Siemens. Correct, reliable operation of the product
requires proper transport, storage, positioning and assembly as well as careful operation and
maintenance.
Trademarks
All names identified by are registered trademarks of the Siemens AG. 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.
Customized documentation
In the Siemens Industry Online Support, you can assemble customized documentation that is
tailored to your needs. All configurable manuals and operating instructions of the Siemens
Industry Online Support are available to you for this purpose. You can select the parts that are
of interest to you and combine them into in a library to form personal documentation. You can
organize the documentation using folders in the library. The folders will later become the
individual chapters of your custom documentation.
You can open your personal library here (https://www.automation.siemens.com/mdm/?
guiLanguage=en).
Requirements
The manuals or operating instructions used must be configurable. You can recognize
configurable manuals by the suffix "configurable" in their name.
To use all the functions, you have to register in the Siemens Industry Online Support and
log on.
Once you have pressed <Shift+F1>, certain directories are searched in a fixed order for user-
defined documentation. The search order is given below:
Call log
You can display a call log for the user-defined documentation for easier connection of the user-
defined documentation. The alarms within the log indicate the directories in which
documentation is searched for and whether the call of the user-defined documentation is
successful. In addition, the file name that is expected for the file is indicated. This allows you
to identify how you must name your documentation and the directories in which you must save
the user-defined documentation. The call log has the same sequence as the one used to search
for user-defined documentation or a homepage.
The log is displayed in the Inspector window in the "Info" tab. Before you can display the call
log, you must first enable the call log in the settings of the TIA Portal or using an XML file.
See also
Conventions for the creation (Page 367)
Specifying settings with an XML file (Page 365)
Creating a homepage (Page 366)
Creating user-defined documentation (Page 371)
Calling user-defined documentation (Page 370)
General remarks on the information system (Page 351)
Note
XML configuration file takes precedence over the settings of the TIA Portal
If you use an XML configuration file and have specified settings for user-defined documentation
there, the settings in the XML file take precedence. As soon as you refresh the XML
configuration file or restart the TIA Portal, the settings from the XML file are applied. The
settings that you have made in the TIA Portal lose their validity.
Procedure
To specify a central storage location for user help, follow these steps:
1. Select the "Settings" command in the "Options" menu.
2. Open the "General > General" area.
3. Navigate to the "User documentation" section.
4. Select the "Display call log for user-defined documentation" check box in order to display
a log of the call of the user-defined documentation in the Inspector window.
5. Select the "Search for user-defined documentation in a central directory" check box in order
to store user-defined documentation in a cross-project directory.
6. Specify the path to where you save the cross-project documentation in the "Central directory
for user-defined documentation" field.
See also
Specifying settings with an XML file (Page 365)
Procedure
To specify settings for the user-defined documentation, follow these steps:
1. Create an XML file named "CorporateSettings.xml", if you are not yet using an XML
configuration file for the integration of company libraries. If you are already using a
configuration file, proceed with step 3.
The configuration file must be saved with "UTF-8" coding.
2. Save the file in the following directory on your computer:
C:\ProgramData\Siemens\Automation\Portal V13\CorporateSettings\
3. Enter the content listed below into the XML configuration file.
4. Adapt the attributes for display of the user-defined documentation. The meaning of the
individual elements is available in the comments in the XML configuration file. Use the value
"true" to activate a function. Use the value "false" to deactivate a function.
XML
<?xml version="1.0" encoding="utf-8"?>
<Document>
<Settings.Settings ID="0">
<ObjectList>
<Settings.General ID="1" AggregationName="General">
<!-- Here you find the settings for global company libraries, if available. -->
<ObjectList>
<Settings.UserDocumentation ID="2" AggregationeName="UserDocumentation">
<!-- In the following section, you specify the values for display of the user-defined
documentation. -->
<AttributeList>
<!-- Activates or deactivates the display of the access log. -->
<DisplayLogInformation>
<Value>true</Value>
</DisplayLogInformation>
<!-- Activates or deactivates the search for user-defined documentation in a central
directory. -->
<EnableLookupFromCentralStorageLocation>
<Value>true</Value>
</EnableLookupFromCentralStorageLocation>
<!-- Specifies the central directory for user-defined documentation. -->
<CentralStorageLocation>
<Value>D:\CorporateDocumentation\UserDocumentation\</Value>
</CentralStorageLocation>
</AttributeList>
</Settings.UserDocumentation>
</ObjectList>
</Settings.General>
</ObjectList>
</Settings.Settings>
</Document>
See also
Using user-defined documentation (Page 361)
Specifying settings in the TIA Portal (Page 364)
Calling user-defined documentation (Page 370)
Creating a homepage (Page 366)
Creating a configuration file for corporate libraries (Page 496)
You can design a homepage for user-defined documentation. The homepage can be an HTML
page that you save either within a CHM or in the directory of the respective language. You can
also use other file formats approved for user-defined documentation. You design the
homepage of the user-defined documentation outside the TIA Portal.
Procedure
To create a homepage, follow these steps:
1. Design a file in HTML format or in any other file format approved for user-defined help.
2. Name the file "Home".
3. Copy the file to the central directory for user-defined documentation on the hard disk or on
a network drive:
<Central directory for user-defined documentation>\<Folder for the respective language>
4. If the respective language folder does not exist yet, create the folder now.
Alternative: If you are creating the homepage for a CHM file, place the homepage in the
main directory of the CHM file.
See also
Specifying settings with an XML file (Page 365)
Using user-defined documentation (Page 361)
Conventions for the creation (Page 367)
Calling user-defined documentation (Page 370)
Displaying the call log (Page 371)
Creating user-defined documentation (Page 371)
You must observe some conventions to ensure that user-defined documentation is called at
the correct location:
the user-defined documentation must be saved in the correct directory.
The file name must be exactly the same as the object name in the TIA Portal.
To prevent malicious code from being executed on your computer, only file formats that are
considered as relatively safe are permitted.
Notice
Infection of the computer with malicious code
If the user-defined documentation contains malicious code, it can infect your computer.
Especially HTML pages and CHM files can contain malicious code.
Make sure that the user-defined documentation comes from a trustworthy source. You should
also use the standard security measures, such as the use of a firewall and an up-to-date virus
scanner.
Language Subfolder
German \de-DE
English \en-US
Spanish \es-ES
French \fr-FR
Language Subfolder
Italian \it-IT
Chinese \zh-CN
The language folder must contain a separate subfolder for each object category. Create the
corresponding subfolders for objects for which you are providing user-defined documentation.
Always use the English designation of the object category. The table below shows the English
designations of the most important object categories in the TIA Portal:
If you are not sure of the English designation for an object category, change the user interface
language of the TIA Portal to English. Alternatively, open the user-defined documentation for
an object with <Shift+F1> and check in the call log which designation is expected for the object
category.
Note
Opening CHM files on network drives
If CHM files are saved on a network drive, the CHM files are not displayed correctly in more
recent versions of Microsoft Windows. This behavior is determined by the security guidelines
of the operating system. All versions of Microsoft Windows as of Windows Server 2003 SP1
are affected.
You can bypass the security guidelines by changing the registry database in Microsoft
Windows.
To not compromise the security of your computer, save the CHM files only locally on your
computer and do not change the registry database.
See also
Using user-defined documentation (Page 361)
Creating a homepage (Page 366)
Requirement
You have already saved user-defined documentation or a homepage according to the
conventions.
Procedure
To open the user-defined documentation, follow these steps:
1. Select the object for which you want to display the user-defined documentation.
2. Press <Shift+F1>.
The suitable user-defined documentation or the homepage opens.
See also
Using user-defined documentation (Page 361)
Opening the Help system (Page 355)
Creating a homepage (Page 366)
Specifying settings with an XML file (Page 365)
Displaying the call log (Page 371)
Requirement
The call log is enabled in the settings of the TIA Portal or using an XML configuration file.
Procedure
To display the call log, follow these steps:
1. Open the "Info" tab in the Inspector window.
2. Open the "General" tab.
3. Select the object for which you want to call the help.
4. Press <Shift+F1>.
If possible, the matching user-defined documentation or the homepage of the user-defined
documentation is opened. In any case, you will be informed in the Inspector window about
which user-defined documentation is opened. You may be shown the directories in which
no user-defined documentation was found.
See also
Calling user-defined documentation (Page 370)
Creating a homepage (Page 366)
You create user-defined documentation for individual elements within a project or global library
outside the TIA Portal. You can create the user-defined documentation in all available user
interface languages.
If you create the user-defined documentation as CHM file, the procedure for creating the help
is somewhat different to the creation process for other file formats.
Note the information provided in chapter "Conventions for the creation (Page 367)".
See also
Creating a homepage (Page 366)
Conventions for the creation (Page 367)
Introduction
Projects are used to organize the storage of data and programs resulting from the creation of
an automation solution. The data that makes up a project includes the following:
Configuration data on the hardware structure and parameter assignment data for modules
Project engineering data for communication over networks
Project engineering data for the devices
Logs for important events in the life cycle of the project
Project hierarchy
Data is stored in a project in the form of objects. Within the project, the objects are arranged
in a tree structure (project hierarchy).
The project hierarchy is based on the devices and stations along with the configuration data
and programs belonging to them.
Common data of the project and online access, for example, are also displayed in the project
tree.
See also
Using logs (Page 376)
Creating a new project (Page 376)
Compatibility of projects (Page 377)
Opening projects (Page 379)
Upgrading projects (Page 380)
Displaying properties of the project (Page 382)
Saving projects (Page 383)
Closing projects (Page 384)
Removing projects (Page 384)
Deleting projects (Page 385)
Displaying logs
To open a log, follow these steps:
1. Open the "Common data > Logs" folder in the project tree.
2. Double-click the desired log in the list.
The contents of the log are displayed in the work area.
3. Optional: To show or hide a particular category of alarms, activate or deactivate the button
for "Errors", "Warnings", or "Information" in the toolbar.
Deleting logs
To delete a log, follow these steps:
1. Select the log in the project tree.
2. Press <Del>.
The selected log is deleted from the project directory and removed from the project tree.
Procedure
To create a new project, follow these steps:
1. Select the "New" command in the "Project" menu.
The "Create a new project" dialog opens.
2. Enter your project name and path or accept the proposed settings.
3. Click the "Create" button.
Result
The new project is created and displayed in the project tree.
See also
The basics of projects (Page 375)
Compatibility of projects (Page 377)
Opening projects (Page 379)
Upgrading projects (Page 380)
Displaying properties of the project (Page 382)
Saving projects (Page 383)
Closing projects (Page 384)
Removing projects (Page 384)
Deleting projects (Page 385)
Product version of the TIA Behavior when opened with the current product version of the TIA Portal
Portal
(file extension of the respec
tive version)
V10.5 (.ap10) The project is automatically upgraded to the latest product version when opened, following
V11.x (.ap11) your confirmation. The upgraded project is a copy of the original project. The original project
is retained unchanged.
V12 (.ap12) You can select between the following options:
Upgrade project to product version V12 SP1 and open in compatibility mode
Upgrade project to the current product version and open
The upgraded project is a copy of the original project in both cases. The original project is
retained unchanged.
V12 SP1 (.ap12) You can select between the following options:
V13 (.ap13) Open project in compatibility mode
Upgrade project to the current product version and open
A copy of the original project is created when you upgrade the project. The original project
is retained unchanged.
Compatibility mode
Compatibility mode is available for projects that were created with TIA Portal V12 SP1 and
V13. If you open a project in the V12 SP1 or V13 project format and do not upgrade it, the
project is in compatibility mode. The range of functions of the TIA Portal is limited to the range
of functions of the earlier product version. The project remains backward compatible and can
still be opened and edited with the earlier version of the TIA Portal.
Components supplied subsequently for the earlier product version as part of a Hardware
Support Package (HSP) can be added to projects in compatibility mode. To continue working
with the project in the earlier version of the TIA Portal, you simply need to install the Hardware
Support Package as well.
Global libraries are always created in the most recent format and are not backwards
compatible, even if the project is opened in compatibility mode.
You need to upgrade the project to use the full range of functions of the current version. By
upgrading the project you convert it to the current project format. The full range of functions of
the current version becomes available.
See also
The basics of projects (Page 375)
Creating a new project (Page 376)
Opening projects (Page 379)
Upgrading projects (Page 380)
Procedure
To open an existing project, follow these steps:
1. Select the "Open" command in the "Project" menu.
The "Open project" dialog box opens and the list of most recently used projects is displayed.
2. Select a project from the list and click "Open".
3. If the project you require is not included in the list, click the "Browse" button. Navigate to
the desired project folder, and open the project file.
Projects in the current project format are opened in the project view. If you have selected
a project from an older version of the TIA Portal, the "Upgrade project" dialog opens. More
information on upgrading the project can be found in chapter "Upgrading projects
(Page 380)".
See also
The basics of projects (Page 375)
Creating a new project (Page 376)
Compatibility of projects (Page 377)
Upgrading projects (Page 380)
Displaying properties of the project (Page 382)
Saving projects (Page 383)
Closing projects (Page 384)
Removing projects (Page 384)
Deleting projects (Page 385)
Upgrading V12 SP1 and V13 projects or using them in compatibility mode
To upgrade a project from TIA Portal V12 SP1 or V13 or to use it in compatibility mode, follow
these steps:
1. Open the project.
The "Upgrade project" dialog box opens.
2. Select how you want to proceed with the project:
Click "Yes" to upgrade the project to the current product version.
Click "No" to use the project in compatibility mode.
3. Optional: If you have upgraded the project to the current product version, compile the
hardware and software of all devices in the project.
Notes
Pay attention to the following notes after upgrading a project:
Note
Upgrading global libraries
Because global libraries are independent of projects, they are not upgraded automatically
together with the project. If you want to continue using global libraries from older versions of
the TIA Portal, you upgrade these global libraries as well. More information on upgrading global
libraries can be found in the chapter "Compatibility of global libraries (Page 484)".
Note
Upgrading know-how-protected blocks
The block is only upgraded and loaded after it has been opened once with the password. This
means you should open know-how-protected blocks once after upgrading the project to also
upgrade the blocks. If you have protected numerous know-how-protected blocks with the same
password, you can select and open all of them at once.
See also
Compatibility of global libraries (Page 484)
Upgrading global libraries (Page 487)
The basics of projects (Page 375)
Creating a new project (Page 376)
Compatibility of projects (Page 377)
Opening projects (Page 379)
Displaying properties of the project (Page 382)
Saving projects (Page 383)
Closing projects (Page 384)
Removing projects (Page 384)
Deleting projects (Page 385)
Compiling project data (Page 393)
Procedure
To display the project properties, follow these steps:
1. Select the open project in the project tree.
2. Select "Properties" in the shortcut menu of the project.
The dialog with the properties of the project opens.
3. Select the project properties in the area navigation that you want to have displayed.
See also
The basics of projects (Page 375)
Creating a new project (Page 376)
Compatibility of projects (Page 377)
Opening projects (Page 379)
Upgrading projects (Page 380)
Saving projects (Page 383)
Closing projects (Page 384)
Removing projects (Page 384)
Deleting projects (Page 385)
Saving a project
To save a project, follow these steps:
1. Select the "Save" command in the "Project" menu.
All changes to the project are saved under the current project name. If you are editing a
project from an earlier version of the TIA Portal, the file extension of the project is also
retained and you can continue to edit the project in the earlier version of the TIA Portal.
Project Save as
To save a project under another name, follow these steps:
1. Select the "Save as" command in the "Project" menu.
The "Save current project as" dialog opens.
2. Select the project folder in the "Save in" box.
3. Enter the new project name in the "File name" box.
4. Confirm your entry with "Save".
The project is saved under the new name and opened.
Note
Undoing actions
Keep in mind that you cannot undo actions once you have saved the project.
See also
The basics of projects (Page 375)
Creating a new project (Page 376)
Compatibility of projects (Page 377)
Opening projects (Page 379)
Upgrading projects (Page 380)
Displaying properties of the project (Page 382)
Closing projects (Page 384)
Removing projects (Page 384)
Deleting projects (Page 385)
Procedure
To close a project, follow these steps:
1. Select the "Close" command in the "Project" menu.
If you have made changes to the project since the last time you saved it, a message is
displayed.
2. Decide whether or not you want to save the changes.
See also
The basics of projects (Page 375)
Creating a new project (Page 376)
Compatibility of projects (Page 377)
Opening projects (Page 379)
Upgrading projects (Page 380)
Displaying properties of the project (Page 382)
Saving projects (Page 383)
Removing projects (Page 384)
Deleting projects (Page 385)
Procedure
To remove a project from the list of recently used projects, follow these steps:
1. Select the "Delete project" command in the "Project" menu.
The "Delete project" dialog opens and includes the list of most recently used projects.
2. Select a project from the list.
3. Click the "Remove" button.
4. Click "Yes" to confirm the prompt in order to remove the project from the list.
Result
The project is no longer displayed in the list of recently used projects. If you open the project
again, it will be added to the list again.
See also
The basics of projects (Page 375)
Creating a new project (Page 376)
Compatibility of projects (Page 377)
Opening projects (Page 379)
Upgrading projects (Page 380)
Displaying properties of the project (Page 382)
Saving projects (Page 383)
Closing projects (Page 384)
Deleting projects (Page 385)
Note
When you delete a project, the entire project data is removed from the storage medium.
Requirement
The project you want to delete is not open.
Procedure
Follow the steps below to delete an existing project:
1. Select the "Delete project" command in the "Project" menu.
The "Delete project" dialog opens and includes the list of most recently used projects.
2. Select a project from the list.
If the project you require is not included in the list, click the "Browse" button. Navigate to
the desired project folder, and open the project file.
3. Click the "Delete" button.
4. Click "Yes" to confirm. This starts the deletion of the project.
Result
The entire project folder is deleted from the file system.
See also
The basics of projects (Page 375)
Creating a new project (Page 376)
Compatibility of projects (Page 377)
Opening projects (Page 379)
Upgrading projects (Page 380)
Displaying properties of the project (Page 382)
Saving projects (Page 383)
Closing projects (Page 384)
Removing projects (Page 384)
See also
Retrieving compressed project (Page 389)
Creating compressed project archive (Page 387)
Minimizing project (Page 388)
Note
The most recently saved state of the project is used for archiving. Therefore, save the project
before using the archiving function. This will ensure that your most recent changes are included
in the archived project.
Procedure
To archive a project, follow these steps:
1. In the "Project" menu, select the "Archive > Compressed archive" command.
The "Archive current project as..." dialog opens.
2. Select the directory in which you want to save the archive file.
3. Enter a file name in the "File name" box.
4. Click "Save".
Result
A compressed file with the extension ".zap13" is generated. Project archives of projects in
compatibility mode for product version V12 SP1 receive the file extension ".zap12" and are
backward compatible with TIA Portal V12 SP1. The archive file contains the complete project
directory. The individual files of the project are also reduced to the essential components in
order to save space.
See also
Working with project archives (Page 386)
Retrieving compressed project (Page 389)
Minimizing project (Page 388)
Note
The most recently saved state of the project is used for minimizing. Therefore, save the project
before using the minimizing function. This will ensure that your most recent changes are
included in the project copy.
Procedure
To minimize a project to its essential components, follow these steps:
1. In the "Project" menu, select the "Archive > Minimize project" command.
The "Minimize current project under..." dialog opens.
2. Select the directory in which you want to save the project copy.
3. Enter the name of the new project directory in the "Directory name" box.
4. Click "Save".
Result
A copy of the original project directory is created at the designated location. The files contained
within it are reduced to their essential components in order to save space.
See also
Working with project archives (Page 386)
Creating compressed project archive (Page 387)
Requirement
No project is open.
Procedure
To extract a project archive, follow these steps:
1. Select the "Retrieve" command in the "Project" menu.
The "Retrieve archived project" dialog opens.
2. Select the project archive.
3. Click "Open".
4. The "Find folder" dialog opens.
5. Select the target directory to which the archived project should be extracted.
6. Click "OK".
Result
The project is extracted to the selected directory and opened immediately. If you extract a
project archive that includes a project from a product version earlier than V12 SP1, you may
have to upgrade the project. You will automatically receive the corresponding prompt as soon
as you open the project. The same rules apply that are described in the chapter "Compatibility
of projects (Page 377)".
See also
Working with project archives (Page 386)
Opening projects (Page 379)
Compatibility of projects (Page 377)
Upgrading projects (Page 380)
Introduction
You can open other projects as a reference in addition to the current project. You can use
these reference projects as follows:
You can drag individual objects from a reference project into the current project and then
edit them.
You can open specific objects, for example, code blocks from a reference project as read-
only. But this is not possible for all elements.
You can use an offline/offline comparison to compare devices of the reference project to
devices from the current project.
Note that reference projects are read-only. You cannot change the objects of a reference
project.
Projects that were created with an older version of the TIA Portal or with a different installation
package can also be opened as reference projects. The same compatibility rules apply here
as for normal opening of a project from an older version of the TIA Portal.
See also: Compatibility of projects (Page 377)
See also
Comparing reference projects (Page 391)
Opening and closing a reference project (Page 390)
Reference projects (Page 328)
See also
Basics of reference projects (Page 390)
Comparing reference projects (Page 391)
Reference projects (Page 328)
Introduction
You can compare devices from reference projects with devices from both the current project
as well as from the same or another reference project or from a library.
Note
Please note the following:
You cannot specify actions for the comparison objects, since the reference projects are
write-protected.
You can perform a detailed comparison for the comparison objects, if the type of
comparison object generally allows a detailed comparison.
When comparing reference projects, you can always switch between automatic and manual
comparison.
Procedure
To compare the objects of a reference project to the device data of the current project, follow
these steps:
1. In the project tree, select the device whose data you want to compare to the data of a
reference project and which allows offline/offline comparison.
2. Select "Compare > Offline/Offline" from the shortcut menu.
The compare editor opens with the selected device displayed in the left area.
3. Open the "Reference projects" palette in the project tree.
4. Select the device of a reference project that you want to compare to the device data from
the current project.
5. Drag the device from the reference project into the right drop area of the compare editor.
You can identify the status of the objects based on the symbols in the status and action
area. When you select an object, the object's properties and the corresponding object of
the associated device is clearly shown in the properties comparison.
You can drag a library or other devices from a reference project from the current project
into drop areas at any time and thus start a new comparison. It does not matter which device
you drag into the drop area.
See also
Basics of reference projects (Page 390)
Reference projects (Page 328)
Opening and closing a reference project (Page 390)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Note
While a device is being compiled, no additional compiling process can be started. Note in this
regard that you can not only perform a compiling process manually, but you can also trigger
it automatically for HMI devices.
See also
Compiling project data (Page 393)
Procedure
To compile project data, follow these steps:
1. In the project tree, select the devices whose project data you want to compile.
2. Select the option you require in "Compile" submenu of the shortcut menu.
Note
Note that the options available to you depend on the selected device.
The project data is compiled. You can check whether or not the compilation was successful
in the Inspector window with "Info > Compile".
See also
General information on compiling project data (Page 392)
Introduction
In order to set up your automation system, you need to load the project data you generated
offline on the connected devices. This project data is generated, for example when configuring
hardware, networks, and connections or when programming the user program or when
creating recipes.
The first time you download, the entire project data is downloaded. During later loading
operations, only changes are downloaded.
You can download the project data to devices and memory cards.
Note
While a device is being compiled, no additional download process can be started. Note in this
regard that you can not only perform a compiling process manually, but you can also trigger
it automatically for HMI devices.
a loaded instance or the correct version of the type does not exist in the project library, the
type or the version is added to the project library.
If required, you can use the "Force download to device" command to download blocks without
synchronization.
See also
Downloading project data to a device (Page 396)
Downloading project data to a memory card (Page 397)
Uploading project data from a device (Page 399)
Requirement
The project data is consistent.
Each device to which you want to download is accessible via an online access.
Procedure
To download the project data to the selected devices, follow these steps:
1. Select one or more devices systems in the project tree.
2. Right-click on a selected element.
The shortcut menu opens.
3. Select the option you require in the shortcut menu of the "Download to device" submenu.
Note
Note that the options available to you depend on the selected device.
When necessary, the project data is compiled.
If you had previously established an online connection, the "Load preview" dialog opens.
This dialog displays messages and proposes actions necessary for downloading.
If you had not previously established an online connection, the "Extended download to
device" dialog opens, and you must first select the interfaces via which you want to
establish the online connection to the device. You have the option of showing all
compatible devices by selecting the corresponding option and clicking the "Start search"
command.
See also: Auto-Hotspot
4. Check the messages in the "Load preview" dialog, and select the actions in the "Action"
column, if necessary.
Warning
Preventing personal injury and material damage
Performing the proposed actions while the plant is in operation can cause serious bodily
injury and property damage in the event of malfunctions or program errors.
Make sure that no dangerous situations can arise before you start the actions.
As soon as loading becomes possible, the "Load" button is enabled.
5. Click the "Load" button.
The loading operation is performed. If there is a need for synchronization, the system
automatically displays the "Synchronization" dialog. This dialog displays messages and
suggests actions that are required for the synchronization. You have the option of
performing these actions or forcing the download without synchronization by clicking "Force
download to device". If you have performed the suggested actions, you will be asked
whether you want to continue with the download. The "Load results" dialog then opens. In
this dialog, you can check whether or not the loading operation was successful and take
any further action that may be necessary.
6. Click the "Finish" button.
Result
The selected project data was downloaded to the devices.
See also
General information on loading (Page 394)
Downloading project data to a memory card (Page 397)
Uploading project data from a device (Page 399)
Requirement
A memory card is displayed.
Downloading the user program to a memory card in the CPU (S7-300/400 only)
To download the user program to a memory card in a CPU of the S7-300/400 series, follow
the steps below:
1. Select a CPU of the S7-300/400 series in the project tree.
2. Select the "Download user program to memory card" command in the "Online" menu.
The "Load preview" dialog opens. This dialog displays alarms and recommends actions
needed for the loading operation.
3. Check the alarms and select the actions in the "Action" column, if necessary.
As soon as downloading becomes possible, the "Load" button is enabled.
4. Click the "Load" button.
The loading operation is performed and the "Load results" dialog is displayed. This dialog
displays alarms and suggests possible actions.
5. Check the alarms and select the actions in the "Action" column, if necessary.
6. Click the "Finish" button.
See also
General information on loading (Page 394)
Downloading project data to a device (Page 396)
Uploading project data from a device (Page 399)
Requirement
A project is open.
The hardware configuration and software to be uploaded must be compatible with the TIA
Portal. If the data on the device was created with a previous program version or with a
different configuration software, please make sure they are compatible.
See also
General information on loading (Page 394)
Downloading project data to a device (Page 396)
Downloading project data to a memory card (Page 397)
Requirement
A project is open.
The memory card is displayed.
See also: Accessing memory cards (Page 468)
The hardware configuration and software to be uploaded must be compatible with the TIA
Portal. If the data on the memory card was created with a previous program version or with
different configuration software, please make sure they are compatible.
Function
You can compare project data of the same type in order to determine possible differences. In
principle, the following comparison methods are available:
Online/offline comparison
With this comparison method you can compare the software of objects of a device with the
objects of a project. This is only possible when you establish an online connection to the
device.
Offline/offline comparison
With this comparison method you can either compare the software or the hardware. When
you compare the software, you can compare objects from projects or libraries. The
hardware comparison is available for devices from the currently open project or from
reference projects. You can decide for the software as well as the hardware comparison
whether the comparison should be performed automatically for all objects or whether you
want to compare individual objects manually.
Detailed comparison
For some objects, for example, blocks, you can also perform a detailed comparison in
addition to the online/offline and offline/offline comparison. This involves opening the blocks
to be compared beside each other and highlighting the differences.
A simple online/offline comparison is performed as soon as you establish an online connection.
During this process, comparable objects in the project tree are marked with icons that represent
the result of the comparison. You can also run a more comprehensive online/offline and offline/
offline comparison in the compare editor. When you compare software, you can also select
actions for non-identical objects in the comparison.
Note
Not all objects allow all types of comparison. Which comparison method you can use for
which project data depends on the products installed.
Compile your user program before you start a comparison or detailed comparison. After
each change of the program during a comparison, repeat this step before you update the
result of the comparison. This ensures that the comparison shows the current status.
See also
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Running a detailed comparison (Page 412)
Requirement
The project tree is open.
Procedure
To perform an online/offline comparison, follow these steps:
1. Select a device in the project tree that allows online/offline comparison.
2. Select the "Compare > Offline/online" command in the shortcut menu.
3. If you have not already established an online connection to this device, the "Go online"
dialog opens. In this case, set all the necessary parameters for the connection and click
"Connect".
The online connection is established and compare editor opens.
Result
All objects that exist online and offline are displayed. The symbols in the compare editor and
in the project tree show you the status of the objects. In the compare editor, you can now define
certain actions for the objects, depending on their status.
See also
Basics of project data comparison (Page 402)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Running a detailed comparison (Page 412)
Requirement
The project tree is open.
Procedure
To perform an offline/offline comparison, follow these steps:
1. Select a device in the project tree that allows offline/offline comparison.
2. Select the "Compare > Offline/offline" command in the shortcut menu.
The compare editor opens and the selected device is displayed in the left area.
3. Drag-and-drop an additional device to the drop area of the right pane.
All existing objects of the selected devices are displayed depending on the settings of the
compare editor in the "Software" tab and an automatic comparison is carried out. You can
identify the status of the objects based on the symbols in the compare editor. You can
define certain actions depending on the status of the objects. You can select an object in
order to additionally display the property comparison for the object.
4. If you want to carry out a manual comparison, click on the button for switching between
automatic and manual comparison in the status and action area. Then select the objects
that you want to compare.
The properties comparison is displayed. You can identify the status of the objects based
on the symbols. You can define certain actions depending on the status of the objects.
5. If you want to carry out a hardware comparison, open the "Hardware" tab. You can once
again carry out a manual comparison, if necessary. But you cannot specify any action.
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Function
The compare editor gives an overview of the results of a comparison in a table. The appearance
varies slightly depending on whether it is an online/offline comparison or a hardware/software
comparison.
2 3 4
The following figure shows the layout of the compare editor for an offline/offline comparison
(software):
2 3 2
4 5 6
2 3 2
4 5 6
Drop areas
In the case of an offline/offline comparison, you can drag the devices you want to compare
into the drop areas. In the case of a software comparison, the devices to be compared can
originate from the opened project, from reference projects, from the project library or from
global libraries. However, note that you can only drop complete libraries into the right drop
area. In the case of a hardware comparison, you can compare devices from the opened project
or from reference projects.
Comparison tables
Comparison tables show the objects of the devices being compared to one another.
The following table shows the meaning of the columns of the comparison table:
Column Description
Name Name of the compare object
Comment Comment on the compare object
Title Title of the compare object
Address Address of the compare object
Numbering Type of numbering for the comparison object
Type Type of compare object
Language Programming language set for the compare object.
Time stamp interface Time of the last modification to the block interface
Time stamp code Time of the last modification to the source code
Author Name of the author of the compare object
Version Version of the compare object
Column Description
Family Name of the object family
Load memory Memory usage of the load memory of the compare object
Work memory Memory usage of the work memory of the compare object
Modified on Time of last modification
Optimized block access Indicates whether "Optimized block access" is enabled for a block.
Signature Signature of the compare object (SIMATIC Safety)
Interface signature Signature of the block interface of the compare object (SIMATIC Safety)
Not all columns are available in every comparison type. For the hardware comparison, for
example, the comparison tables contain only the "Name" column.
Not all columns are shown in the default setting. However, as in all table editors, you can show
or hide the columns as required and sort according to individual columns.
Symbol Description
Folder contains objects whose online and offline versions differ
The following table shows the comparison results symbols for an offline/offline comparison:
Symbol Description
Reference program
Version compared
Symbol Description
Results of the offline/offline comparison are not known
Hardware comparison only: Although the lower-level objects of the container are
identical, there are differences between the containers themselves. Such a con
tainer may be a rack, for example.
Hardware comparison only: The lower-level objects of the container are different.
There are also differences between the containers. Such a container may be a
rack, for example.
The following table shows the symbols for possible actions in a software comparison:
Symbol Description
No action
Overwrite the object of the compared version with the object from the reference
program
Overwrite the object of the output program with the object from the compared
version
Different actions for the compare objects in the folder
Property comparison
The property comparison compares the properties of the selected compare objects. The result
is displayed with symbols. Only the property comparison is made with a manual comparison
so that the status and action area remains empty. With automatic comparison, you can perform
the property comparison in addition to the comparison in the comparison tables.
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Changing the view (Page 416)
Show and hide table columns (Page 411)
Filtering the compare editor view (Page 411)
Updating the comparison results (Page 413)
Synchronizing non-identical objects (Page 414)
Procedure
To show or hide table columns, follow these steps:
1. Click a column header.
2. Select the "Show/Hide" command in the shortcut menu.
The selection of available columns is displayed.
3. To show a column, select the column's check box.
4. To hide a column, clear the column's check box.
5. In order to show or hide multiple columns, click "More" and select or clear the check boxes
of the corresponding columns in the "Show/Hide" dialog.
Result
The columns in both the left and the right comparison table are shown or hidden.
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Overview of the compare editor (Page 405)
Filtering the compare editor view (Page 411)
Running a detailed comparison (Page 412)
Updating the comparison results (Page 413)
Synchronizing non-identical objects (Page 414)
Changing the view (Page 416)
Requirement
The compare editor is open.
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Overview of the compare editor (Page 405)
Changing the view (Page 416)
Show and hide table columns (Page 411)
Running a detailed comparison (Page 412)
Updating the comparison results (Page 413)
Synchronizing non-identical objects (Page 414)
Note
Not all objects allow a detailed comparison. The project data for which you can perform a
detailed comparison depends on the products installed. A detailed comparison of the hardware
components is not available for hardware comparison.
Procedure
Proceed as follows to perform a detailed comparison:
1. First, perform an online/offline or an offline/offline comparison for software.
The compare editor opens.
Note
You can only perform a detailed comparison for objects that are listed in the left as well as
the right comparison table.
2. In the compare editor, select the object for which you want to perform a detailed comparison.
3. Click the "Start detailed comparison" button in the toolbar.
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Overview of the compare editor (Page 405)
Show and hide table columns (Page 411)
Changing the view (Page 416)
Filtering the compare editor view (Page 411)
Updating the comparison results (Page 413)
Synchronizing non-identical objects (Page 414)
Note
For online/offline comparisons, you should note that changes in the device may result in the
system automatically updating the comparison editor if objects in the comparison are affected
by the change. This can have the following results:
Some of the actions you have defined may become invalid, for example if the device no
longer contains the object in question. Objects with such invalid actions will be highlighted
so you can define new, valid actions.
The selection you made before the automatic update may also be cancelled.
Requirement
The comparison editor is open.
Procedure
To update the comparison results, follow these steps:
1. Click the "Refresh view" button in the toolbar.
The comparison results are updated.
Note
Please note that the "Refresh view" button will not be available while the comparison editor
is loading or synchronizing content.
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Overview of the compare editor (Page 405)
Show and hide table columns (Page 411)
Changing the view (Page 416)
Filtering the compare editor view (Page 411)
Running a detailed comparison (Page 412)
Synchronizing non-identical objects (Page 414)
Specifying actions
If you have performed a comparison, you can specify the actions to be performed for non-
identical objects in the compare editor. You cannot select any actions for identical objects.
Note that you cannot execute any actions during hardware comparison.
In the case of an online/offline comparison, only synchronization actions in one direction are
permitted, in order to retain program consistency. Thus, for example, you can load multiple
blocks to a device or from a device, but you cannot perform a combination of loading actions
in one synchronization action. In this case, the first action you set in the compare editor
determines the synchronization direction. For example, if you specify for a block that the offline
block is to be loaded to the device, then the other objects can also only be loaded to the device
via a synchronization action. To load objects from the device again, first select the "No action"
option. You can then specify the action settings again as required. Or, you can perform a new
comparison.
Note
Please note the following CPU-specific aspects when defining actions:
S7-300/400:
You can define actions for the "Program blocks" folder, for folders you have created
yourself or for individual blocks.
Neither SCL nor GRAPH blocks can be loaded from the device to the offline project.
S7-1200/1500:
You can define actions for the "Program blocks" folder, for folders you have created
yourself or for individual blocks. If you have performed an online/offline comparison and
select download to the device as action, a consistent download is executed. If you upload
the object from the device to the project, however, you can also upload individual blocks.
SCL blocks cannot be loaded from the device to the offline project.
Requirement
The compare editor is open.
Procedure
To select an action for a non-identical object, follow these steps:
1. In the status and action area, click in the "Action" column on the cell of the object for which
you want to define an action.
The cell changes to a drop-down list.
2. Click on the drop-down list.
3. Select the action you want.
The action set will be carried out for the object in question the next time synchronization is
performed.
If you have accidentally changed the action you had selected, you can undo the change
before the next synchronization.
4. To restore the previously set action selection, right-click the action in the status and action
area that you want to restore.
5. Select the "Restore last selection" command in the shortcut menu.
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Overview of the compare editor (Page 405)
Show and hide table columns (Page 411)
Synchronizing objects
Synchronization executes the actions you have specified for non-identical objects. Note,
however, that in the case of an online/offline comparison you can only perform actions in one
direction in one synchronization action.
Requirement
The compare editor is open.
The desired actions have been selected.
Procedure
To synchronize objects, follow these steps:
1. Click the "Execute actions" button in the toolbar.
Result
The actions you specified for the objects are performed.
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Overview of the compare editor (Page 405)
Show and hide table columns (Page 411)
Filtering the compare editor view (Page 411)
Updating the comparison results (Page 413)
Specifying actions (Page 414)
See also
Basics of project data comparison (Page 402)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Overview of the compare editor (Page 405)
Show and hide table columns (Page 411)
Filtering the compare editor view (Page 411)
Running a detailed comparison (Page 412)
Updating the comparison results (Page 413)
Synchronizing non-identical objects (Page 414)
Introduction
You can protect your project data from unauthorized access. These include, for example:
Access protection for devices
Copy and display protection of objects
Restrictions for printouts of know-how-protected objects
For objects with know-how protection, this protection is also retained after the object is pasted
into a library. Note that every protection mechanism is not available for all objects. How to
protect specific objects is described in the online help of the product.
See also
Printing project data (Page 436)
Requirement
A protection level has been set for the device.
A protected function for the device has been enabled by entering the password.
Procedure
To revoke the access rights for the device, follow these steps:
1. Select the device for which you want to revoke access rights in the project tree.
2. Select the "Delete access rights" command in the "Online" menu.
Result
The access rights are revoked, and starting from now the user will be prompted to enter the
password again to execute a password-protected function on the device. The function can only
be executed if the correct password is entered.
If the device has an online connection, it will be disconnected.
See also
Protection concept for project data (Page 417)
Documentation settings
Introduction
Once a project is created, the contents can be printed in an easy-to-read format. You may print
the entire project or individual objects within the project. A well-structured printout is helpful
when editing the project or performing service work. The printout can also be used for your
customer presentations or as full system documentation.
You can prepare the project in the form of standardized circuit manuals and print it in a uniform
layout. You can limit the scope of the printout. You have the option to print to the entire project,
individual objects along with their properties, or a compact overview of the project. In addition,
you can print the contents of an open editor.
See also
Creating frames (Page 425)
Creating a cover page (Page 425)
Scope of printout
To be able to print, at least one printable element has to be selected.
If a selected object is printed, all subordinate objects are also printed. For example, if a device
is selected in the project tree, all of its data is also printed. If you select the entire project in
the project tree for printing, all project contents are printed with the exception of the graphical
views. These have to be printed separately. Items in the project tree that are not part of the
project cannot be printed. For example, this includes online portals and connected card readers
and USB memory devices.
When table contents are printed, all lines in the table in which a cell is selected are printed. In
order to print one or more table columns, the desired columns must be selected. If no individual
cells or columns are selected, the entire table is printed.
See also
Printing project data (Page 436)
Procedure
To change the print settings, follow these steps:
1. Select the "Settings" command in the "Options" menu.
The "Settings" window is displayed in the work area.
2. Select the "General" group.
3. Select the desired default settings in the "Print settings" area.
The changes are applied immediately and are retained for all projects, even after the TIA
Portal is closed.
See also
Overview of the print settings (Page 305)
Procedure
To add metadata, follow these steps:
1. To create new document information, double-click "Add new document information" under
"Documentation information > Document information" in the project tree.
The new document information is created and opened immediately.
2. Enter a name for the set in the "Name" field.
3. Fill in the individual fields with the metadata for the project.
Uses of frames
You can embed the regular pages of your plant documentation inside a consistently uniform
page frame. The frame can contain placeholders for project metadata, which is stored in the
document information. It can also contain graphic elements that you design yourself.
You can create your own frames or rely on ready-made page frames. You can adapt a ready-
made page frame and then store it again as a new frame.
Like cover pages, frames can be saved in global libraries where they are available for use
across projects.
Frames are designed for use on right printed pages only.
See also
Library basics (Page 470)
Overview of the "Libraries" task card (Page 472)
Designing cover pages and frames (Page 427)
Using ready-made frames and cover pages (Page 426)
Creating frames
You can create any number of frames for each project. The frames are stored in the project
tree below the "Documentation information > Frames" group. You can assign a frame to all
document information. When you select document information for printing, its associated frame
is used.
Procedure
To create a new frame, follow these steps:
1. Double-click the entry "Add new frame" below the "Documentation information > Frames"
group in the project tree.
The "Creating frames" dialog opens.
2. Enter a name for the frame in the "Name" field.
3. Choose the paper size from the "Paper type" drop-down list.
4. Choose whether the page is to be created in portrait or landscape format in the "Orientation"
drop-down list.
Click the "Add" button.
Result
A new frame is created. The frame is then opened automatically in the documentation editor
where it can be edited.
See also
Editing cover pages and frames (Page 427)
Creating a cover page (Page 425)
Procedure
To create a new cover page, follow these steps:
1. Double-click the entry "Add new cover page" below the "Documentation information > Cover
pages" group in the project tree.
The "Add new cover page" dialog box opens.
2. Enter a name for the cover page in the "Name" field.
3. Choose the paper size from the "Paper type" drop-down list.
4. Choose whether the page is to be created in portrait or landscape format in the "Orientation"
drop-down list.
Click the "Add" button.
Result
A new cover page is created. The cover page is then opened automatically in the
documentation editor where it can be edited.
See also
Editing cover pages and frames (Page 427)
Creating frames (Page 425)
Procedure
To create and edit the ready-made frames and cover pages, follow these steps:
1. Open the "Global libraries" pane in the "Libraries" task card.
2. In the "Templates" folder, open the "Cover Pages" or "Frames" folder.
3. Drag a cover page or a frame from one of the folders into the project tree and drop it into
one of the following folders:
For frames: "Document information > Frames"
For cover pages: "Document information > Cover pages".
The ready-made frame or cover page can now be used in the project.
4. Double-click on the new entry in the project tree click to edit the frame or the cover page.
See also
Using cover pages and frames (Page 424)
Editing cover pages and frames (Page 427)
Procedure
To edit a cover page or a frame in the documentation editor, follow these steps:
1. In the project tree, double-click on the entry for an existing cover page or frame under the
"Documentation information > Frames " or "Documentation information > Cover pages"
group.
The documentation editor opens.
2. Design the cover page or frame as desired.
3. Close the documentation editor.
The changes to the cover page or frame are applied automatically.
See also
Creating a cover page (Page 425)
Creating frames (Page 425)
General operation of the documentation editor (Page 428)
Toolbar
The toolbar provides the following tools (from left to right):
Arrow tool
Enables object selection.
Navigation tool
Allows shifting of the partial page.
Zoom-in button
Magnifies the page display incrementally.
Zoom-out button
Reduces the page display incrementally.
Zoom with selection
Adapts the page size to a selected work area.
Dynamic zoom
Adapts the page width to the work area.
Work area
You can design the cover page or frame in the work area.
"Toolbox" task card
The "Toolbox" task card contains various types of placeholders that you can use on
the cover sheet or frame. The placeholders can be placed in the work place using
a drag-and-drop operation.
Properties in the Inspector window
You can display and modify the properties of the currently selected object in the
"Properties" tab of the Inspector window. For example, you can modify the properties
of the page, format text, specify the position of objects on the page, etc.
Snap to grid:
Specify whether objects are to be aligned automatically to the grid. If the option is selected,
the grid lines function like a "magnet".
Show rulers:
Specify whether the rulers are to be displayed.
See also
Editing cover pages and frames (Page 427)
Specifying the print area (Page 431)
Inserting placeholders for metadata (Page 431)
Requirement
A frame is open in the documentation editor.
Procedure
To define an area for the printed contents, follow these steps:
1. Click on the slightly darker area within the page display in the documentation editor to select
the area for the print content.
This opens the properties of the area to be printed in the Inspector window.
2. Enter the position of the print area on the X and Y axes in the Inspector window.
3. Specify the width and height of the print area in cm in the Inspector window.
Alternatively, you can change the width and position of the print area in the graphic display of
the page. To do so, use the mouse to drag the margins of the print area until the desired size
and position are achieved.
See also
Creating frames (Page 425)
General operation of the documentation editor (Page 428)
All elements are arranged in numbered Z-Orders. If objects overlap, you can determine in
which sequence these are to be arranged.
Types of placeholders
The following types of placeholders are available to you:
Text field
The text field stands as a placeholder for a text element from a document information. In
the properties of the text field, you set which text from a document information should be
automatically inserted during printing.
Field for date and time
A date and time is inserted instead of the placeholder when printing. This can be the date
of creation or the point in time when the last change was made to the project. In the
properties of the Inspector window, you specify which date or time is printed.
Page number
The correct page number is automatically applied when printing.
Free text
You can enter freely selectable text in the properties of the text field. The text is static and
is not influenced by the document information selected at the time of printing.
Image
Select the image file in the properties of the placeholder in the Inspector window. Images
in the formats BMP, JPEG, PNG, EMF or GIF are possible.
Requirement
An cover page or frame is open in the documentation editor.
Procedure
To insert placeholders for metadata on the cover sheet or in a frame, follow these steps:
1. Drag a field from the "Toolbox > Elements" task card to the work area of the documentation
editor.
The placeholder is inserted. The placeholder properties are shown in the Inspector window
and can be edited there.
2. Select the metadata to be inserted during printing from the "Text" drop-down list in the
Inspector window under "Properties > General > Text box". Alternatively, you have the
option of entering free text or selecting an image depending on the type of placeholder.
3. In the Inspector window under "Properties > General > Position and size", specify the
position of the placeholder on the X and Y axis and enter the width and height of the text
box in cm. You specify the sequence of the objects in the "Z-Order" field, if these overlap.
The smaller the value, the further down an object is located.
4. In the Inspector window, go to "Properties > View" and select the font formatting and the
orientation of the text as well as the alignment of the text. You cannot make this setting for
images.
See also
General operation of the documentation editor (Page 428)
Procedure
To create a print preview and to set the scope of the later printout, follow these steps:
1. Select the "Print preview" command in the "Project" menu.
The "Print preview" dialog opens.
2. Select the frame layout you want to use for the printout.
In the "Document information" drop-down list, select the documentation information you
want to use later for the printout.
Select the "Print cover page" check box to print the cover page, which is specified in the
selected document information.
Select the "Print table of contents" check box to add a table of contents to the printout.
The check boxes for printing the cover page and the table of contents can only be selected
if you have started the printout in the project tree.
3. Under "Print objects/area", select what is to be printed. The selection is only possible if you
have started the printout from an editor that supports this function.
Choose "All" to print out the entire content of the editor.
Choose "Selection" to print only the objects currently selected in the editor.
See also
Operation within the print preview (Page 435)
See also
Creating a print preview (Page 433)
Requirement
At least one printer is configured.
The objects to be printed are not protected.
The print scope for protected objects is limited. Disable the know-how protection to print
the objects in full.
6. Under "Print objects/area", select what is to be printed. The selection is only possible if you
have started the printout from an editor that supports this function.
Select "All" to print out the entire content of the editor.
Select "Selection" to print only the objects currently selected in the editor.
7. Select the print scope under "Properties".
Select "All" to print all configuration data of the selected objects.
Select "Visible" to print the information of an editor that is currently visible on the screen.
This option can only be chosen if you have started the printout from an editor.
Select "Compact" to print out an abbreviated version of the project data.
8. Click "Preview" to generate a print preview in advance.
A print preview is created in the work area.
9. Click "Print" to start the printout.
Note
Scope of the "Print" dialog
The options available in the "Print" dialog vary depending on the elements to be printed.
Result
The project data is prepared in the background for printing and then printed on the selected
printer. The status bar shows the progress of the print operation. You can continue working
normally while data is being prepared for printing.
The print results and any errors or warnings are listed in the Inspector window under "Info" at
the conclusion of the print job.
See also
Protection concept for project data (Page 417)
Revoking access rights for devices (Page 418)
Printout of project contents (Page 420)
Designing cover pages and frames (Page 427)
Print media
You can print the labeling strips either on ready-made print sheets or on standard DIN A4
paper. You can separate the individual labeling strips from the ready-made print sheets and
insert them in the designated labeling areas of your modules. If you print on standard paper,
the individual labeling strips must be cut out. Cut marks are automatically included on the
printout and serve as aids.
Because the paper feeds of printers differ slightly, the printout may be slightly offset on the
paper. When the labeling strips are printed on ready-made sheets, printing that is accurate to
the millimeter is important. Otherwise, the text will not be fit exactly inside the stamped area.
In addition, if the printing is imprecise, the labeling of an input or output may no longer be
congruent with the channel status displays of the module. To ensure precise printing, you can
enter an offset value for your printer in the TIA Portal. For information on how to determine the
proper offset value for your printer, refer to Chapter "Determining the print area offset
(Page 445)".
See also
Exporting labeling data as XML (Page 441)
XML schema of the export file (Page 442)
Printing labels (Page 439)
Determining the print area offset (Page 445)
Documentation settings (Page 419)
Printing labels
You can print labeling strips for the modules in your project if provision has been made for
attaching labels to the utilized modules. The labels are first exported to a Microsoft Word file
(.docx). A separate .docx file is created for each module family (for example, for all selected
S7-1500 modules). The labels are always printed from the word processing program.
Requirement
The following requirements apply to printing of labeling strips:
The chosen modules must support the printing of labels. Otherwise, the data can only be
output to an XML file.
A word processing program that supports Microsoft Word DOCX files must be installed,
e.g., Microsoft Word 2010 or later.
You need the ready-made labels for your modules or commercially available DIN A4 paper.
Procedure
To print labeling strips for hardware modules, follow these steps:
1. In the project tree, select the modules for which you want to print labeling strips.
You can select one or more stations in order to print out labeling strips for all modules
plugged into these stations.
Alternatively, select the desired modules below the stations in the "Local modules" folder.
2. Right-click one of the devices, and select the "Export labeling strips" command from the
shortcut menu.
The "Export labeling strips" dialog opens.
3. In the "Content of the labeling strip" area, select the data to be printed on the labeling strip:
Select "Symbolic name" in order to print the symbolic name of the input or output
(corresponds to the contents of the "Name" column in the IO tag table).
Select "Absolute address" in order to print the absolute address of the input or output
(corresponds to the contents of the "Address" column in the IO tag table).
Select "Absolute and symbolic address" or "Symbolic and absolute address" in order to
print both addresses. Printing takes place according to the specified order.
4. In the "Export format" area, define how the labeling data will be output.
Select "Print on SIEMENS labeling sheet" if you are printing on a ready-made label sheet
for your modules.
Select "Print on plain DIN A4 page" if you are printing on standard DIN A4 paper.
5. Select correction values for your printer in the "Offset print area", if required. The correction
values are used for correct alignment of the print area. Correction values are only necessary
if you are printing on ready-made labeling strips.
Enter a correction value, in millimeters, in the "Vertical offset" field. A negative value
shifts the print area upward. A positive value shifts the print area downward.
Enter a correction value, in millimeters, in the "Horizontal offset" field. A negative value
shifts the print area to the left. A positive value shifts the print area to the right.
6. In the "Path" field, select the path where the exported files will be stored.
7. Click the "Export" button to start the export.
The export files are created.
8. Open the DOCX files with a conventional word processing program, such as Microsoft
Word, and change the design of the labeling strips if necessary.
9. Print out the labeling strips from your word processing program. Use the paper that you
specified in the Export dialog for this.
10.If you are using ready-made sheets, separate the labeling strips at the stamped lines
provided for that purpose. When standard DIN A4 paper is used, you must cut out the
labeling strips.
See also
Determining the print area offset (Page 445)
Exporting labeling data as XML (Page 441)
Procedure
To export labeling data for hardware modules as XML, follow these steps:
1. In the project tree or network view, select the modules for which you need labeling strips.
You can select one or more stations in order to export the input and output addresses
of all modules plugged into these stations.
Alternatively, select the desired modules below the stations in the "Local modules" folder.
2. Right-click one of the devices and select the "Export module labeling strips" command from
the shortcut menu.
The "Export labeling strips" dialog opens.
3. In the "Export format" area, select the "Export to XML file" option.
4. In the "Path" field, select the path where the XML file will be stored.
5. Click the "Export" button to start the export to an XML file.
The XML file is created with the name "<Project name>_IO_Channels.xml".
See also
XML schema of the export file (Page 442)
Print function for module labels (Page 438)
Printing labels (Page 439)
</IOChannel>
</Module>
<Module Name="Sample S7-1500" />
<Module Name="DI 16x24VDC BA_1">
<IOChannel Number="0">
<Address>%I0.0</Address>
<Tag>Input Value 1</Tag>
</IOChannel>
<IOChannel Number="1">
<Address>%I0.1</Address>
<Tag>Input Value 2</Tag>
</IOChannel>
<IOChannel Number="2">
<Address>%I0.2</Address>
<Tag>Input Value 3</Tag>
</IOChannel>
<!-- All other channels follow -->
</Module>
<Module Name="AI 4xU/I/RTD/TC ST_1">
<IOChannel Number="0">
<Address>%IW2</Address>
<Tag>
</Tag>
</IOChannel>
<IOChannel Number="1">
<Address>%IW4</Address>
<Tag>
</Tag>
</IOChannel>
<IOChannel Number="2">
<Address>%IW6</Address>
<Tag>
</Tag>
</IOChannel>
<IOChannel Number="3">
<Address>%IW8</Address>
<Tag>
</Tag>
</IOChannel>
</Module>
</Rack>
</Station>
</Stations>
See also
Exporting labeling data as XML (Page 441)
Requirement
You require a ready-made label sheet.
You must have access to the actual printer that you will use subsequently for the printout.
The printer must be made ready for printing on standard DIN A4 paper.
Procedure
To determine the correction value for your printer, follow these steps:
1. Print out a label sheet on standard DIN A4 paper, as described in Chapter "Printing labels
(Page 439)".
2. Compare the printout on the DIN A4 paper with the ready-made label sheet.
3. If the print area is offset, you must use correction values.
Using a ruler, measure the horizontal offset relative to the ready-made label sheet. This
will be entered later in the "Horizontal offset" field of the Export dialog box for the printing.
If the print area is offset to the right, a negative correction value must be entered. If the
print area is offset to the left , a positive correction value must be entered.
Using a ruler, measure the vertical offset relative to the ready-made label sheet. This
will be entered later in the "Vertical offset" field of the Export dialog box for the printing.
If the print area is offset downward, a negative correction value must be entered. If the
print area is offset upward, a positive correction value must be entered.
Function
You can undo performed actions at any time. For this purpose, every action you perform is
saved in an action stack. When undoing actions, the stack is processed from top to bottom. In
other words, if you undo an action that lies further down in the stack, all actions located above
it in the stack will also be undone automatically.
You can redo previously undone actions until you execute a new action. Once you execute a
new action, it is no longer possible to redo previously undone actions.
$FWLRQVWDFN
8QGRVHTXHQFH
+DUGZDUHDQG
QHWZRUNHGLWRU
7DVNSODQQHU
3URJUDPPLQJHGLWRU
6DYHSURMHFW
0HVVDJHV
In this example, you cannot undo actions 1 to 3 because the project was saved. You can undo
actions 4 to 10 in the order indicated by the direction of the arrow. In other words, you must
undo action 10 first. Once you have undone action 8, you cannot then undo action 5. You must
first undo actions 7 and 6. As the final step in the sequence, you can then undo action 4. You
also have the option of undoing several actions in a single step by undoing an action located
further down in the action stack. All actions located above it in the stack will be undone
automatically.
The same principle also applies to redoing of actions.
See also
Undoing an action (Page 447)
Redoing an action (Page 448)
See also
Basics of undoing and redoing actions (Page 446)
Redoing an action (Page 448)
See also
Basics of undoing and redoing actions (Page 446)
Undoing an action (Page 447)
Introduction
You can use the following search options within TIA Portal:
Searching and replacing in the editor
Browsing the hardware catalog
In addition, individual products in TIA Portal offer more search options.
See also
Searching and replacing in the editor (Page 452)
Introduction
You can start a search which is limited to the editor currently open in the workspace. You can
customize the search as follows to suit requirements:
You can optimize the search with additional options.
You can specify the search area.
You can specify the search direction.
Search field
Additional options
Search area
Search direction
Start search
Replace
Start search
Follow these steps to start the "Find and replace" function:
1. Select the "Find and replace" command in the "Edit" menu or open the "Find and replace"
pane in the "Tasks" task card.
The "Find and replace" pane opens.
2. Enter a term in the "Find" drop-down list.
As an alternative, you can select the most recent search key from the drop-down list.
3. Select the options desired for the search.
4. Using the option buttons, select the starting point for the search and the search direction.
5. Click "Find".
The first hit is marked in the editor.
6. Click "Find" again to display the next hit.
The next hit is marked in the editor. Repeat this procedure as needed until you reach the
last hit.
See also
Basics of searching (Page 449)
Project language
Project languages are all languages in which a project will later be used. Based on the editing
language, all the texts can be translated to the various project languages. You specify the
languages that will be available in the project tree under "Languages & Resources > Project
languages".
Editing language
Every project has an editing language. When you enter texts, these are always created in the
editing language. You should therefore make sure that the editing language set is the language
in which you enter the texts. This avoids problems if you translate the texts later.
The editing language does not depend on the language of the user interface. You could, for
example, set English as the user interface language, but use Italian as the editing language.
If you enter texts, these will be created in the project language "Italian" in this case, although
the user interface of the TIA Portal is displayed in English.
You set the editing language in the project tree under "Languages & Resources > Project
languages > Editing language".
Reference language
The reference language is used as a template for translation. The text is displayed in the
reference language for each text box in the "Tasks > Languages and resources" task card.
You therefore know which text that belongs in a text box, even when no text is entered in the
currently selected editing language.
You manage the project texts in the project tree under "Languages & Resources > Project
texts".
Translating texts
The following procedures are available to translate texts.
Translate all texts used in the project in tabular form
You can enter the translations for the individual project languages directly in the "Project
texts" table. You can find the table in the project tree under "Languages & Resources >
Project texts".
Specify text assigned to individual objects in the Inspector window
In the Inspector window, you can translate the texts that are assigned to the currently
selected objects. Columns are displayed in a table for all available project languages. You
can enter the translations for each text in the columns.
Translating texts using reference texts
You can change the editing language for shorter texts. All the text cells are filled again with
the default values and can be filled in the current language. As orientation, you can display
what you last entered in the box in the reference language. To do this, select the "Tasks"
task card and open the "Languages & resources".
Exporting texts and translating them externally
With larger volumes of text, you can export the texts to an Office Open XML file and translate
them in a conventional table calculation program. You then import the translated list again
into the TIA Portal.
Note
Using East Asian project languages
You need Microsoft Windows at least in the Professional version or higher to display East
Asian project languages. Microsoft Windows in the Professional version must be installed in
the local language. With the "Ultimate" or "Enterprise" versions, it is sufficient to install the
appropriate language pack.
See also
Overview of the program settings (Page 302)
Changing the settings (Page 306)
Application examples for multilanguage projects (Page 462)
Requirement
You are in the project view.
A project is open.
Procedure
To select the project languages, follow these steps:
1. Click on the arrow symbol to the left of "Languages & Resources" in the project tree.
The elements below this are displayed.
2. Double-click on "Project languages".
In the work area, you will see a list of languages that you can select.
3. Select the required languages.
Result
All texts can be displayed in the activated languages if there is already a translation for these
languages.
Requirement
You are in the project view.
A project is open.
Procedure
To change the editing language, follow these steps:
1. Click on the arrow symbol to the left of "Languages & Resources" in the project tree.
The lower-level elements are displayed.
2. Double-click on "Project languages".
The possible settings for the project languages are displayed in the work area.
3. Select the editing language in "General > Editing language".
Requirement
You are in the project view.
You have selected at least one further project language.
Procedure
To translate text in the project-wide list, follow these steps:
1. Click on the arrow symbol to the left of "Languages & Resources" in the project tree.
The elements below this are displayed.
2. Double-click "Project texts".
A list with the user texts in the project is displayed in the work area.
3. Click on "System texts" if you you want to edit the list of system texts rather than the user
texts.
4. You can improve the clarity of the lists if you have a lot of texts.
To group identical texts and to translate them all at once, click the "Switch on/off
grouping" button in the toolbar.
To hide texts that do not have a translation, click the "Filter for empty texts on/off" button
in the toolbar.
To further limit the displayed project texts to certain devices, select the devices for which
you want to display project texts in the drop-down list.
5. Enter the translation of the project texts in the relevant column.
Requirement
Enter a text in at least one project language for the texts to be translated.
Procedure
To edit the text of the currently selected object, follow these steps:
1. Select the object whose text you want to edit.
2. Open the "Properties" tab in the Inspector window.
3. Open the lower-level "Texts" tab in the inspector window.
A table with all the texts that belong to the selected objects is displayed. The table contains
one column for the currently selected editing language and the reference language, as well
as additional columns for the other project languages.
4. Add or change the entries in the table for each project language.
See also
Application examples for multilanguage projects (Page 462)
Introduction
After changing the editing language, all texts are shown in input boxes in the new editing
language. If there is not yet a translation available for the newly set language, the input boxes
are empty or filled with default values.
If you enter text in an input box, this is saved in the current editing language. Following this,
the texts exist in two project languages for this input field, in the previous editing language and
in the current editing language. This makes it possible to create texts in several project
languages.
You can display existing translations for an input box in other project languages. These serve
as a comparison for text input in the current editing language and they are known as the
reference language.
Note
The display of reference texts depends on the installed products and is not supported by every
editor.
Requirement
There is at least one translation into a different project language for an input field.
Procedure
To display the translation of an input cell in a reference language, follow these steps:
1. In the "Tasks" task card, select the "Languages & Resources" pane.
2. Select a reference language from the "Reference language" drop-down list.
Result
The reference language is preset. If you click in a text box, translations that already exist in
other project languages are shown in the "Tasks > Languages & Resources" task card.
Note
Row limit in Microsoft Excel
Note that spreadsheet programs may be able to process only a certain number of rows.
Microsoft Excel 2003 supports a maximum of 65536 rows, for example. Later versions of
Microsoft Excel support significantly more rows.
See also
Application examples for multilanguage projects (Page 462)
Importing project texts (Page 461)
See also
Exporting project texts (Page 459)
3. Have the user texts contained in the file translated into English in a spreadsheet program
such as Microsoft Excel.
4. Import the file into the TIA Portal after it has been translated.
All texts are now available in German and English.
See also
Project text basics (Page 454)
Exporting project texts (Page 459)
Translating text associated with individual objects (Page 458)
Introduction
You can centrally manage texts to be referenced in alarms. All the texts are stored in text lists.
Each text list has a unique name with which you can call up its content. A range of values is
assigned to each text in a text list. If a value from a range of values occurs, the corresponding
text is called up.
All the texts can be translated to all project languages. Here, you have two options available:
You can enter the translation of the texts in a list. You will find the list in the project tree
under "Languages & Resources > Project texts".
You can export all texts to a file in Office Open XML format and enter the translation in a
spreadsheet program. The translations can then be imported again. Only export the data
to areas that are protected with appropriate access mechanisms. Only import files that
originate from trusted sources.
The texts are translated into the other project languages within the framework of the project
texts. In the text lists editor, you only have to manage the assignment of individual texts to a
text list.
See also
Exporting project texts (Page 459)
Requirement
You are in the project view.
A project is open.
The project includes a least one device.
Procedure
To create user-defined text lists, follow these steps:
1. Click on the arrow to the left of a device in the project tree.
The elements arranged below the device are displayed.
2. Double-click on "Text lists".
All the text lists assigned to the device are displayed in the work area listed in a table.
3. Double-click on the first free row in the table.
A new user-defined text list is created.
4. Enter a name for your new text list in the "Name" column.
5. Select if you want to specify the value ranges in decimal, binary or in bits from the drop-
down list in the "Selection" column. Depending on the device, there may be further options
available at this point.
6. Enter a comment in the "Comment" column.
A new user-defined text list is created and you can now enter the value ranges and texts.
Requirement
You are in the project view.
A project is open.
The project includes a least one device.
Procedure
To add to user-defined text lists with value ranges and texts, follow these steps:
1. Click on the arrow to the left of a device in the project tree.
The elements arranged below are displayed.
2. Double-click on "Text lists".
All the text lists assigned to the device are displayed in the work area listed in a table.
3. Select a text list in the table.
The contents of the selected text list are displayed in the work area. There, you can enter
a value range and assign texts to the individual value ranges.
4. Enter the value ranges you require in the "Range from" and " Range to" columns. The entry
must be made in the numeric format selected for the text list.
5. Enter a text for each value range in the "Entry" column.
Requirement
You are in the project view.
A project is open.
The project includes a least one device.
Procedure
To edit texts in system-defined text lists that are assigned to a value range, follow these steps:
1. Click on the arrow to the left of a device in the project tree or the "Common data" element.
The elements arranged below are displayed.
2. Double-click on "Text lists".
All the text lists assigned to the device or used in common are displayed in the work area
listed in a table.
3. Select a text list in the table.
The contents of the selected text list are displayed in the work area. Here, you can add to
or edit the texts assigned to a value range.
4. Enter a text for each value range in the "Entry" column.
Introduction
Memory cards are plug-in cards that come in a variety of types and can be used for a variety
of purposes. Depending on the device type or device family, memory cards can be used for
purposes, such as:
Load memory of a CPU
Storage medium for projects, firmware backups, or any other files
Storage medium for performing a firmware update
Storage medium for the PROFINET device name
For information regarding the technical variants of the respective memory cards and general
information on their handling, refer to the respective documentation for the device. For
information on handling memory cards in the TIA Portal, refer to the online help under the
keyword "Memory Card".
Notice
Memory card is unusable for SIMATIC devices
If you use a SIMATIC memory card for non-SIMATIC purposes or you format it incorrectly, you
will overwrite the internal structure of the SIMATIC memory card. The structure is not
recoverable and the SIMATIC memory card becomes unusable for SIMATIC devices.
Do not use memory cards for non-SIMATIC-related purposes, and do not format SIMATIC
memory cards with third-party devices or Windows tools.
See also
Adding a user-defined card reader (Page 468)
Accessing memory cards (Page 468)
Displaying properties of memory cards (Page 469)
Introduction
If your card reader is not detected automatically, you can add it manually.
Requirement
The project view is open.
Procedure
To add a card reader, follow these steps:
1. Open the project tree.
2. Select the "Card Reader / USB memory > Add user-defined Card Reader" command in the
"Project" menu.
The "Add user-defined Card Reader" dialog opens.
3. In the drop-down list box, select the path for the card reader.
4. Confirm your entries with "OK".
See also
Basics about memory cards (Page 467)
Accessing memory cards (Page 468)
Displaying properties of memory cards (Page 469)
Requirement
A memory card is inserted in the card reader.
The project view is open.
Note
You cannot work with multiple memory cards at one time. Only insert one memory card into
the card reader.
Procedure
To access memory cards, follow these steps:
1. Open the project tree.
2. Select the "Card Reader / USB memory > Card Reader / Show USB memory" command
in the "Project" menu.
The "Card reader / USB memory" folder is displayed in the project tree.
3. Open the "Card Reader / USB memory" folder.
You can now access the memory card.
Note
If data from a non-installed product is stored on the memory card, the folders that contain
these data are shown in gray. You receive an error message when you attempt to access
such a folder. Install the corresponding product if needed.
See also
Basics about memory cards (Page 467)
Adding a user-defined card reader (Page 468)
Displaying properties of memory cards (Page 469)
Requirement
A memory card is inserted in the card reader.
The project view is open.
Procedure
To display the properties of a memory card, follow these steps:
1. Right-click on the memory card for which you want to display the properties.
2. Select the "Properties" command in the shortcut menu.
The "Memory Card <name of the memory card>" dialog opens. The properties are displayed
in this dialog.
See also
Basics about memory cards (Page 467)
Adding a user-defined card reader (Page 468)
Accessing memory cards (Page 468)
Introduction
You can store objects you want to reuse in libraries. For each project there is a project library
that is connected to the project. In addition to the project library, you can create any number
of global libraries that can be used over several projects. Since the libraries are compatible
with each other, library elements can be copied and moved from one library to another.
Libraries are used, for example, to create templates for blocks that you first paste into the
project library and then further develop there. Finally, you copy the blocks from the project
library to a global library. You make the global libraries available to other employees working
on your project. The other employees continue to use the blocks and adapt them to their
individual requirements as needed.
Both the project library and global libraries distinguish between two different types of objects:
Master copies
Almost every object can be saved as a master copy and pasted into the project again later.
You can, for example, save entire devices with their contents or cover sheets for plant
documentation as master copies.
Types
Elements that are required to run user programs, for example, blocks, PLC data types, user-
defined data types or faceplates are suitable as types. Types can be versioned and
therefore support professional further development. Projects using the types can be
updated as soon as new versions of the types are available.
Project library
Each project has its own library, the project library. In the project library, you store the objects
you want to use more than once in the project. The project library is always opened, saved,
and closed together with the current project.
Global libraries
In addition to the project library, you use global libraries if you want to use libraries over several
projects. Global libraries exist in three versions:
System libraries
Siemens supplies global libraries for its own software products. These include off-the-peg
functions and function blocks that you can use within your project. The supplied libraries
cannot be changed. The supplied libraries are loaded automatically matching the project.
If you are working with the project in compatibility mode, the corresponding libraries for the
respective product version of the TIA Portal are loaded. For all other projects, the supplied
libraries of the latest TIA Portal version are loaded.
Corporate libraries
Corporate libraries are made available centrally by your organization, for example, in a
central folder on a network drive. The TIA Portal manages the corporate libraries
automatically. As soon as a more recent version of an existing corporate library becomes
available, you receive a prompt to update the corresponding corporate library to the more
recent version.
User libraries
Global user libraries are independent of a specific project and can therefore be passed on
to other users. Shared access to global user libraries is also possible, for example on a
network drive, if all users open the global user library with write protection.
Global user libraries from older versions of the TIA Portal that you created yourself can still
be used. To continue using global user libraries from older versions of the TIA Portal, they
must first be upgraded.
See also
Overview of the "Libraries" task card (Page 472)
Overview of the library view (Page 475)
Overview of the library management (Page 478)
Basics on master copies (Page 497)
Basics on types (Page 501)
"Elements" pane
In this pane, you can display the contents of folders in the library. The "Elements" pane is not
displayed by default. If you want to display the "Elements" pane, you have to enable it first.
Three view modes are available in the "Elements" palette:
Details mode
The properties of folders, master copies and types are shown in table form in details mode.
List mode
In list mode, the contents of folders are listed.
Overview mode
In overview mode, the contents of folders are displayed with large symbols.
See also: Using the element view (Page 474)
"Info" pane
You can display the contents of the library elements in the "Info" pane. The individual versions
of types and the last revision date of the version are also displayed.
"Types" folder
In the "Types" directories, you can manage types and type versions of objects that you use as
instances in the project.
See also: Using types (Page 501)
See also
Library basics (Page 470)
Comparing library elements (Page 532)
Introduction
When you open the "Libraries" task card the first time, the "Project library" and "Global libraries"
palettes are opened and the "Info" palette is closed. You can display the "Elements" palette if
needed.
The elements view shows the elements of the selected library. Three view modes are available
in the elements view:
Details
The properties of folders, master copies and types are shown in table form in details mode.
List
In list mode, the contents of folders are listed.
Overview
In overview mode, the contents of folders are displayed with large symbols.
The "Info" palette shows the contents of the selected library element. If you select a type in
the elements view, for example, the type versions are displayed in the "Info" palette.
Requirement
The "Libraries" task card is displayed.
Procedure
To use the element view, follow these steps:
1. Click "Open or close the element view" in the "Project library" or "Global libraries" pane.
2. To change the view mode from the details view to the list mode or overview mode, click the
corresponding icon on the toolbar.
See also
Library basics (Page 470)
Overview of the "Libraries" task card (Page 472)
Using global libraries (Page 483)
Comparing library elements (Page 532)
Library tree
Library overview
"Library view" button
"Open or close library overview" button
Library tree
The library tree is similar to the "Libraries" task card, apart from a few minor differences. In
contrast to the task card, there is no "Elements" palette, because the elements are displayed
in the library overview. In addition, you can close the library view in the library tree, or open
and close the library overview.
See also: "Libraries" task card (Page 472)
Library overview
The library overview corresponds to the overview window and displays the elements of the
currently selected object in the library tree. You can display the elements in three different
views:
Details view
The objects are displayed in a list with additional information, such as the date of the last
change.
List view
The objects are displayed in a simple list.
Icon view
The objects are displayed as icons according to category.
In addition, you can perform the following actions in the library overview:
Renaming elements
Deleting elements
Copying elements
Moving elements
Editing type instances
Versioning types
WinCC only: Editing faceplates and HMI user data types
See also: Overview window (Page 331)
See also
Basics on master copies (Page 497)
Basics on types (Page 501)
Opening and closing the library view (Page 477)
Library basics (Page 470)
Comparing library elements (Page 532)
See also
Overview of the library view (Page 475)
Library basics (Page 470)
Using the "Libraries" task card (Page 472)
Using global libraries (Page 483)
Comparing library elements (Page 532)
"Types" area
The "Types" area displays the contents of the folder that you have selected in the library view.
For each type, the types that it references are displayed. You can expand or collapse all type
nodes by using the buttons in the toolbar of the "Types" area. You can also filter the view with
the "Filter" drop-down list.
"Uses" area
The "Uses" area gives you an overview of the points of use of the selected types and master
copies. The "Uses" area is divided into two tabs:
"Use in the project" tab
The "Use in the project" tab is used to show the instances of type versions and their
respective point of use in the project. When you select an instance, you can show the cross
references of the instance in the project in the Inspector window.
"Use in the library" tab
The "Use in the library" tab is used to show all points within the library at which a type or a
master copy is used.
See also
Opening library management (Page 480)
Filtering the display of types (Page 481)
Displaying cross references of an instance (Page 482)
Displaying instances in the project (Page 481)
Displaying relations to other library objects (Page 483)
Library basics (Page 470)
Basics on master copies (Page 497)
Basics on types (Page 501)
Procedure
To open the library management, follow these steps:
1. Open the library view.
2. Select a type or any folder that contains types.
3. Select the "Library management" command from the shortcut menu.
Result
The library management opens and the types are displayed with their versions.
See also
Overview of the library management (Page 478)
Requirement
The library management is open.
Procedure
To filter the displayed types, follow these steps:
1. In the "Types" area, select the folder whose contents you want to filter.
2. Select the required filter in the "Filter" drop-down list.
In the "Types" area, types are displayed that correspond to the selected filter criteria.
See also
Overview of the library management (Page 478)
State of type versions (Page 503)
Creating a test version of a type (Page 511)
Editing a test version of a type (Page 513)
Creating an editing version of a type (Page 514)
Requirement
The library management is open.
Procedure
To display the instances of a type or its versions, follow these steps:
1. Select a type or one of its versions in the "Types" area.
2. Open the "Uses in the project" tab in the "Uses" area.
The instances in the project are displayed for each type version. The "Path" column shows
the path at which the respective instance is located in the project.
3. Optional: Click the path to jump directly to the respective instance in the project tree.
The library management is hidden and the instance is selected in the project tree.
See also
Displaying cross references of an instance (Page 482)
Using types (Page 509)
Overview of the library management (Page 478)
Displaying relations to other library objects (Page 483)
Requirement
The library management is open.
Procedure
To display the cross references of an instance in the project, follow these steps:
1. In the "Types" area, select a type version whose instances you want to display.
2. Select the instance of the required type version in the "Uses > Uses in the project" area.
3. Open the "Info > Cross-references" tab in the inspector window.
The cross reference of the instance are displayed in the project.
See also
Using cross-references (Page 533)
Overview of the library management (Page 478)
Displaying instances in the project (Page 481)
Requirement
The library management is open.
Procedure
To display the other library objects from which a type version is referenced, follow these steps:
1. Select a folder, an individual type or an individual version in the "Types" area.
2. Open the "Uses in the library" tab in the "Uses" area.
In the "Uses" area, you can now see which other library objects are referenced by the
individual type versions.
3. Optional: To jump to the referenced library object, click on the respective path in the "Path"
column.
See also
Displaying instances in the project (Page 481)
Overview of the library management (Page 478)
Requirement
The "Libraries" task card is displayed or the library view is open.
Procedure
To create a new global library, follow these steps:
1. Click the "Create new global library" icon in the toolbar of the "Global libraries" palette or
select the command "Global libraries > Create new library" in the "Options" menu.
The "Create new global library" dialog opens.
2. Specify the name and the storage location for the new global library.
3. Confirm your entries with "Create".
Result
The new global library is generated and pasted into the "Global libraries" palette. A folder with
the name of the global library is created in the file system at the storage location of the global
library. The actual library file is given the file name extension ".al13".
See also
Library basics (Page 470)
Opening a global library (Page 486)
Displaying properties of global libraries (Page 488)
Saving a global library (Page 490)
Closing a global library (Page 491)
Deleting a global library (Page 491)
Compatibility mode
If a project is open in compatibility mode for product version V12 SP1 or V13 of the TIA Portal,
the global library must also be in compatibility mode. You can use objects from the global
library in the project opened in compatibility mode. You can also save new objects in the global
library if the objects originate from a project in compatibility mode. A global library in
compatibility mode can still be opened and edited with the earlier version of the TIA Portal.
See also
Compatibility of projects (Page 377)
Opening a global library (Page 486)
Upgrading global libraries (Page 487)
Upgrading projects (Page 380)
Requirement
The "Libraries" task card is displayed or the library view is open.
Procedure
To open a global library, follow these steps:
1. Click the "Open global library" icon in the toolbar of the "Global libraries" pane or select the
command "Global libraries > Open library" in the "Options" menu.
The "Open global library" dialog box is displayed.
2. Select the global library you want to open. Library files are identified by the file name
extension ".al[version number]". This means global libraries that were saved with current
TIA Portal product version have the file name extension ".al13".
3. Write protection is activated for the library. If you want to modify the global library, disable
the "Open as read-only".
4. Click "Open".
The global library is opened and pasted into the "Global libraries" pane if the library version
matches the project version. The "Upgrade global library" dialog opens if you have selected
a global library from an older version of the TIA Portal. More information on upgrading the
global library can be found in the chapter "Upgrading global libraries (Page 487)".
See also
Retrieving global libraries (Page 494)
Upgrading global libraries (Page 487)
Opening projects (Page 379)
Compatibility of global libraries (Page 484)
Library basics (Page 470)
Creating a global library (Page 483)
Displaying properties of global libraries (Page 488)
Saving a global library (Page 490)
Closing a global library (Page 491)
Deleting a global library (Page 491)
See also
Opening a global library (Page 486)
Compatibility of global libraries (Page 484)
Upgrading projects (Page 380)
Requirement
The "Libraries" task card is displayed or the library view is open.
Procedure
To display the properties of a global library, follow these steps:
1. Right-click the global library whose properties you want to display.
2. Select the "Properties" command in the shortcut menu.
A dialog containing the properties of the global libraries opens.
3. Select the properties in the area navigation that you want to have displayed.
See also
Opening a global library (Page 486)
Library basics (Page 470)
Creating a global library (Page 483)
Saving a global library (Page 490)
Closing a global library (Page 491)
Deleting a global library (Page 491)
Procedure
To open the logs of a global library, follow these steps:
1. Open the global library in the "Libraries" task card or in the library view.
2. Open "Common data > Logs" in the lower-level folder.
3. Double-click the required log.
The log opens in the work area.
See also
Updating a library with the contents of another library (Page 528)
Note
Backward compatibility with older versions of the TIA Portal
Note that global libraries can no longer be opened in older versions of the TIA Portal once they
have been saved in the current version.
Requirement
The "Libraries" task card is displayed or the library view is open.
Saving changes
To save a global library, follow these steps:
1. Right-click on the global library you want to save.
2. Select the "Save library" command in the shortcut menu.
See also
Working with archives of global libraries (Page 492)
Archiving global libraries (Page 493)
Library basics (Page 470)
Creating a global library (Page 483)
Opening a global library (Page 486)
Displaying properties of global libraries (Page 488)
Requirement
The "Libraries" task card is displayed or the library view is open.
Procedure
To close a global library, follow these steps:
1. Right-click on the global library you want to close.
2. Select the "Close library" command in the shortcut menu.
If you have made changes to the global library, select whether or not you want to save the
changes.
The global library is closed.
See also
Creating a global library (Page 483)
Opening a global library (Page 486)
Displaying properties of global libraries (Page 488)
Saving a global library (Page 490)
Library basics (Page 470)
Deleting a global library (Page 491)
Requirement
The "Libraries" task card is displayed or the library view is open.
Procedure
To delete a global library, follow these steps:
1. Right-click the global library you want to delete.
2. Select the "Delete" command in the shortcut menu.
3. Click "Yes" to confirm.
Result
The global library is removed from the "Global libraries" palette. The entire library for the global
library is deleted from the file system.
See also
Library basics (Page 470)
Creating a global library (Page 483)
Opening a global library (Page 486)
Displaying properties of global libraries (Page 488)
Saving a global library (Page 490)
Closing a global library (Page 491)
See also
Archiving global libraries (Page 493)
Retrieving global libraries (Page 494)
Requirement
The global library is loaded.
Procedure
To archive a global library, follow these steps:
1. Select the global library that you want to archive.
2. Right-click the global library and select the "Archive" command from the shortcut menu.
The "Archive global library as..." dialog opens.
3. Select the directory where you want to save the archive file or the new directory of the global
library.
The directory may not be located in a project directory or within the directory of a global
library.
4. Select the file type from the "File type" drop-down list:
Global libraries archive, if you want to create a compressed file of the library.
Minimized global library, if you only want to create a copy of the library directory with
minimal storage requirement.
5. Enter a file name in the "File name" field if you are creating an archive file. If you are creating
a minimized global library, enter the name of the new library directory to be created in the
"File name" box.
6. Click "Save".
Result
A compressed file with the extension ".zal13" or ".zal12" is generated. The file extension
depends on whether you have archived a library in V12 SP1 compatibility mode or in the library
format of TIA Portal V13.
The file includes the complete directory of the global library. The individual files of the global
library are also reduced to the essential components in order to save space.
If you have minimized the global library, only a copy of the original directory of the global library
is created at the required location. The files contained within it were reduced to their essential
components in order to save space.
See also
Working with archives of global libraries (Page 492)
Retrieving global libraries (Page 494)
Procedure
To extract the archive of a global library, follow these steps:
1. Select the "Global libraries > Retrieve library" command in the "Options" menu.
The "Retrieve archived global library" dialog opens.
2. Select the archive file.
3. Select the check box "Open read-only" if you want to load the global library write-protected.
4. Click "Open".
5. The "Find folder" dialog opens.
6. Select the target directory to which the archived global library should be extracted.
7. Click "OK".
Result
The global library is extracted to the selected directory and opened immediately.
If the archive file contained a global library from TIA Portal V12 SP1, the global library is opened
in compatibility mode. Manually upgrade the library to the library version of TIA Portal V13, if
necessary.
See also
Working with archives of global libraries (Page 492)
Archiving global libraries (Page 493)
Opening a global library (Page 486)
Compatibility of global libraries (Page 484)
Upgrading global libraries (Page 487)
Introduction
Corporate libraries are global libraries made available by an administrator and assigned to the
TIA Portal. The administrator can assign new libraries or change libraries at any time. New
libraries are automatically loaded in the TIA Portal following your confirmation. As soon as
more recent versions of corporate libraries are available, the existing corporate libraries are
automatically updated to the more recent version, also following your confirmation.
The corporate libraries are located just like normal global libraries in the "Global libraries"
palette of the "Libraries" task card.
Procedure
To provide a configuration file for corporate libraries, follow these steps:
1. Create an XML configuration file with the content listed below. Use the coding "UTF-8".
2. Save the XML file under the name "CorporateSettings.xml".
3. Save the file in the following directory on your computer:
C:\ProgramData\Siemens\Automation\Portal V13\CorporateSettings\
XML
<?xml version="1.0" encoding="utf-8"?>
<Document>
<Settings.Settings ID="0">
<ObjectList>
<Settings.General ID="1" AggregationName="General">
<AttributeList>
<CorporateLibraryPaths>
<!-- Example of an entry -->
<Item>D:\CorporateLibraries\Corporate_Library_1.al13</Item>
<!-- Here you enter additional global libraries, if any. -->
</CorporateLibraryPaths>
</AttributeList>
</Settings.General>
</ObjectList>
</Settings.Settings>
</Document>
Result
As soon as you have saved the XML configuration file in the respective directory, you will
receive a prompt in the TIA Portal to load the corporate libraries.
See also
Specifying settings with an XML file (Page 365)
Requirements
The "Libraries" task card is displayed or the library view is open.
If you want to create new folders within a global library, you have to open the global library
with write permission.
Procedure
To create a new folder, follow these steps:
1. Right-click any folder within the library.
2. Select "Add folder" from the shortcut menu.
A new folder is created.
3. Enter a name for the new folder.
See also
Working with types in the project library (Page 506)
Filtering master copies (Page 500)
Master copies are used to create standardized copies of frequently used elements. You can
create as many elements as needed and insert them into the project based on a master copy.
The elements inherit the properties of the master copy.
You store master copies either in the project library or in a global library. Master copies in the
project library can only be used within the project. When you create the master copy in a global
library, it can be used in different projects.
The following elements can be created as master copies in the library, for example:
Devices with their device configuration
Tag tables
Instruction profiles
Watch tables
Elements from the documentation settings, for example, cover sheets and frames
Blocks and groups containing multiple blocks
PLC data types and groups containing multiple PLC data types
Text lists
Alarm classes
Technology objects
In many cases, the objects you add as master copy contain additional elements. A CPU, for
example, can contain blocks. If the included elements are uses of a type version, the used
versions of the types are automatically created in the library. The elements contained therein
are then used as an instance and linked to the type.
See also
Adding master copies (Page 498)
Using master copies (Page 500)
Basics on types (Page 501)
Filtering master copies (Page 500)
Requirement
The "Libraries" task card is displayed.
If you add a device as a master copy, this device meets the following requirements:
The device is compiled and consistent.
The device contains no test instance of a type.
If you add the master copy to a global library, the global library is opened with write
permission.
Note
Avoiding complex structures of master copies
To prevent name conflicts and conflicts regarding the folder structure during subsequent use
of master copies, avoid complex master copies. Complex master copies are, for example,
master copies that consist of multiple elements and nested folders.
See also
Basics on master copies (Page 497)
Using master copies (Page 500)
Library basics (Page 470)
Adding types to the project library (Page 506)
Requirement
The "Libraries" task card is displayed or the library view is open.
Procedure
To filter the view, follow these steps:
1. Open the "Master copies" folder in the project library or a global library.
2. In the drop-down list of the toolbar, select the type of objects you want to display under
"Master copies".
Result
Only the selected type of master copies is displayed. You can set the filter to "All" to return to
an unfiltered view.
See also
Library basics (Page 470)
Creating folders in a library (Page 497)
Basics on master copies (Page 497)
Using master copies (Page 500)
Using the element view (Page 474)
Requirement
The "Libraries" task card is displayed.
Procedure
To paste a master copy into the project, follow these steps:
1. Open the "Master copies" folder or any subfolder of "Master copies" in a library.
2. Using a drag-and-drop operation, move the desired master copies or whole folders to the
point of use.
Or:
1. Open the element view.
2. Using a drag-and-drop operation, move the desired master copies or whole folders from
the "Elements" pane to the point of use.
Result
A copy of the master copies is inserted. If incompatible master copies were included in a
multiple selection, these are omitted and a copy is not created in the project.
See also
Basics on master copies (Page 497)
Adding master copies (Page 498)
Filtering master copies (Page 500)
Library basics (Page 470)
Using the element view (Page 474)
Using types
Types are elements that are required for the execution of user programs. Types can be
versioned and further developed from a central location.
The following elements can be stored as type in the project library or the global library:
Functions (FCs)
Function blocks (FBs)
PLC data types
User data types
Faceplates
Screens
Styles
User-defined functions
Any number of instances can be derived from the versions of types in the project. The instances
are then linked to the version of the type. If you are using types from a global library, the type
is also created in the project library. If the type already exists in the project library, missing type
versions are added if necessary. The instance is then linked only to the respective type version
in the project library.
Types and their instances are marked with a black triangle. The following figure shows an
instance, marked with a black triangle, and an ordinary program block:
Versions of types
Versions are assigned to each type. The version number is displayed in both the "Libraries"
task card as well as the library view next to the respective type. The version number is also
displayed in the project tree next to instances of types. This allows you to see at all times which
version of an instance is used in the project.
The version number consists of three numbers separated by periods. You can randomly assign
the first two digits. Numbers from 1 to 999 are permitted as the first two numbers. The third
digit is the build number. It is automatically incremented by one when you edit an instance
related to the version. The build number is reset to 1 when you release the version.
The versions of types can have three states:
In progress (faceplates and HMI user data types)
In test (all sorts of types except faceplates and HMI user data types)
Released
The following figure shows a type with two versions. One version is "in test" and one version
is released:
See also
State of type versions (Page 503)
Basics on master copies (Page 497)
Adding types to the project library (Page 506)
Using types (Page 509)
Editing library elements (Page 526)
Duplicating types (Page 509)
"Released" status
The "released" status is available for all types, regardless of the point of use. If a version has
been released, the symbol of the version is marked with a seal in the library:
Released versions can be opened with write protection in their instance. If you want to edit a
released version, you must first create a new "In progress" or "in test" version.
See also
Basics on types (Page 501)
Using types (Page 509)
Creating a test version of a type (Page 511)
Editing a test version of a type (Page 513)
Creating an editing version of a type (Page 514)
Performing a consistency check for a version (Page 514)
Discarding versions (Page 515)
Release versions (Page 516)
Assigning a version (Page 524)
Updating the project to the latest versions (Page 518)
Remove the link between instance and type (Page 520)
Filtering the display of types (Page 481)
Requirement
The released version has an instance in the project; except with types, this is a faceplate or
an HMI user data type.
Procedure
To display the properties of a type or a version and to enter a comment, follow these steps:
1. Select a type or the version of a type in the "Libraries" task card or in the library view.
2. To do this, right-click on the type or one of its versions and select the "Properties" command
from the shortcut menu.
The "Properties" dialog box opens.
3. If needed, enter a comment on the type in the "Comment" field or edit an existing comment.
Requirement
The "Libraries" task card is displayed.
The elements that you want to add as type are compiled.
The elements are consistent.
For blocks, all other requirements are met as described in section "Block requirements
(Page 507)
Procedure
To add an existing element to the project library as a type, follow these steps:
1. Open the project library in the "Libraries" task card.
2. Drag-and-drop one or more elements into the "Types" folder or any subfolder of "Types".
Alternative: Copy the elements in the project tree to the clipboard and add the elements in
the desired project library folder.
The "Generate type" dialog opens.
See also
Basics on types (Page 501)
Duplicating types (Page 509)
Block requirements (Page 507)
Library basics (Page 470)
Adding master copies (Page 498)
Block requirements
Block requirements
To create a type from a block, the block must meet the following requirements:
The block must match the type of CPU.
A block which does not match a CPU can be identified by an incompatibility symbol to the
right of the block in the project tree. This is the case, for example, when you copy a block
from an S7-1500 CPU to an S7-300 CPU. A block of an S7-1500 is not compatible with an
S7-300 CPU and cannot be compiled. This means that you cannot create a type from the
block.
The block is not a system data block.
The block does not include global data access or single instance call of an instance data
block.
This also applies, for example, to the call of a data block within an STL block with the "OPN"
command.
See also
Adding types to the project library (Page 506)
Duplicating types
Types in the project library can be duplicated. If you duplicate a type, the following applies to
the duplicate:
The duplicate is created in the same folder.
The duplicate is created from the highest version of the type.
The duplicate does not have an instance in the project.
Requirement
The type is released.
Procedure
To duplicate a type in the project library, follow these steps:
1. Right-click on a type.
2. Select the "Duplicate type" command in the shortcut menu.
The "Duplicate type" dialog opens.
3. Enter the properties of the new type:
Enter a name for the new type in the "Name of the type" field.
Enter a version number for the new type in the "Version" field.
Enter the name of the editor who is responsible for the type in the "Author" field.
Enter a comment on the type in the "Comment" field.
4. Click "OK" to confirm.
The new type is generated with a released version.
See also
Adding types to the project library (Page 506)
Editing library elements (Page 526)
Using types
Types from the project library can be used any number of times within a project. The use of
types is always linked to a version of the respective type in the project library. If the type
contains dependent elements, these are also created as a type of use at a suitable point in
the project. Examples of dependent elements are PLC data types referenced in a block.
You can only assign a version of the same type to a device. If necessary, you can create uses
of several types at the same time.
Uses of a type are called instances in the project tree.
Requirement
The desired versions have been released.
A device which supports the category of desired type is already available in the project
The device is not yet assigned any further instance of the same type.
Procedure
To create an instance of a type, follow these steps:
1. In the project library, select the versions from which you want to create an instance.
2. Using a drag-and-drop operation, move the versions from the project library to the point of
use in the project tree or an editor.
Alternative: To automatically use the newest version, move the types themselves from the
project library to the point of use using a drag-and-drop operation.
For example, use a drag-and-drop operation to move the type of a function block to the
block folder of the CPU in the project tree. To call the type directly from another block, for
example, move the type from the project library to the point of use in the program editor
using a drag-and-drop operation.
Alternative:
1. Copy one or more instances to the clipboard.
2. Paste the instances at a suitable point in the same project or in a different project.
See also
Basics on types (Page 501)
State of type versions (Page 503)
Displaying types for an instance (Page 511)
Library basics (Page 470)
Using master copies (Page 500)
Procedure
To jump to the type associated with an instance in the project library, follow these steps:
1. Right-click the instance of the type in the project tree.
2. Select the "Go to type" command from the shortcut menu.
The associated type is displayed in the project library.
See also
Using types (Page 509)
Create a version with "in testing" status for the test. The creation of a version "in testing" is
suitable for all sorts of types except for faceplates and HMI user data types. On the other hand,
versions "in progress" can be created from faceplates and HMI user data types.
There are two ways to create a test version of a type and define the test environment:
In the "Libraries" task card or library view
Generate the new version with "in testing" status in the "Libraries" task card or in the library
view. You can generate the new version either directly from the type or from a specific
version of the type.
At an instance in the project tree
You can also create the test version directly at the instance in the project tree. Since the
instance is always used in a specific version in the project, a new version of the type is
generated from the version used at the instance.
You can also create test versions from several types at the same time.
The following rules apply to a version "in testing":
You can set only one version to "in testing" for each type at a given time.
A version in testing may only be linked to a single instance in the project. Therefore, it is
not possible to copy an instance to the clipboard, to duplicate it or to create an additional
type from the instance as long as it has "in testing" status.
Requirement
There is at least one instance of the type within the project in a given version.
If you want to create the new version from a particular version of the type, the instance
must be used in this version in the project.
Procedure
To generate a new test version of a type or the version of a type, follow these steps:
1. Select the type, a version of the type, or the instance.
When you create the test version directly at the instance, you can select several elements
or folders with multiple selection. You can skip steps 3 and 4 because the test environment
is already defined by the selected instance.
2. Right-click the selected element and select the "Edit type" command from the shortcut
menu.
If you have started the editing in the "Libraries" task card or in the library view, the "Edit
type" dialog opens. If you have started the editing at the instance in the project tree, the
test instance is immediately opened for editing in the library view.
Result
A new version of the type is created. The new version is "in testing" and is identified as such
in the user interface.
See also
Basics on types (Page 501)
State of type versions (Page 503)
Library basics (Page 470)
Note
Deleting and renaming interface parameters
You can add new parameters. However, if you rename or delete existing parameters, these
parameters will not be supplied when the block is called.
Procedure
To edit the test version of a type, follow these steps:
1. Right-click the test version or the instance.
2. Select the "Edit type" command from the shortcut menu.
The test instance is opened and can be edited.
See also
Basics on types (Page 501)
State of type versions (Page 503)
Library basics (Page 470)
Performing a consistency check for a version (Page 514)
Discarding versions (Page 515)
Release versions (Page 516)
Requirement
The project library is opened in the "Libraries" task card or in the library view.
Procedure
To create a new version of a type in progress, follow these steps:
1. Right-click the type or the version of the type.
2. Select the "Edit type" command from the shortcut menu.
A new "in progress" version is created and opened for editing in the library view.
See also
Basics on types (Page 501)
State of type versions (Page 503)
Library basics (Page 470)
Requirement
The project library is opened in the "Libraries" task card or in the library view.
The version is "in progress" or "in test".
Procedure
To perform a consistency check for the version of a type, follow these steps:
1. Right-click on the version that you want to check for consistency.
2. Select the "Consistency check" command in the shortcut menu.
The consistency check is carried out. You receive a message with the result of the
consistency check.
See also
Release versions (Page 516)
Discarding versions (Page 515)
Editing a test version of a type (Page 513)
Basics on types (Page 501)
State of type versions (Page 503)
Library basics (Page 470)
Discarding versions
Discard versions of a type "in test" or "In progress" when you no longer need the version. You
can also select several types or folders and discard all test or editing versions contained
therein. All uses of the deleted versions are reset to the last released status.
Requirement
The version that you want to discard is in the state "In testing" or "In progress".
Your are in the library view of the "Libraries" task card is open.
Procedure
To discard one version, follow these steps:
1. Right-click the version that you want to discard.
2. Select the "Discard changes and delete version" command from the shortcut menu.
The version is deleted.
Alternative in the library view:
1. Click the "Discard changes and delete version" button in the toolbar while a version is
opened for editing.
The version is deleted.
See also
Basics on types (Page 501)
State of type versions (Page 503)
Library basics (Page 470)
Performing a consistency check for a version (Page 514)
Requirement
Your are in the library view of the "Libraries" task card is open.
Release versions
When you are finished editing a type version, release the version for productive use. Assign
a version number for the release. You can also use a multiple selection to release several
versions at the same time.
Requirement
The "Libraries" task card is open or you are in the library view.
The versions that you want to release are "in test" or "In progress" status.
The versions are consistent.
A consistency check is performed as soon as you start the release. If errors that prevent a
release occur during the consistency check, a message is displayed indicating how you
can correct the errors.
Procedure
To release type versions, follow these steps:
1. Select the versions you want to release.
2. Right-click your selection.
3. Select the "Release version" command from the shortcut menu.
The "Release type version" dialog box opens.
Result
The selected versions are released.
The properties are applied for the types themselves, the versions to be released, and for all
future versions. Versions already released remain unaffected by the changes.
If needed, all instances with the same original version are updated to the most recent version
and the unused versions of the type are deleted.
See also
Releasing all versions within a folder (Page 517)
Basics on types (Page 501)
State of type versions (Page 503)
Library basics (Page 470)
Performing a consistency check for a version (Page 514)
Assigning a version (Page 524)
Adding types to a global library (Page 520)
Updating the project to the latest versions (Page 518)
Requirement
Your are in the "Libraries" task card or in the library view.
The folder includes versions "in test" or "in progress" status.
All versions "in test" or "in progress" are consistent.
A consistency check is performed as soon as you start the release. If errors that prevent
release occur during the consistency check, a message is displayed indicating how to
correct the errors.
Procedure
To release all type versions within a folder, follow these steps:
1. Right-click the required folder.
2. Select the "Release all" command from the shortcut menu.
The "Release type version" dialog box opens.
3. If necessary, change the properties of the version:
In the "Author" field, enter the editor of the versions to be released.
In the "Comment" field, enter a comment on the versions to be released.
4. Select the "Delete all unused type versions from the library" check box to delete all versions
from the library that are not connected to any instance in the project. Versions with
dependencies on other types or master copies are not deleted.
5. Click "OK" to confirm.
Result
All type versions "in test" or "in progress" status within the selected folder are released.
The properties are applied for the versions to be released and for all future versions. Versions
already released remain unaffected by the changes.
Versions of types not used in the project may be deleted.
See also
Release versions (Page 516)
Each of the following elements can be selected as source for the update:
The entire project library
Individual folders within the project library
Individual types
You can select multiple types.
Requirement
Your are in the "Libraries" task card or in the library view.
Procedure
To update instances in a project with the contents from the project library, follow these steps:
1. Select the entire project library or elements from it.
2. Right-click the required elements and select the "Update > Project" command from the
shortcut menu.
The "Update project" dialog box opens.
3. Select either the entire project or individual devices for the update.
4. Select the options for the update process:
The "Update all instances of the affected types" check box is always selected during
this process.
Select the "Delete all unused versions of affected types" check box to delete all older
versions of the updated types from the project library.
5. Click "OK" to confirm.
The update is performed.
Result
The following changes were made to the project:
All older versions were deleted from the project library as needed.
All instances within the selected devices were updated to the most recent version of the
linked types.
You can find a log of the update process in the projection tree under "Common data".
See also
Updating the project to the latest type versions (Page 523)
Using logs (Page 376)
Updating a library with the contents of another library (Page 528)
Basics on types (Page 501)
Requirement
The instance may not be "in test".
Procedure
To remove the link between instances and their type versions, follow these steps:
1. Select one or more instances in the project tree.
2. Right-click the selection and select the "Terminate connection to type" command from the
shortcut menu.
3. The link to the corresponding type versions is removed.
See also
Basics on types (Page 501)
Library basics (Page 470)
State of type versions (Page 503)
Requirement
The "Libraries" task card is displayed or the library view is open.
The global library to which you want to add types is opened and can be written to.
Procedure
To add types to a global library, follow these steps:
1. Open the required folder in the global library in the "Libraries" task card or in the library
view.
2. Drag one or more types from the project library to the "Types" folder or any subfolder of the
global library.
Alternative:
1. Copy the required types from the project library to the clipboard.
2. Open the required global library in the "Global library" palette of the "Libraries" task card.
3. Right-click the "Types" folder or any of its subfolders.
4. Select the "Paste" command in the shortcut menu.
Result
The types are inserted in the global library. Dependent types, such as types of HMI user data
types or tags, are also copied to the global library, provided they do not already exist there.
This ensures that all necessary elements for generating an instance are present in the global
library.
If a type already exists in the global library, the described action corresponds to an update of
the global library. In this case, the most recent released versions of the types are added to the
global library.
See also
Basics on types (Page 501)
Release versions (Page 516)
Assigning a version (Page 524)
Updating the project to the latest type versions (Page 523)
Library basics (Page 470)
Using types
To use types from the global library, create an instance of a particular version of the type at a
suitable point in the project. If necessary, you can create uses of several types at the same
time. Uses of a type are called instances in the project tree.
Requirement
A device which supports the category of the type is already available in the project.
The device is not assigned to any further instances of the same type.
Procedure
To use the version of a type in the project, follow these steps:
1. In the global library, select the versions from which you want to create an instance.
2. Using a drag-and-drop operation, move the desired versions of the types to the point of
use.
Alternative: To automatically use the newest version, move the types themselves from the
library to the point of use using a drag-and-drop operation.
For example, use a drag-and-drop operation to move the type of a function block to the
block folder of the CPU in the project tree. To call the type directly from another block, for
example, move the type from the library to the point of use in the program editor using a
drag-and-drop operation.
Result
Missing types or individual versions are added in the project library. If a type is not yet present
in the project library, it is stored in the same folder as before in the global library. An instance
is created from the types and their dependent elements and inserted at the point of use. The
instances are connected to the respective type version in the project library.
If you have created the instances in an editor, instances of the types are also created at the
appropriate points in the project tree. The folder structure from the library is reproduced in the
project tree. You will therefore find the instances in the same folders as in the global library.
See also
Basics on types (Page 501)
Updating the project to the latest type versions (Page 523)
Library basics (Page 470)
Using the element view (Page 474)
Requirement
Your are in the "Libraries" task card or in the library view.
The updated global library is open.
Procedure
To update instances in a project with the contents from a global library, follow these steps:
1. Select the updated global library or the individual elements from it.
2. Right-click the global library or the required elements and select the "Update > Project"
command from the shortcut menu.
The "Update project" dialog box opens.
3. Select either the entire project or individual devices for the update.
Result
The following changes were made to the project:
The most recent version of the select types is present in the project library. All older versions
were deleted if necessary.
All instances within the selected devices were updated to the most recent version of the
linked types.
You can find a log of the update process in the projection tree under "Common data".
See also
Updating the project to the latest versions (Page 518)
Using logs (Page 376)
Updating a library with the contents of another library (Page 528)
Basics on types (Page 501)
Library basics (Page 470)
Adding types to a global library (Page 520)
Requirement
The "Libraries" task card or the library view is open.
Your selection must not contain types with "in test" or "In progress" status.
Procedure
To assign several types the same version, follow these steps:
1. Select the types to which you want to assign a common version.
2. Select the "Assign version" command from the shortcut menu.
The "Assign version" dialog box opens.
3. If necessary, change the properties of the version:
In the "Version" field, determine the new version number. The version number must be
higher than the highest version number of all selected types.
In the "Author" field, enter the person responsible for the version to be released.
In the "Comment" field, enter a comment on the version to be released.
4. Click "OK" to confirm.
Result
The selected type versions are changed as follows:
A new version of all selected types is created with the specified version number.
The properties are applied to all selected types, the new version and to all future versions.
Lower versions remain unaffected by the changes. If you make no changes to the
properties, the properties of the last released version of each type are applied.
The build number of dependent types is incremented to the next free build number as long
as the dependent types were not in your selection. If you had selected a dependent type
as well, the version number you specified will be assigned.
A log of the changes is created. If you have versioned the types in the project library, you find
the log in the project tree under "Common data > Logs". If you have versioned types in a global
library, you find the log in the "Common data > Logs" folder in the level below the global library.
See also
Basics on types (Page 501)
State of type versions (Page 503)
Library basics (Page 470)
Release versions (Page 516)
Adding types to a global library (Page 520)
Using logs (Page 376)
Displaying logs of global libraries (Page 489)
Note
User-defined documentation for types and master copies
User-defined documentation is not affected by any of the operations within the library. If you
move a master copy or a type to a different location, you also move the associated user-defined
documentation in the file system to the corresponding location.
For additional help on using the user-defined documentation, refer to the chapter "Using user-
defined documentation (Page 361)".
Copying types
The following rules apply when you copy types to the clipboard:
Types are always copied to the clipboard with all associated versions. However, only
versions that have previously been released are copied.
Types are always copied to the clipboard with all dependent elements.
Master copies are always copied to the clipboard with all type versions used in them.
Cutting elements
You can only paste previously cut library elements into the same library. In so doing, you can
only paste master copies into the "Master copies" folder or any of its subfolders. Likewise, you
can only paste types into the "Types" folder or any of its subfolders.
Pasting types
Pasting types in a different library corresponds to updating the target library.
The following rules apply when you have pasted a type into a different library:
A type is always pasted with all its versions.
If the type already exists in the target library, all versions that are more recent than the
existing versions are added to the corresponding types in the target library.
If there is already a version with released status in the target library, this version is not
pasted again.
If the same version exists with in test or in progress status in the target library, it is replaced
by the released version.
If a type needs other types, these are also added at the respective location.
Moving elements
When you move an element from one library to another, the element is copied and not moved.
The same rules apply as described under "Pasting types" and "Pasting master copies".
Deleting instances
If you delete an instance that has dependencies to other instances, this instance is restored
during the next compilation. The instance is then linked again to the original type version. This
restores the consistency of the project.
See also
Library basics (Page 470)
Remove the link between instance and type (Page 520)
Updating a library with the contents of another library (Page 528)
Conventions for the creation (Page 367)
Using user-defined documentation (Page 361)
Duplicating types (Page 509)
Note
User help for copying types
User help is not copied together with a type to another library. You need to copy the user help
for types to the corresponding directory.
Additional help on using the user help can be found in the chapter "Conventions for creating
user help (Page 367)".
Requirement
If you want to update a global library, you have to open it with write permission.
Procedure
To update a library with the contents of a different library, follow these steps:
1. Select a library or individual elements from a library as source for the update.
2. Right-click the source and select the "Update > Library" command from the shortcut menu.
The "Update library" dialog box opens.
3. Select the type of library you want to update:
Select "Update the project library" to update the project library with types from a global
library.
Select "Update a global library" if you want to update a global library.
4. Optional: In the drop-down list, select the global library that you want to update, if you want
to update a global library.
Result
The following changes were made to the target library:
Types not yet available in the target library were copied together with all their versions.
More recent versions were added to the types that already exist in the target library. If a
more recent version of a type already existed in the target library, the latest version was
nevertheless copied and automatically assigned a newer version number.
If needed, all versions of types were deleted from the project library if these were not used
in any instance in the project.
A log listing all performed changes to the target library was created for the update process.
If you have updated the project library, you can find the log in the project tree under
"Common data > Logs".
If you have updated a global library, you can find the log in the "Common data > Logs"
folder in the level below the global library.
See also
Using logs (Page 376)
Updating the project to the latest versions (Page 518)
Updating the project to the latest type versions (Page 523)
Displaying logs of global libraries (Page 489)
Library basics (Page 470)
Using user-defined documentation (Page 361)
Procedure
To harmonize the names and the path structure, follow these steps:
1. Open the library management.
2. Click "Harmonize project" in the toolbar.
The "Harmonize project" dialog box opens.
3. Select the device with which you wish to harmonize the library.
4. Select the "Harmonize paths between project and library" check box if you want to restore
the path structure.
5. Select the "Harmonize names between project and library" check box if you want to have
the names corrected.
6. Confirm your entries with "OK".
Result
Depending on your settings, the names and the path structure in the project are harmonized
with the library.
The changes to the project are logged. The log is available under "Common data > Logs" in
the project navigation.
See also
Library basics (Page 470)
Overview of the library view (Page 475)
Overview of the library management (Page 478)
Using logs (Page 376)
See also
Library basics (Page 470)
Overview of the library view (Page 475)
Overview of the library management (Page 478)
Using logs (Page 376)
Displaying logs of global libraries (Page 489)
Introduction
You can compare devices from libraries with devices from both the current project as well as
from the same or another libraries or reference projects. Note, however, that reference projects
are write-protected. You can also compare instances in a device with their type version in a
library. Not all actions are available for the comparison with types. You cannot, for example,
overwrite an instance of a newer version with an older type version from the library.
When comparing library elements, you can always switch between automatic and manual
comparison.
Procedure
To compare library elements with the device data of a project, follow these steps:
1. In the project tree, select the device whose data you want to compare to a library element
and which allows offline/offline comparison.
2. Select the "Compare > Offline/offline" command in the shortcut menu.
The compare editor opens and the selected device is displayed in the left area.
3. Open the "Libraries" task card.
4. Select the library element that you want to compare to the device data.
5. Drag the library element into the right drop area of the compare editor.
You can identify the status of the objects based on the symbols in the status and action
area. When you select an object, the object properties and the corresponding object of the
assigned device are clearly shown in the property comparison.
You can drag other devices into the drop areas from the current project, a library or from a
reference point at any time to start a new comparison. It does not matter which device you
drag into the drop area.
See also
Using the compare editor (Page 405)
Carrying out offline/offline comparisons (Page 404)
Using the library view (Page 475)
Library basics (Page 470)
Overview of the "Libraries" task card (Page 472)
Overview of the library view (Page 475)
Using the element view (Page 474)
Using global libraries (Page 483)
Introduction to cross-references
The cross-reference list provides an overview of the use of objects within the project. You can
see which objects are interdependent and where the individual objects are located. Cross-
references are therefore part of the project documentation.
You can also jump directly to the point of use of an object.
Which objects you can display and localize in the cross-reference list depends on the installed
products.
See also
Displaying cross references of an instance (Page 482)
Introduction
You can use the TIA Portal to run and test the hardware and software of the project in a
simulated environment. The simulation is performed directly on the programming device or
PC. No additional hardware is required.
The simulation software provides a graphical user interface for monitoring and changing the
configuration. It differs according to the currently selected device.
See also
Starting the simulation (Page 534)
Procedure
To start the simulation software, follow these steps:
1. Select the device you want to simulate, for example, in the project tree.
2. Select the "Simulation > Start" command in the "Online" menu.
This calls the simulation software.
See also
Simulation of devices (Page 533)
Device view (Page 539), Network view (Page 537), Topology view (Page 542): Graphic area
Device view (Page 539), Network view (Page 537), Topology view (Page 542): Table area
Hardware catalog (Page 548)
Inspector window (Page 547)
The hardware and network editor provides you with three views of your project. You can switch
between these three views at any time depending on whether you want to produce and edit
individual devices and modules, entire networks and device configurations or the topological
structure of your project.
Drag the devices and modules you need for your automation system from the hardware catalog
to the network, device ot topology view.
The inspector window contains information on the object currently marked. Here you can
change the settings for the object marked.
Introduction
The network view is one of three working areas of the hardware and network editor. You
undertake the following tasks here:
Configuring and assign device parameters
Networking devices with one another
Structure
The following diagram shows the components of the network view:
You can use your mouse to change the spacing between the graphic and table areas of the
network view. To do this, click between the graphic and the table areas and change the spacing
by moving the divider to the left or right while keeping the mouse button pressed. The Speedy
Splitter (the two small arrow keys) allows you to use a single click to minimize the table view,
maximize the table view or restore the last selected split.
Toolbar
The toolbar provides the following functions:
Icon Meaning
Mode to network devices.
Mode to create connections. You can use the adjacent drop-down list to set the con
nection type.
Mode to create relations.
Opens the dialog for manual name assignment for PROFINET devices. For this purpose
the IO device must be inserted and connected online with the IO system.
Show interface addresses.
Enables page break preview. Dotted lines are displayed at the positions where the pages
break when printed.
You can zoom in (+) or zoom out (-) the view in steps using the zoom symbol or draw a
frame around an area to be zoomed in.
Saves the current table view. The layout, width and visibility of columns in the table view
is stored.
Graphic area
The graphic area of the network view displays any network-related devices, networks,
connections and relations. In this area, you add devices from the hardware catalog, connect
them with each other via their interfaces and configure the communication settings.
The operator controls for view control are located at the bottom edge of the graphic area:
Select the zoom leveling using the drop-down list. You can also enter a value directly into
the field of the drop-down list.
You can also set the zoom level using the slider.
You can re-focus the window of the graphic area using the icon in the bottom right corner.
Overview navigation
Click in the overview navigation to obtain an overview of the created objects in the graphic
area. By holding down the mouse button, you can quickly navigate in the overview navigation
to the desired objects and display them in the graphic area.
Table area
The table area of the network view includes various tables for the devices, connections and
communication settings present:
Network overview
Connections
Relations
IO Communication
VPN
You can use the shortcut menu of the title bar of the table to adjust the tabular display.
See also
Adding a device to the hardware configuration (Page 565)
Layout of the user interface (Page 307)
Displaying diagnostics status and comparison status using icons (Page 1356)
Networking devices in the network view (Page 582)
Tabular network overview (Page 585)
Introduction
The device view is one of three working areas of the hardware and network editor. You
undertake the following tasks here:
Configuring and assign device parameters
Configuring and assign module parameters
Structure
The following diagram shows the components of the device view:
You can use your mouse to change the spacing between the graphic and table areas of the
device view. To do this, click between the graphic and the table areas and change the spacing
by moving the divider to the left or right while keeping the mouse button pressed. The Speedy
Splitter (the two small arrow keys) allows you to use a single click to minimize the table view,
maximize the table view or restore the last selected split.
Toolbar
The toolbar provides the following functions:
Icon Meaning
Switches to the network view. The device view can switch between the existing devices
using the drop-down list.
Show the area of unplugged modules.
Opens the dialog for manual name assignment for PROFINET devices. For this pur
pose the IO device must be inserted and connected online with the IO system.
Show module labels.
Icon Meaning
Enables page break preview. Dotted lines are displayed at the positions where the
pages break when printed.
You can use the Zoom icon to zoom in (+) or out (-) incrementally or to drag a frame
around an area to be enlarged.
With signal modules, you can recognize the address labels of the I/O channels from
a zoom level of 200% or higher.
Saves the current table view. The layout, width and visibility of columns in the table
view is stored.
Graphic area
The graphic area of the device view displays hardware components and if necessary the
associated modules that are assigned to each other via one or more racks. In the case of
devices with racks, you have the option of installing additional hardware objects from the
hardware catalog into the slots on the racks.
The operator controls for view control are located at the bottom edge of the graphic area:
Select the zoom leveling using the drop-down list. You can also enter a value directly into
the field of the drop-down list.
You can also set the zoom level using the slider.
You can re-focus the window of the graphic area using the icon in the bottom right corner.
Overview navigation
Click in the overview navigation to obtain an overview of the created objects in the graphic
area. By holding down the mouse button, you can quickly navigate in the overview navigation
to the desired objects and display them in the graphic area.
Table area
The table area of the device view gives you an overview of the modules used and the most
important technical and organizational data.
You can use the shortcut menu of the title bar of the table to adjust the tabular display.
See also
Working with racks (Page 558)
Network view (Page 537)
Area for unplugged modules (Page 563)
Inserting a module into a rack (Page 568)
Objects in the device view (Page 560)
Layout of the user interface (Page 307)
Displaying diagnostics status and comparison status using icons (Page 1356)
Introduction
The topology view is one of three working areas of the hardware and network editor. You
undertake the following tasks here:
Displaying the Ethernet topology
Configuring the Ethernet topology
Identifying and minimizing differences between the desired and actual topology
Structure
The following figure provides an overview of the topology view.
You can use your mouse to change the spacing between the graphic and table areas of the
topology view. To do this, click between the graphic and the table areas and change the
spacing by moving the divider to the left or right while keeping the mouse button pressed. The
Speedy Splitter (the two small arrow keys) allows you to use a single click to minimize the table
view, maximize the table view or restore the last selected split.
Toolbar
The toolbar provides the following functions:
Icon Meaning
Opens the dialog for manual name assignment for PROFINET devices. For this pur
pose the IO device must be inserted and connected online with the IO system.
Enables page break preview. Dotted lines are displayed at the positions where the
pages break when printed.
You can zoom in (+) or zoom out (-) the view in steps using the zoom symbol or draw
a frame around an area to be zoomed in.
Saves the current table view. The layout, width and visibility of columns in the table
view is stored.
Graphic area
The graphic area of the topology view displays Ethernet modules with their appropriate ports
and port interconnections. Here you can add additional hardware objects with Ethernet
interfaces. See: Adding a device to the hardware configuration (Page 565)
The operator controls for view control are located at the bottom edge of the graphic area:
Select the zoom leveling using the drop-down list. You can also enter a value directly into
the field of the drop-down list.
You can also set the zoom level using the slider.
You can re-focus the window of the graphic area using the icon in the bottom right corner.
Overview navigation
Click in the overview navigation to obtain an overview of the created objects in the graphic
area. By holding down the mouse button, you can quickly navigate in the overview navigation
to the desired objects and display them in the graphic area.
Table area
This displays the Ethernet or PROFINET modules with their appropriate ports and port
interconnections in a table. This table corresponds to the network overview table in the network
view.
You can use the shortcut menu of the title bar of the table to adjust the tabular display.
See also
Layout of the user interface (Page 307)
Displaying diagnostics status and comparison status using icons (Page 1356)
Overview
The following table provides an overview of the settings for the hardware configuration:
See also
Changing the settings (Page 306)
To check that all content fits on one page, you can either use the print preview or activate the
page break preview. When page break preview is activated, dashed lines are displayed within
the graphic editor at the location where the page break is later made.
See also
Changing the print options (Page 546)
Documentation settings (Page 419)
Creating a print preview (Page 433)
Printing project data (Page 436)
Activating the page break preview for printout (Page 546)
Procedure
Proceed as follows to activate the page break preview:
1. Select the graphic area of the corresponding view.
2. Click on the "Show page break" symbol in the toolbar of the graphic editor.
Dashed lines are displayed within the graphic editor at the location a page break is later
made.
3. To modify the frame layout, select the "Print" command in the "Project" menu.
4. To disable page break preview, click again on the "Show page break" symbol in the toolbar
of the graphic editor.
Procedure
To change the scope of the printout, proceed as follows:
1. In the "Options" menu, select the "Settings" command.
2. In the area navigation, open the "Print settings" parameter group under "General".
3. Scroll to the "Hardware configuration" group.
4. Select or clear the "Active graphic view" check box, depending on whether you want to print
the graphics of the network and device view as well.
5. Select or clear the "Active table" check box, depending on whether you want to print the
table for the editor as well.
See also
Printing hardware and network configurations (Page 544)
Structure
The Inspector window consists of the following components:
Function
The information and parameters in the Inspector window are split into different types of
information:
Properties
Info
Diagnostics
To display the corresponding information and parameters, click in the relevant area. The
"Properties" area is the most important one for configuring an automation system. This area
is displayed by default and contains various tabs:
General: Display the properties and settings of the device or module. Here you can edit the
settings and parameters. The left pane of the Inspector window is used for area navigation.
Information and parameters are arranged there in groups. If you click on the arrow symbol
to the left of the group name, you can expand the group if sub-groups are available. If you
select a group or sub-group, the corresponding information and parameters are displayed
in the right pane of the Inspector window and can be edited there too.
IO tags: Display the IO tags of the PLC. You can assign names for the tags, assign the tags
to the user-defined tag tables via a drop-down list, and enter comments for the tags. The
IO tags are also shown in the PLC tag table.
System constants: Display the constants required by the system with the HW IDs of the
modules. The system constants are also shown in the PLC tag table.
Texts: Display the reference language and specify the text source for the project texts.
See also
Editing properties and parameters (Page 574)
Overview of hardware and network editor (Page 535)
Translating text associated with individual objects (Page 458)
Project text basics (Page 454)
Addressing modules (Page 848)
Structure
The "Hardware catalog" task card consists of the following panes:
Component selection
The component selection in the "Catalog" pane contains the installed hardware components
in a tree structure. You can move the devices or modules you want from the catalog to the
graphic work area of the device or network view.
Installed hardware components without a license are grayed out. You cannot use non-licensed
hardware components.
Hardware components belonging to various components groups thematically are partially
implemented as linked objects. When you click on such linked hardware components, a catalog
tree opens in which you can find the appropriate hardware components.
Information
The "Information" pane contains detailed information on the object selected from the catalog:
Schematic representation
Name
Article number
Version number
Description
See also
Browsing the hardware catalog (Page 557)
Overview of hardware and network editor (Page 535)
Requirement
The TIA Portal has access to the Internet.
Procedure
To enable access to Siemens Industry Online Support, follow these steps:
1. In the "Options" menu, select the "Settings" command.
2. Open the "Hardware configuration" group in the area navigation.
3. Select the "Via Internet" check box.
Result
You can access product support, FAQs and manuals in the hardware catalog via the shortcut
menu for the module.
See also
Displaying product support for hardware components (Page 551)
Requirement
You have access to the Internet.
Access to Product Support is enabled in the settings of the TIA Portal.
For information on how to enable the function, refer to section "Enabling product support
(Page 550)".
Procedure
To display the information for a particular module in Siemens Industry Online Support, follow
these steps:
1. Navigate to the required module in the hardware catalog.
2. Right-click the module.
3. Select one of the following entries in the shortcut menu:
Information on product support
FAQs
Manuals
Result
The default browser set in the operating system is opened and the relevant page in the
Siemens Industry Online Support is loaded.
See also
Enabling product support (Page 550)
See also
Keyboard operation in the TIA Portal (Page 339)
Selected objects
10.1.2.1 Basics
Configuring
"Configuring" is understood to mean arranging, positioning, and networking devices and
modules within the device or network view. Racks are represented symbolically. Just like "real"
racks, they allow you to plug in a defined number of modules.
An address is automatically assigned to each module. The addresses can be subsequently
modified.
When the automation system is started, the CPU compares the configuration that is preset by
the software with the actual configuration of the system. Possible errors can be detected and
reported straight away.
Assigning parameters
"Assigning parameters" is understood to mean the setting of properties of the components
used. Parameter assignment is carried out for hardware components and for data exchange
settings:
Properties of modules with assignable parameters
Settings for data exchange between components
The parameters are loaded to the CPU and transferred to the corresponding modules when
the CPU starts up. Modules can be replaced with ease since the assigned parameters are
automatically loaded into the new module during startup.
See also
Changing properties of the modules (Page 1184)
See also
Opening projects (Page 379)
Introduction
Specific slot rules apply to each automation system and module.
If you select a module from the hardware catalog in the device view, all possible slots for the
module selected are marked in the rack. You can only drag modules to marked slots.
If you insert, move or swap a module, the slot rules are also applied.
Consistency
Some slot rules depend on how the environment is configured. This means that you can
sometimes plug modules into the rack although this would result in inconsistencies at the
current time. If you change the configuration, for example by selecting different modules or
module parameter settings, you can make the configuration consistent again.
In cases where inserting a module results in an inconsistency that can be corrected, this will
be permitted. A consistency check is run when the configuration is compiled. Inconsistencies
are displayed as alarms in the Inspector window under "Info". Based on the result of the
consistency check, you can revise your configuration and make it consistent again.
Introduction
Use the "Hardware catalog" task card to select the hardware components you want for a
hardware configuration. Use the hardware catalog to select the interconnectable hardware
components in the network and topology view and to select the modules you want in the device
view.
Context filter
You can use the "Filter" option of the hardware catalog to restrict the number of displayed
hardware components and the number of hardware components that can be found by
searching.
If you select the filter, only those components are displayed that can be selected currently in
the hardware catalog. If the do not select the filter, the entire hardware catalog is displayed.
If you switch between the various views, the view of the filter objects is adapted to the current
context.
Search options
You can use the search function to search for specific entries in the hardware catalog. Note
the following rules when entering search terms:
No distinction is made between upper and lower case text.
Dashes and blanks are ignored during the search.
The search function considers parts of a search term.
Several search terms must be separated by a space
You start the search from an object highlighted in the hardware catalog and either search
upwards or downwards.
Icon Meaning
Downwards search
Upwards search
See also
Hardware catalog (Page 548)
Introduction
To assign modules to a device, you need a rack, for example a mounting rail. Secure the
modules on the rack and connect these via the backplane bus with the CPU, a power supply
or other modules.
Creating a rack
If you insert a device in the network view, a station and a rack suitable for the device selected
are created automatically. The rack and slots available are displayed in the device view. The
number of slots available again depends on the type of device used.
Rack structure
A rack always contains the device that has been inserted in the network view. The device is
permanently assigned a slot which will depend on the type of device in question. There are
additional slots on the right of the device and, if necessary, on left of the device; slot numbers
are located above slots in which devices are plugged.
A corresponding short description is displayed above the plugged devices and modules. You
show or hide this short description via the toolbar under "View" with the command "Display
module titles" or the corresponding symbol in the toolbar of the device view (Page 539).
Symbol Meaning
Show module titles
When modules are selected in the hardware catalog, all the slots permitted for this module are
marked. This allows you to see immediately the slot into which the selected module can be
inserted.
In the following screenshot, a signal module has been selected in the hardware catalog for a
partially filled S7-1200 rack:
Since slots 101-103 are reserved for communications modules, only the other free slots are
shown as available slots.
You can expand and collapse the front group of slots using an arrow symbol above the
expandable slot. When the group of slots is collapsed, the first and last of the group's slot
numbers are displayed.
The following figure shows the expanded slot group:
Groups of slots into which modules have already been plugged cannot be collapsed.
Graphic view of the allocation of the rack by the CPU and various modules in slots 1 to 4, as well as 101 and 102.
You can use the divider to adjust the proportion of the device view between the left area (graphic view) and the right
area (device overview). If you click on the arrows, you can quickly switch the division of the separate areas.
Device view with the tabular representation of the rack's slots and the inserted components. You can show additional
columns and hide displayed columns using the shortcut menu of the column title.
Each line in the device overview represents one slot. The key information for each slot is
displayed in the various columns:
Column Meaning
Online status Symbolic representation of the online status
Fail-safe Symbolic representation for fail-safe module
Module Name of module, can be edited in any way
Column Meaning
Rack Number of the rack
Slot Slot number
I address Input address area, can be edited in any way
Q address Output address area, can be edited in any way
F-source address F-source address when using fail-safe I/O
F-destination address F-destination address when using fail-safe I/O
Type Catalog name of module
Article no. Article number of the module
Firmware Firmware version of the module
Comment Optional comment
You can select the individual I/O channels and have the following options for channels with
PLC tags:
You see the general properties of the selected PLC tag in the inspector window under
"Properties".
In the inspector window under "Info > Cross-references" you find the cross-reference
information on the selected PLC tag. If you have selected the PLC tag, you can also open
the cross-reference information using the shortcut menu.
See also
Device view (Page 539)
You open the area of unplugged modules with the respective icon in the toolbar of the device
view (Page 539).
Icon Meaning
Open area of unplugged modules
Note
To free up slots, move modules from your configuration into the storage area and plug the
modules you want from the storage area into the freed up slots.
You can use this approach to temporarily move modules whose parameters have already been
assigned out of the configuration without deleting them.
Selecting a CPU
Introduction
Select a CPU from the hardware catalog and place it, together with a rack, in the network view.
On this device drag the desired modules from the hardware catalog; they are arranged
automatically on the rack.
Requirement
The hardware catalog is open.
You must be in the network view.
Procedure
To select a CPU from the hardware catalog, proceed as follows:
1. In the hardware catalog navigate to the folder with the desired CPUs.
2. Open the folder with the desired CPU type; you will see all article numbers for the selected
CPU type.
3. Click on a CPU article number to get information about the selected CPU in the "Information"
pane.
4. Set up the CPU and a rack. You have the following options:
Use drag-and-drop to drag the CPU from the hardware catalog into network view.
Use Copy & Paste to copy the CPU to the network view.
Double-click the CPU entry in the hardware catalog.
See also
Browsing the hardware catalog (Page 557)
Adding a device to the hardware configuration (Page 565)
Inserting a module into a rack (Page 568)
Working with racks (Page 558)
Creating an unspecified CPU (Page 567)
Introduction
There are various ways of adding a connectable device from the hardware configuration in the
network view and the topology view:
Command "Add new device" in the project tree
Double-click device in hardware catalog
5. If necessary, set the firmware version using the drop-down list in the hardware catalog.
6. Drag the device to the network view or the topology view.
You have now placed the device in the network view or in the topology view. The displayed
rectangle (in other words "Station") symbolizes the plugged device together with its rack and
any lower-level modules. Double-click on the device or station to open the device view and
view the new rack and inserted device. In the next steps, you can configure the device in the
device view and equip the rack with modules.
See also
Network view (Page 537)
Creating an unspecified CPU (Page 567)
Topology view (Page 542)
Introduction
If you have not yet selected a CPU but have already started programming or want to use an
existing program, you have the option of using an unspecified CPU. You can also adjust some
settings with unspecified CPUs. The setting options are restricted to parameters that all CPUs
of the same CPU family have in common.
See also
Selecting a CPU (Page 564)
Adding a device to the hardware configuration (Page 565)
Introduction
Once you have added devices from the hardware catalog to your configuration in network view,
you can add modules to the devices. There are various ways of adding a module to a rack in
the device view:
If there is an available valid slot, double-click a module in the hardware catalog.
Use drag-and-drop to move the module from the hardware catalog to an available valid slot
in the graphic or table area:
Text entry from the "Catalog" pane
Preview graphic from the "Information" pane
Select "Copy" in the shortcut menu for a module in the hardware catalog and then select
"Paste" in the shortcut menu on an available valid slot in the graphic or table area.
To access the device view from the network view, double-click a device or station in the network
view or select the Device view tab. The device view contains an illustration of the device
selected within a rack. The graphic illustration of the rack in the software corresponds to the
real structure, i.e. you can see the same number of slots as exist in the real structure.
Note
You can also move a module to a rack in the network view. The filter function for the hardware
catalog must be deactivated in this instance. The module is automatically plugged into a free
and permitted slot. If there are no slots available, the module will be moved to the area of
unplugged modules (Page 563).
Equipping a rack
Arrange the modules on a rack according to the applicable slot rules.
After a module has been inserted in a rack with an already inserted CPU, the address areas
are checked automatically so that addresses are not assigned twice. After it has been inserted,
each module then has one valid address range. To do so, DP slaves and IO devices must be
networked with a CPU via the corresponding DP master or IO system.
Requirements
You are in the device view.
The hardware catalog is open.
3. If necessary, set the firmware version using the drop-down list in the hardware catalog.
4. Drag the signal module to a free slot in the rack.
You have now inserted the digital signal module in a slot in the rack. Repeat these steps with
the other modules.
The name of the module is displayed above the inserted modules. You can activate or
deactivate module labeling in the menu bar with "View > Show module labels".
Inserting module
You can also drag modules and drop them between modules that have already been inserted.
To do this, drag a module above and between the two existing modules while holding down
the mouse button.
A mouse pointer appears. When you release the mouse button, all modules plugged to the
right of the pointer are moved one slot to the right. Any redundant modules are moved to the
area of unplugged modules. The new module is plugged at the point of the freed up slot.
See also
Device view (Page 539)
Area for unplugged modules (Page 563)
General slot rules (Page 556)
Rules
CPUs or modules from the rack and from the area of unplugged modules can be deleted.
When a rack is deleted in the device view, the plugged hardware components are moved
to the area of unplugged modules.
Procedure
Proceed as follows to delete a hardware component:
1. Select the hardware components you want to delete.
Network view: Select devices or network relevant hardware components in the graphic
view or in the network view.
Device view: In the graphic view or device overview, select racks or modules in racks
or in the area of unplugged components.
Topology view: Select devices or hardware components with Ethernet interfaces in the
graphic view or in the topology view.
Project tree: Select devices or individual hardware components from the tree structure.
2. Select "Delete" from the shortcut menu or press <Del>.
If the "Delete" menu item is unavailable, your selection contains at least one component
that cannot be deleted.
The selected hardware components are deleted.
Note
Deleting hardware components may result in inconsistencies in the project, such as violation
of slot rules. Inconsistencies are reported during the consistency check. Correct the
inconsistencies by taking appropriate action, for example, ensuring compliance with the slot
rules.
See also
Keyboard operation: Editing objects (Page 553)
Rules
Single objects as well as several objects can be copied at the same time.
Modules inserted in the rack and in the area of unplugged modules can be copied.
You can only copy devices and modules to free and valid slots in keeping with the slot rules.
Racks with a CPU inserted cannot be copied individually, but only as complete units along
with all inserted hardware components.
Procedure
Proceed as follows to copy a hardware component:
1. Select the hardware components you want to copy.
Device view: Select the module in a rack or put it in the area of unplugged modules.
Network view: Select the station or the relevant hardware component from the network
view.
Project tree: Select the station or module.
2. Select "Copy" from the shortcut menu or press <Ctrl+C>.
If the "Copy" menu item is unavailable, your selection contains at least one component that
cannot be copied.
3. Select the location at which the content of the clipboard is to be pasted.
Device view: Select a free slot in the rack or area of unplugged modules.
Network view: Select a station where you want to insert devices or modules or move
the mouse pointer to a free location in the network view to paste a copied station or a
hardware component relevant to the network view.
4. Select "Paste" from the shortcut menu or press <Ctrl+V>.
If the "Paste" menu item is unavailable, the clipboard is empty or contains at least one
component that cannot be pasted at this point.
The selected object is pasted at the chosen point.
Once you have selected a station where you want to insert a module in the network view, the
module is inserted in the first free and valid slot. If no free, valid slots are available, the object
is inserted in the area of unplugged modules.
Note
You can also copy a module from one device to another:
To do so, copy a module in the hardware and network editor, select a different device in the
network view or the drop down list of the device view and insert the module.
You can insert the copied object directly in a slot or place it in the area of unplugged modules
in the device view. If you add the copied object in the network view of a device or a station, it
will be inserted in the first available slot.
If there is no slot available for the object, it is automatically placed in the area of unplugged
modules (Page 563).
Note
You can use <Ctrl> and drag-and-drop to directly copy a selected hardware component.
See also
Keyboard operation: Editing objects (Page 553)
Rules
You can move devices and modules from the rack and the area for unplugged modules
taking the slot rules into consideration.
CPs can be moved in the network view. The CP is plugged in a free and valid slot in the
target device. If there are no free slots available, the CP to be inserted is moved to the area
for unplugged modules.
In the network view, CPU and slave head modules can be moved between the devices;
depending on CPU type also within the rack.
Note
Moved CPs are disconnected from their network but keep their network parameters and
address. If you reconnect the CP to the network and its address has been assigned, use a
dialog to assign a new unique address to the CP.
Procedure
Proceed as follows to move a hardware component:
1. Select the hardware component you want to move.
Device view: Select the module in a rack or put it in the area of unplugged modules.
Network view: Select the hardware component of relevance to the network view.
2. Select "Cut" from the shortcut menu or press <Ctrl+X>.
If the "Cut" menu item is unavailable, your selection contains at least one component that
cannot be cut.
3. Select the location to which the cut object is to be moved.
Device view: Select a free slot in the rack or area of unplugged modules.
Network view: Select a station where you want to insert devices or modules.
4. Select "Paste" from the shortcut menu or press <Ctrl+V>.
If the "Paste" menu item is unavailable, the clipboard is empty or contains at least one
component that cannot be pasted at this point.
The selected hardware component is moved to the target. If the hardware component being
moved is a networked object, it is disconnected from the network.
Note
You can use drag-and-drop to directly move a selected hardware component.
See also
Keyboard operation: Editing objects (Page 553)
Rules
You can only replace hardware components if they support module replacement and if the two
components are compatible.
Procedure
To replace one module with another, proceed as follows:
1. Select the module you want to replace.
2. Open the shortcut menu:
If the "Replace device" entry is enabled, the module can be replaced.
If the "Replace device" entry is disabled, a module cannot be replaced.
3. Click on "Replace device" in the shortcut menu. The "Replace device" dialog box appears.
4. Under "New device" in the tree structure, select the module with which you want to replace
your current module.
5. Click "OK".
The existing module is replaced by the new one.
As an alternative, you can take a module by dragging it from the hardware catalog to the module
you are replacing. If the module can be replaced by the selected module, this is indicated by
the mouse pointer symbol.
Requirement
You are in the device view.
Note
You can also edit properties and parameters in the network view. In the graphic network view,
you have access to the network-related hardware components and the station. You can access
modules and hardware components not displayed in the graphic network view using the table
network view.
Procedure
To change the properties and parameters of the hardware components, proceed as follows:
1. In the graphic view, select the CPU, module, rack or interface you want to edit.
2. Edit the settings for the selected object:
Use the table view to edit addresses and names, for example.
In the Inspector window additional setting possibilities are available in "Properties".
Note that modules can only be fully parameterized if they are assigned to a CPU. Therefore,
PROFIBUS or PROFINET interfaces modules must first be networked with the CPU or a
centrally inserted communication module so that they form a master system or IO system.
Only then is it possible, for example, to edit the addresses of the distributed components that
are inserted.
Selection of a module
Editing option for addresses in the device overview
Selection options in the inspector window
Editing option for addresses in the inspector window
See also
Inspector window (Page 547)
Introduction
The currently used input and output addresses can be displayed in the address overview in a
table form. The address overview can be found in the Inspector window under "Properties" of
the CPU.
PIP
The "PIP" table column shows the assignment of the address to the cyclic process image or
to a process image partition (PIP).
For S7-300/400:
"OB1-PA": The address is assigned to the cyclic process image. The operating system
updates this address automatically in each program cycle.
"PIP x": The address is assigned to the process image partition x (for example PIP 1, no
cyclic process image). The operating system updates this PIP when the assigned OB is
executed. If this PIP is not assigned to an OB, the operating system does not update this
PIP. You have the option to update the PIP yourself with the instructions "UPDAT_PI" and
"UPDAT_PO" (for S7-400 and some S7-300 CPUs).
For S7-1200:
"Automatic update": The address is assigned to the cyclic process image (PIP 0). The
operating system updates this address automatically in each program cycle.
"None": The address not assigned to any process image partition. You access this address
directly in the user program (direct I/O access, no process image).
"PIP x": The operating system updates this PIP when the assigned OB is executed. If this
PIP is not assigned to an OB, the operating system does not update this PIP. You have
the option to read inputs or write outputs in the user program via direct I/O access. The
instructions "UPDAT_PI", "UPDAT_PO", "SYNC_PI" and "SYNC_PO" are not supported
for S7-1200.
"PIP OB servo": The process image partition "PIP OB Servo" is not assigned to an
organization block (fixed setting for organization block: "---(None)" ). The operating system
does not update this PIP or any of the addresses contained in it: You access the addresses
directly in the user program (direct I/O access).
For S7-1500:
"Automatic update": The address is assigned to the cyclic process image (PIP 0). The
operating system updates this address automatically in each program cycle.
"None": The address not assigned to any process image partition. You access this address
directly in the user program (direct I/O access, no process image).
"PIP x" (PIP 1 to PIP 31): The operating system updates PIP x when the assigned OB is
executed. If this PIP is not assigned to an OB, the operating system does not update PIP
x. You have the option to update the PIP x in the user program with the instructions
"UPDAT_PI" and "UPDAT_PO". If PIP x is assigned to an isochronous mode interrupt OB
(OB 61 to OB 64), the operating system does not update PIP x. You have the option to
update PIP x in your user program with the instructions "SYNC_PI" and "SYNC_PO".
"PIP OB servo": The process image partition "PIP OB servo" is permanently assigned to
the OB "MC-Servo". STEP 7 generates this OB automatically when you create a technology
object in the Motion Control area. When the OB is executed, the PIP OB Servo is updated
isochronously. All drives and encoders used by Motion Control are assigned to this process
image partition.
See also
Specifying input and output addresses (Page 849)
Explanation of terms
The terms "Module version" and "Firmware version" are explained in more detail in the
following section.
Module version: The specific version of the configuration software from which the module
description stems.
Example: V11.0.0.0
Firmware version: The version of the firmware of the module whose parameters are
assigned offline
Example: V2.0
Requirement
You have created a device configuration.
You have installed an update or an optional package at a later date. As a result of this
installation, the module version of at least one module type was updated in the hardware
catalog, whereby the new version is incompatible with the previous version.
You have used such modules in your device configuration and want to use the modified or
added properties.
Procedure
Perform the following step for each affected module type.
1. Select the affected module in the device view.
2. In the Inspector window, go to "Properties > General > Catalog Information". Click the
"Update module version" button there.
3. In the query that then appears, specify whether you want to update the module version only
for the selected module or for all modules of this type in the current project.
Result
The selected modules are replaced by the same modules with updated module version in the
current project.
Function
You have the option of comparing the hardware components of two devices allowing you to
identify any differences. You can perform an offline/offline comparison for this purpose. The
devices to be compared can be from one project or different projects.
You can compare the central as well as the distributed I/O. The devices to be compared can
be assigned either automatically or manually. The automatic assignment of central I/O is based
on the slot number. With the distributed I/O, the automatic assignment can be made according
to the following criteria:
Assignment using the address/HW ID: The assignment is made using the addresses or IDs
of the devices. This criterion is suitable for comparing devices within a project.
Assignment using the name: The assignment is made based on the device names. This
criterion is suitable for comparing devices in different projects.
You can either specify the assignment yourself or let the system decide. In the latter case, the
system selects the assignment itself depending on the context.
See also
Basics of project data comparison (Page 402)
Overview of the compare editor (Page 405)
Making a device comparison (Page 580)
Procedure
Follow the steps below to compare devices:
1. Select a device in the project tree that allows offline/offline comparison.
2. Select the "Compare > Offline/offline" command in the shortcut menu.
The comparison editor opens and the selected device is displayed in the left area.
3. Open the "Hardware" tab.
4. Drag an additional device to the drop area in the right-hand pane.
All existing objects of the selected devices are displayed depending on the settings of the
comparison editor in the "Hardware" tab and an automatic comparison is made. You can
identify the status of the objects based on the symbols in the comparison editor.
5. If you want to change the matching criterion, click on the arrow of the "Available matching
criteria" button in the toolbar. Then, select the matching criterion you want to use.
6. If you want to make a manual comparison, click the button for switching between automatic
and manual comparison above the status area. Then select the objects you want to
compare.
The properties comparison is displayed. You can see the status of the objects based on
the symbols.
See also
Basics of device comparison (Page 579)
Overview of the compare editor (Page 405)
Network configuration
The following steps are necessary when configuring networks:
Connect devices to subnet
Specify the properties/parameters for each subnet
Specify the device properties for every networked module
Download configuration data to the devices to supply interfaces with the settings resulting
from the network configuration
Document the network configuration
For Open User Communication, creating and configuring a subnet is supported by the
assignment of connection parameters.
Networking options
In the project, you can create and network devices with components capable of
communication. The following basic options are available for networking the devices:
You link the interfaces of the components capable of communication with one another. A
new subnet is created suitable for the type of interface.
You connect the interface of the devices capable of communication with a new or existing
subnet.
You create an Open User Communication connection. When you assign parameters to the
connection for Open User Communication, a subnet is created automatically between the
communication partners.
You use the graphic connection configuration to configure connections; missing networks
are hereby recognized and are created either automatically or via dialog.
Due to the different tasks of the devices or the span of the plant, you may need to use several
subnets. These subnets are managed in a project.
Options
In the graphic network view, you have an overview of the subnets of the entire system in the
project. You can use the tabular network overview for additional support.
Depending on the starting situation, there are various ways of undertaking configuration to
network the interface for a component capable of communication. The procedures are
described in the following section:
Creating an individual subnet
Creating several subnets at one time
Connecting two target devices via a new subnet
Connecting devices to existing subnet
Selecting an existing subnet from a list
Automatic networking during the configuration of the connection;
See also: Auto-Hotspot
Possible starting situations are:
A suitable subnet is not yet available.
The subnet with which you want to connect the component already exists.
The selected interface is connected to a new subnet. Consistent address parameters are set
automatically for the interface.
The following schematic shows an interface with outgoing line connecting to a subnet:
4. Now move the pointer in networking mode onto the interface of the target device. You can
either keep the mouse button pressed or release it.
5. Now release the left mouse button or press it again (depending on your previous action).
Note
If you want to exit networking mode beforehand, press <Esc>, right-click or double-click in the
background of the network view.
A new subnet is created. The interfaces are now connected via the new subnet. Consistent
address parameters are set automatically for the interface.
The following schematic shows two networked devices:
5. Now release the left mouse button or press it again (depending on your previous action).
If you want to exit networking mode beforehand, press <Esc>, or right-click.
Result:
The interface and selected subnet are now connected. Consistent address parameters are set
automatically for the interface.
Meaning
The tabular network overview adds the following functions to the graphic network view:
You obtain detailed information on the structure and parameter settings of the devices.
Using the "Subnet" column, you can connect components capable of communication with
created subnets.
Requirements
The subnet with which you want to connect an interface has already been created.
If the subnet has not yet been created, change to the network view and make the settings
required for networking.
Introduction
Communication between networked devices requires the following parameters to be
configured:
Network parameters
Network parameters identify the network within the system configuration, for example, using
a name.
Interface parameters
Interface parameters define specific properties of a component capable of communication.
Addresses and transmission characteristics are set automatically and are consistent with
the network parameters.
Note
Network parameters and interface parameters are usually set during networking such that
communication can take place for numerous applications without the parameters having
to be changed.
Changing networkings
Introduction
You can cancel an interface's network connection or assign it to another subnet of the same
subnet type.
Consequences
Depending on the version, a distinction should be made between:
Canceling a network connection for an interface
The configured parameters for the interface remain unchanged.
Assigning a network connection to another subnet
If the addresses in the assigned subnet are not unique, in other words, they already exist,
they will be changed automatically to make them unique.
2. Select the "Disconnect from subnet" command in the shortcut menu of the interface.
The network connection is deleted, the interface addresses are, however, not changed.
Configured connections are retained; however these connections are marked red in the
connection table because they are not networked. Specified connections remain specified.
See also
Networking devices in the network view (Page 582)
Introduction
You can copy subnets as individual objects or copy them along with networked devices or
other networks.
For example, you can create complex configurations to be used more than once in different
variants within the project with no additional effort.
You will find other rules relating to the structure of a network in the manuals for setting up
automation systems.
PROFIBUS addresses
Requirements
The 121xC CPU is PROFIBUS compatible as of firmware version 2.0.
Note
PROFIBUS address "0"
Reserve PROFIBUS address "0" for a programming device that you will briefly connect up to
the PROFIBUS network at a later date for servicing.
See also
What you need to know about PROFIBUS bus parameters (Page 591)
Note
It may be possible for the bus parameters to be adjusted depending on the bus profile. If the
bus parameters cannot be adjusted, they are grayed out. The offline values of the bus
parameters are always shown even if you are online and linked to the target system.
The parameters shown apply to the entire PROFIBUS subnet and are briefly explained below.
If you want to create a customized bus profile, we recommend the following settings:
Minimum target rotation time (Ttr) = 5000 x HSA (highest PROFIBUS address)
Minimum response monitoring (watchdog) = 6250 x HSA
Recalculating
You can use the "Recalculate" button to recalculate the parameters.
See also
PROFIBUS addresses (Page 590)
Description of the bus parameters (Page 592)
See also
What you need to know about PROFIBUS bus parameters (Page 591)
Introduction
Depending on the device types connected and protocols used on the PROFIBUS, different
profiles are available. The profiles differ in terms of the setting options and calculation of bus
parameters. The profiles are explained below.
Meaning of profiles
Profile Meaning
DP Select the "DP" bus profile when the only devices connected to the PROFIBUS
subnet are those which satisfy the requirements of standard EN 50170 Volume
2/3, Part 8-2 PROFIBUS. The bus parameter setting is optimized on these de
vices.
This includes devices with DP master and DP slave interfaces of the SIMATIC
S7 and distributed I/Os of other manufacturers.
Standard Compared to the "DP" profile, the "Standard" profile also offers scope for devi
ces of another project or devices which have not been configured here to be
taken into account when calculating the bus parameters. The bus parameters
are then calculated following a simple, non-optimized algorithm.
Universal (DP/FMS) Select the "Universal (DP/FMS)" bus profile when individual devices on the
PROFIBUS subnet use the PROFIBUS-FMS service.
This includes the following devices for example:
CP 343-5 (SIMATIC S7)
PROFIBUS-FMS devices of other manufacturers
As with the "Standard" profile, this profile allows you to take other devices into
account when calculating the bus parameters.
Customized The PROFIBUS subnet will only function without problem if the parameters for
the bus profile are matched to one another. Select the "Customized" profile
when none of the usual profiles "match" a PROFIBUS device and you need to
adapt the bus parameters to your special structure. Information on this can be
found in the documentation for the PROFIBUS device.
You should only change the default values if you are familiar with how to con
figure the bus profile for PROFIBUS.
Not all combinations that can be theoretically set can be used even with this
bus profile. The PROFIBUS standard specifies several parameter limits that
depend on other parameters. For example, a responder must not respond (Min
Tsdr) before the initiator can receive the message frame (Trdy). These standard
specifications are also checked in the "Customized" profile.
Tip: The bus parameters last valid on the PROFIBUS subnet are always auto
matically set as customized. For example, if the "DP" bus profile was valid for
the subnet, then the bus parameters for "DP" are set in the "Customized" bus
profile. The parameters can be modified on this basis.
The monitoring times are not automatically recalculated so that you do not put
at risk the consistency of set values, for example with configurations in other
configuration tools without realizing that you have done so.
You can also have the Ttr monitoring times and target rotation time calculated
on the basis of parameters you have set: Click here on the "Recalculate" button.
Note
Both mono-master mode and multi-master mode are possible with all PROFIBUS profiles.
IP address
The IP parameters are visible if the module capable of communication supports the TCP/IP
protocol. This is usually the case for all Ethernet modules.
The IP address consists of 4 decimal figures in the range of 0 to 255. The decimal figures are
separated from one another by a dot.
Example: 140.80.0.2
The IP address consists of:
Address of IP subnet
Address of the device (generally also called host or network node)
Subnet mask
The subnet mask splits these two addresses. It determines which part of the IP address
addresses the network and which part of the IP address addresses the device.
The set bits of the subnet mask determine the network part of the IP address.
Example:
Subnet mask: 255.255.0.0 = 11111111.11111111.00000000.00000000
In the example given for the above IP address, the subnet mask shown here has the following
meaning:
The first 2 bytes of the IP address identify the subnet - i.e. 140.80. The last two bytes address
the device, i.e. 0.2.
It is generally true that:
The network address results from AND logic operation of the IP address and subnet mask.
The device address results from the AND NOT logic operation of the IP address and subnet
mask.
Note
Range of values for the first decimal point
A value of between 224 and 255 is also possible for the first decimal number of the IP address
(address class D, etc). This is not recommended, however, because there is no address check
for these values.
Result:
All devices with addresses between 129.80.001.xxx and 129.80.127.xxx are on one IP subnet,
all devices with addresses between 129.80.128.xxx and 129.80.255.xxx are on another IP
subnet.
Router
The task of the routers is to connect the IP subnets. If an IP datagram is to be sent to another
network, it first has to be conveyed to a router. To make this possible, you have to enter the
address of the router for each device in the IP subnet.
The IP address of a device in the subnet and the IP address of the router can only differ at the
points at which there is a "0" in the subnet mask.
See also
Settings for interconnecting Ethernet devices (Page 598)
Topology view:
In the topology view, you specify the physical interconnection of Ethernet ports.
You specifically determine which Ethernet port of a device is to be connected with a specific
Ethernet port of another device by means of an Ethernet cable (preset topology).
Example:
You specify that port 1 of the PROFINET interface of the CPU is to be connected to port 2 of
the PROFINET interface of device A by means of an Ethernet cable.
You also specify the interface for devices with several PROFINET interfaces.
Example:
You specify that port 1 of PROFINET interface X2 of the CPU is to be connected to port 2 of
the PROFINET interface of device A by means of an Ethernet cable.
The Ethernet ports can be interconnected in a table or graphically.
Network view:
In the network view, you specify which devices are to be connected with each other via an
Ethernet subnet. You do not specify the Ethernet ports by which the devices are interconnected
with each other (that is the task of the port interconnection).
The port interconnection has effects on the network view:
When you interconnect Ethernet ports of devices with each other in the topology view, STEP
7 connects the interconnected PROFINET interfaces of the devices in the network view with
an Ethernet subnet (green line).
However, the course of the green line does not reflect the actual cable routing. You specify
the actual wiring in the topology view.
An Ethernet subnet always has a name and an S7 subnet ID. You can set these two values
in the subnet properties.
Response of STEP 7:
When you interconnect the ports of two devices that are not linked in the topology view, STEP
7 links these devices with the default subnet.
Example:
Step 1: Create a subnet in the network view at PLC_4, "Connect devices that are not linked
with this subnet in case of port connection" option is enabled.
Result: All PLCs are now connected to the same default subnet (network view).
Example:
Step 1: Create a subnet in the network view at PLC_4, "Connect devices that are not linked
with this subnet in case of port connection" option is disabled.
Result: PLC_1 and PLC_2 are connected to a new subnet (network view).
Example: Manual conversion of the IP subnet part for devices with multiple PROFINET
interfaces in a subnet
The IP address is: "192.168.0.1".
The subnet mask is "255.255.255.0".
The first three numbers "192.168.0" form the IP subnet part of the IP address "192.168.0.1".
Change the IP subnet part, for example, to "192.168.1"
See also
Interconnecting ports in the graphic view (Page 670)
Interconnecting ports in the table view (Page 671)
Configuring Industrial Ethernet (Page 596)
S7 connection
Definition
A connection defines a logical assignment of two communication partners in order to undertake
communication services. A connection defines the following:
Communication partner involved
Type of connection (for example, S7 connection)
Special properties (e.g., whether a connection is established permanently or whether it is
established and terminated dynamically in the user program, and whether status messages
are to be sent)
Connection path
Introduction
Each connection requires connection resources for the end point and/or transition point on the
devices involved. The number of connection resources is device-specific.
If all the connection resources of a communication partner are assigned, no new connections
can be established. This situation is apparent when a newly created connection in the
connection table has a red background. The configuration is then inconsistent and cannot be
compiled.
S7 connections
In the case of S7 connections via the PN interface, one connection resource per S7 connection
is assigned for the endpoint for the S7-1200 CPU. One connection resource is also required
for the connection partner.
You can find an overview of available and assigned connection resources for selected S7-1200
CPU in the Inspector window at "Properties > Connection Resources"
Benefits
The information shown in these views are always up-to-date in terms of the current user
actions. This means:
The connection table displays all connections created.
If you have selected a connection in the connection table:
When connection mode is enabled, the connection path is highlighted in the network
view.
The "Properties" tab in the Inspector window displays the parameters of this connection.
Specifying a connection
If both partners for the connection type selected are networked on the same network, use the
graphic or interactive selection of both communication partners to create a fully specified
connection.
This connection is entered automatically in the connection table of the S7-1200 CPU. A local
connection name is assigned for this connection.
The following schematic shows a configured connection with a networked device:
This step activates the connection mode: You can now select the connection type you want.
You will see this from the following:
The devices that can be used for the connection type selected in your project are color-
highlighted in the network view.
2. Hold down the mouse button and drag the mouse pointer from the device from which the
connection will originate to the device at which the connection ends.
3. Release the mouse button over the destination device to create the connection between
the two devices.
Result
A specified connection is created.
The connection path is highlighted.
The connection is entered in the connection table.
Procedure
Proceed as follows to interactively create a connection:
1. Select the "Add new connection" command in the shortcut menu of a connection partner
for which you want to create a connection.
The "Create new connection" dialog appears.
2. Select the partner endpoint.
In the right pane of the dialog, a possible connection path fitting the selected endpoint is
displayed, if available. Incomplete paths, for example, for a non-specified CPU, are marked
by an exclamation mark on a red background.
3. To accept the configured connection and to configure additional connections to other
endpoints, click "Add".
To close the dialog, click "OK".
2. Select the S7-CPU for which you want to display the connection partners in the network
view and then select the "Highlight connection partners" command in the shortcut menu.
3. Select "All connection partners" in the following menu.
The local device and the CPUs of the target devices are selected. The local connection
partner shows an arrow pointing right and the remote connection partners show an arrow
pointing left.
4. To open a list with information on the target devices, click the arrow of the local device.
This additional function is useful in complex network configurations in which some devices
are not visible.
Note
You can display one of the connection partners which cannot be seen in the current display
range of the network view. Click on the communication partner in the list that appears. Result:
The display is moved such that the connection partner becomes visible.
If you want to store the layout, width and visibility of the table columns, click on the "Remember
layout" function in the top right-hand of the network view.
Symbol Meaning
Remember layout
Saves the current table view. The layout, width and visibility of columns in the table view is
stored.
Deleting connections
You can delete configured connections using the network view or the connection table.
In the network view you can delete one highlighted connection per action. In the connection
table you can delete one or several connections per action.
Procedure
To delete a connection, follow these steps:
1. Select the connection to be deleted:
In the network view: Select the connection to be deleted.
In the connection table: Select the rows of the connections to be deleted (multiple
selection possible).
2. Open the shortcut menu with a right mouse click.
3. Select the "Delete" command.
Result
The selected connection is removed completely.
Copying connections
Introduction
Connections are not copied singly but always in context along with the project or the device.
You can copy:
Entire projects
One or more devices within a project or from one project to another
Copying a project
When you copy a project all configured connections will also be copied. No settings whatsoever
are required for the copied connections because the connections remain consistent.
Copying devices
If you copy devices for which connections have been configured, the connections are copied
as well. To complete the connection path, you must still finalize the networking.
An S7-1200 CPU with a V.10 firmware is merely a server for connections and has no
connection configuration itself. Consequently, no connections are copied along with it when
an S7-1200 CPU with a V1.0 firmware is copied.
Remedies
To assign a closed connection path to an existing open connection path, expand the device
configuration in such a way that the interfaces required for the connection type are available
for both partners. At "Properties > General > Interface" in the Inspector window, you can use
the "Find connection path" button to create a connection to an existing partner.
Local ID
The local ID of the module from which the connection is viewed is displayed here (local partner).
You can change the local ID. You may need to do this if you have already programmed
communication function blocks, and you want to use the local ID specified in those function
blocks for the connection.
Address details
Displaying address details of the S7 connection. With an unspecified partner, the values for
the rack and slot can be changed. All other values are obtained from the current configuration
and cannot be changed.
Meaning
The address details show the end points of the connection and can localize these via the
specification of rack and slot.
When a connection is established, the connection-specific resources of a module are assigned
permanently to this connection. This assignment requires that the connection resource can be
addressed. The TSAP (Transport Service Access Point) is, as it were, the address of the
resource that is formed with the help of the connection resource or, in the case of S7-1200
CPUs (firmware V2.0 or higher) with the SIMATIC-ACC (SIMATIC Application Controlled
Communication).
Introduction
S7-1200 CPUs with a firmware version of V2.0 or higher support one-way and two-way S7
connections via CM/CP interfaces. This increases the number of Ethernet ports and networks
that can be used for S7 connections. Even though the connection is then guided via the CM/
CP, the associated S7-1200 CPU is an end point of the connection. The other end point can
be any other device in the case of two-way connections. This other device must also support
S7 connections.
Note
Data transfer > 240 byte transfer is supported by the current CPs.
CPs with an older product version support the transfer of data with a data length of up to 240
bytes.
For more information, refer to the details provided in the Ethernet CP equipment manual.
HMI connection
Definition
A connection defines a logical assignment of two communication partners in order to undertake
communication services. A connection defines the following:
Communication partner involved
Type of connection (e.g., HMI connection)
Special properties (e.g., whether a connection is established permanently or whether it is
established and terminated dynamically in the user program, and whether status messages
are to be sent)
Connection path
Introduction
Each connection requires connection resources for the end point and/or transition point on the
devices involved. The number of connection resources is device-specific.
If all the connection resources of a communication partner are assigned, no new connections
can be established. This situation is apparent when a newly created connection in the
connection table has a red background. The configuration is then inconsistent and cannot be
compiled.
HMI connections
For HMI connections via the integrated PN interface, one connection resource for the endpoint
per HMI connection is occupied for the HMI device.
One connection resource is also required for the connection partner (PLC).
Benefits
The information shown in these views are always up-to-date in terms of the current user
actions. This means:
The connection table displays all connections created.
If you have selected a connection in the connection table:
You will graphically see the connection path in the network view.
The "Properties" tab in the Inspector window displays the parameters of this connection.
Specifying a connection
If both partners for the connection type selected are networked on the same network, use the
graphic or interactive selection of both communication partners to create a fully specified
connection.
This connection is entered automatically into the connection table of the HMI device. A local
connection name is assigned for this connection.
The following schematic shows a configured connection with a networked device:
The connection mode for the connection type you have selected is then activated.
You will see this from the following:
The devices that can be used for the connection type selected in your project are color-
highlighted in the network view.
2. Hold down the mouse button and drag the mouse pointer from the device from which the
connection will originate to the device at which the connection ends.
3. Release the mouse button over the destination device to create the connection between
the two devices.
Result
A specified connection is created.
The connection path is highlighted.
The connection is entered in the connection table.
Procedure
Proceed as follows to interactively create a connection:
1. Select the "Create new connection" command in the shortcut menu of a connection partner
for which you want to create a connection.
The "Create new connection" dialog is opened.
2. Select the partner endpoint.
In the right pane of the dialog, a possible connection path fitting the selected endpoint is
displayed, if available. Incomplete paths, for example, for a non-specified CPU, are marked
by an exclamation mark on a red background.
3. To close the dialog, click "OK".
To accept the configured connection and to configure additional connections to other
endpoints, click "Apply".
2. Select the "Highlight connection partners" command in the shortcut menu for the HMI device
whose connection partners you want to display in the network view.
3. Select "All connection partners" in the following menu.
The local device and the CPUs of the target devices are selected. The local connection
partner shows an arrow pointing right and the remote connection partners show an arrow
pointing left.
4. To open a list with information on the target devices, click the arrow of the local device.
This additional function is useful in complex network configurations in which some devices
are not visible.
Note
You can display one of the connection partners which cannot be seen in the current display
range of the network view. Click on the communication partner in the list that appears. Result:
The display is moved such that the connection partner becomes visible.
See also
Creating a new connection graphically (Page 619)
Deleting connections
You can delete configured connections using the network view or the connection table.
In the network view you can delete one highlighted connection per action. In the connection
table you can delete one or several connections per action.
Procedure
To delete a connection, follow these steps:
1. Select the connection to be deleted:
In the network view: Select the connection to be deleted.
In the connection table: Select the rows of the connections to be deleted (multiple
selection possible).
2. Open the shortcut menu with a right mouse click.
3. Select the "Delete" command.
Result
The selected connection is removed completely.
Copying connections
Introduction
Connections are not copied singly but always in context along with the project or the device.
You can copy:
Entire projects
One or more devices within a project or from one project to another
Copying a project
When you copy a project all configured connections will also be copied. No settings whatsoever
are required for the copied connections because the connections remain consistent.
Copying devices
If you copy devices for which connections have been configured (HMI devices), the
connections are copied as well. To complete the connection path, you must still finalize the
networking.
An S7-1200 CPU with a V.10 firmware is only a server for connections and has no connection
configuration itself. Consequently, no connections are copied along with it when an S7-1200
CPU with a V1.0 firmware is copied.
Remedies
If the connection cannot be repaired by opening the connection properties, changing them or
undoing them in the configuration, then it may be necessary to delete the connection and re-
create it.
Address details
Displaying address details of the HMI connection. With an unspecified partner, the values for
the rack and slot can be changed. All other values are obtained from the current configuration
and cannot be changed.
Miscellaneous
Display of the access points for the online connection between HMI device and connection
partner.
Introduction
Open User Communication (OUC) is the name given to a program-controlled communication
process for communicating via the integrated PN/IE interface of S7-1200/1500 and S7-300/400
CPUs. Different connection types are available for this communication process.
The main feature of Open User Communication is its high degree of flexibility in terms of the
data structures transferred. This allows open data exchange with any communicating devices
providing they support the connection types available here. Since this communication is
controlled solely by instructions in the user program, event-driven connection establishment
and termination is possible. Connections can also be modified by the user program during
runtime.
For CPUs with an integrated PN/IE interface, the TCP, UDP, and ISO-on-TCP connection
types are available for Open User Communication. The communication partners can be two
SIMATIC PLCs or a SIMATIC PLC and a suitable third-party device.
Connection establishment
For Open User Communication, instructions for establishing and terminating the connection
must exist for both communication partners. One communication partner sends its data using
TSEND, TUSEND or TSEND_C while the other communication partner receives the data using
TRCV, TURCV or TRCV_C.
One of the communication partners starts the connection establishment as the active partner.
The other communication partner reacts by starting its connection establishment as the
passive partner. If both communication partners have initiated their connection establishment,
the communication connection is fully established.
Connection configuration
You can specify establishment of the connection via a connection description DB with the
TCON_Param, TCON_IP_v4, or TCON_IP_RFC structure by means of parameter assignment
as follows:
Manually create, assign parameters and write directly to the instruction.
Supported by connection configuration.
Connection configuration supports the establishment of the connection and should, therefore,
be given preference over the other methods.
You specify the following in the connection configuration:
Connection partner
Connection type
Connection ID
Connection description DB
Address details according to selected connection type
In addition, you specify here which communication partner activates the connection
establishment and which partner establishes a connection passively in response to a request
from its communication partner.
See also
Principle of operation of connection-oriented protocols (Page 638)
Connection configuration
Introduction
You can find the connection configuration in the inspector window of the program editor if you
want to program Open User Communication with the communication instructions TSEND_C,
TRCV_C or TCON.
Connection configuration supports the flexible functionality of communication programming:
The parameters entered for the connection configuration are stored in an automatically
generated global DB derived from the TCON_Param, TCON_IP_v4 or TCON_IP_RFC
structure. You can modify the connection parameters in this connection description DB.
"Configuration" tab
Enter the desired connection parameters in the "Configuration" tab. The area navigation of the
"Configuration" tab includes the "Connection parameters" group. This group contains the
connection configuration. Here, you can enter the parameters for the connections and the
address details with system support. Here, you also connect the CONNECT (TCON,
TSEND_C, TRCV_C) or ID (TCON, TSEND, TRCV, TUSEND, TURCV) block parameters of
the selected communication instructions.
When all the required parameters are assigned, a check mark is set in front of the "Connection
parameters" group in the area navigation.
Note
The connection parameter assignment does not check whether the connection IDs and port
numbers (TCP, UDP) or TSAPs (ISO-on-TCP, ISO) are unique. When you configure Open
User Communication, you should, therefore, make sure that the parameter settings are unique
within a device.
See also
Connection parameters with structure according to TCON_Param (Page 640)
Connection parameters with structure according to TCON_IP_v4 (Page 643)
Connection parameters with structure according to TCON_IP_RFC (Page 644)
Overview
The following table shows the general connection parameters:
Parameter Description
End point The names of the local end point and the partner end point are shown.
The local end point is the CPU for which TCON, TSEND_C or TRCV_C is programmed. The
local end point is, therefore, always known.
The partner end point is selected from the drop-down list. The drop-down list shows all avail
able possible connection partners including unspecified connection partners for devices
whose data is unknown in the project.
For S7-1500, broadcast can be selected as the partner end point (message to all subnet
devices). For S7-1500 CPs/CMs, multicast can also be selected as the partner end point
(message to a group within the subnet). The connection type is converted automatically to
UDP in this case.
As long as no connection partner is set, all other parameters in the mask are disabled.
Interface The interface of the local end point is displayed. If multiple interfaces are available, e.g., by
means of CPs or CMs, the interface can be selected from the drop-down list. To display or
select the partner interface, a specified partner end point must first be selected.
Subnet The subnet of the local end point is displayed, provided this exists. The partner subnet is
displayed only after the partner end point has been selected.
If at least one of the two connection partners is not connected with a subnet, the two connec
tion partners are connected with each other.
A connection between partners in different subnets is only possible with IP routing. The IP
routing settings can be edited in the properties of the relevant Ethernet interfaces.
Address The IP address or the PROFIBUS address of the local end point is displayed, depending on
the subnet used. The corresponding address of the partner is displayed only after the partner
end point has been selected.
If you have selected an unspecified connection partner, the input box is empty and has a red
background. In this case, you must specify a valid IP address/PROFIBUS address. The ad
dress type (IP or PROFIBUS) depends on the type of subnet that is set for the local partner.
Broadcast (S7-1500 only): If "Broadcast" is set as the partner end point, a non-editable IP
address with host address 255 is entered automatically for the connection partner. The net
work allocation corresponds to that of the sender. Example: Local IP address 192.168.0.1,
partner IP address 192.168.0.255.
Multicast (S7-1500 CPs/CMs only): If "Multicast" is set as the partner end point, the editable
IP address 224.0.1.0 is entered automatically for the connection partner.
Connection type Select the connection type you want to use from the "Connection type" drop-down list:
TCP
ISO-on-TCP
UDP
With the S7-1500, you can also select the ISO connection type at the configuration type of
the configured connections for TSEND_C and TRCV_C or TCON.
The connection types can only be used for partners that support the corresponding protocol.
Parameter Description
Connection type With the S7-1500, two different configuration types can be set for TSEND_C and TRCV_C:
(for S7-1500 only) Programmed connections use program blocks for the connection description.
Configured connections are saved for the configuration and are only created after
download to the device in runtime. You can also use the configured connection to select
the connection type ISO.
The specified configuration method depends on the selected connection type. If both config
uration methods are possible, the programmed connection is preset.
The same configuration method must be set for both connection partners.
Connection ID Enter the connection ID in the input box. You can change the connection ID in the input boxes
or enter it directly in TCON.
Ensure that the connection ID assigned is unique within the device.
Connection data The names of the connection description DBs for the connection description structured ac
cording to TCON_IP_v4, TCON_IP_RFC or TCON_Param are displayed in the drop-down
lists.
The drop-down list is still empty after selection of a connection partner. You can use the drop-
down list to generate a new data block or to select an existing data block. This data block is
filled automatically with the values from the connection configuration. The name of the selec
ted data blocks is entered automatically in the CONNECT block parameter of the selected
TSEND_C, TRCV_C or TCON instruction.
From the drop-down list, you can also reference another valid data block. If a DB is referenced
using the CONNECT input parameter of the TSEND_C, TRCV_C or TCON extended instruc
tions and this does not correspond to the structure of a TCON_IP_v4, TCON_IP_RFC or
TCON_Param, the drop-down list is shown with no content on a red background.
Connection name If the connection type of the configured connections is set for TSEND_C and TRCV_C for the
(for S7-1500 only) S7-1500, the "Connection data" parameter is replaced with the "Connection name" parame
ter. The name of the configured connection serves here as the connection data.
The drop-down list is still empty after selection of a connection partner. You can use the drop-
down list to generate a new connection or to select an existing connection. If needed, a data
block is created and automatically filled with the values from the connection configuration.
The name of the data block is entered automatically in the CONNECT block parameter of the
TSEND_C or TRCV_C instruction.
You can also reference an existing connection from the drop-down list.
Active connection establish Use the "Active connection establishment" check box to specify the active partner of the Open
ment User Communication (only with TCP and ISO-on-TCP).
Port Address component for a TCP or UDP connection. The default after creating a new TCP
(only with TCP and UDP) connection is 2000.
You can change the port numbers.
The port numbers must be unique on the device!
TSAP Address component for an ISO-on-TCP connection. The default value after creating a new
(ISO-on-TCP only) ISO-on-TCP connection is E0.01.49.53.4F.6F.6E.54.43.50.2D.31 (S7-1200/1500) or
E0.02.49.53.4F.6F.6E.54.43.50.2D.31 (S7-300/400).
You can enter the TSAP-ID with an extension or as an ASCII TSAP.
The TSAPs must be unique on the device!
Note
UDP connection for the "Broadcast" setting (S7-300/400/1200)
The parameters of the UDP connection for the "Broadcast" setting for the partner end point
are stored in a connection description DB TCON_IP_v4 : With respect to UDP communication
with TCON and TUSEND/TURCV , the TCON_IP_v4 is not filled with any partner parameters
(value=0). However, the partner address and the partner port are necessary for sending the
data and must be entered by the user in the TADDR_Param . The TADDR_Param for UDP
communication is referenced by the TUSEND-/TURCV block parameter ADDR . The values
for both parameters can be taken from the connection configuration.
The configuration must also be adapted for the other recipients of UDP communication. In
order to receive broadcast frames, the partner port must be configured at the receiver end.
For this purpose, the RemotePort parameter of the TADDR_Param must be filled at the ADDR
block.
Note
Communication via TSEND_C and TRCV_C (S7-1500)
When TSEND_C and TRCV_C are used, a separate TSEND_C and TRCV_C block pair with
a configured connection is required for each communication. Multiple TSEND_C and TRCV_C
block pairs cannot simultaneously use the same configured connection for communication.
Additional connections for a TSEND_C or TRCV_C instruction can be created in the inspector
window for the connection parameters using the appropriate button next to the connection data.
The connections configured using TSEND_C and TRCV_C are displayed in a connection table
in the inspector window under "Properties > Configuration > Overview of configured
connections" when the TSEND_C or TRCV_C block is selected.
See also
Assignment of port numbers (Page 645)
TSAP structure (Page 647)
Examples of TSAP assignment (Page 650)
Ability to read back connection description parameters (Page 646)
Creating and assigning parameters to connections (Page 633)
Connection parameters with structure according to TCON_Param (Page 640)
Connection parameters with structure according to TCON_IP_v4 (Page 643)
Connection parameters with structure according to TCON_IP_RFC (Page 644)
Requirement
Your project must contain at least one S7-CPU.
The program editor is open.
A network is available.
Procedure
To insert the extended instructions for Open User Communication, proceed as follows:
1. Open the task card, pane and folder "Instructions > Communication > Open User
Communication".
2. Drag one of the following instructions to a network:
TSEND_C
TRCV_C
TCON
The "Call options" dialog opens.
3. Edit the properties of the instance DB in the "Call properties" dialog. You have the following
options:
Change the default name.
Select the "Manual" check box to assign your own number.
You can also execute the DB as a multi-instance for function blocks.
4. Click "OK" to complete your entry.
Result
A corresponding instance DB is created at a single instance for the inserted instruction
TSEND_C, TRCV_C or TCON. In the case of a multi-instance, the instance DB of the function
block is used.
With TSEND_C, TRCV_C or TCON selected, you will see the "Configuration" tab under
"Properties" in the Inspector window. The "Connection parameters" group in area navigation
contains the connection parameter assignment that you can now make.
See also
Creating and assigning parameters to connections (Page 633)
Requirement
A CPU exists with a TCON, TSEND_C or TRCV_C communication instruction.
Procedure
To create a connection for Open User Communication, follow these steps:
1. Select a TCON, TSEND_C or TRCV_C block of Open User Communication in the program
editor.
2. Open the "Properties > Configuration" tab in the inspector window.
3. Select the "Connection parameters" group. Until you select a connection partner, only the
empty drop-down list for the partner end point is enabled. All other input options are
disabled.
The connection parameters already known are displayed:
Name of the local end point
Interface of the local end point
IP address (for Ethernet subnet) or PROFIBUS address (for PROFIBUS subnet) of the
local end point.
4. In the drop-down list box of the partner end point, select a connection partner. You can
select an unspecified device or a CPU in the project as the communication partner. Certain
connection parameters are then entered automatically.
The following parameters are set:
Name of the partner end point
Interface of the partner end point
IP address (for Ethernet subnet) or PROFIBUS address (for PROFIBUS subnet) of the
partner end point.
If the connection partners are networked, the name of the subnet is displayed.
5. With the S7-1500, in the "Configuration type" drop-down list, you choose between using
program blocks or configured connections.
6. Select an existing connection description DB in the "Connection data" drop-down list or for
configured connections select an existing connection under "Connection name". You can
also create a new connection description DB or a new configured connection. Later, you
can still select other connection description DBs or configured connections or change the
names of the connection description DBs in order to create new data blocks:
You can also see the selected data block at the interconnection of the CONNECT input
parameter of the selected TCON, TSEND_C or TRCV_C instruction.
If you have already specified a connection description DB for the connection partner
using the CONNECT parameter of the TCON, TSEND_C or TRCV_C instruction, you
can either use this DB or create a new DB.
If you edit the name of the displayed data block in the drop-down list, a new data block
with the changed name but with the same structure and content is generated and used
for the connection.
Changed names of a data block must be unique in the context of the communication
partner.
A connection description DB must have the structure TCON_Param, TCON_IP_v4 or
TCON_IP_RFC, depending on CPU type and connection.
A data block cannot be selected for an unspecified partner.
Additional values are determined and entered after the selection or creation of the
connection description DB or configured connection.
The following is valid for specified connection partners:
ISO-on-TCP connection type
Connection ID with default of 1
Active connection establishment by local partner
TSAP ID
for S7-1200/1500: E0.01.49.53.4F.6F.6E.54.43.50.2D.31
for S7-300/400: E0.02.49.53.4F.6F.6E.54.43.50.2D.31
The following is valid for unspecified connection partners:
TCP connection type
Partner port 2000
The following applies for a configured connection with a specified connection partner:
TCP connection type
Connection ID with default of 257
Active connection establishment by local partner
Partner port 2000
The following applies for a configured connection with an unspecified connection partner:
TCP connection type
Local port 2000
8. Select the desired connection type in the relevant drop-down list. Default values are set for
the address details depending on the connection type. You can choose between the
following:
TCP
ISO-on-TCP
UDP
For configured connections with S7-1500, ISO applies in addition.
9. You can edit the input boxes in the address details. Depending on the selected protocol,
you can edit the ports (for TCP and UDP) or the TSAPs (for ISO-on-TCP and ISO).
10.Use the "Active connection establishment" check box to set the connection establishment
characteristics for TCP, ISO and ISO-on-TCP. You can decide which communication
partner establishes the connection actively.
Changed values are checked immediately for input errors by the connection configuration and
entered in the data block for the connection description.
Note
Open User Communication between two communication partners can only work when the
program section for the partner end point has been downloaded to the hardware. To achieve
fully functional communication, make sure that you load not only the connection description of
the local CPU on the device but also that of the partner CPU as well.
See also
Description of the connection parameters (Page 630)
Starting connection parameter assignment (Page 632)
TSAP structure (Page 647)
Assignment of port numbers (Page 645)
Connection parameters with structure according to TCON_Param (Page 640)
Connection parameters with structure according to TCON_IP_v4 (Page 643)
Connection parameters with structure according to TCON_IP_RFC (Page 644)
Deleting connections
Introduction
The data of a created connection for Open User Communication is stored in a connection
description DB. You can delete the connection by deleting the data block containing the
connection description.
Requirement
You have created an Open User Communication connection.
Procedure
To delete a connection, follow these steps:
1. Select a communication partner for Open User Communication in the project tree.
2. Open the "Program blocks > System blocks > Program resources" folder below the selected
communication partner.
3. Select the "Delete" command from the shortcut menu of the data block with the connection
parameter assignment.
Note
If you are not certain which block to delete, open the extended instruction TCON, TSEND_C
or TRCV_C. You will find the name of the data block as the CONNECT input parameter or in
the connection parameter assignment as the "Connection data" parameter.
If you only delete the instance DBs of the extended instructions TCON, TSEND_C or TRCV_C,
the assigned connections are not deleted as well.
Note
If the connection DB is still being used by other blocks of the extended instructions, then the
corresponding calls, their instance DBs, and, if present, the combination blocks TSEND_C and
TRCV_C must also be deleted from the block folder, provided they are not used elsewhere.
This action prevents the program from being inconsistent.
Result
You have deleted the connection.
Note
Insert an extended instruction TCON, TSEND_C, or TRCV_C again in order to reference an
existing connection description with the TCON_Param, TCON_IP_v4, or TCON_IP_RFC
structure again via the "Connection data" parameter.
Introduction
Connection-oriented protocols establish a logical connection to the communication partner
before data transmission is started. After the data transmission is complete, they then terminate
the connection, if necessary. Connection-oriented protocols are used especially when reliable
data transmission is important. Several logical connections can exist over one physical line.
Open User Communication supports the following connection types:
TCP
ISO-on-TCP
ISO (S7-1500 only)
UDP
Both communication partners must support the same connection type for a connection. If a
communication partner does not support a connection of the type ISO-on-TCP, for example,
use the connection type TCP instead, if it is supported.
For communication partners that cannot be configured in the TIA Portal, such as third-party
devices or PCs, enter "unspecified" for the partner end point during connection parameter
assignment. The required connection type for unspecified devices is listed in the respective
documentation.
Note
Connections with ISO
For S7-1500 CPUs, configured connections of the type ISO can be created using the
TSEND_C and TRCV_C instructions. For additional information on these connection types,
refer to the general connection descriptions.
Characteristics of TCP
TCP is a streaming protocol in which the length of the data stream is transmitted to the receiver
so that it can receive the data stream as individual TCP segments. This means no information
about the start and end of a message is transmitted during data transmission via a TCP
connection. The receiver cannot determine by the received segments of the data stream where
one message in the data stream ends and the next one begins. It is therefore recommended
that the number bytes to be received (parameter LEN, instruction TRCV/TRCV_C) be assigned
the same value as the number of bytes to be sent (parameter LEN, instruction TSEND/
TSEND_C).
If the length of the sent data and the length of the expected data do not match, the following
occurs:
Length of data to be received (parameter LEN, instruction TRCV/TRCV_C) greater than
length of data to be sent (parameter LEN, instruction TSEND/TSEND_C):
TRCV/TRCV_C copies the received data to the specified receive area (parameter DATA)
only after the assigned length is reached. When the assigned length is reached, data of
the subsequent job are already being received. As a result, the receive area contains data
from two different send jobs. If you do not know the exact length of the first message, you
are unable to recognize the end of the first message and the start of the second message.
Length of data to be received (parameter LEN, instruction TRCV/TRCV_C) less than length
of data to be sent (parameter LEN, instruction TSEND/TSEND_C):
TRCV/TRCV_C copies the number of bytes you specified in the LEN parameter to the
receive data area (parameter DATA). Then, it sets the NDR status parameter to TRUE (job
completed successfully) and assigns RCVD_LEN (amount of data actually received) the
value of LEN. With each subsequent call, you receive a further block of the sent data.
A receive area with fixed data length can be specified in the TRCV/TRCV_C instructions with
the protocol version of the Ad-hoc mode.
Characteristics of ISO-on-TCP
ISO-on-TCP is a message-oriented protocol which detects the end of the message at the
receiver end and indicates the data that belongs to the message to the user. This does not
depend on the specified reception length of the message. This means that information
regarding the length and the end of a message is included during data transmission via an
ISO-on-TCP connection.
If the length of the sent data and the length of the expected data do not match, the following
occurs:
Length of data to be received (parameter LEN, instruction TRCV/TRCV_C) greater than
length of data to be sent (parameter LEN, instruction TSEND/TSEND_C):
TRCV/TRCV_C copies all the sent data to the receive data area (parameter DATA). Then,
it sets the NDR status parameter to TRUE (job completed successfully) and assigns
RCVD_LEN (amount of data actually received) the length of the data sent.
Length of data to be received (parameter LEN, instruction TRCV/TRCV_C) less than length
of data to be sent (parameter LEN, instruction TSEND/TSEND_C):
TRCV/TRCV_C does not copy any data to the receive data area (parameter DATA), but
instead supplies the following error information: ERROR=1, STATUS=W#16#8088
(destination buffer too small).
Characteristics of UDP
UDP is a message-oriented protocol which detects the end of the message at the receiver end
and indicates the data that belongs to the message to the user. This does not depend on the
specified reception length of the message. This means that information on the length and the
end of a message is included during data transmission via a UDP connection.
If the length of the sent data and the length of the expected data do not match, the following
occurs:
Length of data to be received (parameter LEN, instruction TRCV/TRCV_C) greater than
length of data to be sent (parameter LEN, instruction TUSEND/TSEND_C):
TURCV/TRCV_C copies all the sent data to the receive data area (DATA parameter). Then,
it sets the NDR status parameter to TRUE (job completed successfully) and assigns
RCVD_LEN (amount of data actually received) the length of the data sent.
Length of data to be received (parameter LEN, instruction TRCV/TRCV_C) less than length
of data to be sent (parameter LEN, instruction TUSEND/TSEND_C):
TRCV/TRCV_C copies as much data to the receive data area (parameter DATA) as the
LEN parameter requests. No further error message is generated. In this case, the user has
to call a T_URCV again in order to receive the remaining bytes.
See also
Basics of Open User Communication (Page 625)
TSEND_C: Send data via Ethernet (Page 3625)
TRCV_C: Receive data via Ethernet (Page 3636)
TSEND: Send data via communication connection (Page 3674)
TRCV: Receive data via communication connection (Page 3677)
TUSEND: Send data via Ethernet (UDP) (Page 3687)
TURCV: Receive data via Ethernet (UDP) (Page 3690)
Note
TCON_Param for S7-1500 CPU
The connection description DB with the structure according to TCON_Param is also supported
by S7-1500 CPUs for migration reasons. However, we recommend that you use the new
structures TCON_IP_v4 and TCON_IP_RFC.
See also
Principle of operation of connection-oriented protocols (Page 638)
Description of the connection parameters (Page 630)
Ability to read back connection description parameters (Page 646)
Overview of connection configuration (Page 627)
TSAP structure (Page 647)
Assignment of port numbers (Page 645)
See also
Principle of operation of connection-oriented protocols (Page 638)
Description of the connection parameters (Page 630)
Ability to read back connection description parameters (Page 646)
Overview of connection configuration (Page 627)
Assignment of port numbers (Page 645)
See also
Principle of operation of connection-oriented protocols (Page 638)
Description of the connection parameters (Page 630)
Ability to read back connection description parameters (Page 646)
Overview of connection configuration (Page 627)
TSAP structure (Page 647)
Introduction
When an Open User Communication is created, the value 2000 is automatically assigned as
the port number.
Permissible values for port numbers are 1 to 49151. You can assign any port number within
this range. However, because some ports may already be used depending on the system, port
numbers within the range from 2000 to 5000 are recommended.
Note
Port numbers must be unique. The connection configuration or a corresponding block call is
rejected with an error if the port numbers are assigned twice.
Note
The user usually specifies the value 0 for the local port on the active connection end point for
UDP/TCP. In this case, the CPU operating system selects the next available port above 49151.
The partner port usually has the default 0 with the passive connection end point. The
corresponding parameter is disabled in the connection configuration.
** These ports are disabled depending on the function scope of the CPU in use. The
documentation of the respective CPUs provides the assignment of these ports.
See also
Description of the connection parameters (Page 630)
Creating and assigning parameters to connections (Page 633)
Note
You can only change the values in the running user program if the instructions TCON,
TSEND_C or TRCV_C are not being processed and the referenced connection is not
established.
The connection configuration does not support nested entries of connection descriptions in
DB types that can only be found via offset referencing (for example, Global-DB).
The structure of the connection description cannot be changed.
See also
Connection parameters with structure according to TCON_Param (Page 640)
Description of the connection parameters (Page 630)
TSAP structure
Introduction
For an ISO-on-TCP connection, Transport Service Access Points (TSAPs) must be assigned
for both communication partners. TSAP IDs are assigned automatically after an ISO-on-TCP
connection is created. To ensure the uniqueness of TSAP IDs within a device, you can change
the preassigned TSAPs in the connection parameter assignment.
Structure of TSAPs
You must comply with certain rules when assigning TSAPs. A TSAP must contain a certain
number of bytes, which are able to be displayed and entered as hexadecimal values (TSAP-
ID) or as ASCII characters (ASCII-TSAP):
$6&,,76$3
76$3,'
Entries or changes of the TSAP-ID or the ASCII-TSAP in the corresponding entry fields always
take effect in the other display format as well.
If a TSAP contains no valid ASCII characters, the TSAP is displayed only as TSAP-ID and not
as ASCII-TSAP. This is the case after a connection is created. The first two hex characters as
TSAP-ID identify the communication type and the rack/slot. Because these characters are not
valid ASCII characters for a CPU, the ASCII-TSAP is not displayed in this case.
$6&,,76$3QRWSUHVHQW
76$3,'FRQWDLQVLQYDOLG$6&,,FKDUDFWHUV
76$3,' 76$3H[WHQVLRQ
FRPSOHWH76$3,'
In addition to the rules for length and structure of TSAPs, you must also ensure the uniqueness
of the TSAP-ID. The assigned TSAPs are not automatically unique.
*An S7-1200 CPU is normally inserted on rack 0 and slot 1, and an S7-300/400 CPU on rack
0 and slot 2. For this reason, hex value 01 or 02 is valid for the second position of the TSAP
ID with extension. If the connection partner is an unspecified CPU, for example, a third-party
device, the hex value 00 is also permissible for the slot address.
Note
For unspecified communication partners, the local TSAP-ID and the partner TSAP-ID can have
a length of 0 to 16 bytes, in which all hex values from 00 to FF are permitted.
Code ..0 ..1 ..2 ..3 ..4 ..5 ..6 ..7 ..8 ..9 ..A ..B ..C ..D ..E ..F
2.. ! " # $ % & ( ) * + , - . /
3.. 0 1 2 3 4 5 6 7 8 9 : ; < = > ?
4.. @ A B C D E F G H I J K L M N O
5.. P Q R S T U V W X Y Z [ \ ] ^ _
6.. ` a b c d e f g h i j k l m n o
7.. p q r s t u v w x y z { | } ~
See also
Examples of TSAP assignment (Page 650)
Description of the connection parameters (Page 630)
Creating and assigning parameters to connections (Page 633)
You can change the values in the entry fields of the TSAP-ID and the ASCII-TSAP at any time.
The entry field of the TSAP-ID shows the complete TSAP stored in the data block of the
connection description. The TSAP-ID with TSAP extension, which is limited to 16 characters,
is not displayed in the "TSAP (ASCII)" entry field because the character E0 does not represent
a valid character for the ASCII-TSAP.
If the displayed TSAP-ID is a valid ASCII-TSAP, it is displayed in the "TSAP (ASCII)" entry
field.
Changes in the entry fields for TSAP-ID and ASCII-TSAP affect the other field.
Once you have exited the entry field of the TSAP-ID, a check is performed automatically to
determine whether the first character of the TSAP-ID is a valid ASCII character. Since the
character "E0" now present in the TSAP-ID is not a valid character for the ASCII-TSAP, the
"TSAP (ASCII)" entry field no longer displays an ASCII-TSAP.
If a valid ASCII character is used, the check for compliance with the length specification of 2
to 16 characters follows.
After the entry field is exited, a message is output because the TSAP-ID is neither a valid ASCII-
TSAP (this would have to have a hex value in the range from 20 to 7E as the first value) or a
valid TSAP-ID (this would have to have the identifier "E0" as the first value).
When you exit the entry field, the TSAP-ID is recognized as a valid ASCII-TSAP and the
resulting ASCII-TSAP "ISOonTCP-1" is written to the "TSAP (ASCII)" entry field.
See also
TSAP structure (Page 647)
Description of the connection parameters (Page 630)
Requirement
To be able to use the PUT and GET instructions, the following requirements must be satisfied:
At least one S7-1200/1500 CPU or S7-300/400 CPU must be created in the project.
Firmware 2.0 or higher must be installed on an S7-1200 CPU. If you have not yet created
a second CPU in the project, you can initially establish the connection to an unspecified
partner.
An S7 connection must exist between the two CPUs. If you have not yet established a
connection between two CPUs, a connection is automatically established during the
configuration of the instructions.
For both instructions, an instance data block is required in which all data used by the
instruction is stored. The instance data block is created automatically as soon as you drag
a PUT or GET instruction to a network in the program editor. For the correct execution of
the program, it is essential that the instance data blocks are not changed; consequently,
these data blocks are know-how protected. You only have read access to the instance data
blocks.
See also
Overview of connection configuration (Page 653)
Assigning parameters to start request (Page 658)
PUT: Set parameters for write and send area (Page 659)
GET: Set parameters for read and memory area (Page 660)
Connection configuration
Introduction
The connection parameters for the PUT and GET instructions are assigned in the inspector
window of the program editor. All parameters are saved in the corresponding instance data
block.
See also
Assigning parameters to start request (Page 658)
PUT: Set parameters for write and send area (Page 659)
GET: Set parameters for read and memory area (Page 660)
Overview
The following table shows the general connection parameters:
Parameter Description
End point The names of the local end point and the partner end point are shown.
Local end point
The local end point is the CPU in which the PUT or GET instruction is programmed.
Partner end point
The partner end point is selected from the drop-down list. The drop-down list shows all
available possible connection partners including unspecified connection partners for
devices whose data is unknown in the project.
As long as no connection partner is set, all other parameters in the mask are disabled.
Interface The interface of the partner CPU is displayed. The partner interface is not displayed until a
specified partner CPU has been selected.
Interface type The type of interface via which communication is handled is displayed.
Subnet name The subnet of the local end point is displayed, provided this exists. The partner subnet is
displayed only after the partner end point has been selected.
If at least one of the two connection partners is not connected with a subnet, the two connec
tion partners are automatically connected with each other. The partner which is not connected
to a network is hereby connected to the same subnet via which the other partner is already
connected to a network.
A connection of connection partners to different subnets is only possible with IP or S7 routing.
The IP routing settings can be edited in the properties of the relevant Ethernet interfaces.
Address The IP address of the local end point is displayed. The IP address of the partner is displayed
only after the partner end point has been selected.
If you have selected an unspecified connection partner, the input box is empty and has a red
background. In this case, you will need to specify a valid IP address for the connection partner.
Connection ID The currently set connection ID is displayed. You can change the connection ID in the con
nection table in the network view. You can also directly access the connection table while
you are setting the connection parameters. To do this, click the "Create new connection" icon.
Parameter Description
Connection name The name of the connection which was automatically created when the PUT/GET instruction
was inserted is displayed. You can change the name of the connection by entered a different
name in the field. You can also create a new connection or edit existing connections by
clicking the "Create new connection" icon.
Active connection establish Use the "Active connection establishment" option button to specify which partner starts the
ment communication. When the connection is created, the local partner is initially specified by
default for the establishment of the connection. If a device does not support active connection
establishment, you have to activate active connection establishment on the other partner.
Configured at one end If this check box is selected, the connection partner is the server for this connection. It cannot
actively send or receive. This corresponds to the behavior of the PUT/GET instructions. In
this case, other instructions are not possible. If the check box is not selected, other instructions
can also be used for the communication.
Procedure
To insert PUT/GET instructions, follow these steps:
1. Open the "Instructions" task card in the "Communication > S7 Communication" folder.
2. Drag a PUT or GET instruction to a network.
The "Call options" dialog opens.
3. Optional: Edit the properties of the instance DB in the "Call properties" dialog. You have
the following options:
Change the default name.
Select the "Manual" check box to assign your own number.
4. Click "OK".
Result
A corresponding instance data block is created for the inserted PUT or GET instruction. For
S7-300 CPUs, a function block is also created in the program resources.
When PUT or GET instruction is selected, you will see the "Configuration" tab under
"Properties" in the inspector window. The "Connection parameters" group in area navigation
contains the connection parameter assignment that you can now make.
See also
Creating and assigning parameters to connections (Page 657)
Deleting connections (Page 658)
Requirement
A CPU exists with a PUT or GET communication instruction.
Procedure
To configure an S7 connection using PUT/GET instructions, follow these steps:
1. In the program editor, select the call of the PUT or GET instruction.
2. Open the "Properties > Configuration" tab in the inspector window.
3. Select the "Connection parameters" group. Until you select a connection partner, only the
empty drop-down list for the partner end point is enabled. All other input options are
disabled.
The connection parameters already known are displayed:
Name of the local end point
Interface of the local end point
IP address of the local end point
4. In the drop-down list box of the partner end point, select a connection partner. You can
select an unspecified device or a CPU in the project as the communications partner.
The following parameters are automatically entered as soon as you have selected the
connection partner:
Interface of the partner end point
Interface of the partner end point. If several interfaces are available, you can change
the interface as required.
Interface type of the partner end point
Subnet name of both end points
IP address of the partner end point
Name of the connection which is used for the communication. If no connection exists
yet, it is automatically established.
5. If required, change the connection name in the "Connection name" input box. If you want
to create a new connection or edit an existing connection, click on the "Create new
connection" icon.
Note
The PUT and GET instructions between two communication partners can only run if both
the hardware configuration and the program part for the partner end point have been loaded
into the hardware. To achieve fully functional communication, make sure that you load not
only the connection description of the local CPU on the device but also that of the partner
CPU as well.
Deleting connections
A connection which was automatically created during the insertion of a PUT or GET instruction
appears in the connection table of the network view like every standard connection. As a result,
it can be deleted in the connection table.
Procedure
To delete a connection, follow these steps:
1. Open the connection table in the network view.
2. In the connection table, select the connection that you want to delete.
3. To do this, right-click the connection and select the "Delete" command from the shortcut
menu.
Result
The connection is deleted. The PUT or GET instruction and the associated instance data blocks
are retained and must be manually deleted if necessary.
To continue using the PUT or GET instruction, you must configure the connection again in the
inspector window of the program editor, since all connection parameters were also deleted
when the connection was deleted. In this case, specify a new communication partner and a
suitable connection.
Requirement
The program editor is open.
You have already inserted a PUT or GET instruction.
A connection has been established between two communication partners.
Procedure
To define the REQ control parameter, follow these steps:
1. Select the PUT or GET instruction in the program editor.
2. Open the "Configuration" tab in the inspector window.
See also
Data consistency (Page 3608)
PUT: Set parameters for write and send area (Page 659)
GET: Set parameters for read and memory area (Page 660)
Requirement
The program editor is open.
You have already inserted a PUT instruction.
A connection has been established between two communication partners.
Procedure
To specify the read and the memory area for the instruction, follow these steps:
1. Select the PUT instruction in the program editor.
2. Open the "Configuration" tab in the inspector window.
3. Select the "Block parameter assignment" entry in the area navigation.
4. In the "In/Outputs > Write area (ADDR_1) > Start" field, select a "REMOTE" data type
pointer to the area of the partner CPU which is to be written.
Only absolute addressing is permitted.
Example: P#DB10.DBX5.0 Byte 10
5. In the "Length" field, enter the length of the write area and select the data type of the memory
area from the drop-down list.
6. In the "In/Outputs > Send area (SD_1) > Start" field, select a pointer to the area in the local
CPU which contains the data to be sent.
7. In the Length field, enter the length of the memory area to be read and select the data type
from the drop-down list.
Only the data types BOOL (for a bit array, "0" must be used as address and an integer
multiple of byte must be used as length), BYTE, CHAR, WORD, INT, DWORD, DINT, REAL,
COUNTER, TIMER are permitted.
If the VARIANT pointer accesses a DB, the DB must always be specified (for example:
P#DB10.DBX5.0 Byte 10).
See also
GET: Set parameters for read and memory area (Page 660)
Requirement
The program editor is open.
You have already inserted a GET instruction.
A connection has been established between two communication partners.
Procedure
To specify the read and the memory area for the instruction, follow these steps:
1. Select the GET instruction in the program editor.
2. Open the "Configuration" tab in the inspector window.
3. Select the "Block parameter assignment" entry in the area navigation.
4. In the "In/Outputs > Read area (ADDR_1) > Start" field, select a "REMOTE" data type
pointer to the area of the partner CPU which is to be read.
Only absolute addressing is permitted.
Example: P#DB10.DBX5.0 Byte 10
5. In the "Length" field, enter the length of the read area and select the data type of the memory
area from the drop-down list.
6. In the "In/Outputs > Memory area (RD_1) > Start" field, select a pointer to the area in the
local CPU in which the read data is to be stored.
7. In the Length field, enter the length of the memory area and select the data type from the
drop-down list.
Only the data types BOOL (for a bit array, "0" must be used as address and an integer
multiple of byte must be used as length), BYTE, CHAR, WORD, INT, DWORD, DINT, REAL,
COUNTER, TIMER are permitted.
See also
PUT: Set parameters for write and send area (Page 659)
Note
Devices without valid IP address
Topology information (LLDP) cannot be read from a device without valid IP address.
To prevent devices from having an invalid IP address, specify in the settings of the TIA Portal
for hardware configuration that devices without valid IP address are temporarily assigned an
IP address.
Note
Subnet membership
Before the topology determination, you have to set for the local interface of your PG/PC the
network address that the Ethernet components that are to be determined also have in the real
plant. If you do not meet this requirement, no further topology information (information about
ports and neighborhood relationships) can be determined.
The position of a device in the network view and its position in the topology view are not
dependent on each other; in other words, the same device generally appears at different
locations in the two views.
If you open the hardware catalog in the topology view, you only see devices with an Ethernet
interface.
Which functions are there in the graphic view and which functions are there in the table view?
Displaying the Ethernet topology
Identifying and minimizing differences between the desired and actual topology
Requirement
The device or network view is open in the hardware and network editor.
Procedure
To start the topology view of your project, follow these steps:
1. Click on the "Topology view" tab.
Or:
1. Open the network view of the hardware editor.
2. Select a PROFINET device or a PROFINET module.
3. Select the "Go to topology view" command in the shortcut menu.
Result
The graphic view of the topology view is started. If you opened the topology view using the
shortcut menu, the selected component remains selected after the change of view.
Displaying topology
What is shown?
The graphic view of the configured topology shows the following:
Configured PROFINET devices and passive Ethernet components along with their ports
Configured stations with non-Ethernet components if there is at least one Ethernet
component in the station
Configured interconnections between the ports
Type of display
The way in which the graphic view of the topology view and the network view are displayed is
very similar:
Compared with the device view, components are shown in a simplified form.
The interconnections between ports are shown as horizontal and vertical lines. These are
dashed when an interconnection between a tool changer port and its possible partner ports
is involved.
What is shown?
The table view of the configured topology shows exactly the same content as the graphic view
except for the logical PROFINET subnets:
All the configured PROFINET devices and passive Ethernet components along with their
ports
All the configured stations with non-Ethernet components if there is at least one Ethernet
component in the station
Configured interconnections between the ports
For each port with the "Alternating partner port" property, there are as many completed
rows as there are potential partner ports plus one empty row.
Type of display
As the name implies, the table view of the topology view consists of a table, the topology
overview table. It is structured like the network overview table. It consists of the following
columns:
Device / port
This is the most important column of the table. The entries in this column have a hierarchical
structure with the PROFINET ports being the last element in the hierarchy. You can expand
and collapse the hierarchical entries. For a CPU, for example, an entry consists of the
following elements:
Station name
Device name
Name of the PROFINET interface
Names of the ports
Note: All the other columns only have entries in the rows containing the port names.
Type (as default, this column is not displayed)
Shows what type of station, device or interface the table row relates to or whether it belongs
to a port.
Article no. (by default, this column is not displayed)
Article no. of the device
Displaying the diagnostics status of ports and cables in the graphic view
Requirements
The graphic view of the topology view is open.
Procedure
To determine the diagnostics status of the port, follow these steps:
1. Go online with the required component or components.
Result
The following icons are displayed:
The corresponding diagnostics icon is displayed for each device.
If there is an error in at least one lower-level component, the diagnostics icon "Error in lower-
level component" is also displayed in the left-hand lower corner of the diagnostics icon.
The corresponding diagnostics icon is displayed for each port.
Every cable between two ports that are online has the color that matches its diagnostics
status.
You will find the possible diagnostics icons for ports and the color coding of Ethernet cables
in the description of hardware diagnostics. See: Displaying diagnostics status and comparison
status using icons (Page 1356)
Requirement
The table view of the topology view is open.
Procedure
To obtain the diagnostics status of hardware components of the topology overview table, follow
these steps:
1. Go online with the required components.
Result
The following icons are displayed at the left-hand edge of the topology overview table in each
row that belongs to the component involved:
The diagnostics icon belonging to the hardware component is displayed.
If the hardware component has lower-level components and if there is an error in at least
one of the lower-level components, the diagnostics icon "Error in lower-level component"
is also displayed in the left-hand lower corner of the diagnostics icon of the hardware
component.
For the possible diagnostics icons for hardware components, refer to the description of
hardware diagnostics. See: Displaying diagnostics status and comparison status using icons
(Page 1356)
Note
The display of the diagnostics status of hardware components in the topology overview table
and the network overview table is identical.
Requirement
The topology view is open. There may be an online connection to one or more devices, but
this is not actually necessary.
Procedure
To find the differences between the configured and the actual topology, follow these steps:
1. Click the "Offline/online comparison" button in the toolbar of the topology overview.
Result
The "Partner station", "Partner interface" and "Cable data" columns in the topology overview
table are removed.
Two additional groups of columns are added to the right-hand side of the table and these are
initially empty:
On the far right, columns for the topology to be identified online are added.
Between the columns for the offline and the online topology, the "Status", "Action" and
"Description" columns are added to show the result of the offline/online comparison.
Note
As default, the "Description" column is not displayed.
After the actual topology has been identified, the added columns are filled. These steps are
described in more detail in the following section.
Note
A difference between offline and online view is displayed for that port connected with the PG/
PC which is only available online. This is because the PG/PC cannot be configured offline.
If a device does not support topology functions, the "Status" column remains
empty.
"Action"
The possible actions are shown here in the form of icons. The following icons are possible:
Icon Meaning
No action possible
"Description"
This column describes the selected action in words.
Configuring topology
Interconnecting ports
Overview
Note
Interconnecting an electric with an optical port
If you want to interconnect an electric and an optical port, you have to decide between RT and
IRT communication:
With RT communication, it is not necessary to configure a media converter.
With IRT communication, you have to make the interconnection via a media converter.
What effects does the interconnection of ports have on the network view?
Note
In the properties of a subnet in the network view, you can specify that this subnet is used when
a port interconnection is created between two devices that are not networked.
When you create an interconnection between two ports, the following effects are possible in
the network view:
If the corresponding interfaces are disconnected: If you have specified a default subnet,
this is used. Otherwise a new subnet is created to connect the two interfaces.
If one (and only one) of the two interfaces involved is networked: The non-networked
interface is connected to the same subnet as the already networked interface.
In all other cases: The corresponding interfaces are not connected to a logical subnet.
See also
Interconnecting ports (Page 1129)
Settings for interconnecting Ethernet devices (Page 598)
Requirement
You are in the graphic view of the topology view.
Note
Creating a ring for S7-300, S7-400, and S7-1500 CPUs
If you create a ring using port interconnections for S7-300, S7-400, or S7-1500 CPUs, an MRP
domain is created automatically.
Result: The existing port interconnection is deleted. The new port interconnection is created.
Procedure Interconnecting two interconnected ports with each other without first deleting the two
existing port interconnections
To do this, follow these steps:
1. Place the mouse cursor on the interconnected port that is to receive a new partner port.
2. Drag the port to the new partner port that has also already been interconnected.
Result: The two existing port interconnections are deleted. The new port interconnection is
created.
Which actions are possible with port interconnections in the table view?
The following actions are possible with port interconnections in the table view:
Creating a new port interconnection
Changing an existing port interconnection
Deleting an existing port interconnection
Requirement
The row with the port whose interconnection you want to create, modify or delete is visible in
the topology overview.
Procedure
To create the interconnection of a port for the first time, to modify it or delete it, follow these
steps:
1. Move the mouse pointer to the "Partner port" column in the row of the source port.
2. Click the drop-down list there.
3. Select the required partner port (when creating or changing a port interconnection) or the
"Not interconnected" entry (when deleting a port interconnection).
Result
The required action is performed. The new partner port (after creating or modifying a port
interconnection) or the "Select port" entry (after deleting a port interconnection) is displayed
in the "Partner port" column.
Interconnecting a port with more than one partner port in the graphic view
Requirement
You have configured a port of a PROFINET device with the "Alternative partners" property
and have specified its possible partner ports.
The graphic view of the topology view is open.
Procedure
1. Interconnect this port (referred to hereafter as source port) with one of the partner ports
you have specified (referred to hereafter as target port).
2. Interconnect the source port with an additional target port.
You can do this in several ways:
Drag the mouse pointer from a partner port that is already interconnected to a target
port.
Drag the mouse pointer from an interconnection that has already been created to a
target port.
Drag the mouse pointer from a target port to a partner port that is already interconnected.
Drag the mouse pointer from a target port to an already created interconnection.
3. If necessary, repeat the step above one or more times.
Result
An interconnection is created between the source port and the alternative partner ports. This
is indicated by a dashed line.
Interconnecting a port with more than one partner port in the table view
Which actions are possible with port interconnections to several partner ports in the table view?
When working with a tool changer, the following actions can be performed with port
interconnections to multiple partner ports in the table view:
Creating a new port interconnection
Changing an existing port interconnection
Deleting an existing port interconnection
Requirement
You have configured a port of a PROFINET device with the "Alternative partners" property
and have specified its possible partner ports.
The row with the port whose interconnection you want to create, modify or delete is visible
in the topology overview.
Procedure
To create the interconnection of a port to one or more partner ports for the first time, to modify
it, or to delete it, follow these steps:
1. Move the mouse pointer to the "Partner port" column in the row of the source port.
2. Click the drop-down list there.
3. Select the required partner port (when creating or changing a port interconnection) or the
"Not interconnected" entry (when deleting a port interconnection).
Result
The required action is performed:
If you are creating an interconnection, a new row is inserted in the topology overview table.
The new partner port is displayed there in the "Partner port" column.
If you change an interconnection, the new partner port is displayed in the "Partner port"
column.
If you delete an interconnection, the row with the previous port interconnection is deleted.
Note
With a tool changer, there are normally several rows for a port with port interconnections
to more than one partner port. The last row is always an empty row. The first row can be
edited, all other rows are read-only.
Requirement
The table view of the configured topology is open.
Procedure
To rename a station, a device, an interface or a port, proceed as follows:
1. Click twice in the relevant field of the topology overview table (the second click starts the
editing mode).
2. Enter the new name and then press the ENTER key (this closes editing mode).
Result
The object is renamed.
Offline/online comparison
Overview
During the offline/online comparison, the configured topology is compared with the actual
existing topology. Devices identified online are automatically assigned to configured devices
as far as this is possible.
Note
The availability detection can take several seconds. During this time, no user input is possible.
Automatic assignment
A device identified online is automatically assigned to a configured device if the following
properties of the two devices match up:
Device name
Article number
Number of ports
The following section describes the situations that can occur and what action you can take:
Identical port interconnections
This is the ideal situation. No action is necessary here.
There are interconnections for the identified and configured device, there are however
differences.
The following actions are possible:
If it is possible to adopt the online configuration
No action
No action
No automatic assignment
In the following situations, no automatic assignment is possible:
No device can be identified online to match a configured device. In this case the
corresponding columns in the "Online topology" area of the topology overview table are
empty.
In this case, you should add the already configured device to your system or delete the
configured device from the configuration.
A device identified online cannot be assigned to any configured device. In this case the
corresponding columns in the "Offline topology" area of the topology overview table are
empty.
In this case, you can adopt the device identified online in the project (Page 677).
Requirement
You have run an offline/online comparison in the topology view. The result of this is that at
least one device identified online was automatically assigned to a configured device, but that
there are differences relating to the interconnection.
Procedure
To adopt one more port interconnections identified online in the project manually, follow these
steps:
1. Select the value "Adopt" in the "Action" column for a port of a configured device to which
a device identified online was assigned.
2. Repeat the step if necessary for other ports of the same configured device.
3. Repeat the steps up to now if necessary for other configured devices to which devices
identified online were assigned and for which there are differences relating to the
interconnection.
4. Click the "Synchronize" button.
Result
The port interconnections identified online and the cable information for the corresponding
devices are adopted in the project. Successful adoption is indicated by the diagnostics icon
"Identical topology information" for each port.
Note
If other port interconnections are recognized for a device identified online and these differ from
those that exist in the project, adopting these in the project means that the port interconnections
that were previously in the project are replaced by those identified online. If no port
interconnections are detected for a device identified online, adopting in the project means that
all the port interconnections of this device are deleted in the project.
Requirements
You have run an offline/online comparison in the topology view. The result of this is that at
least one device identified online could not be assigned to any configured device.
Procedure
To adopt one more devices identified online in the project manually, follow these steps:
1. For a configured device without an online partner, move the mouse pointer to the "Device/
port" column of the online topology.
2. Select the device you want to assign to the configured device from the drop-down list of
this box.
3. Repeat the previous steps if necessary for other configured devices without an online
partner.
Result
The selected device that was identified online is moved up from the end of the table. Following
this, it is in the row of the configured device to which you have just assigned it.
Configuring security
General
Supported devices
Supported devices
Security functions can be configured for the following products:
SCALANCE S:
S602 V2/V3/V4
S612 V2/V3/V4
S613 V2
S623 V3/V4
S627-2M V4
SOFTNET Security Client:
SOFTNET Security Client V4
Scope of performance
You can use the following security functions in STEP 7:
Configuration of the security modules
Creating VPN configuration data for SOFTNET Security Client V4
Creating VPN configuration data for SCALANCE M875
Test and diagnostics functions, status displays
The global security settings are located in the project navigation. These security settings can be configured inde
pendently of the module and subsequently assigned to individual security modules as required. Changes to the
global security settings must be loaded on all security modules involved. This also applies to the settings of redun
dancy relationships.
If the first security module to be configured is a CP, the global security settings are only displayed when the security
functions have been enabled in the local security settings of the CP. If the first security module to be configured is
a SCALANCE S module, the global security settings are displayed after logging in to the security project. The
following main folders and entries are available in the global security settings:
User login
For the security configuration within a project, there is a separate user management. Log in to the security
configuration using the "User login" entry. The first time that there is a login to the security configuration, a user
with the system-defined role "Administrator" is created automatically. You can create further users in the security
configuration in the user management.
User administration
In user administration, you can create users, define rights for roles and assign these roles to users.
Certificate manager
In the certificate manager, you see an overview of all the certificates used in the project. You can, for example,
import new certificates as well as export, renew or replace existing certificates.
Firewall
Under the "Firewall" entry, you can define global IP and MAC firewall rule sets and user-specific IP rule sets
(SCALANCE S modules only) and assign security modules. IP and MAC service definitions are used to define
the IP and MAC firewall rules compactly and clearly.
VPN groups
All created VPN groups are contained in this folder. You can create new VPN groups here and assign security
modules to these VPN groups. You can also adapt VPN group properties of VPN groups that have already been
created.
NTP
Here, you can create NTP servers and assign them to one or more security modules. This ensures that time
synchronization is performed through the assigned NTP server. Unsecured NTP servers can only be configured
in the local security settings.
RADIUS
Here, you can create RADIUS servers and assign them to one or more security modules. With this, you ensure
that authentication queries from users who log on to the selected security module to activate user-specific IP
rule sets are forwarded to the assigned RADIUS server.
Working area with security module
Once you have selected a security module in the work area, you can configure its local security settings in "Proper
ties" > "General". If the selected security module is in a VPN group, related information is displayed in the VPN tab.
VPN tab
This tab displays information about all the VPN groups to which the security module that was selected in the working
area belongs. Information about the respective participants of a VPN group can be displayed and hidden.
Local security settings are configured for a specific security module. After a security module has been selected in
the working area, its local security settings are available in the Inspector window under "Properties" > "General".
Note for CPs:
Before local security settings can be configured for CPs, these must first be enabled.
To do this, log in to your security project and then in the Inspector window, select the "Activate security features"
check box in the "Properties" > General" tab, "Security" entry. The local security settings are then displayed below
the "Security" entry. When the check box is selected, the following settings (assuming they were enabled) are
migrated automatically to the local security settings.
CP x43-1 Advanced:
SNMP
FTP configuration
Time-of-day synchronization
Web server
Entries of IP access lists
CP 1543-1:
SNMP
FTP configuration
Time-of-day synchronization
CP 1243-1:
SNMP
Time-of-day synchronization
CP 1242-7, CP 1243-7:
Time-of-day synchronization
CP 1628:
SNMP
Time-of-day synchronization
Depending on the particular security module, additional security functions are also available such as NTP (secure),
SNMPv3, FTPS.
In addition, firewall rules that enable a connection to be established are created automatically for configured con
nections. Log settings are available to record blocked packets.
Overview
The following consistency checks are available:
Local consistency checks
Project-wide consistency checks
In the individual dialog descriptions in this help system, the rules you need to take into account
for your entries are listed under the keyword "Consistency check".
Note
You can only download configured data to a security module if the project-wide consistency
check for the security module was successful.
Module-specific function
Only SCALANCE S modules as of V3 can be replaced by SCALANCE S modules as of V3,
refer to the section:
Replacing a security module (Page 771) in the section "SCALANCE S".
Managing certificates
Overview of certificates
secure communication between a network node and a security module. Certificate authorities
can be:
STEP 7 itself. If the "applicant" and "issuer" are the same, this is a self-signed certificate;
in other words, issued by STEP 7.
A higher ranking (commercial) certificate authority. These third-party certificates are
external to the project and are imported and stored in the certificate store of STEP 7.
Certificates created by one of the two certificate authorities always have a private key so that
the device certificates can be derived from them.
The following functions are also available in the certificate manager:
Import of new certificates and certificate authorities.
Import of SSL certificates (CP x43-1 Adv. only), e.g. for FTP communication.
Export of the certificates and certificate authorities used in the project.
Renewal of expired certificates and certificate authorities.
Replacing existing certificate authorities.
Addition of trusted certificates and certificate authorities.
Deleting manually imported certificates.
Note
Downloading the configuration
After replacing or renewing certificates, the configuration must be downloaded to the relevant
security modules.
After replacing or renewing CA certificates, the configuration must be downloaded to all
security modules.
Note
Current date and current time of day on the security modules
When using secure communication (for example, HTTPS, VPN...), make sure that the security
modules involved have the current time of day and the current date. Otherwise the certificates
used are not evaluated as valid and the secure communication does not work.
In the individual tabs, you have the following commands available in the shortcut menu:
Command Meaning
Import / Export Import / export of device certificates or CA certificates. The certifi
cates are transferred to the security module. The following formats
are permitted:
*.cer (certificate only)
*.crt (certificate only)
*.pem (certificate only)
*.p12 (certificate and corresponding private key)
Displays Opens the certificate dialog of Windows where you see an overview
of all certificate data.
Renew Opens the "Create new certificate" dialog in which you can import
(only in the "CA" and "Device a certificate or have a new certificate created by STEP 7 when nec
certificates" tabs) essary, for example with compromised certificates.
Replace Opens the "Change certificate authority (CA)" dialog in which you
(only in the "CA" tab) can replace an existing certificate authority with a new one.
Delete Deletes a certificate in the "Trusted certificates and root certification
authorities" tab.
Certificate authorities
"CA" tab
The certificates displayed here are created by a certificate authority.
CA certificates of a project: When you create a new project, a CA certificate is generated
for the project. The SSL certificates for the individual security modules are derived from
this certificate.
CA group certificates: When you create a new VPN group, a CA certificate is generated for
the VPN group. The VPN group certificates of security modules located in the VPN group
are derived from this certificate.
Device certificates
Renewing certificates
Meaning
In this dialog, you renew CA certificates and device certificates. If necessary, for example with
compromised certificates, you can import a certificate or have a new certificate generated by
STEP 7.
5. Depending on the certificate, enter the following values in the "Applicant" or "Alternative
applicant name" input box:
6. Select a period during which the certificate is valid. As default the current time is entered
in the "Valid from:" box and the value of the current certificate is entered in the "Valid to:".
Replacing certificates
Meaning
Open the "Change certification authority (CA)" to replace the existing CA certificate of the
project or the CA group certificate with a new one.
Permitted characters The following characters from the ANSI X 3.4-1986 character
set are permitted:
0123456789
A...Z a...z
!#$%&()*+,-./:;<=>?@ [\]_{|}~^
Characters not allowed "'`
Length of the user name (authenti 1 ... 32 characters
cation method "password")
Length of the user name (authenti 1 ... 255 characters
cation method "RADIUS")
Length of the password 8 ... 32 characters
Length of the role name 1 ... 32 characters
Maximum number of users per 128
project
Maximum number of users on one 32 + 1 administrator when creating the project
security module
Maximum number of roles per 125
project
Maximum number of roles on one 37
security module
Note
User names and passwords
As an important measure for increasing security, always make sure that user names and
passwords are as long as possible and include special characters, upper and lowercase letters
and numerals.
Using password policies, you can tighten the restrictions listed above for passwords even
further. How to define password policies is described in the section:
Password strength
When a new password is entered, its password strength is checked. The following levels are
distinguished for the password strength:
Very weak
Weak
Medium
Good
Strong
Very strong
Create users
Meaning
The security functions configured in STEP 7 are protected from unauthorized access by a
separate user management. Before you can access the global and local security settings of
security modules, you need to log in to the security configuration as a user.
Note
Users with the "Administrator" role
There must always be at least one user with full configuration rights within a project. The
administrator that is created automatically when you first enable the security functions in the
project can only be deleted if at least one other user exists with the system-defined role
"Administrator".
The following parameters are available in user management in the "User" tab:
Parameter Meaning
User name Name of the user to be created.
Click on the "Add new user" entry in the "User name" column to create
a new user.
Password (only with the Entry of the password for the user. When it is entered, the password
"Password" authentication strength is checked. For more detailed information on password
method) strength, refer to the following section:
Rules for user names, roles and passwords (Page 690)
Authentication method Password: Use this authentication method for users that edit and
download the STEP 7 Security project and that need to run
diagnostics on the security module. The authentication of the user
is performed by the security module when user-specific IP rule sets
are activated.
RADIUS: (only for SCALANCE S as of V4): The authentication of
the user is performed by a RADIUS server when user-specific IP
rule sets are activated. The password of the user is not configured
in STEP 7 when using this authentication method but must be
stored on the RADIUS server. Only use this authentication method
for users that only need to log on to the Web page of a security
module. A user with the "RADIUS" authentication method cannot
log on to STEP 7 Security projects.
Role Selecting a system-defined or user-defined role.
Maximum time of the session Entry of the time after which a user logged on to the Web page for user-
(only for SCALANCE S V3 or specific IP rule sets of SCALANCE S modules is automatically logged
higher) off. The time entered here starts after the logon and after renewing the
session on the Web page of the security module.
Default setting: 30 minutes
Minimum value: 5 minutes
Maximum value: 480 minutes
Comment Entry of optional comments.
Creating roles
Overview
You can assign a system-defined or a user-defined role to a user. Specify the module rights
of a user-defined role for each security module.
System-defined roles
The system-defined roles listed below are predefined. Certain rights are assigned to the roles
that are the same on all modules and that the administrator can neither change nor delete.
Administrator
Default role when creating a security configuration.
Unlimited access rights to all configuration data and all security modules.
Standard
Role with restricted access rights.
Diagnose
Read access to configurations.
Read access to the security module in the "Online" mode for testing and diagnostics.
Remote-Access
No rights except for logging on to the Web page for user-specific firewall rule sets.
administrator (radius)
Role that can be used to activate user-specific IP rule sets with authentication using a
RADIUS server.
Access rights to all configuration data except SNMP MIBs.
radius
Role that can be used to activate user-specific IP rule sets with authentication using a
RADIUS server.
Read-only access.
You will find a detailed list of the configuration and module rights assigned to the system-
defined roles "Administrator", "Standard" and "Diagnostics" in tables 1-3 to 1-7 of the section
Managing rights (Page 694).
For more detailed information on user-specific IP rule sets, refer to the following section: Auto-
Hotspot
For more detailed information on authentication using a RADIUS server, refer to the following
section: Auto-Hotspot
User-defined role
In addition to the system-defined roles, you can create user-defined roles. For a user-defined
role, select the configuration or module rights and specify the appropriate module rights for
every security module used in the project. You manually assign the user-defined roles to the
relevant user.
Parameter Meaning
Role Freely selectable role name.
Double-click on the "Add new role" entry to create a new user-defined role.
You can then set the rights for the created role.
Description Specifying the system-defined role With user-defined roles, the "User-de
fined role" character string is displayed.
Maximum time of the ses Entry of the time after which a user with the assigned role is automatically
sion (only for SCALANCE logged off from the Web page for user-specific IP rule sets of SCALANCE
S V3 or higher) S modules. The time entered here starts after the logon and after renew
ing the session on the Web page of the security module.
Default setting: 30 minutes
Minimum value: 5 minutes
Maximum value: 480 minutes
Comment Entry of additional, optional comments.
Note
Deleting roles
A user-defined role can only be deleted when it is no longer assigned to any user. If necessary,
assign the user a different role.
System-defined roles cannot be deleted.
Managing rights
Configuration rights
Configuration rights are not module dependent and control the rights for configuration in STEP
7.
Depending on the user type, the following configuration rights are available for selection:
Module rights
Module rights are configured per module. The "Service" column shows the service to which
the particular right relates. With the "Copy rights" and "Paste rights" commands in the shortcut
menu, you can transfer the rights from one module to another.
Depending on the user type, the following module rights are available for selection:
* To be able to use the function, the module right "Web: Access Web diagnostics and CP
file system" must be enabled as well.
** To be able to use the function, the module right "FTP: Read files from CP file system"
must be enabled as well.
*** To be able to use the function, the module right "FTP: Write files to CP file system" must
be enabled as well.
**** To use the function, the configuration right "Security diagnostics" must also be enabled.
Setting module rights before and after creating the security modules
Within a user-defined role, the module rights for each security module are defined separately.
If a security module was created before this role was added and module rights within a role
need to be set, STEP 7 presets the module rights for the security module according to the
selected rights template. The preset module rights can then be adapted when adding the role.
If a security module was created after adding a role, no rights are preset for this security
module. In this case, you will need to edit an existing role and set all the module rights yourself
for the security module.
You can also transfer existing module rights to another module by copying and, if necessary,
adapting them there. To do this, select a module in the shortcut menu in the module rights and
select the "Copy rights" or "Paste rights" menu command.
Meaning
Using the password policies, specifications can be defined that need to be taken into account
when assigning passwords to new users.
After selecting a check box, the corresponding policy is active and can, if necessary, be
adapted using the relevant input box.
Parameter Meaning
Minimum password length Minimum number of characters that passwords are required
to contain. The corresponding check box is enabled as default
and cannot be disabled.
Minimum value: 8 characters
Maximum value: 32 characters
Minimum number of digits Minimum number of digits that passwords are required to
contain.
Minimum value: 1 digit
Maximum value: 32 digits
Minimum number of special characters Minimum number of special characters that passwords are
required to contain. A special character is any character that
is neither a letter nor digit.
Minimum value: 1 special character
Maximum value: 32 special characters
Number of user passwords blocked for re-use Number of the most recently used passwords that are not
available for use as a new password if the password is
changed.
Minimum value: 1 password
Maximum value: 10 passwords
At least one uppercase and lowercase character If you select this check box, passwords must contain at least
one uppercase and one lowercase letter.
Module-specific function
This function is available only for SCALANCE S V4 modules or higher, refer to:
Auto-Hotspot in the section "SCALANCE S".
Context
You can generate the VPN information for the assignment of parameters to a SCALANCE M
using STEP 7. For this to be possible, the module must be in at least one VPN group with a
security module or a SOFTNET Security Client. With the generated files, you can then
configure the SCALANCE M using the Web Based Management of the device.
Generated files
The following file types are generated:
Export file with the configuration data
File type: *.txt file in ASCII format
Contains the exported configuration information for the SCALANCE M including
information on the additionally generated certificates.
VPN group certificates of the module
File type of the private key: *.p12 file
The file contains the module certificate and the key material.
Access is password protected.
CA certificates of VPN groups
File type: *.cer file
Note
No transfer to the security module
Configuration files are not transferred to the security module. An ASCII file is generated with
which you can configure the VPN-relevant properties of the SCALANCE M. To allow this, the
SCALANCE M must be located in at least one VPN group with another security module.
Note
Protecting exported configuration files from unauthorized access
Configuration files for SCALANCE M exported from STEP 7 can contain security related
information. You should therefore make sure that these files are protected from unauthorized
access. This is particularly important when passing on the files.
Overview
You will find information on configuration interfaces of SCALANCE S modules in Auto-Hotspot
of the section "SCALANCE S". The information contained here deals with the following
configuration options:
Mode (bridge mode / routing mode / ghost mode (only for SCALANCE S602 as of V3.1)):
Setting the operating mode (Page 773)
IP address parameters: Configuring IP address parameters (Page 774)
Port settings (only for SCALANCE S as of V3): Configuring port mode (Page 775)
Settings for the Internet Service Provider (ISP) if one of the interfaces is operated using
PPPoE (only for SCALANCE S as of V3): Configuring an Internet connection (Page 776)
Dynamic DNS (only for SCALANCE S as of V3): Configuring dynamic DNS (Page 778)
LLDP (only for SCALANCE S as of V4 in routing mode): Configuring LLDP (Page 781)
Media redundancy in ring topologies (MRP client), (only for SCALANCE S627-2M as of V4
in routing mode): Auto-Hotspot
For more information on special features of the Ghost mode, refer to the following section:
Special features of the ghost mode (Page 784)
The configuration of the interfaces of CPs is described in the sections dealing with the CPs.
Setting up a firewall
Module-specific function
Configuration of the firewall is not possible for the CP 1242-7.
Meaning
The firewall functionality of the security modules is intended to protect networks and stations
from third-party influence and interference. This means that only certain, previously specified
communications relations are permitted. The firewall discards invalid frames without sending
a response.
To filter the data traffic, IP addresses, IP subnets, services or MAC addresses can be used.
You can also set a bandwidth limitation.
The firewall functionality can be configured for the following protocol levels:
IP firewall with stateful packet inspection (layer 3 and 4)
Firewall also for Ethernet "non-IP" frames according to IEEE 802.3 (layer 2)
With security modules capable of VPN, the firewall can also be used for the encrypted data
traffic (IPsec tunnel). With the SCALANCE S602 Security module, the firewall can only be used
for unencrypted data traffic.
Firewall rules
Firewall rules describe which packets in which direction are permitted or forbidden. IP rules
affect all IP packets of layer 3 or higher. MAC rules only affect frames lower than layer 3.
Service definitions
With the aid of service definitions, you can also define firewall rules clearly in a compact form.
Service definitions are configured in the global security settings and can be used in the global,
local and user-specific firewall rules.
Application
Regardless of the module, global firewall rule sets are configured in the global security settings.
A firewall rule set consists of one or more firewall rules and is assigned to the individual security
modules.
In the global firewall rule sets, a distinction is made between the following:
IP rule sets
MAC rule sets
The following schematic illustrates the relationship between globally defined rule sets and
locally used rule sets.
3URMHFW
JOREDOUXOHVHWQ
0RGXOH
JOREDOUXOHVHW ORFDOUXOHVHW
JOREDOUXOHVHW ORFDOUXOHO
5XOHJ JOREDOUXOHVHW
5XOHJ
ORFDOUXOHO
5XOHJ
JOREDOUXOHVHW
Configuring
When configuring global firewall rules, you can make detailed firewall settings. You can allow
individual services for a single node or all services for the node for access to the station or
network.
Note
Assigning firewall rule sets with incompatible firewall rules
For a security module, only the firewall rules from firewall rule sets are adopted correctly if the
security module supports them. A firewall rule contained in a global firewall rule set with the
direction "From: External" or "To: Any" is, for example not assigned to a CP 1628. The other
firewall rules of the global firewall rule set are adopted if the CP 1628 supports them.
Result
You have created the global firewall rule set and can now assign this to the required security
modules.
Note the descriptions in the following section:
Assigning global firewall rule sets (Page 705)
Requirement
You have enabled the advanced firewall mode for the security modules you want to assign to
a firewall rule set.
Procedure
1. In the global security settings, select the entry "Firewall" > "Global firewall rule sets" >
"Assign module to a firewall rule set".
2. From the "Rule set" drop-down list, select the rule set to which you want to assign the
security module.
In the right-hand table, you will see the security modules that you can assign to the selected
firewall rule set. In the left-hand table, you will see the security modules already assigned
to the selected firewall rule set.
3. In the "Available modules" area, select the security modules you want to assign to the
selected rule set.
4. Click the "<<" button to assign the selected modules to the selected rule set.
Result
The global rule set is used by the assigned security modules as a local rule set and appears
automatically at the end of the list of firewall rules in the local security settings.
IP services
Defining IP services
Procedure
Using the definition of IP services, you can define succinct and clear firewall rules for specific
services. You select a name and assign the service parameters to it.
These services defined in this way can also be grouped together under a group name.
When you configure the packet filter rules, you then use this name.
Procedure
Using the definition of ICMP services, you can define succinct and clear firewall rules for
specific services. You select a name and assign the service parameters to it.
These services defined in this way can be grouped together under a group name.
When you configure the packet filter rules, you then use this name.
MAC services
Meaning
Using the definition of MAC services, you can define succinct and clear firewall rules for specific
services. You select a name and assign the service parameters to it.
These services defined in this way can be grouped together under a group name.
When you configure the global or local packet filter rules, you use this name.
Note
Processing for S7-CPs
Only settings for ISO frames with DSAP=SSAP=FE (hex) are processed. Other frame types
are not relevant for S7 CPs and are therefore discarded even before processing by the firewall.
Meaning
Local firewall rules are configured in the local security settings of a security module and apply
only to this security module. After enabling the firewall functionality you can either use
predefined firewall rules or define firewall rules in the advanced firewall mode.
Note
Deactivating the advanced firewall mode not possible
Once you have activated the advanced firewall mode, you can no longer deactivate it.
Configuration limits
Meaning
With IP packet filter rules, you filter according to IP frames, such as TCP, UDP and ICMP.
Within a packet filter rule, you can also fall back on the definitions of the IP services.
Meaning
With the MAC packet filter rules, you filter according to MAC frames.
Within a packet filter rule, you can also fall back on the definitions of the MAC services.
Button Meaning
Delete This deletes the selected rule or the selected global rule set.
Notes on removing a globally defined and locally assigned rule set:
if you delete a rule set here, this only cancels the assignment to the security mod
ule.
Save as global rule set (only for local Copies the selected firewall rule(s) and inserts it as a global firewall rule set in the
firewall rules) global security settings. The firewall configuration currently configured for the se
curity module remains unaffected by this procedure.
Move up Use this button to move the selected rule or selected global rule set up one position
in the list. As an alternative, you can move the selected rule or the selected rule
set by dragging it with the mouse. You can select multiple entries.
The rule / rule set you moved is therefore handled with higher priority.
Move down Use this button to move the selected rule or selected global rule set down one
position in the list. As an alternative, you can move the selected rule or the selected
rule set by dragging it with the mouse. You can select multiple entries.
The rule / rule set you moved is therefore handled with lower priority.
Define service for MAC rules This opens the dialog in which you can manage the MAC services and service
groups.
IPv4 addresses
An IPv4 address consists of 4 decimal numbers in the range from 0 to 255 separated from
each other by a dot.
IPv6 addresses
IPv6 addresses consist of 8 fields each with four hexadecimal numbers (128 bits in total). The
fields are separated by a colon. IPv6 addresses can only be entered in IP packet filter rules
for the CP 1243-1 and CP 1543-1 V1.1.
Example: fd00:ffff:ffff:ffff:ffff:ffff:2f33:8f21
Rules / simplifications:
Leading zeros within a field can be omitted.
Example: Instead of 2001:0db8:2426:08d3:1457:8a2e:0070:7344 it is also possible to use
the notation 2001:db8:2426:8d3:1457:8a2e:70:7344.
If one or more fields have the value 0 (or 0000), a shortened notation is possible.
Example: Instead of 2001:0db8:0:0:0:0:1428:57ab it is also possible to use the notation
2001:db8::1428:57ab.
To ensure uniqueness, this shortened form can only be used once within the entire address.
Decimal notation with periods
The last 2 fields or 4 bytes can be written in the normal decimal notation with periods.
Example: The IPv6 address fd00::ffff.125.1.0.1 is equivalent to fd00::ffff:7d01:1.
Address range notation in IP packet filter rules: In the same way as IPv4 addresses, IPv6
addresses can also be noted in the form of address ranges.
Example: The entry "2001:0db8:85a3:08d3:1319:8a2e:0:0/96" covers all IPv6 addresses
from 2001:0db8:85a3:08d3:1319:8a2e:0:0 to 2001:0db8:85a3:08d3:1319:8a2e:ffff:ffff.
Module-specific function
The recording of packet filter events is not available for the CP 1242-7 and CP 1243-7. The
recording of audit events and system events is not available for the CP 1242-7.
During configuration, you also select one or both of the possible logging procedures:
Local logging
Network Syslog
In both logging procedures, the security module recognizes the three following types of events:
Packet filter events
Audit events
System events
Storage Meaning
Ring buffer At the end of the buffer, the recording continues at the start of the buffer
and overwrites the oldest entries.
One-shot buffer Recording stops when the buffer is full.
Note for CP
For CPs, select only level 3 or level 6 since only events of these levels are generated for CPs.
Level 0 to level 3 error messages are output if level 3 is selected.
If you select level 6, the error messages of levels 0 to 6 are output.
Note
Severity of the system events of line diagnostics
Den System-Ereignissen der Leitungsdiagnose darf keine geringere Severity zugewiesen
werden, als Sie fr den Filter eingestellt haben. Bei einer geringeren Severity knnen diese
Ereignisse den Filter nicht passieren und werden nicht aufgezeichnet.
Option / parameter
Enable network Syslog Enables and disables the transfer of logging events to the Syslog server.
Syslog server Here, enter the IP address of the Syslog server. As an alternative, an FQDN
can be entered for SCALANCE S modules as of V4.
The Syslog server must be accessible from the security module at the
specified address and, if applicable, using the router configuration under
the "Routing" entry of the local security settings. If the Syslog server cannot
be accessed no Syslog messages are sent. You can recognize this oper
ating state on the basis of corresponding system alarms. To activate the
sending of the Syslog information again, you may have to update the rout
ing information and initiate a restart of the security module.
Enabling event classes Enable the classes of events to be transferred to the Syslog server. You
can classify packet filter and audit events according to the Severity and
using the Facility according to their origin.
Module name The module name is displayed and cannot be changed at this point.
Note
Non-secure transfer of logging events
Logging events are transferred to Syslog servers in plain language. This should be taken into
account when using Syslog servers.
Meaning
If you operate the security module in routing mode, the networks connected to the internal and
external interface are transformed into separate subnets. The DMZ interface (SCALANCE
S623/S627-2M only) is connected in routing mode regardless of the mode. In routing mode,
the frames intended for an existing IP address in the subnet are forwarded. The firewall rules
for the direction of transmission also apply.
Overview of NAT/NAPT
Module-specific function
This function is only available for SCALANCE S and CP x43-1 Adv.
Requirements
The security module is in routing mode or the DMZ interface is activated (SCALANCE
S623 / S627-2M only).
Since firewall rules that enable communication in the configured address translation
direction are generated automatically for NAT / NAPT rules, the advanced firewall mode
must be enabled for the security module. For more detailed information, refer to section
Relationship between NAT/NAPT router and firewall (Page 732)
See also
Overview of the routing settings (Page 723)
NAT/NAPT routing
Enabling NAT
The input boxes for NAT are enabled. NAT address translations only take effect with the entries
in the address translation list described below. After creating NAT rules, the corresponding
firewall rules are generated and displayed in advanced firewall mode, see section:
Relationship between NAT/NAPT router and firewall (Page 732)
If PPPoE is activated for the external interface or the DMZ interface, the action "Destination
NAT" cannot be configured. When configuring the action "Source NAT", the IP address cannot
be entered in the "Source translation" input box because this is obtained dynamically during
runtime.
If the DMZ interface of the security module (SCALANCE S623/S627-2M only) is activated, the
action "Source NAT" can also be performed in the following directions:
Internal to DMZ
External to DMZ
DMZ to external
If the SCALANCE S module (only SCALANCE S612/S623/S627-2M as of V4) is in a VPN
group and the tunnel interface is enabled, the "Source NAT" action can also be performed in
the following directions:
Internal to tunnel
External to tunnel
DMZ to tunnel (only if the DMZ interface is activated)
The following applies, for example for the direction "internal to external": The source IP address
of a frame coming from the internal network is checked to see whether it matches the IP
address specified in the "Source IP address" input box. If it matches, the frame with the external
IP address specified in the "Source translation" input box is forwarded to the external network
as a new source IP address. In the external network, the external IP address is effective.
The following table shows the input required for the action "Source NAT".
Note
You can configure an address translation to the module IP address in the destination network
for all frames going from a source network to a destination network. The security module also
assigns a port number for each frame. This is an n:1 NAT address translation in which multiple
IP addresses of the source network are translated to one IP address of the destination network.
Enter, for example, the following parameters for the direction "internal to external":
Action: "Source NAT"
From: "Internal"
To "External"
Source IP address: "*"
Source translation: External IP address of the security module
Enabling NAPT
The input boxes for NAPT are enabled. NAPT translations only take effect with the entries in
the list described below. After creating NAPT rules, the corresponding firewall rules are
generated and displayed in advanced firewall mode, see section:
Relationship between NAT/NAPT router and firewall (Page 732)
The IP address translation with NAPT can be performed in the following direction:
External to internal
If the DMZ interface of the security module (SCALANCE S623/S627-2M only) is activated, the
IP address translation with NAPT can also be performed in the following directions:
External to DMZ
DMZ to internal
DMZ to external
If the SCALANCE S module (only SCALANCE S612/S623/S627-2M as of V4) is in a VPN
group and the tunnel interface is enabled, the IP address translation with NAPT can also be
performed in the following directions:
Tunnel to internal
Tunnel to external
Tunnel to DMZ (only if the DMZ interface is activated)
The following applies, for example for the direction "external to internal": Frames intended for
the external IP address of the security module and for the port entered in the "Source port"
column are forwarded to the specified destination IP address in the internal network and to the
specified destination port.
The following table shows the input required for address translation with NAPT:
Module-specific function
Address translation with NAT/NAPT in VPN tunnels is only available for SCALANCE S612/
S623/S627-2M modules as of V4, refer to the section:
Address translation with NAT/NAPT in VPN tunnels (Page 802)
Meaning
After creating NAT/NAPT rules, STEP 7 automatically generates firewall rules that enable
communication in the configured address translation direction. The generated firewall rules
are visible in advanced firewall mode and can, if necessary, be moved and expanded
(additional IP address / IP address range / IP address band, services, bandwidth). In addition
to this, the automatically generated firewall rules should be checked in terms of their priority
and their position. If there are also manually configured firewall rules in the rule list that have
higher priority than the automatically generated firewall rules, under certain circumstances no
NAT / NAPT will be performed.
If there are several identical NAT / firewall pairs of rules, the priority in the firewall rule list
decides which rule is used.
Firewall parameters generated by STEP 7 cannot be adapted. After deactivating NAT/NAPT,
the firewall rules generated by STEP 7 are disabled.
To clarify the relationship between the NAT/NAPT rules and the corresponding firewall rules,
they are identified by corresponding, consecutive numbers.
The following table shows the system behind the firewall rules generated for NAT rules for
SCALANCE S modules.
Table 10-22 NAT address translation and corresponding firewall rules for SCALANCE S modules
The following table shows the system behind the firewall rules generated for NAT rules for CP
x43-1 Adv.
Table 10-23 NAT address translation and corresponding firewall rules for CP x43-1 Adv.
The following table shows the system behind the firewall rules generated for NAT rules for
SCALANCE S modules.
Table 10-24 NAPT translation and firewall rules created for SCALANCE S modules
The following table shows the system behind the firewall rules generated for NAPT rules for
CP x43-1 Adv.
Table 10-25 NAPT translations and created firewall rules for CP x43-1 Adv.
Module-specific function
The configuration of NAT/NAPT rules in the user-specific firewall is only available for
SCALANCE S modules as of V3, refer to the section:
Relationship between NAT/NAPT router and user-specific firewall (Page 804)
Meaning
The date and time are maintained on the security module to verify the validity (time) of a
certificate and for time stamping log entries.
Note
Configuring the firewall for communication with NTP servers
If the NTP server cannot be reached by the security module, you will need to allow the
frames from the NTP server explicitly in the firewall (UDP, port 123).
Note
Before the security functions of a CP (time-of-day slave) are used, this must receive a valid
time-of-day synchronization frame from the time master.
Property Meaning
Key ID Numeric value between 1 and 65534.
Authentication Select the authentication algorithm.
Hex/ASCII Select the format for the NTP key.
Key Enter the NTP key with the following lengths:
Hex: 22 ... 40 characters
ASCII: 11 ... 20 characters
6. Assign a the required security module to the NTP server (secure) you have created, see
section:
Assigning the security module to an NTP server (secure) (Page 739).
Time from partner: For the CP 1243-1, CP 1242-7 and CP 1243-7 in the communication
type "Telecontrol communication", the time of day is obtained from the partner (telecontrol
server).
Synchronization cycle: Specifies the cycle for time-of-day synchronization. For the
synchronization cycle of the CP, and individual hour or minute interval can be specified.
NTP:
Time zone (for CP x43-1 Adv. / CP 1628 only): In NTP mode, it is generally UTC
(Universal Time Coordinated) that is transferred. This corresponds to GMT (Greenwich
Mean Time). The time offset from UTC can be set by configuring the local time zone.
Update interval in seconds: Defines the interval between the time queries in seconds.
For SCALANCE S as of V3, the time interval for querying the NTP server is specified
automatically.
Note
Setting the update interval for CPs
If the "Enable security functions" check box is enabled in the local security settings of a
CP, the setting for the update interval is transferred from the CP's local settings into the
CP's local security settings.
Time-of-day synchronization on the full minute (for CP x43-1 Adv./CP 1243-1/CP 1628
only): With this option, you can decide whether or not the time of day is forwarded to
the communications bus on the full minute. This option is required for certain special
applications.
Accept time of non-synchronized NTP servers (only for CPs): Here you can specify
whether the security module also accepts the time-of-day from non-synchronized NTP
servers.
Forward time of day to station (only for CP x43-1 Adv./CP 1628): Disable this option if
the CPU requests the time separately from an NTP server. This prevents the time on
the CPU obtained directly from the NTP server from being overwritten by the time
detected in the CP. The accuracy may be reduced slightly due to forwarding via the CP.
NTP server: Creating NTP servers in the local security settings is described in the
section Defining an NTP server (Page 736).
Requirement
You have defined an NTP server (secure) in the global security settings.
"NTP" or "NTP (secure)" is selected as the time-of-day synchronization mode in the local
security settings of the security module that you want to assign to an NTP server (secure).
Procedure
1. Double-click the "NTP" entry in the global security settings.
2. Double-click the entry "Assign module to an NTP server".
3. From the "NTP Server" drop-down list, select the NTP server (secure) to which you want
to assign a security module.
4. In the "Available modules" section, select the security module that you want to assign to
the selected NTP server (secure).
5. Click the "<<" button to assign the selected security module to the selected NTP server
(secure).
Result
You have assigned the security module to the NTP server (secure). The NTP server (secure)
is displayed automatically in the local security settings in the list of NTP servers.
Module-specific function
The use of the security module as a DHCP server is only possible with SCALANCE S modules,
see subsection:
Auto-Hotspot in the section "SCALANCE S".
Configuring SNMP
Overview of SNMP
What is SNMP?
The security module supports the transfer of management information using the Simple
Network Management Protocol (SNMP). For this purpose, an SNMP agent that receives and
responds to SNMP requests is installed on the security module. The information on the
properties of SNMPcompliant devices is entered in MIB files (MIB = Management Information
Base) for which the user must have the required rights.
In SNMPv1, the "community string" is also sent. The "community string" is like a password that
is transmitted along with the SNMP request. If the community string is correct, the security
module replies with the required information. If the string is incorrect, the security module
discards the query and does not reply. The community string is transmitted via SNMPv1 without
encryption.
SNMPv3 lets you transmit encrypted data.
Module-specific function
The configuration of SNMP is possible only for SCALANCE S V3 or higher, CP x43-1 Adv.,
CP 1543-1, CP 1243-1 and CP 1628.
SNMPv1
The security module uses the following default values for the community strings to
control the access rights in the SNMP agent. These default values should be adapted
to increase security.
For read access: public
For read and write access: private
To enable write access using SNMP, select the "Allow write access" option.
SNMPv3
Select either only an authentication algorithm or an authentication algorithm and an
encryption algorithm.
Authentication algorithm: none, MD5, SHA-1
Encryption algorithm: none, AES-128, DES
Note
Preventing the use of DES
DES is an insecure encryption algorithm. Therefore, it should only be used for reasons
of down compatibility.
Note
When using SNMPv3 no RADIUS authentication is possible.
5. If SNMPv3 is to be used, assign a user a role with corresponding activated SNMP rights to
enable access to the module via SNMP. An overview of SNMP rights is available in the
section:
Managing rights (Page 694).
6. In the "Advanced settings" area, for SCALANCE S modules configure module-specific
information about the author, location and e-mail address overwriting the information from
the project properties.
The following applies to values written to the security module by an SNMP tool using an
SNMP-SET command:
If you select the "Keep values written by SNMP set" check box, the values are not
overwritten when there is another download of a STEP 7 configuration to the security
module.
Module-specific function
This function is available only for SCALANCE S V3 modules or higher, see section
Configuring proxy ARP (Page 808)
Module-specific function
This function is only available for CP x43-1 Advanced, see subsection:
Activating the Web server on CP x43-1 Advanced (Page 835) in the section "Security for
S7-300 / S7-400 / PC CPs".
Module-specific function
This function is available only for SCALANCE S612/S613/S623/S627-2M, CP x43-1 Adv., CP
1243-1, CP 1543-1 V1.1, 1243-7 and CP 1628.
Requirement
Note
Current date and current time of day on the security modules
When using secure communication (for example, HTTPS, VPN...), make sure that the security
modules involved have the current time of day and the current date. Otherwise the certificates
used are not evaluated as valid and the secure communication does not work.
The following properties of the VPN groups are displayed in columns in the "VPN" tab of the
"Network data" area:
Property/column Meaning
VPN Names of the VPN groups of which the selected
security module is member
Security module Names of the assigned security modules
Authentication Type of authentication: Preshared key or certificate
Group membership until Date and time up to which the VPN group certifi
cate of the security module is valid
Type Model numbers of the assigned security modules
Comment Comment
Configuration limits
Authentication methods
Note
Knowledge of IPsec necessary
To be able to set these parameters, you require IPsec experience. If you do not make or modify
any settings, the defaults apply.
Parameter Description
IKE mode Main mode
Aggressive mode
The difference between the main and aggressive mode is the "identity
protection" used in the main mode. The identity is transferred encrypted
in main mode but not in aggressive mode.
DH group phase 1 Groups selectable for the Diffie-Hellman Key exchange:
Group 1
Group 2
Group 5
Group 14
SA lifetime type Phase 1 Security Association (SA):
Time: Time limit in minutes
The lifetime of the current key material is limited in time. When the time
expires, the key material is renegotiated.
SA lifetime Numeric value:
Range of values for time: 1440 ... 2500000 minutes (default: 2500000)
Phase 1 encryption Encryption algorithm:
DES*: Data Encryption Standard (56 bit key length, mode CBC)
3DES-168: Triple DES (168-bit key length, mode CBC)
AES-128, 192, 256: Advanced Encryption Standard (128 bit, 192 bit
or 256 bit key length, mode CBC)
Phase 1 authentication Authentication algorithm:
MD5: Message Digest Algorithm 5
SHA1: Secure Hash Algorithm 1
*DES is an insecure encryption algorithm. It should only be used for reasons of down
compatibility. DES is not supported by CP 1543-1 V1.1, CP 1243-1, CP 1242-7 and CP 1243-7.
Parameter Description
SA lifetime type Phase 2 Security Association (SA):
Time: Time limit in minutes. The lifetime of the current key material is
limited in time. When the time expires, the key material is renegotiated.
Limit: Limitation of the data volume in MB
SA lifetime Numeric value:
Range of values for time: 60 ... 16666666 minutes (default: 2880)
Range of values for limit: 2000 ... 500000 MB (default: 4000)
Phase 2 encryption Encryption algorithm:
DES*: Data Encryption Standard (56 bit key length, mode CBC)
3DES-168: Triple DES (168-bit key length, mode CBC)
AES-128: Advanced Encryption Standard (128-bit key length, mode
CBC)
Phase 2 authentication Authentication algorithm:
MD5: Message Digest Algorithm 5
SHA1: Secure Hash Algorithm 1
Perfect Forward Secrecy If you enable this check box, new Diffie-Hellmann public key values are
exchanged for recalculation of the keys. If the check box is disabled, the
values already exchanged in phase 1 are used for recalculation of the
keys.
*DES is an insecure encryption algorithm. It should only be used for reasons of down
compatibility. DES is not supported by CP 1543-1 V1.1, CP 1243-1, CP 1242-7 and CP 1243-7.
VPN modes
Depending on the mode of the security modules that were added to a VPN group, different
modes of VPN groups are distinguished. The mode of a VPN group provides information about
the security modules and their modes that can be added to the VPN group.
* SCALANCE S623/S627-2M modules in bridge mode can be inserted in a VPN group in routing mode
if their DMZ interface is activated (not at the same time).
Parameter Setting
Authentication method Certificate
DH group phase 1 Group 2
SA lifetime 1440 2500000 minutes
Encryption phase 1 AES-256
Authentication phase 1 SHA-1
Parameter Setting
Authentication method Certificate
DH group phase 1 Group 2
SA lifetime 1440 2500000 minutes
Encryption phase 1 3DES-168
Authentication phase 1 SHA-1
Parameter Setting
Authentication method Certificate
DH group phase 1 Group 2
SA lifetime 1440 2500000 minutes
Encryption phase 1 DES
Authentication phase 1 MD5
Parameter Setting
Authentication method Preshared key
DH group phase 1 Group 2
SA lifetime 1440 2500000 minutes
Encryption phase 1 3DES-168
Authentication phase 1 SHA1
Module-specific function
This function is available only for SCALANCE S612/S613/S623/S627-2M, CP x43-1 Adv. and
CP 1628.
Module-specific function
SCALANCE S modules in bridge mode provide a learning mode with which the internal network
nodes can be learned automatically during operation. For more detailed information, refer to
subsection:
Using the learning mode to learn internal nodes (Page 809) in the section "SCALANCE S".
Module-specific function
How to configure IP network nodes for SCALANCE S modules manually is explained in:
Configuring IP network nodes manually (Page 810) in the section "SCALANCE S".
Module-specific function
How to configure MAC network nodes for SCALANCE S modules manually is explained in
Configuring MAC network nodes manually (Page 811) in the section "SCALANCE S".
Module-specific function
How to configure the internal subnets for SCALANCE S modules is explained in
Configuring internal subnets manually (Page 811) in the section "SCALANCE S".
Module-specific function
How to allow access to S7-300 / S7-400 CPs for VPN connection partners is explained in
Allow access to S7-300 / S7-400 CPs for VPN connection partners (Page 836) in the section
"Security for S7-300 /S7-400 /PC CPs".
Configuring NDIS nodes for PC CPs that can be reached through the tunnel
Module-specific function
How you configure NDIS nodes for PC CPs that can be reached through the tunnel is explained
in
Configuring NDIS nodes manually for PC CPs that can be reached through the tunnel
(Page 836) in the section "Security for S7-300 / S7-400 / PC CPs".
Requirement
The module is a member of a VPN group.
can be found by the partner. If the IP address is assigned dynamically and therefore changes
constantly, the partner cannot establish a connection as things stand.
Mode Meaning
Start connection to partner (initiator/res If this option is selected, the module is "active", in other
ponder) (default) words, it attempts to establish a connection to the partner
with a fixed IP address. The reception of requests for VPN
connection establishment is also possible.
This option is recommended when you obtain a dynamic IP
address from the provider for the gateway of the security
module you are configuring.
The partner is addressed using its configured WAN IP ad
dress, its configured external module IP address or the
configured DNS name.
Wait for partner (responder) If this option is selected, the module is "passive", in other
words, it waits for the partner to initiate the connection.
This option is recommended when you have been assigned
a static IP address by the provider for the gateway of the
security module you are configuring. It means attempts to
establish a connection can only be initiated by the partner.
This partner can, for example, have a dynamic WAN IP
address.
Note
Make sure that you do not set all the modules in a VPN group to "Wait for connection from
remote VPN gateway" otherwise no connection is established.
WAN IP address / FQDN - addresses of the modules and gateways in a VPN over Internet
When operating a VPN with IPsec tunnel over the Internet, additional IP addresses are
generally required for the Internet gateways such as DSL routers. The individual security or
SCALANCE M modules must know the external IP addresses of the partner modules in the
VPN.
Note
To use a WAN as an external public network, enter the IP address that you received from the
provider as the external IP address, through which the security module is then reachable in
the WAN (Internet). To allow the security module to send packets via the WAN, you need to
enter your DSL router as "Standard router".
If you use a DSL router as Internet gateway, the following ports (at least) must be opened on
it as described in the relevant documentation:
Port 500 (ISAKMP)
Port 4500 (NAT-T)
To allow this, in the module-specific VPN settings, you have the option of assigning an IP
address as a "WAN IP address". When you download the module configuration, the group
members are then informed of the WAN IP addresses of the partner modules. As an alternative
to a WAN IP address, you can also enter an FQDN. Depending on the existing addresses,
VPN endpoints are used as default according to the following priorities:
1. WAN address
2. FQDN of the primary dynamic DNS service
3. FQDN of the secondary dynamic DNS service
4. External IP address / DMZ IP address of the security module
Note: After removing an existing WAN address, the external IP address / DMZ IP address is
always used.
In the interface selection of the connection-specific VPN settings, you yourself can decide
which address the partner will be informed of. In these settings, you can also specify the
interface to be used for communication by the nodes of a VPN group and the security module
that is authorized to set up connections.
6HFXULW\0RGXO :$1 6HFXULW\0RGXO
WAN
,QWHUQHW*DWHZD\ ,QWHUQHW*DWHZD\
/$1 /$1
*356,QWHUQHW*DWHZD\
6&$/$1&(0
/$1
See also
How to create an IPsec tunnel with VPN groups (Page 742)
Module-specific function
This function is available only for SCALANCE S623/S627-2M as of V4, see section
Auto-Hotspot.
Note
Requirement for online diagnostics in ghost mode (only for SCALANCE S S602 as of V3.1)
Online diagnostics is only available in ghost mode if the security module has learned the IP
address of the internal node and has adopted this for its external interface. After this, the
security module can be reached via the IP address of the external interface.
Meaning
Display of the status of the security module selected in the project.
Module-specific function
This function is available only for SCALANCE S V3 modules or higher, see section
Overview of the individual interfaces - "Interface settings" entry (Page 816)
Module-specific function
This function is available only for SCALANCE S V3 modules or higher, see section
Overview of the Dyn. DNS settings - "Dynamic DNS" entry (Page 818)
Module-specific function
This function is available only for SCALANCE S V3 modules or higher, see section
Display of the ARP table - "ARP table" entry (Page 820)
Module-specific function
This function is available only for SCALANCE S V3 modules or higher, see section
Users logged in to the Web page - "Logged in users" entry (Page 820)
Module-specific function
This function is available only for SCALANCE S612/S613/S623/S627-2M, CP x43-1 Adv., CP
1243-1, CP 1243-7, CP 1543-1 V1.1 and CP 1628.
Meaning
Display of the communication status of the following network components:
Other security modules of the VPN group to which the selected security module belongs
Internal network nodes of these security modules
Module-specific function
This function is available only for SCALANCE S612/S613/S623/S627-2M and CP x43-1 Adv.
Meaning
Display of all learned and configured network nodes. This also displays whether or not the
learning mode of the security module is enabled.
Module-specific function
This function is only available for CP x43-1, see subsection:
Updated firewall rules - "Dynamically updated firewall rules" entry (Page 836) in the section
"Security for S7-300 / S7-400 / PC CPs".
Module-specific function
This function is available only for SCALANCE S V4 modules or higher, see section
Display of the firewall blacklist - "Firewall blacklist" entry (Page 821).
Module-specific function
This function is available only for SCALANCE S, see section
Setting the date and time - "Date and time" entry (Page 821).
Module-specific function
This function is available only for SCALANCE S602 as of V3.1, see section
Diagnostics in ghost mode - "Ghost mode" entry (Page 821).
Logging functions
Module-specific function
This function is available only for SCALANCE S, CP x43-1 Adv., CP 1243-1, CP 1243-7, CP
1543-1 and CP 1628.
Meaning
Display of logged system events and starting and stopping reading system events from the
local memory of the security module.
The system log automatically logs successive system events, for example the start of a
process. The logging can be scaled based on event classes.
For more information on opening saved system events in log files, refer to section
Evaluating system events in offline mode - "System log" entry (offline view) (Page 766).
Module-specific function
This function is available only for SCALANCE S, CP x43-1 Adv., CP 1243-1, CP 1243-7, CP
1543-1 and CP 1628.
Meaning
Display of logged security events and starting and stopping reading of security events from
the local memory of the security module.
The audit log automatically logs successive security-relevant events. This includes, for
example, user actions such as enabling and disabling packet logging.
For more information on opening security events stored in log files, refer to section
Evaluating security events in offline mode - "Audit log" entry (offline view) (Page 767).
Module-specific function
This function is available only for SCALANCE S, CP x43-1 Adv., CP 1243-1, CP 1543-1 and
CP 1628.
Meaning
Display of logged data packets and starting and stopping reading of packet filter events.
The packet filter log records certain packets of the data traffic. Data packets are only logged
if they match a configured packet filter rule (firewall) or to which the basic protection reacts
(corrupt or invalid packets). This is only possible when logging is enabled for the packet filter
rule.
For information about activation of the logging, refer to section
Auto-Hotspot.
As well as reading the log data from the buffer and transferring it to the display, it can also be
saved in a file for archiving.
For information on opening the stored packet filter log data, refer to section
Evaluating packet filter events in offline mode - "Packet filter log" entry (offline view)
(Page 767).
Evaluating system events in offline mode - "System log" entry (offline view)
Module-specific function
This function is available only for SCALANCE S, CP x43-1 Adv., CP 1243-1, CP 1243-7, CP
1543-1 and CP 1628.
Meaning
Opens logged system events that you saved as a file in the online view.
For more information, refer to chapter Logging system events - "System log" entry (Page 764).
Evaluating security events in offline mode - "Audit log" entry (offline view)
Module-specific function
This function is available only for SCALANCE S, CP x43-1 Adv., CP 1243-1, CP 1243-7, CP
1543-1 and CP 1628.
Meaning
Opens logged security events that you saved as a file in the online view.
For more detailed information, refer to section Logging security events - "Audit log" entry
(Page 765).
Evaluating packet filter events in offline mode - "Packet filter log" entry (offline view)
Module-specific function
This function is available only for SCALANCE S, CP x43-1 Adv., CP 1243-1, CP 1543-1 and
CP 1628.
Meaning
Opens logged data packets that you saved as a file in the online view.
For more detailed information, refer to section Logging data packets - "Packet filter log" entry
(Page 765).
Download functions
Note
Additional security measures when using the SOFTNET Security Client
The SOFTNET Security Client provides a solution for secure communication with automation
cells via VPN. For self-protection of the PC/PG and the corresponding automation cell, it is
advisable to use additional measures such as a virus scanner and the Windows firewall.
In Windows 7, the firewall of the operating system must be enabled so that VPN tunnel
establishment works.
Note
Refer to the information on parameters in section
Including security module in configured VPN group (Page 748).
Note
If you create several SOFTNET Security Clients within a group, no tunnels are set up between
these clients but only from the relevant client to the security modules.
:RUNVWDWLRQ
FRPSXWHU
([SRUWRIWKHFRQILJXUDWLRQIRU
62)71(76HFXULW\&OLHQWZLWK
GDWDPHGLXP
62)71(7
6HFXULW\&OLHQW
The configuration is stored in the file types "*.dat", "*.p12" and "*.cer".
Procedure
To generate the configuration files, perform the following steps in STEP 7:
1. In the "Devices & networks" view, select the "Topology view" or the "Network view" tab.
2. Insert a PC system of the type "SOFTNET Security Client" in the selected tab from the
hardware catalog.
3. Assign the SOFTNET Security Client to the VPN groups in which the PG/PC will
communicate over IPsec tunnels.
4. Make sure that the "Generate SSC files" check box is selected under the "Configuration of
the SOFTNET Security Client" entry in the local security settings of the SOFTNET Security
Client.
5. Select the storage location for the configuration files.
6. Compile the configuration of the SOFTNET Security client to export the configuration file.
7. If you selected certificate as the authentication method, specify a password for the
certificate of the VPN configuration. If you do not assign a password, the project name (not
the project password) is used as the password.
Result: Export of the configuration files is completed.
8. Adopt the files of the type *.dat, *.p12, *.cer on the PG/PC on which you want to operate
the SOFTNET Security Client.
Note
Protecting exported configuration files from unauthorized access
Configuration files for SOFTNET Security Client exported from STEP 7 can contain security
related information. You should therefore make sure that these files are protected from
unauthorized access. This is particularly important when passing on the files.
SCALANCE S
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Requirement
To be able to replace security modules, their module descriptions must be up to date. To update
the module description of security modules, follow the steps below:
1. Select the security module to be edited.
2. In the local security settings, click on the entry "General" > "Catalog information".
3. Click the "Update module description" button.
x Without losses
! Possibly with losses
- The module type and the firmware version are not changed.
Overview
Note
External interface and DMZ interface as Internet access
The simultaneous operation of PPPoE on the external interface and on the DMZ interface (dual
ISP) is not possible.
To use this IP address assignment mode, specify the ISP in the "PPPoE" entry. The IP address,
the subnet mask, the standard router and the DNS server of the interface are specified by the
ISP.
Note
A configured standard router is not taken into account when using PPPoE. This is assigned
dynamically to the module by the ISP.
Note
No network components between SCALANCE S and DSL modem
If the interface of a SCALANCE S module is operated using PPPoE, there must be no other
network components between this interface and the connected DSL modem, otherwise the
dial-in data of the Internet Service Provider may be transferred unencrypted over this link.
When using the "CHAP" authentication protocol, the data is transferred encrypted.
The selection applies to interface routing between the external and internal interface. The DMZ
interface (SCALANCE S623 and S627-2M only) is always connected in routing mode.
Bridge mode For operation in flat networks. External and internal interface
are in the same IP subnet.
For S623 / S627-2M: External and internal interface are in
the same IP subnet, the DMZ interface is in a different IP
subnet or is deactivated.
Routing mode All interfaces are in different IP subnets. If you have activated
the routing mode, you must configure an internal IP address
and subnet mask for the internal interface of the security
module.
Note
If you have enabled the routing mode for the SCALANCE S
module, no MAC firewall rules can be defined.
Ghost mode (only for SCALANCE S S602 as of V3.1) In operation, the security module adopts the IP address of
the node connected to the internal interface of the security
module for the external interface. The IP address data speci
fied for the external interface is only used for downloading the
configuration prior to operation in ghost mode.
Meaning
Specify network parameters such as the IP address and subnet mask for the interface(s) of
the security module.
3. If applicable, enable the interface using the "Activate interface" check box.
4. Select the "Ethernet addresses" entry.
5. Complete the settings specified in the following table.
Parameter Meaning
IP address IP address for the external interface.
The IP address consists of four decimal numbers from 0 to
255, with each number being separated by a period, for ex
ample, 141.80.0.16.
Subnet mask The subnet mask consists of four decimal numbers that are
separated by period, for example, 255.255.0.0
Use router (not possible for the tunnel interface) Select this check box if you want to use a standard router and
enter its IP address in the "Router address" input box.
Note
Networking the physical interfaces
Network the physical interfaces of the security module with suitable subnets to avoid IP address
conflicts.
Meaning
The port mode specifies the transmission speed and the duplex method. The same parameters
should be set for the ports involved in communication.
For SCALANCE S V2 modules, the port mode is set to "Autonegotiation" as default. This means
the transmission speed and the duplex setting are selected automatically. Moreover, the auto-
crossing function is supported.
Deactivating a port is possible only for external ports and for the DMZ port of SCALANCE S623/
S627-2M. The port modes for media module ports are configured in the device view and are
based on the range of functions of the media module in question.
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Requirement
The "PPPoE" entry is only displayed in the local security settings if the IP assignment method
"PPPoE" is configured for one of the interfaces.
Meaning
In this entry, you make settings related to the Internet Service Provider (ISP) if a connection
using PPPoE is set for one of the interfaces of the security module.
Function Description
Authentication protocol Select none or one of the following authentication
protocols:
PAP (Password Authentication Protocol)
CHAP (Challenge Handshake Authentication
Protocol)
Note
Both communications partners have to use the
same authentication method otherwise no connec
tion can be established.
User name Enter the name for logging in with the ISP account.
Password Enter the password for logging in with the ISP ac
count.
Repeat password Enter the password for logging in with the ISP ac
count again.
Function Description
Permanent connection Permanent Internet connection. After the connection has been
terminated by the provider, the connection is automatically re
stored even if there are currently no packets to be sent.
On-demand connection The Internet connection is established automatically if packets
need to be sent to the Internet.
In this setting, delays in the sending of packets are possible.
Maximum idle time (only with the If no packets are sent during a certain time, the Internet connec
setting "on-demand connection") tion is automatically terminated. In the "Maximum idle time" box,
enter the time in seconds after which the connection will be ter
minated.
Default setting: 300
Minimum value: 10
Maximum value: 3600
Forced disconnection (only with the Select the check box to be able to adapt the time of the forced
"Permanent connection" setting) disconnection by the security module.
Forced disconnection time (only The provider terminates the Internet connection automatically af
with the "Permanent connection" ter a certain period. If you enter a time of day in this box, the
setting) security module terminates the Internet connection itself at this
time. This allows disconnection of the Internet connection by the
provider to be delayed under certain circumstances. A self-initi
ated forced disconnection is only possible with an existing per
manent connection.
Default setting: 00.00
Permitted entries: 00:00 ... 23:59
Module-specific function
FQDNs can be configured for SCALANCE S V3 or higher. The resolution of FQDNs by
SCALANCE S modules is possible for SCALANCE S as of V4.
Meaning
With dynamic DNS, you can access a constantly changing IP address with a permanently
defined name (FQDN). This is necessary, for example, if you want to access a server that can
be reached via a public IP address that changes.
How it works
The security module signals the current WAN IP address via which the security module can
be reached to a provider for dynamic DNS (for example DynDNS.org, no-ip.com). The provider
makes sure that DNS queries sent to the FQDN of the security module are replied to with the
current WAN IP address of the security module.
Dynamic DNS is permitted on the following interfaces:
External interface
DMZ interface
Option Meaning
Obtain DNS server address automatically The address of the DNS server can be obtained
automatically using PPPoE if the security mod
ule is connected to the Internet via a DSL mo
dem. Can only be set for the external interface
and the DMZ interface.
Use the following DNS server address: Enter the address of the preferred and of the al
ternative DNS server manually.
4. Activate the "Activate service" check box in the "Primary dynamic DNS service" area and
make the following settings:
Setting Meaning
Provider Choose the provider with which you have set up
an account for dynamic DNS.
With the predefined providers (DynDNS.org and
No-IP.com), the provider update URL and the
check IP service URL are already completed. To
use a different provider and/or to use an HTTP
URL as the provider update URL, you need to
set up a user-defined provider.
User account with the provider Enter the user name that you specified when you
created the account.
Password with the provider Enter the password that you specified when you
created the account.
FQDN Enter the host name (e.g. mysecuritymodule)
and the domain name (e.g. dyndns.org) that is
registered with the provider separated by a peri
od. The FQDN can function as a VPN endpoint
and differ from the FQDN in the "VPN" entry. You
can configure which VPN endpoint the VPN part
ner is informed of in the connection-specific VPN
settings.
Monitor IP address change on DSL router If the security module is connected to the Internet
via a DSL router, enabling this function activates
the function of the Check IP service. The security
module periodically sends queries to determine
the current IP address of the DSL router and to
detect an IP address change on the DSL router.
The IP address specified in this way is sent to
the provider with each change ID.
Period Specify the interval at which the Check IP service
is called.
Default setting: 20 minutes
Minimum value: 10 minutes
Maximum value: 1440 minutes
5. In case the primary provider fails, create a second provider in the "Secondary dynamic DNS
service" area (optional setting).
Setting Meaning
Ignore errors when checking the To ensure that the authentication data is protected, the certificate
server certificate of the update server is checked as default. If the certificate check
fails, the HTTPS connection is terminated and the account data
is not transferred. If you select the check box, the function is dis
abled, for example if the server certificate of the dynamic DNS
service is invalid (for example expired). It is advisable not to ignore
the check and not to select the check box.
Provider update URL Enter the URL you received from your provider. The placeholder
texts <FQDN> and <CurrentWanIP> need to be placed at the
correct positions in the URL.
Check IP service URL Enter the URL you received from your provider.
Configuring LLDP
Module-specific function
This function is available only for SCALANCE S V4 modules or higher.
Requirement
The security module is in routing mode.
Meaning
LLDP (Link Layer Discovery Protocol) is a protocol used to discover network topologies. A
device capable of LLDP can send information about itself to neighboring devices at regular
intervals and at the same time receive information from neighboring devices. The received
information is stored on every device with LLDP capability in an LLDP MIB file. Network
management systems can access these LLDP MIB files using SNMP and therefore recreate
the existing network topology.
Configurable parameters
The degree of activity of the security module in terms of LLDP can be configured under the
"LLDP mode" entry of the relevant interface.
Parameter Description
Name Name of the port for which the setting is configured.
LLDP mode Configured LLDP mode:
RxTx: LLDP frames can be sent and received
Off: No LLDP frames can be sent or received
Module-specific function
This function is available only for SCALANCE S627-2M modules.
Meaning
The term "media redundancy" groups together various methods for increasing availability in
Industrial Ethernet networks in which devices can be reached over different paths. This might
be achieved by meshing networks, arranging parallel transmission paths or by closing a linear
bus topology to form a ring.
With two lower-layer rings per SCALANCE S module, layer 3 communication is possible
between the rings.
Requirement
The security module is in routing mode.
Media modules are configured for the interfaces to be connected to MRP rings.
The interfaces of the security module to be connected to rings are networked with the
relevant ring managers.
Configurable parameters
Module-specific function
This function is available only for SCALANCE S602 as of V3.1.
Meaning
In ghost mode, the security module has no IP address of its own, neither on the internal nor
on the external interface. Instead, the security module obtains the IP address for its external
interface during runtime from a node connected to the internal interface of the security module
whose IP address parameters may be unknown at the time of configuration. It is possible to
change an IP address of the internal node and a corresponding IP address at the external
interface. Since the internal node is identified based on its MAC address, IP address changes
are made only for the learned MAC address. No IP address is configured or obtained at the
internal interface of the security module.
As regards the MAC addresses, the security module replaces the MAC address of the internal
node with the MAC address of the security module in all outgoing packets on the external
interface (responses from the internal node).
Table 10-38 Port assignment for incoming connections (from external to security module)
Note
After activating SNMP, the
SNMP port is permanently as
signed to the security mod
ule. If SNMP is not activated,
the internal node can be ac
cessed using SNMP with the
aid of a firewall rule.
Table 10-39 Port assignment for outgoing connections (from security module to external)
Configuration limits
A maximum of one internal node is recognized by the security module. If several internal nodes
exist, the security module reacts as follows:
The first device the security module recognizes in the internal network obtains access to
the external network segment if the firewall is suitably configured.
The data traffic of any additional nodes in the internal network area is blocked in the
outgoing direction at level 2 (MAC layer) based on the sender address.
Overview
Module-specific function
This function is available only for SCALANCE S V4 modules or higher.
Meaning
RADIUS (Remote Authentication Dial-In User Service) is a protocol for authenticating users
by servers on which user data can be stored centrally. The use of RADIUS servers can increase
the protection of user names, assigned roles and passwords.
5$',86VHUYHU
3*IRUDFFHVVWRDXWRPDWLRQFHOO
([WHUQDOQHWZRUN
6HFXULW\PRGXOH
,QWHUQDO$XWRPDWLRQFHOO
1 Entry of the user data on the Web page of the security module
2 Authentication by RADIUS server and activation of the user-specific IP rule set
3 Access to an automation cell
The network setup shown above is simply an example. The RADIUS server can also be located
in the internal network or in the DMZ network of the security module.
For the configuration options described below, it is assumed that a RADIUS server is
configured in STEP 7 and was assigned to the relevant security module. In addition to this,
one user or role must be configured with the "RADIUS" authentication method. For more
detailed information, refer to the following sections:
Defining a RADIUS server (Page 791)
Assigning a RADIUS server to a security module (Page 791)
Create users (Page 691)
Creating roles (Page 692)
For general information on user-specific IP rule sets, refer to the following section:
Auto-Hotspot
Configuration options
To authenticate the user using a RADIUS server, there are two configuration options available:
The user and the user's role are known on the security module, only the password
management for the user is performed on the RADIUS server. The user and the password
are configured on the RADIUS server.
A user with the "RADIUS" authentication method is configured.
The user is assigned to the user-specific IP rule set.
Result:
When a user logs on to the Web page of the security module, the authentication query
is forwarded to the RADIUS server.
The RADIUS server runs a password check and signals the result back to the security
module.
If the password check is passed successfully, the user-specific IP rule set is activated.
The role is known on the security module, user management is via the RADIUS server. The
user and the password are configured on the RADIUS server.
A user-defined role or a system-defined role is assigned to the user-specific IP rule set.
Under the entry "RADIUS" > "RADIUS settings" in the local security settings of the
security module, the check box "Allow RADIUS authentication of unconfigured users"
and the check box "Filter ID is required for authentication" are enabled.
Result:
When a user logs on to the Web page of the security module, the authentication and
authorization query is forwarded to the RADIUS server.
The RADIUS server runs a password check and signals the result back to the security
module.
Case a: If, in addition to this, the role name is configured on the RADIUS server:
The RADIUS server returns the role name assigned to the user to the security module.
Case b: If the role name is not configured on the RADIUS server:
The security module assigns the user the system-defined role "radius".
If the password check is passed successfully, the user-specific IP rule set is activated.
Meaning
Before authentication by a RADIUS server is possible, this first needs to be stored in the
STEP 7 project. Following this, you assign the defined RADIUS server to the security module
for which the RADIUS server will handle user authentication.
Procedure
1. Double-click on the "RADIUS" entry in the global security settings.
2. Double-click on the "Add new RADIUS server" entry.
3. Enter the required parameters according to the following table.
Parameter Meaning
Name Freely selectable name for the RADIUS server.
IP address / FQDN IP address or FQDN of the RADIUS server.
Port UDP port via which the RADIUS server can be reached. As
default, authentication data is received at port 1812.
Shared secret Entry of the password that will be used when transferring the
logon data between the RADIUS server and security modules
for encryption.
The following characters from the ANSI X 3.4-1986 character
set are permitted:
0123456789
A...Z a...z
!#$%&()"*'+`,-./:;<=>?@ [\]_{|}~^
Length of the shared secret: 1 ... 31 characters
Repeat shared secret Confirmation of the password
Authentication method Display of the method used to check the user data. Only the
"PAP" method (Password Authentication Protocol) is suppor
ted.
Comment Entry of freely selectable, optional comments.
Result
You have defined a RADIUS server and can now assign this to the required security modules.
Requirement
You have defined a RADIUS server.
Procedure
1. Select the module to be edited.
2. Select the "RADIUS" entry in the local security settings.
3. Select the "Enable RADIUS authentication" check box.
Note
Changing the method of authentication with the Web server on the security module
If RADIUS authentication is enabled on the security module, the method for authentication
with the Web server is changed from "Digest Access Authentication" to "Basic Access
Authentication".
4. In the "RADIUS timeout" input box, enter the maximum time in seconds that the security
module will wait for a response from the RADIUS server.
5. In the "RADIUS repetitions" input box, enter the number of connection establishment
attempts with the RADIUS server.
6. Select the "Allow RADIUS authentication of unconfigured users" check box if the user-
specific IP rule to be activated was assigned a role instead of a user.
7. Select the "Filter ID is required for authentication" check box if the assigned role is a user-
defined role.
8. Under the entry "RADIUS server", select the RADIUS server you want to assign to the
security module from the "Name" drop-down list.
As an alternative, you can assign security modules for which RADIUS authentication is
enabled to RADIUS servers in the global security settings. You will find general information
on authentication by the RADIUS server in the following section:
Auto-Hotspot
Setting up a firewall
Note
Detailed firewall settings in advanced firewall mode
In advanced firewall mode, you can restrict firewall rules to individual nodes. To change to
advanced firewall mode, select the "Enable firewall in advanced mode" check box. For more
detailed information about the advanced firewall mode, refer to the section
Overview of local firewall rules (Page 711)
Service From in From ex From internal From DMZ to Enabled ports Meaning
ternal to ternal to to DMZ internal
external internal
Allow IP x x x x - IP communication for the selected
communica communication directions is al
tion lowed.
Allow S7 x x x x TCP port 102 Communication of the nodes using
protocol the S7 protocol is allowed.
Allow FTP/ x x x x TCP port 20 For file management and file ac
FTPS (ex TCP port 21 cess between server and client.
plicit mode)
Allow HTTP x x x x TCP port 80 For communication with a Web
server.
Allow x x x x TCP port 443 For secure communication with a
HTTPS Web server, for example, for Web
diagnostics.
Allow DNS x x x x TCP port 53 Communication connection to a
UDP port 53 DNS server is allowed.
Allow SNMP x x x x TCP port For monitoring nodes capable of
161/162 SNMP.
UDP port
161/162
Allow SMTP x x x x TCP port 25 For sending e-mails via an SMTP
server.
Service From in From ex From internal From DMZ to Enabled ports Meaning
ternal to ternal to to DMZ internal
external internal
Allow NTP x x x x UDP port 123 For synchronization of the time of
day.
Allow DHCP x x x x UDP port 67 Only in bridge mode
UDP port 68 Communication connection with a
DHCP server is permitted.
You can view the logged packets at the "Packet filter log" entry in the "Online & Diagnostics"
dialog. For more detailed information, refer to the section Logging data packets - "Packet filter
log" entry (Page 765).
Note
Detailed firewall settings in advanced firewall mode
In advanced firewall mode, you can restrict firewall rules to individual nodes. To change to
advanced firewall mode, select the "Enable firewall in advanced mode" check box. For more
detailed information about the advanced firewall mode, refer to the section Overview of local
firewall rules (Page 711).
If you deselect the check box, tunneled communication and also the types of communication
selected in the other boxes are permitted.
Overview
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Meaning
Initially, individual or multiple users are assigned to user-specific IP rule sets. The user-specific
IP rule sets are then assigned to individual or multiple security modules. This makes it possible,
to allow user-specific access. If, for example all access to the networks downstream from a
security module is blocked, certain nodes can be allowed for a user based on their IP
addresses. This means that access is allowed for this user but access remains blocked for
other users.
Result
The user-specific rule set is used by the assigned security modules as a local rule set and
automatically appears in the local list of firewall rules.
The user can log on with the security module. Authentication of the user is performed
depending on the selected authentication method either by the security module or a
RADIUS server.
Meaning
Possible selections for the communication directions "From" and "To" in the IP rules of the
advanced firewall mode.
Meaning
Possible selections for the communication directions "From" and "To" in the MAC rules of the
advanced firewall mode.
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Requirement
This function is available only in advanced firewall mode.
x enabled as default
- disabled as default
* cannot be adapted
Specifying routes
Meaning
Specifies routes for addressing subnets that cannot be reached directly via the security module.
Module-specific function
Address translation with NAT/NAPT in VPN tunnels is only available for SCALANCE S612/
S623/S627-2M modules as of V4.
Meaning
Address translations with NAT/NAPT can also be performed for communications relations
established via a VPN tunnel.
Requirements
The following requirements apply generally to a SCALANCE S module that will perform an
address translation with NAT/NAPT in a VPN tunnel:
The SCALANCE S module is in a VPN group.
The SCALANCE S module is in routing mode and/or the DMZ interface of the SCALANCE
S module is activated.
Module-specific function
The configuration of NAT/NAPT rules in the user-specific firewall is only available for
SCALANCE S modules as of V3.
Meaning
After creating NAT/NAPT rules, STEP 7 automatically generates a user-specific IP rule set in
the user-specific firewall that enables communication in the configured address translation
direction. You can then assign this user-specific IP rule set to individual or multiple users and/
or individual or multiple roles (only for SCALANCE S modules as of V4).
The generated firewall rules can, if necessary, be moved and expanded (additional IP address,
services, bandwidth). Firewall parameters generated by STEP 7 cannot be adapted. If the user-
specific IP rule set is assigned to a security module with NAT/NAPT deactivated, the NAT/
NAPT rules from the user-specific firewall are also applied to this security module.
Note
The address translation actions "Source-NAT + Destination-NAT" and "Double-NAT" are not
supported in conjunction with the user-specific firewall.
Overview
You can operate the SCALANCE S module on the internal network and on the DMZ network
as DHCP server (DHCP = Dynamic Host Configuration Protocol). This allows IP addresses to
be assigned automatically to the devices connected to the internal network or the DMZ
network.
Simultaneous DHCP server operation on both interfaces is possible (SCALANCE S623/
S627-2M only).
The IP addresses are either distributed dynamically from an address range you have specified
or you can select a specific IP address and assign it to a particular device. If devices on the
internal interface or on the DMZ interface should always be assigned the same IP address for
firewall configuration, the address assignment must only be static based on the MAC address
or based on the client ID.
Requirements
You configure the devices on the internal network or on the DMZ network so that they obtain
the IP address from a DHCP server.
Depending on the mode, the security module sends an IP address of the standard router to
the nodes in the relevant subnet or you need to inform the nodes in the subnet of a router IP
address.
Router IP address will be transferred
In the following situations, the DHCP protocol of the security module will inform the nodes
of the router IP address:
The node is connected to the DMZ interface (SCALANCE S623/S627-2M only)
In this case, the security module sends its own IP address as the router IP address.
The node is connected to the internal interface and the security module is configured
for router mode
In this case, the security module sends its own IP address as the router IP address.
The node is connected to the internal interface and the security module is not configured
for router mode, there is, however, a standard router specified in the configuration of
the security module.
In this case, the security module transfers the IP address of the standard router as the
router IP address.
Router IP address will not be transferred
In the following situations, enter the router IP address manually on the node:
The node is connected to the internal interface and the security module is not configured
for router mode. There is also no standard router specified in the configuration of the
security module.
See also
Configuring a DHCP server (Page 806)
3. Select the interface for which you want to make the DHCP settings.
4. Make the address assignment. You have the following configuration options:
Static address assignment
Devices with a specific MAC address or client ID are assigned the specified IP
addresses. You specify these addresses by entering the devices in the address list in
the "Static address assignment" group box.
Dynamic address assignment
Devices whose MAC address or whose client ID was not specified specifically, are
assigned a random IP address from the specified address range. For this purpose,
activate the "Dynamic IP address pool" check box. Set the address range in the
"Dynamic IP address pool" input area.
Note
Dynamic address assignment - reaction after interrupting the power supply
Please note that dynamically assigned IP addresses are not saved if the power supply is
interrupted. On return of the power, you must therefore make sure that the nodes request an
IP address again.
You should therefore only use dynamic address assignment for the following nodes:
Nodes that are used temporarily in the subnet (such as service devices).
Nodes that have been assigned an IP address and send this as the "preferred address"
the next time they request an address from the DHCP server (for example PC stations).
For permanent nodes you should preferably use static address assignment by specifying a
client ID or the MAC address.
The following IP addresses must not be in the range of the free IP address range (dynamic
IP addresses):
All router IP addresses in the "Routing" entry
Syslog server
Standard router
Security module address(es)
DHCP is supported by the security module on the interface to the internal subnet and on
the interface to the DMZ network. The following additional requirements for IP addresses
in the range of the dynamic address assignments result from this operational behavior of
the security module:
Bridge mode
The range must be within the network defined by the security module.
Routing mode
The range must be within the internal subnet defined by the security module.
Note
The DMZ network always represents a separate subnet. When using DHCP on the DMZ
interface, make sure that the free IP address range (dynamic IP addresses) is within
the DMZ subnet.
The free IP address range must be fully specified by entering the start address and the end
address. This end address must be higher than the start address.
The IP addresses you enter in the address list in the "Static address assignments" input
area must be in the address range of the internal subnet or in the DMZ subnet of the security
module.
See also
Running a consistency check (Page 684)
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Overview
Proxy ARP allows routers to respond to ARP queries for hosts. The hosts are in networks
separated by routers but use the same IP address range.
If PC1 sends an ARP request to PC2, it receives an ARP response and the hardware address
of the interface (MAC address of the port of the security module) on which the query was
received from the security module located in between and not from PC2. The querying PC1
then sends its data to the security module that then forwards it to PC2.
Detectable nodes
The following nodes are detected:
Network nodes with IP capability
Network nodes with IP capability are found when they transmit an ICMP response to the
ICMP subnet broadcast.
IP nodes downstream from routers can be found if the routers pass on ICMP broadcasts.
ISO network nodes
You can also teach-in network nodes without IP capability that can be addressed by means
of ISO protocols.
This is only possible if they reply to XID or TEST packets. TEST and XID (Exchange
Identification) are auxiliary protocols for exchanging information on layer 2. By sending
these packets with a broadcast address, these network nodes can be located.
PROFINET nodes
Using DCP (Discovery and basic Configuration Protocol), it is possible to find PROFINET
nodes.
Network nodes that do not meet these conditions must be configured manually.
Subnets located on the other side of internal routers also need to be configured manually.
Note
If more than 128 internal nodes are being operated, the permitted configuration limits are
exceeded and an illegal operating status results. Due to the dynamics in the network traffic,
this causes internal nodes that have already been learned to be replaced by new previously
unknown internal nodes.
See also
Configuring internal subnets manually (Page 811)
Meaning
As an alternative to the learning mode that you enable using the "Enable learning of internal
nodes" check box and that allows the security module to learn the internal network nodes
dynamically, you can enter the network nodes to be learned manually in the "Internal IP nodes"
entry and in doing so enable them for VPN tunnel communication. The MAC address of a
network node can be specified as an option.
Requirement
The security module is in bridge mode.
The security module is a member of a VPN group.
Meaning
As an alternative to the learning mode that you enable using the "Enable learning of internal
nodes" check box and that allows the security module to learn the internal network nodes
dynamically, you can enter the network nodes to be learned manually in the "Internal MAC
nodes" entry and in doing so enable them for VPN tunnel communication.
Requirement
The security module is in bridge mode.
The security module is a member of a VPN group.
Requirement
The security module is a member of a VPN group.
Overview
Meaning
Failures of the security modules SCALANCE S623 as of V4 and SCALANCE S627-2M as of
V4 can be automatically compensated by routers and firewall redundancy during operation.
To do this, group two security modules of the type SCALANCE S623 or SCALANCE S627-2M
in a redundancy relationship by activating routers and firewall redundancy for both security
modules. Following this, you decide which security module of the redundancy relationship is
passive in normal mode (secondary module). You make this setting for the security module of
the redundancy relationship that is active in normal operation (primary module). If the primary
module fails during operation, the secondary module automatically adopts the function as
firewall and (NAT/NAPT) router. To ensure the identical configuration of both security modules,
these are connected together via their DMZ interfaces and their configurations are
synchronized during operation. In this case, the DMZ interfaces of the security modules
involved cannot be used for other purposes.
Address redundancy
In addition to their module IP addresses, the two security modules share a common IP address
on the external and on the internal interface so that if one of the security modules fails, the IP
addresses do not need to be changed. To do this, you need to configure an IP address for the
external and for the internal interface of the redundancy relationship.
Note
Loading a configuration on security modules of a redundancy relationship (only SCALANCE
S623/S627-2M as of V4)
The properties of a redundancy relationship configured for the primary module must be loaded
both on the primary module and on the secondary module. To load the configuration, the
physical IP address via which your engineering station can reach the security module must be
used. The virtual IP addresses of the redundancy relationship cannot be used for loading.
Requirement
The security modules SCALANCE S623/S627-2M as of V4 are not assigned to any other
redundancy relationship.
Procedure
1. Select the security module that will be the active security module in normal operation
(primary module).
2. In the local security settings, select the entry "Router and firewall redundancy".
3. Select the "Router and firewall redundancy" check box.
4. In the "Secondary module" drop-down list, select the security module that will be the passive
security module in normal operation.
Result: You have created a redundancy relationship between the security modules.
For general information on configuring network parameters, refer to the following section:
Configuring IP address parameters (Page 774)
Configuring routing
Routes for the redundancy relationship are configured on the primary module. Standard routers
must be specified in the "External interface [P1] red" or "Internal interface [P2] green" entry
and must be identical per interface.
For general information on configuring routing, refer to the following section:
Specifying routes (Page 801)
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Meaning
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Meaning
Message Meaning
Success
DDNS_OK The update query was successful.
Connection-related status messages
DDNS_E_CON_UDP_SRV_RESOLV_ERR DNS name of the update server unknown, FQDN cannot
be resolved using the known DNS server.
DDNS_E_CON_UDP_SRV_UNREACHABLE Update server unreachable ("Timeout").
Security-related status messages (errors)
DDNS_E_CERT_SUBJECT_INVALID The common name of the subject in the certificate does
not match the domain name of the update server or its
IP address.
DDNS_E_CERT_UNABLE_TO_GET_ISSUER_CERT Issuer certificate not found.
The certificate chain could not be followed back to the
root CA because an issuer certificate was not found. The
trust chain is incomplete.
DDNS_E_CERT_SIGNATURE_INVALID The signature of a certificate could not be read or is in
valid.
DDNS_E_CERT_NO_TRUST A certificate in the trust chain is invalid, in other words:
Not yet valid or ready expired
V3 extensions invalid
Critical V3 extension is not supported
DDNS_E_CERT_DEPTH_ZERO_SELFSIGNED_CERT The update server has supplied a self-signed certificate
and the certificate is not in the certificate store for trust
worthy root CA certificates.
DDNS_E_CERT_SELF_SIGNED_CERT_IN_CHAIN The certificate chain could be established using non
trustworthy certificates but no suitable root CA certificate
was found in the certificate store for trustworthy certifi
cates.
DDNS_E_CERT_CHAIN_TOO_LONG The certificate chain exceeds the maximum supported
verification depth.
DDNS_E_CERT_INVALID_CA A CA certificate is invalid, in other words expired, not yet
valid or the V3 extensions are not suitable for the inten
ded purpose (for example CA not set to TRUE for CA
certificates).
DDNS_E_CERT_KEYUSAGE_UNSUITED The V3 extensions key usage or extended key usage
set in a certificate of the trust chain are not suitable for
the use of the certificate.
Message Meaning
DDNS_E_CERT_EXTENSION_UNSUPPORTED A certificate in the trust chain used an extension marked
as critical that is not supported.
Agent-related status messages (errors)
DDNS_E_AGT_BAD_AGENT The update request does not correspond to the
structure required by cRSP, for example URL
parameters missing.
The update request was sent to an illegal URL on
the update server.
The configured update string contains errors.
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Meaning
Display of the ARP table of the security module.
Module-specific function
This function is available only for SCALANCE S V3 modules or higher.
Meaning
Shows the users logged in to the Internet page for user-specific IP rule sets.
Meaning
Displays the IP addresses of nodes that have exceeded the permitted number of connections
and firewall statuses per time unit. These nodes are entered in the IP blacklist of the firewall.
The number of connections and firewall statuses per time unit is only limited if the "Use
extended status options" check box is selected in the "Standard rules for IP services" entry in
the local security settings.
If you click the "Delete all" button, the displayed IP addresses are removed from the firewall
blacklist of the security module. The IP addresses are also no longer displayed.
Module-specific function
This function is available only for SCALANCE S602 as of V3.1.
Meaning
Display of address information as well as information on IP address changes of the internal
node.
Download functions
Downloading a configuration
need to enable the IP addresses of the other modules of the group explicitly in the firewall of
this SCALANCE S and configure this module first.
Note
Downloading the configuration when operating in ghost mode (only SCALANCE S602 as of
V3.1)
When you operate the security module in ghost mode, the external interface of the security
module takes over the IP address of the internal node at runtime. Before you can download a
new configuration via the external interface to the security module, you need to specify the IP
address for downloading a configuration that the security module obtained from the internal
node during runtime.
To find out the current IP address of the security module, you can search for reachable nodes
in STEP 7 with the menu command "Online" > "Accessible devices".
Note
Loading a configuration on security modules of a redundancy relationship (only SCALANCE
S623/S627-2M as of V4)
The properties of a redundancy relationship configured for the primary module must be loaded
both on the primary module and on the secondary module. To load the configuration, the
physical IP address via which your engineering station can reach the security module must be
used. The virtual IP addresses of the redundancy relationship cannot be used for loading.
Firmware version
The configuration of a SCALANCE S as of V3 can also be downloaded to a SCALANCE S
module whose firmware version is higher than the firmware version of the SCALANCE S
module in STEP 7.
Operating mode
Configurations can be downloaded while the SCALANCE S modules are operating. Restart
the SCALANCE S module to activate your configuration changes.
Note
Special characteristics
As long as a module has not yet set IP parameters (in other words, prior to the first
configuration), there must be no router between the module and the configuration computer.
If you swap a PC from the internal to the external interface of the SCALANCE S, access
from this PC to the SCALANCE S is blocked for approximately 20 minutes.
Configuration status
Prior to each download, the existing configuration on the security module is checked and
compared with the configuration to be downloaded from the STEP 7 project. If the configuration
of the module originates from the STEP 7 project currently to be downloaded and there are
differences between these configurations, it is possible to download only files with differences
between the module and project configuration to the security module. In some situations, this
can speed up the download.
Transferring firmware
Setting up a firewall
Note
Detailed firewall settings in advanced firewall mode
In advanced firewall mode, you can restrict firewall rules to individual nodes. To change to
advanced firewall mode, select the "Activate firewall in advanced mode" check box.
Note
Relationship between log settings in default mode and firewall rules
Log settings that are made in "Predefined IP rules" and "Predefined MAC rules" have no effect
on firewall rules that were automatically created as a result of configuring a connection. This
means, for example, that tunneled frames belonging to a configured connection cannot be
logged. In advanced firewall mode, logging can be extended to the automatically generated
firewall rules of connections.
Note
Relationship between log settings in default mode and firewall rules
Log settings that are made in "Predefined IP rules" and "Predefined MAC rules" have no effect
on firewall rules that were automatically created as a result of configuring a connection. This
means, for example, that tunneled frames belonging to a configured connection cannot be
logged. In advanced firewall mode, logging can be extended to the automatically generated
firewall rules of connections.
Note
Relationship between log settings in default mode and firewall rules
Log settings that are made in "Predefined IP rules" and "Predefined MAC rules" have no effect
on firewall rules that were automatically created as a result of configuring a connection. This
means, for example, that tunneled frames belonging to a configured connection cannot be
logged. In advanced firewall mode, logging can be extended to the automatically generated
firewall rules of connections.
Note
Relationship between log settings in default mode and firewall rules
Log settings that are made in "Predefined IP rules" and "Predefined MAC rules" have no effect
on firewall rules that were automatically created as a result of configuring a connection. This
means, for example, that tunneled frames belonging to a configured connection cannot be
logged. In advanced firewall mode, logging can be extended to the automatically generated
firewall rules of connections.
Meaning
Possible selections for the communication directions "From" and "To" in the IP rules of the
advanced firewall mode.
Context
Possible selections for the communication directions "From" and "To" in the MAC rules of the
advanced firewall mode.
Module-specific function
This function is not available for the CP 1628.
Meaning
You set access protection for certain IP addresses using the IP access lists. List entries that
have already been created and the corresponding rights are displayed in the local settings of
the CP in the entry "Firewall" > "IP rules" (advanced firewall mode).
Note
Changed behavior after activation of security
Once you have activated the security function for a CP, access protection will only apply
to the external interface. You can apply access protection to the internal interface as well,
by configuring suitable firewall rules in advanced firewall mode.
The CP also responds to ARP requests from IP addresses that have not been released
(layer 2).
If the IP access list of a CP contains no entries and you activate security for the CP, the
firewall will be activated and prevent access to the CP from external locations. Configure
the corresponding firewall rules in advanced firewall mode so that the CP can be reached.
Meaning
For connections that were configured using CPs, STEP 7 automatically creates firewall rules
that allow communication with the partner of the CP in the specified direction (CP active/
passive). The connection establishment directions are taken into account. To display these
firewall rules, if the advanced firewall mode is enabled, the "Update connection rules" button
needs to be clicked. The firewall rules are then displayed in advanced firewall mode.
Note
Enabling UDP multicast and UDP broadcast connections manually
No automatic firewall rules are created for UDP multicast and UDP broadcast connections. To
enable the connections, add the relevant firewall rules manually in advanced firewall mode.
Depending on how the connection establishment is configured, the following level 3 firewall
rules are created. If the security module is in a VPN group, the direction "External" changes
to "Tunnel". This applies only to CPs that support VPN.
The IP address of the connection partner is entered in the "Source IP address" or "Destination
IP address" column of these firewall rules.
For level 2 connections, "Allow" rules are created for both directions. If the security module is
in a VPN group, the direction "External" changes to "Tunnel".
The MAC address of the connection partner is entered in the "Source MAC address" or
"Destination MAC address" column of these firewall rules.
Note
Changing the connection configuration
Changes to the connection configuration of CPs also change the connection-related firewall
rules. To display the modified firewall rules, click the "Update connection rules" button.
Module-specific function
This function is only available for CP x43-1.
Meaning
After activating the Web server, you have access to the Web pages of the module. In the local
security settings, you can restrict access to these Web pages using the HTTPS protocol. This
access is controlled using the "Allow access only using HTTPS" check box. In addition, you
must configure the firewall accordingly.
Possible selections
Decide whether or not the VPN connection partner can have access to the CP and/or the
internal subnet of the CP in routing mode (SCALANCE S / M).
Configuring NDIS nodes manually for PC CPs that can be reached through the tunnel
Module-specific function
This function is only available for CP x43-1 Adv.
Meaning
Display of the IP addresses or IP address ranges that were enabled dynamically using HTTP
or HTTPS, or loaded by a user. The rights assigned for accessing the S7 CP are displayed for
the enabled IP addresses. An update of the IP addresses in this tab can only be triggered by
the following events:
Extension/modification of the IP access control list
Update of firewall rules
Dynamic extensions transmitted to the CP at runtime, for example, PROFINET IO devices
Since only the dynamically updated firewall rules are displayed here, you also need to take
into account the firewall rules that were configured offline and downloaded to the station for a
full picture of the current firewall status of the module.
Setting up a firewall
Note
Detailed firewall settings in advanced firewall mode
In advanced firewall mode, you can restrict firewall rules to individual nodes. To change to
advanced firewall mode, select the "Activate firewall in advanced mode" check box.
Note
Relationship between log settings in default mode and firewall rules
Log settings that are made in "Predefined IP rules" and "Predefined MAC rules" have no effect
on firewall rules that were automatically created as a result of configuring a connection. This
means, for example, that tunneled frames belonging to a configured connection cannot be
logged. In advanced firewall mode, logging can be extended to the automatically generated
firewall rules of connections.
Meaning
With the predefined IPv6 rules, you have the option of configuring the firewall for services in
which IPv6 is used. By enabling a predefined IPv6 rule in the local security settings of the CP
1543-1 V1.1, the system-defined ICMPv6 services that can be seen in the global security
settings in the "ICMP" tab in "Firewall" > "Services" > "Define services for IP rules"are also
enabled in the firewall. The firewall of the CP 1543-1 V1.0 allows ICMPv6 packets through
even without enabling a predefined IPv6 rule.
Note
Relationship between log settings in default mode and firewall rules
Log settings made in "Predefined IPv6 rules" have no effect on firewall rules that were
automatically generated as a result of configuring a connection. This means, for example, that
tunneled frames belonging to a configured connection cannot be logged. In advanced firewall
mode, logging can be extended to the automatically generated firewall rules of connections.
Note
Relationship between log settings in default mode and firewall rules
Log settings that are made in "Predefined IP rules" and "Predefined MAC rules" have no effect
on firewall rules that were automatically created as a result of configuring a connection. This
means, for example, that tunneled frames belonging to a configured connection cannot be
logged. In advanced firewall mode, logging can be extended to the automatically generated
firewall rules of connections.
Note
Relationship between log settings in default mode and firewall rules
Log settings that are made in "Predefined IP rules" and "Predefined MAC rules" have no effect
on firewall rules that were automatically created as a result of configuring a connection. This
means, for example, that tunneled frames belonging to a configured connection cannot be
logged. In advanced firewall mode, logging can be extended to the automatically generated
firewall rules of connections.
Meaning
With the predefined IPv6 rules, you have the option of configuring the firewall for services in
which IPv6 is used. By enabling a predefined IPv6 rule in the local security settings of the CP
1243-1, the system-defined ICMPv6 services that can be seen in the global security settings
in the "ICMP" tab in "Firewall" > "Services" > "Define services for IP rules" are also enabled in
the firewall.
Note
Relationship between log settings in default mode and firewall rules
Log settings made in "Predefined IPv6 rules" have no effect on firewall rules that were
automatically generated as a result of configuring a connection. This means, for example, that
tunneled frames belonging to a configured connection cannot be logged. In advanced firewall
mode, logging can be extended to the automatically generated firewall rules of connections.
Note
Relationship between log settings in default mode and firewall rules
Log settings that are made in "Predefined IP rules" and "Predefined MAC rules" have no effect
on firewall rules that were automatically created as a result of configuring a connection. This
means, for example, that tunneled frames belonging to a configured connection cannot be
logged. In advanced firewall mode, logging can be extended to the automatically generated
firewall rules of connections.
Meaning
Possible selections for the communication directions "From" and "To" in the IP rules of the
advanced firewall mode.
Meaning
Possible selections for the communication directions "From" and "To" in the MAC rules of the
advanced firewall mode.
Meaning
For connections that were configured using CPs, STEP 7 automatically creates firewall rules
that allow communication with the partner of the CP in the specified direction (CP active/
passive). The connection establishment directions are taken into account. To display these
firewall rules, if the advanced firewall mode is enabled, the "Update connection rules" button
needs to be clicked. The firewall rules are then displayed in advanced firewall mode.
Note
Enabling UDP multicast and UDP broadcast connections manually
No automatic firewall rules are created for UDP multicast and UDP broadcast connections. To
enable the connections, add the relevant firewall rules manually in advanced firewall mode.
Depending on how the connection establishment is configured, the following level 3 firewall
rules are created. If the CP (not CP 1543-1 V1.0) is in a VPN group, the direction "External"
changes to "Tunnel".
The IP address of the connection partner is entered in the "Source IP address" or "Destination
IP address" column of these firewall rules.
For level 2 connections, "Allow" rules are created for both directions. If the CP (not CP 1543-1
V1.0) is in a VPN group, the direction "External" changes to "Tunnel".
The MAC address of the connection partner is entered in the "Source MAC address" or
"Destination MAC address" column of these firewall rules.
Note
Changing the connection configuration
Changes to the connection configuration of CPs also change the connection-related firewall
rules. To display the modified firewall rules, click the "Update connection rules" button.
Introduction
The Web server lets you monitor and administer the CPU through authorized users by means
of a network. This permits evaluation and diagnostics over long distances. All you need is a
web browser.
Web browser
You need a web browser to access the HTML pages of the CPU.
The following web browsers have been tested for communication with the CPU:
Internet Explorer (Version 8)
Mozilla Firefox (Version 21)
mobileSafari (iOS5)
Additional information
Additional information about the Web server of the various CPU families is available under the
key word "Web server" in the information system.
Information on creating your own web pages for access to the CPU is available under the
keyword "User-defined web pages" in the information system.
You can find links to additional manuals about the subject "Web server" under "See also".
See also
S7-1500 web server (http://support.automation.siemens.com/WW/view/en/59193560)
Documentation S7-300 (http://support.automation.siemens.com/WW/view/en/12996906)
Documentation S7-400 (http://support.automation.siemens.com/WW/view/en/44444467)
S7-1200 web server (http://support.automation.siemens.com/WW/view/en/36932465)
Introduction
DP master systems that consist of a DP master and DP slaves which are connected via a bus
and communicate with one another via the PROFIBUS DP protocol are referred to as
distributed I/O.
Below, we refer to communication-capable modules with DP interface that can take on the role
of DP master or DP slave.
Additional information
Additional information on distributed I/O is available under the key word "Distributed I/O" and
"I-slave" in the information system.
Addressing modules
Addressing modules
Introduction
In the device overview, you see the addresses or address ranges of the modules in the I
address and Q address columns. There are other addresses as well, which are explained
below.
I/O address
I/O addresses (input/output addresses) are required to read inputs and set outputs in the user
program.
Input and output addresses are assigned automatically when modules are inserted in the rack.
The address of the first channel is the start address of a module. The addresses of the other
channels are derived from this start address. The address end is obtained from the module-
specific address length.
The hardware identifier is assigned automatically when components are inserted in the device
or network view and in the PLC tags. A name is also assigned automatically for the hardware
identifier. The system constants of the PLC tags cannot be changed either.
See also
Specifying input and output addresses (Page 849)
Assigning addresses to a location in the program (Page 850)
Introduction to loading a configuration (Page 1146)
Inspector window (Page 547)
Requirement
You are in the device view.
Procedure
To change the preset address range proceed as follows:
1. In the device view, click on the module for which you want to set the start address.
2. Go to "I/O addresses" in "Properties" in the inspector window.
3. Under "Start address" enter the required start address.
4. Press <Return> or click on any object to accept a modified value.
If you have entered an invalid address, a message indicating the next available address is
displayed.
Note
You can also change the addresses directly in the device overview.
See also
Editing properties and parameters (Page 574)
Input and output addresses in the address overview (Page 576)
Requirement
The device view of the hardware and network editor is open.
The zoom level in the device view must be set to at least 200% to allow you to see the
individual I/O channels.
The instruction window of the programming editor or a tag table is open.
Procedure
To assign I/O channels of modules to the points of use in the program or to a tag table, follow
these steps:
1. In the device view, navigate to the module with the desired I/O channel.
2. Click and hold down the mouse button to drag the desired I/O address to the corresponding
point of use of the block or to the tag table.
The address of the module is assigned to the point of use in the program or entered as a tag
in the tag table.
Note
The tag for an input or output of a block can also be dragged to the input or output of a module
in order to link the tag to the I/O channel of the module.
Signal board
Introduction
Signal boards allows you to increase the number of the S7-1200 CPU's own inputs and outputs.
Just like all other hardware components, you will find signal boards in the hardware catalog.
However, you do not insert signal boards in the rack like other modules but directly in a slot of
the CPU itself.
Note the following points when using a signal board:
Each CPU can have only one signal board inserted in it.
A signal board can only be inserted when the slot in the CPU is free.
There are various ways of inserting a signal board in a CPU:
Double click on a signal board in the hardware catalog when there is a free slot in the CPU
Drag from the hardware catalog to a free slot in the CPU
Shortcut menu of a signal board in the hardware catalog for copying and pasting
Requirement
The hardware catalog is open.
The S7-1200 CPU has a free slot for the signal board.
You have now inserted a signal board in the slot of the CPU.
If you are in the network view, you can also drag a signal board to a device. If the CPU has a
an empty slot for a signal board, the signal board is inserted automatically into this slot.
Introduction
The Web server allows you to monitor the CPU via the Internet or the intranet of your company.
This permits evaluation and diagnostics over long distances.
Alarms and status information are visualized on HTML pages.
Web browser
You need a web browser to access the HTML pages of the CPU.
The following PC web browsers, for example, are suitable for communication with the CPU:
Internet Explorer (Version 8.0, 9.0)
Mozilla Firefox (Version 17.0.1 and higher)
Google Chrome 23.0
Apple Safari 5.1.7 (Windows)
Apple Safari 6.0.2 (Mac)
The following Web browsers of mobile devices are also suitable:
Internet Explorer 6.0 for HMI Panels
Mobile Safari (iOS 5.0.1)
Page/information Description
Intro/Introduction Entry page for the standard web pages
Start Page The start page provides an overview of general
Start page with general CPU information information on the CPU, the name of the CPU, the
type of CPU and basic information on the current
operating state.
Identification Displays the static identification information such
Identification information as serial number, article number and version num
bers.
Diagnostic Buffer Displays the content of the diagnostics buffer with
Diagnostic information the most recent entries first.
Module Information Displays whether the centrally inserted compo
Module information nents of a station are OK, whether there are main
tenance requirements or components cannot be
reached, for example.
As of firmware version 4 a firmware update is pos
sible via this Web page.
Communication Displays the communication connections during
Communication open communication (OUC); displays resources
and address parameters.
Varable Status Displays the status of operands of the user pro
Tags gram to monitor and change the values.
Data Logs Data logs in CSV format to transfer to the hard disk
(File Browser as of firmware version 4) of the programming device. The data logs are cre
ated with data log instructions in the user program
and filled with data.
As of firmware version 4 you have access to files
of the internal load memory and of the external
load memory (Memory Card), for example to the
content of the directory "DataLogs" and "Recipes"
via the Web page "File Browser".
User Pages The user web pages deliver a list of web pages
User pages (if user-defined web pages have been with customer-specific web applications.
configured and loaded)
See also
S7-1200 web server (http://support.automation.siemens.com/WW/view/en/36932465)
Requirement
The web server must be started.
The web server only starts when it has been activated in the properties of the CPU in the "Web
server" section.
Note the following:
The web pages are normally transmitted via an non-secure connection and are not secured
against hacker attacks. If you want to transfer the web pages in encrypted form to the browser,
use the URL https://, followed by the IP address of the CPU.
Logon
No logon is required to access the standard web pages read-only. A user must be logged on
to execute certain actions like changing the operating mode of the CPU or for write access.
For S7-1200 CPUs up to FW version V3:
You must be logged on as "admin" for the actions listed above. The logon input boxes are on
the top left of each standard web page.
If you log on as "admin", you must enter the user name and password there.
Name: admin.
See also
Access for HTTPS (Page 857)
See also
Data logging - Overview (Page 3318)
Concept
The concept of user-defined web pages allows you to access freely-designed web pages of
the CPU from a web browser. The Web server of the CPU provides this function.
You are not dependent on special tools for the design and functionality of the user-defined
web pages. You can adapt the pages in the layout with CSS, provide dynamic content with
JavaScript or use any framework to produce web pages.
The totality of files processed by the Web server is also referred to as the "web application".
To synchronize between the user program and the Web server, but also to initialize, you must
call the WWW (SFC 99) instruction in the user program.
If no interaction is required between the web application and the user program, for example,
if a web page only provides static information, only initialization in the user program is
required.
If a simple data exchange is necessary between PLC tags and tags in web applications, to
display the contents of PLC tags or write a value in a PLC tag for example, the syntax for
reading and writing tags has to be observed. In this case only an initialization is required
in the user program, for example in the startup OB.
If a further interaction is required between the web application and the user program, you
must handle status and control information from the Web Control DB in addition to the
synchronization between Web server and user program. This is the case, for example,
when user entries are transmitted via the web browser to the Web server for evaluation by
the CPU. Unlike simple data exchange, the user program directly influences the time at
which the requested web page is relayed back to the web browser. In this case, you must
be acquainted with the concept of manual fragments and the structure of the Web Control
DB.
Initialization
User-defined web pages are "packaged" in data blocks for processing by the CPU. You must
generate appropriate data blocks from the source data (HTML files, images, JavaScript files,
etc.) during configuration to be able to download the web application into the CPU. The Web
Control DB takes on a special role (default: DB 333). It contains status and control information
as well as links to additional data blocks with coded web pages. Data blocks that contain coded
web pages are termed "Fragment DBs".
When the data block is downloaded into the CPU, the CPU does not "know" that user-defined
web pages are coded inside it. The "WWW" (SFC 99) instruction, for example, in the Startup
OB informs the CPU which DB is the Web Control DB. The user-defined web pages can be
accessed via a web browser after this initialization.
Synchronization
If the user program is to exchange data with the user-defined web pages, the WWW (SFC 99)
instruction must be used in the cyclic program section.
Examples of interaction between user program and web page:
Check received data
Assemble and send back data to the web browser making the request
In this case, the status information must be able to be evaluated and control information must
be transmitted to the Web server, for example, to release a requested web page.
Procedural overview
Basic information
This section provides a step-by-step explanation of the basic procedure used to create and
download custom web pages and to use them in the operating phase.
The following graphic provides a simplified representation of the process used in creating and
displaying custom web pages:
+70/
*,)
:::
Programming a web application (using suitable tools when required and AWP commands for
dynamic pages when applicable).
The web application is comprised of single source files, for example, *.html, *.gif, *.js, etc.
Using STEP 7:
Generate the data blocks (Web Control DB and fragment DBs) from source files. The DBs
contain meta information and the complete web application, including the images and the
dynamic and static parts of the web application. The DBs are stored under "System blocks"
in the project tree.
Call the "WWW" instruction in the user program. This instruction initializes the web server
of the CPU for a web application.
If required, complete final programming for interaction between the web server and user
program
Downloading the blocks to the CPU.
Call the web page in the browser. The web pages of the CPU are called by entering the IP
address of the CPU.
Additional information
You can find additional information and examples relating to the S7-1200 web server on the
Internet (http://support.automation.siemens.com/WW/view/en/36932465).
Rules
The tool must be able to directly edit the HTML code so that the AWP command can be
inserted into the HTML page.
Only the AWP commands are parsed in the CPU and, for example, replaced by values from
the user program/process image of the CPU.
Files containing AWP commands must be coded in UTF-8. In the metadata of the HTML
page, therefore, set the attribute charset to UTF-8 and save the file UTF-8 coded.
Files containing AWP commands must not contain the following sequence: ]]
Files containing AWP commands must not contain the following sequence outside of the
"Tag read ranges" (:=<Tag name>:): :=
Tip: Replace the first character of a prohibited sequence with its character coding; for the
colon, for example, :.
A small example for a custom web page should make clear the basic design.
Requirement
The CPU must have a web server and the web server of the CPU must be activated.
To be able to access PLC tags with write access as a user, you must be logged on as
"admin".
For the example below, PLC tags must be defined for those PLC tags that are to be shown
on the web page. This is shown here for the first tab used, "Tank_below_max".
<title>Mix</title>
</head>
<body>
<h1>Mix</h1>
<h2> Actual State </h2>
<table border="1">
<tr>
<th>Variable</th>
<th>State</th>
</tr>
<tr>
<td>Tank below max</td>
<td>:="Tank_below_max":</td>
</tr>
<tr>
<td>Tank above min</td>
<td>:="Tank_above_min":</td>
</tr>
</table>
</body>
</html>
AWP commands
The interface between a freely-programmable web application for a CPU that has a Web server
and the CPU data is declared by the AWP command (Automation Web Programming).
To develop web applications you are only subject to the restrictions of the web browser. In one
of the programming languages of STEP 7, control with the user program which CPU data is
displayed at what time in the web browser of the viewer. Use AWP commands, which you
comment within the HTML files, to declare data to be used for intentional interaction between
the web application and the user program.
AWP commands are inserted as HTML comments with a special syntax into HTML files; they
declare the following features:
Read PLC tags
Write PLC tag
Read special tags
Write special tags
Define enum types
Assign tags to enum types
Defining fragments
Import fragments
See also
Reading tags (Page 864)
Writing tags (Page 867)
Special tags (Page 868)
Reading tags
User-defined web pages can read PLC tags.
The PLC tag must be specified by a PLC tag name.
These OUT variables (direction of output as viewed from the controller) are inserted at any
location within the HTML text with the syntax described in the following.
Syntax
:=<varname>:
These references are replaced when the Web server is in operation by the current values of
the PLC tag in each case.
<varname> can be a simple, global PLC tag but also a complete tag path to a structural
element.
If the PLC tag name contains the character : (colon) or \ (backslash), this character must
be designated with the escape sequence \: or \\ as standard character of the PLC tag name.
6HTXHQFH 6HTXHQFH
See also
AWP commands (Page 863)
Writing tags
Custom web pages can write data into the CPU.
This requires an AWP command that identifies the PLC tag to be written.
The PLC tag must also be specified by a PLC tag name.
The IN tags (direction of input as viewed from the controller) are placed on the browser page.
This can be done, for example, in a form.
The tags are either set in the HTTP header (by cookie or POST method) or in the URL (GET
method) by the browser and are then written by the Web server into the respective PLC tag.
Syntax
To allow the IN tags to be written to the CPU, the tags must first be defined by an explicit AWP
instruction:
<!-- AWP_In_Variable Name='<PLC_Varname1>' Name='<PLC_Varname2>'
Name='<PLC_Varname3>' -->
Several tags can be defined in an instruction - such as that shown above.
The specific PLC tag name is hereby written in double quotation marks; for example
<PLC_Varname1> = "myVar".
In cases where the name of the tag that you use for the web application is not identical to the
name of the PLC tag, the "Use" parameter can be used to assign to a PLC tag:
<!-- AWP_In_Variable Name=<Webapp_Varname> Use=<PLC_Varname>
Example
The "AWP_In_Variable" AWP command is indispensable when handling forms.
<form method='post' action='/awp/appl/x.html'>
<p>
<input name='"var1"' type='text'>
<input value='set' name='Button1' type='submit'>
</p>
</form>
In the form defined above, the HTTP request method "post" is used to transfer the tag "var1"
to the Web server. The user places the "var1" tag in the form field. The tag 'Button1' has the
value 'set', but is not required for the CPU. To allow the "var1" tag to be written to the CPU,
the following instruction must be included in the same fragment:
<!-- AWP_In_Variable Name='"var1"' -->
Since PLC tags are enclosed in double quotation marks ("), the name in the AWP command
must be enclosed in single quotation marks (') or in masked quotation marks (\"). To avoid the
numerous escape sequences, we recommend the use of single quotation marks.
<!-- AWP_In_Variable Name="Info".par1 -->
<!-- AWP_In_Variable Name="\"Info".par1\"" -->
The user must have rights to change tags. The Web server ignores the commands if the user
has no change rights.
This rules applies to all writing access to web pages on a CPU.
See also
Requirements for web access (Page 855)
AWP commands (Page 863)
Special tags
Special tags are mainly HTTP tags set in the definition of the World Wide Web Consortium
(W3C) . Special tags are also used for cookies and server tags.
The AWP command to read and write special tags differ only in that they have additional
parameters than the AWP command used to read and write normal tags.
Name Description
COOKIE_VALUE:name Value of cookie with name: "name"
COOKIE_EXPIRES:name Execution time of cookie with name: "name" in
seconds (must be set beforehand).
HEADER:Status HTTP status code (if no other value has been set,
status code 302 is returned).
HEADER:Location Path for forwarding to another page. Status code
302 must be set.
HEADER:Retry-After Anticipated time in which the service is not availa
ble. Status code 503 must be set.
HEADER: All other header tags can also be forwarded in this
way.
Use the AWP command "AWP_Out_Variable" to specify which PLC tags are to be transferred
in the HTTP header to the web browser.
Basic structure:
Parameter description
Name: Type and name of special tag
Use (optional parameter): In cases where the name of the special tag is not identical to the
name of the PLC tag, parameter "Use" can be used to assign to a PLC tag.
Example:
Name Description
HEADER:Accept-Language Accepted or preferred language
HEADER:Authorization Proof of authorization for a requested resource
HEADER:Host Host and port of the requested resource
HEADER:User-Agent Information on the browser
HEADER: All other header tags can also be forwarded in this
way
The AWP command "AWP_In_Variable" is used to define which special tags are to be
evaluated in the user program of the CPU.
Basic structure:
Parameter description:
Name: Type and name of special tag
Use (optional parameter): In cases where the name of the special tag is not identical to the
name of the PLC tag, the parameter Use can be used to assign to a PLC tag.
Examples:
The tag name in the HTTP header is replaced by the PLC tag name specified by Use . The
cookie is written to the PLC tag "info".language .
The tag name in the HTTP header is replaced by the PLC tag name specified by Use. The
cookie is written to the PLC tag "info".language .
See also
AWP commands (Page 863)
Enumeration types
Creating enums
Enter an AWP command using the following syntax at the start of the HTML file:
<!-- AWP_Enum_Def Name="<Name of the enum type>"
Values='0:"<Text_1>", 1:"<Text_2>", ... , x:"<Text_x>"' -->
For example, for German values to be saved as an HTML file in the "de" folder of the HTML
directory:
For example, for English values, to be saved as an HTML file in the "en" folder of the HTML
directory:
Assigning enums
Tags are assigned from the user program to the individual enum texts using a special AWP
command:
<VarName> is thereby the symbolic name from the user program and <EnumTypeName> is
the previously set name of the enum type.
Note
In each fragment in which enum texts are referenced by a PLC tag, this PLC tag must be
assigned by the appropriate AWP command of the enum type name.
Ensure that no AWP command for importing fragments is positioned between an enum
assignment and enum usage because this import can result in the enum assignment lying in
a different fragment than the enum usage.
Example
Enum type "state" is defined with values "0" and "1". "0" means "off", "1" means "on":
The following code is contained in the HTML code of the web page to be output:
Depending on the value of the "operating state" tag, the result displayed is no longer "0" or
"1", but "off" or "on".
Creating enums
<!-- AWP_Enum_Def Name="<Name des Enum Typs>" Values='0:"<Text_1>",
1:"<Text_2>", ... , x:"<Text_x>"' -->
Definition of fragments
Fragments
Fragments are "logical sections" of a web page to be processed by the CPU individually.
Fragments are usually complete pages but can also be individual elements such as files (for
example, images) or complete documents.
Defining fragments
The start of a fragment is specified by this command. A fragment runs to the start of the next
fragment or to the end of the file.
<Name> Indicates the name of the fragment.
The name must start with a letter [a-zA-Z] or an underscore ( _ ). Letters, underscores or
numbers [0-9] can follow after this first character.
<Type> Indicates the type of the fragment.
"manual" The user program is informed of the request for a fragment; the web page to
be returned can be changed by the user program.
"automatic" The page is automatically processed (default).
<id> A numeric ID can be stipulated for the fragment. If no ID is assigned, the fragment is
automatically assigned an ID. For manual pages (<Type>=manual) , the fragment can be
addressed in the user program of the CPU by this ID.
Note
Keep the ID low because the highest ID influences the size of the Web Control DB.
Importing fragments
You can declare a fragment in an HTML page and import this fragment into other web pages.
Example
A company logo is to be displayed on all web pages of a web application.
There is only one instance of the HTML code for the fragment that displays the company logo.
You can import the fragment as often and into as many HTML files as required.
Syntax
Example
HTML code within a web page that declares a fragment:
Example
HTML code within another web page that imports the declared fragment:
Requirement
All source files required for the web application (*.html, *.js, *.png, ...) have been created.
The source files are located in one folder, but only those source files that are required for
the web application. No other files may be located in this folder.
Note
Length of file names and tag names
If you have a comprehensive web application with many files and directories, the generation
of the web data blocks may possibly fail. If this happens, the generation is aborted with the
message "Text list overflow...". The cause is system-internal size limitations for management
information saved in the web data block.
Remedy: Use short file names and short tag names.
Procedure
To create data blocks from the source files for user-defined web pages in STEP 7, proceed
as follows:
1. Select the CPU, for example, in the device configuration.
2. Select the properties for user-defined web pages in the inspector window under "Properties
> General > Web server".
3. As "HTML source", select the folder that contains the source files for the web application.
4. Enter the HTMP page to be opened on starting the web application as the start HTML page.
Web Control DB
The Web Control DB (DB 333 by default) is created by STEP 7 and contains information on
the structure of user pages, the status of communication and any errors that occur.
Additional fragment DBs are also created as well as the Web Control DB. These fragment DBs
(there may also only be one fragment DB) are referenced in the Web Control DB. The fragment
DBs contain the web pages and media data coded in fragments, for example, images. The
content of the fragment DB cannot be changed by the user program. It is created automatically
and is only for data management.
The status and control tags of the Web Control DB are accessed via symbols.
The following lists the tags of the Web Control DB required for status evaluation and to control
interaction.
The Web Control DB provides two types of information:
Global status information: Not bound to a concrete web page request.
Request status and control information: Information about queued requests.
Last_error Description
1 Fragment DB is inconsistent (does not match the Web Control DB).
2 A web application already exists with this name.
3 Memory problem initializing in the web server.
4 Inconsistent data in the Web Control DB.
5 A fragment DB is not available (not loaded).
6 No AWP ID for a fragment DB.
7 The enum fragment is not available (contains the texts and information on the enum
types).
8 An action requested via the command flag in the Web Control DB is prohibited in the
current state.
9 Web application is not initialized (if there is no reinitializing after disabling).
10 Web server is disabled.
... Last_error is reset once the web application has been successfully initialized.
Example:
The tag for the DB is: "WEB-Control_DB". Whether errors have occurred during initialization
of the web application can be determined by requesting bit "WEB-
Control_DB".commandstate.error in the user program.
If an error has occurred you can analyze it using the "WEB-
Control_DB".commandstate.last_error value.
Fragment type
To react to the received data in the user program the "manual" fragment type must be used
for the fragment writing the data (for "manual pages"):
<!-- AWP_Start_Fragment Name="testfrag" ID="1" Type="manual" -->
The values are always transferred to the Web server of the CPU for automatic and manual
pages in the same way:
Example:
<form method="POST" action="">
<p>
<input type="submit" value="Set new value">
<input type="text" name='"Velocity"' size="20">
</p>
</form>
In cases where a request has been made, this program section writes the fragment ID in the
#frag_index tag and the request no. (value range 1-4) in the #req_index tag.
Using the information from this, the information transferred in the request can now be
processed separately for each fragment ID in the program (for example, plausibility check).
Once processing of the request has been completed by the program, the request must be
answered and the appropriate entry is once more reset under"requesttab" of the Web Control
DB (for example, DB 333).
A simple programming example for replying to requests:
Principle sequence of a browser request with interaction from the user program
The following figure shows the simplified, principle sequence of the web browser request on
the effects of Web Control DB content and the actions required from the user program until
the processed web page is returned (response).
5HVSRQVH
:HEEURZVHU
5HTXHVW
&38
3URFHVVUHTXHVW 3URFHVVUHVSRQVH
:HEVHUYHU
:HE&RQWURO'%
In addition to the other links in the navigation bar, the standard web pages also have a link to
"user pages".
Click on the "user pages" link to open the web browser you have configured as the default
HTML page.
Requirements
The language-dependent HTML; pages must be stored in a folder structure containing folders
with the respective language abbreviations:
Requirements
The HTML pages are contained in the predefined language folders, for example, HTML pages
with German text are in the "de" folder, HTML pages with English text are in the "en" folder.
function DoLocalLanguageChange(oSelect) {
SetLangCookie(oSelect.value);
top.window.location.reload();
}
function SetLangCookie(value) {
var strval = "siemens_automation_language=";
// this is the cookie by which the web server
// detects the desired language
// this name is required by the web server
strval = strval + value;
strval = strval + "; path=/ ;";
// set path to the application, since otherwise
// path would be set to the requesting page
// would not get the cookie.
// The path for user defined applications follows this
sample:
// path=/awp/<application name>/<pagename>
// example: path=/awp/myapp/myappstartpage.htm
//(where myapp is the name of the web application
// entered in the web server properties of the cpu)
/*
use expiration if this cookie should live longer
than the current browser session
var now = new Date();
var endttime = new Date(now.getTime() + expiration);
strval = strval + "; expires=" + endttime.toGMTString()
+ ";";
*/
document.cookie = strval;
}
Operating principle
With S7-1200 Firmware Version 4.1 or higher, the configuration control enables you to
configure the structure of a control system and to work with variants (options) that differ from
this configuration.
All modules that are needed in a set of similar plant units or machines are configured in a
master project with a maximum configuration (station master).
Provision is made in the user program of the master project for various station options for
various plant units or machines as well as the selection of a station option. A station option
uses, for example, only some of the configured modules and these modules are inserted
in varying order.
An operator selects a station option for a specific plant on-site. The operator does not have
to modify the project and thus also does not have to download a modified configuration for
this.
6WDWLRQPDVWHU
6WDWLRQRSWLRQ
6WDWLRQRSWLRQ 6WDWLRQRSWLRQ
A control data record you have programmed in the startup program notifies the CPU as to
which modules are missing or located in different slots as compared to the preset configuration.
The configuration control has no effect on the parameter assignment of the modules.
Configuration control gives you the flexibility to vary the central installation as long as the real
configuration can be derived from a preset maximum configuration.
Below you will find a description of how to activate configuration control (CPU parameter
assignment) and how to structure the required data record.
Requirement
STEP 7 Version V13 SP1 or higher
CPU S7-12XX Firmware Version V4.1 or higher Modules that support the "Configuration
control" function also have the "Configuration control" entry in the description (info text) of
the hardware catalog.
Recommendation: Before you load a new program with a modified control data record,
perform a memory reset. This action will prevent inconsistent states that may result from
the presence of incompatible control data records.
The startup parameter "Compare preset to actual configuration" is set to "Startup CPU even
if mismatch" (default setting).
Required steps
1. Enable the "Allow to reconfigure the device via the user program" parameter when
configuring the CPU ("Configuration control" area).
2. Create a control data record (e.g., in a data block) according to the current configuration
based on the sample described below for the control data record. The control data record
has the number 196. If you want to transfer the control data record as a whole block to the
WRREC instruction (input parameter RECORD), note that you must first create a PLC data
type containing the structure of the control data record and base the data block on this PLC
data type.
3. Transfer the control data record to the CPU in the startup program.
The configuration control for the centrally inserted modules takes effect only after an
operating mode change of the CPU from STOP to RUN. For this reason, call the extended
WRREC (Write data record) instruction in the startup OB, and transfer the created control
data record to the CPU; see next section.
If a valid control data record is not transferred in the startup OB, the control is not ready for
operation. The CPU returns from startup to STOP in this case.
REPEAT
"WRREC_DB"(REQ := "start_config_control",
ID := 33,
INDEX := 196,
LEN := "conf_LEN",
DONE => "conf_DONE",
BUSY => "conf_BUSY",
ERROR => "conf_ERROR",
RECORD := "ConfDB",
STATUS => "conf_STATUS");
UNTIL NOT "conf_BUSY"
END_REPEAT;
Below, you will find explanations for individual block parameters that you must supply with
specific values in the configuration control context. For the remaining block parameters, see
also WRREC (Page 3071):
Parameter Explanation
ID HW identifier; is always 33 (decimal) for configuration control for centrally arranged
modules.
INDEX Data record number; is always 196 (decimal) for configuration control for centrally ar
ranged modules.
RECORD Control data record to be transferred.
See the section "Control data record" for the structure of the control data record.
Tip: The "RECORD" block parameter of the WRREC instruction (V1.1 and higher) is of
the "VARIANT" data type and therefore requires a tag with data type. If you store the
control data record in a data block, this data block must thus have a data type. The data
block created must not be of the "Global-DB" type. Rather, it must be derived from a
user data type.
Proceed as follows:
1. First, create a new PLC data type (user data type) with the structure of the control
data record and name it, for example, "ConfDB".
2. Create a new data block. Select the newly created user data type, e.g., "ConfDB",
as the type for this data block.
In graphical programming languages, you realize the loop using instructions for program
control.
Example in FBD: Use the LABEL (jump label) and JMP (jump at RLO=1) instructions to
program a loop.
The byte numbers represent the configured slots in ascending order (see above):
Byte 4 stands for the configured slot of the expansion board
Byte 5 to byte 9 stand for the configured slots 2 to 9
Byte 13 to byte 15 stand for the configured slots 101 to 103
Which value you must enter in the respective byte results from the following rule:
If the module is present in the real configuration, enter the real slot number of the module.
Example 1: The module configured in slot 2 is located in slot 2.
Enter value 2 (= actual slot) in byte 5 (= configured slot 2).
Example 2: The module configured in slot 3 is located in slot 2.
Enter value 2 (= actual slot) in byte 6 (= configured slot 3).
If the module is configured but is missing in the real structure, enter 0 in the byte for the
configured slot.
If a module is not located in this slot in the hardware configuration, enter 16#FF (255) in
the byte for the configured slot.
Rules
Observe the following rules:
The configuration control does not support the repositioning of communications modules.
The slot entries in the control data record for slots 101 to 103 must correspond to the real
positions of the modules or be defined as not present in the hardware configuration by
entering 16#FF (255).
Slot gaps in the configuration are not allowed. For example, if a signal module is inserted
in slot 4 in the real configuration, slots 2 and 3 of the real configuration must also be
occupied. The same applies to slots 101 to 103. If a communication module is inserted in
slot 102 in the real configuration, slot 101 must also have a communication module inserted
in the real configuration.
If you have enabled configuration control, the CPU is not ready for operation without a
control data record. The CPU returns from startup to STOP if a valid control data record is
not transferred in the startup OB. The central I/O is not initialized in this case. The cause
for the STOP mode is entered in the diagnostics buffer.
For addressing the WRREC instruction, use the HW identifier 33 (decimal, for the ID block
parameter) to write the control data record.
The control data record is saved retentively in the CPU, which means that it is not necessary
to write the control data record 196 again at a restart if the configuration is unchanged. Prior
to commissioning, we recommend that a memory reset be performed for the CPU in order
to delete any control data record that is present.
Slot entries in the control data record outside the configured preset configuration are
ignored by the CPU.
Each real slot may only be present once in the control data record.
A real slot may only be assigned to one configured slot.
Note
Modified configuration
The writing of a control data record with a modified configuration triggers the following
automatic reaction by the CPU:
Memory reset with subsequent startup with this modified configuration.
As a result of this reaction, the retentively saved original data record 196 is deleted and the
new data record 196 is saved retentively.
Error messages
The following error messages are returned if an error occurs during writing of the control data
record:
See also
VARIANT (Page 1951)
S7-1200 System Manual (http://support.automation.siemens.com/WW/view/en/89851659)
Additional configurations
See also
Overview of point-to-point communication (Page 1197)
General information on high-speed counters (Page 1193)
Configuring PID_Compact V1 (Page 7243)
Configuring PID_3Step V1 (Page 7276)
Motion functionality of the CPU S7-1200 (Page 7330)
S7-1200 CM/CP
Telecontrol S7-1200
Changing the project number or station number for the entire STEP 7 project
If you change the project number or the station number in the "CP identification" parameter
group for a telecontrol CP, this parameter is changed for all CPs in the STEP 7 project.
Download to device
Only use the "Download to device" function with the mobile wireless CP via a TeleService
connection as follows:
1. Select the CP in STEP 7.
2. Select the "Online" > "Download to device" menu.
3. In the "Extended download" dialog that appears, select the TeleService interface.
4. Download the project data from the "Extended download" dialog.
Modes of the CP
The CP 12427 allows an S71200 to communicate as a GPRS station with a central station
or other remote networks via the GSM network. For communication using GPRS, the CP is
set to one of the following operating modes:
Telecontrol
This operating mode of the CP allows the GPRS station to exchange data with the following
partners:
Communication with the Telecontrol server
This CP mode allows the GPRS station to exchange data with a telecontrol server.
The Telecontrol server is a PC connected to the Internet with the "TCSB" application. It
is generally located in the master station and serves to monitor and control the remote
GPRS stations. Data can be exchanged with the OPC client of a central control system
via the integrated OPC interface.
The Telecontrol server PC is not configured in STEP 7. The "TCSB" application has its
own configuration user interface.
Communication with another remote GPRS station
The message frames are transmitted via the Telecontrol server.
Communication with an engineering station (for TeleService)
Communication with the Telecontrol server is performed via the GSM network and the
Internet.
This operating mode requires a SIM card with GPRS service enabled and a Telecontrol
server that can be reached by the CP.
GPRS direct
This operating mode of the CP is used for direct communication between remote stations
via the GSM network. No Telecontrol server is required.
To allow network nodes in public wireless networks to be directly accessible, these need
to be addressed using a fixed address. Here, SIM cards with a fixed IP address are used
that allow the stations to address each other directly.
The possible communications services and security functions (for example VPN) depend
on what is offered by the network provider.
Possible communications partners of the station with a CP 12427 in "GPRS direct" mode
are:
A node that can be reached by the CP via an IP address (S7 station with CP 12427)
An engineering station (for TeleService)
See also
Connection establishment with a CP 1242-7 (Page 899)
Connection modes
"GPRS direct" mode
There are no different connection modes in the "GPRS direct" mode.
"Telecontrol" mode
The CP can be configured for the following connection modes.
"Permanent" connection mode
There is a permanent TCP connection to the telecontrol server. Following connection
establishment, there is a permanent TCP connection to the telecontrol server even if
data is not transferred permanently.
"Temporary" connection mode
A connection is only established to the telecontrol server when required.
If a TCP connection is established, process data is sent as soon as the telecontrol instructions
are called on the CPU.
A connection is always established by the CP. If a connection established by the CP is
interrupted, the CP automatically attempts to re-establish the connection.
Note
"Authorized phone numbers" in the STEP 7 project
A phone number entered here gives the sender who transfers this phone number the right
to trigger connection establishment.
If an asterisk (*) is entered in the list, the CP accepts SMS messages from all senders.
If the list is empty, the CP cannot be woken up for connection establishment.
Wake-up SMS
Depending on the connection type and the triggering server or intermediary TeleService
server, the following text must be transferred in the wake-up SMS:
For telecontrol connections:
Text for the wake-up SMS message for establishing a connection to the telecontrol
server:
TELECONTROL
Text for the wake-up SMS message for establishing a connection to the main telecontrol
server:
TELECONTROL MAIN
Text for the wake-up SMS message for establishing a connection to the substitute
telecontrol server:
TELECONTROL BACKUP
The configuration of the telecontrol server for the GPRS CP is set in STEP 7 in "Telecontrol
interface > Operating mode > main or substitute telecontrol server".
Note
Wake-up with a mobile phone
One of the texts listed above can be used in a wake-up SMS message.
With a wake-up call, the station always connects to the main telecontrol server.
Reconnection delay
If a second telecontrol server or a second router of the telecontrol server is configured, the CP
attempts to connect to the second partner at the 4th attempt. If the second partner is also
unreachable, the 7th time the CP attempts to connect to the first partner again and so on.
Note
If the partner cannot be reached, connection establishment via the mobile wireless network
can take several minutes. This may depend on the particular network and current network load.
Depending on your contract, costs may result from each connection establishment attempt.
Datapoint types
During the configuration of the user data to be transferred by the CP, each data point is
assigned a protocol-specific data point type. The data point types supported by the CP along
with the compatible S7 data types are listed below. They are grouped according to format
(memory requirements).
The direction relates to the direction of transfer (monitoring direction = "in", control direction =
"out").
CP 12431, CP 12427 GPRS V2, CP 12437 LTE(EU/USA): Supported data point types
Table 10-67 Supported data point types and compatible S7 data types
Format (memory require Data point type S7 data types Operand area
ments)
Bit Digital input BOOL I, Q, M, DB
Digital output BOOL I, Q, M, DB
Command output (CP 12431 BOOL I, Q, M, DB
only)
Byte Digital input BYTE, CHAR I, Q, M, DB
Digital output BYTE, CHAR I, Q, M, DB
Integer with sign (16 bits) Analog input INT I, Q, M, DB
Analog output INT I, Q, M, DB
Counter (16 bits) Counter input WORD I, Q, M, DB
Integer with sign (32 bits) Analog input DINT I, Q, M, DB
Analog output DINT I, Q, M, DB
Counter (32 bits) Counter input DWORD, UDINT I, Q, M, DB
Floating-point number Analog input REAL Q, M, DB
with sign (32 bits) Analog output REAL Q, M, DB
Floating-point number Analog input LREAL Q, M, DB
with sign (64 bits) Analog output LREAL Q, M, DB
Block of data Data ARRAY 1) DB
(1 .. 64 bytes) Data ARRAY 1)
DB
1)
For the possible formats of the ARRAY data type, refer to the following section.
Table 10-68 Supported data point types, DNP3 object groups, variants and compatible S7 data types
Format (memory re Data point type DNP3 object group Direction S7 data types Operand area
quirements) [variations]
Bit Binary Input 1 [1, 2] in BOOL I, Q, M
Binary Input Event 2 [1, 2] in BOOL I, Q, M
Binary Output 1)
10 [2] out
Binary Output Event 1)
11 [1, 2] out
Binary Command 12 [1] out BOOL I, Q, M
Integer (16 bits) Counter Static 20 [2] in UINT, WORD I, Q, M
Frozen Counter 2)
21 [2, 6] in
Counter Event 22 [2, 6] in UINT, WORD I, Q, M
Frozen Counter Event 3)
23 [2, 6] in
Analog Input 30 [1] in INT I, Q, M
Analog Input Event 32 [2, 4] in INT I, Q, M
Analog Output Status 4)
40 [2] out
Analog Output 41 [2] out INT I, Q, M
Analog Output Event 4)
42 [2, 4] out
Integer (32 bits) Counter Static 20 [1] in UDINT, I, Q, M
DWORD
Frozen Counter 2)
21 [1, 5] in
Counter Event 22 [1, 5] in UDINT, I, Q, M
DWORD
Frozen Counter Event 3)
23 [1, 5] in
Analog Input 30 [2] in DINT I, Q, M
Analog Input Event 32 [1, 3] in DINT I, Q, M
Analog Output Status 4)
40 [1, 3] out
Analog Output 41 [1] out DINT I, Q, M
Analog Output Event 4)
42 [1] out
Floating-point num Analog Input 30 [5] in REAL Q, M
ber (32 bits) Analog Input Event 32 [5, 7] in REAL Q, M
Analog Output Status 4)
40 [3] out
Analog Output 41 [3] out REAL Q, M
Analog Output Event 4)
42 [5, 7] out
Floating-point num Analog Input 30 [6] in LREAL Q, M
ber (64 bits) Analog Input Event 32 [6, 8] in LREAL Q, M
Analog Output 41 [4] out LREAL Q, M
Analog Output Event 4)
42 [6, 8] out
Format (memory re Data point type DNP3 object group Direction S7 data types Operand area
quirements) [variations]
Block of data (1...64 Octet String 110 [ ] in 5)
I, Q, M
bytes) 5) Octet String Event 5)
111 [ ] in 5)
I, Q, M
1)
This object group can be configured in the Data point editor of STEP 7 using object group 12.
2)
This object group can be configured in the Data point editor of STEP 7 using object group 20.
3)
This object group can be configured in the Data point editor of STEP 7 using object group 22.
4)
This object group can be configured in the Data point editor of STEP 7 using object group 41.
5)
With these data point types, contiguous memory areas up to a size of 64 bytes can be transferred. All S7 data types with a
size between 1 and 64 bytes are compatible. If the array is modified later, the data point must be recreated.
Table 10-69 Supported data point types, IEC types and compatible S7 data types
Format (memory Data point type IEC type Direction S7 data types Operand area
requirements)
Bit Single point information <1> in BOOL I, Q, M
Single point information with time tag <30> in BOOL I, Q, M
Single command <45> out BOOL I, Q, M
Byte Step position information <5> in BYTE I, Q, M
Step position information with time tag <32> in BYTE I, Q, M
Integer (16 bits) Measured value, normalized value <9> in INT I, Q, M
Measured value, normalized value <34> in INT I, Q, M
with time tag
Measured value, scaled value <11> in INT I, Q, M
Measured value, scaled value with <35> in INT I, Q, M
time tag
Set point command, normalised value <48> out INT I, Q, M
Set point command, scaled value <49> out INT I, Q, M
Format (memory Data point type IEC type Direction S7 data types Operand area
requirements)
Integer (32 bits) Bitstring of 32 bits <7> in DWORD, I, Q, M
UDINT
Bitstring of 32 bits with time tag <33> in DWORD, I, Q, M
UDINT
Integrated totals <15> in DWORD, I, Q, M
UDINT
Integrated totals with time tag <37> in DWORD, I, Q, M
UDINT
Floating-point num Measured value, short floating point <13> in REAL Q, M
ber (32 bits) number
Measured value, short floating point <36> in REAL Q, M
number with time tag
Set point command, short floating <50> out REAL Q, M
point number
Block of data Bitstring of 32 bits 1)
<7> in 1)
I, Q, M
(1...32 Bit) 1) Bitstring of 32 bits with time tag 1)
<33> in 1)
I, Q, M
Bitstring of 32 bits 1)
<51> out 1)
I, Q, M
1)
With these data point types, contiguous memory areas up to a size of 32 bits can be transferred. All S7 data types with a
size between 1 and 32 bits are compatible. If the array is modified later, the data point must be recreated.
Storage of values
The values of all data points are stored in the image memory of the CP. Values in the image
memory are transferred only after being called by TCSB (CP 12431, CP 12427 GPRS V2,
CP 12437 LTE) or the master (CP 12431 DNP3 / CP 12431 IEC).
Events are also stored in the send buffer and can be transferred unsolicited.
The capacity of the send buffer is divided up equally for all enabled partners.
If the connection to a communications partner is interrupted, the individual values of the events
are retained in the buffer. When the connection returns, the buffered values are sent. The
frame memory operates chronologically; in other words, the oldest frames are sent first (FIFO
principle).
If a frame was transferred to the communications partner, the transferred values are deleted
from the send buffer.
If frames cannot be transferred for a longer period of time and the send buffer is threatening
to overflow, the response is as follows:
CP 12431 / CP 12427 GPRS V2 / CP 12437 LTE
The forced image mode
If the send buffer reaches a fill level of 80%, the CP changes to the forced image mode.
New values from data points configured as an event are no longer added to the send buffer
but rather they overwrite older existing values in the image memory.
When the connection to the communications partner returns, the CP changes back to the
send buffer mode if the fill level of the send buffer has fallen below 50%.
CP 12431 DNP3 / CP 12431 IEC
If a send buffer fill level of 100% is reached, the oldest values are overwritten.
Type of transmission
Depending on your CP type, you have the following transmission types available:
Transfer after call
The current value of the data point is entered in the image memory of the CP. A new value
overwrites the older value in the image memory. After being called by the communications
partner, the current value at the time is transferred.
Event class ...
The value is entered in the send buffer as an event and transferred unsolicited to the
communications partner.
The configurable event classes of the various CPs are described in the following sections.
Trigger
Various trigger types are available for starting event-driven transfer:
Threshold value trigger
The value of the data point is transferred when this reaches a certain threshold. The
threshold is calculated as the difference compared with the last stored value, refer to the
section Threshold value trigger (Page 912).
Time trigger
The value of the data point is transferred at configurable intervals or at a specific time of
day.
Event trigger
The value of the data point is transferred when a configurable trigger signal is fired. For the
trigger signal, the edge change (0 1) of a trigger tag is evaluated that is set by the user
program. When necessary, a separate trigger tag can be configured for each data point.
Resetting the trigger tag in the bit memory area / DB:
If the memory area of the trigger tag is in the bit memory or in a data block, the trigger tag
is reset to zero when the data point value is transferred.
You specify whether the value of a data point is transferred to the communications partner
immediately after the trigger fires or after a delay in the "Transmission mode" parameter.
Transmission mode
The transmission mode of a frame is set in the "Trigger" tab of the data point. With the two
options, you specify whether frames of events are sent immediately or following a delay:
Spontaneous
The value is transferred immediately.
Conditional spontaneous
The value is transferred only when one of the two following conditions is fulfilled:
The communications partner queries the station.
The value of another event with the transmission mode "Unsolicited" is transferred.
Status identifiers
The status identifiers of the data points listed in the following tables are transferred along with
the value in each frame to the communications partner. They can be evaluated by the
communications partner.
Depending on the CP type, the CP sets different status identifiers for each data point. They
are transferred in 1 or 2 bytes.
The meaning of the individual status bits relates to the value of the bit in the "Bit status" row
in the tables.
Bit 7 6 5 4 3 2 1 0
Flag name NON_ Substituted LOCAL_ CARRY OVER_ RESTART ONLINE
EXISTENT FORCED RANGE
Meaning Data point Substitute Local opera Counted Limit value Value not Value is in
does not ex value tor control value over of the ana updated af valid
ist or S7 ad flow before log prepro ter start
dress un reading the cessing
reachable value overshot /
undershot
Bit status (always 1 1 1 1 1 1 1
0)
CP 12431 DNP3
The status identifiers are transferred in 1 byte.
Bit 7 6 5 4 3 2 1 0
Flag name LOCAL_ DISCONTI OVER_ RESTART ONLINE
FORCED NUITY RANGE
Meaning Local opera Counted val Limit value of Value not up Value is inva
tor control ue overflow the analog dated after lid
before read preprocess start
ing the value ing overshot /
undershot
Bit status (always (always (always 1 1 1 1 1
0) 0) 0)
CP 12431 IEC
The status identifiers are transferred in 1 byte.
Bit 7 6 5 4 3 2 1 0
Flag name SB CY OV NT IV
substituted carry overflow not topical invalid
Meaning Substitute Counted val Value range Value not up Value is inva
value ue overflow exceeded, dated lid
before read analog value
ing the value
Bit status (always (always 1 (always 1 1 1 0
0) 0) 0)
Configuration of the data point index (CP 12431 / CP 12437 LTE / CP 12427 GPRS V2)
Within a CP, the indexes of the data point classes must comply with the following rules:
Input
The index of a data point of the type input must be unique throughout all data point types
(digital inputs, analog inputs etc.).
Output
A data point of the type output can have the same index as a data point of the type input.
Several data points of the type output can have the same index.
Note
Data points for the inter-station communication with a CP in another S7 station
Note that for inter-station communication, the indexes of the two corresponding data points
(data point pair) must be identical for the sending and receiving CP.
In the integration threshold value calculation, it is not the absolute value of the deviation of the
process value from the last stored value that is evaluated but rather the amount of the
integrated deviation.
Table 10-73 Example of the integration calculation of a threshold value configured with 2.0
Time [s] Process value Current process Absolute deviation Integrated deviation
(calculation cycle) stored in the value from the stored val
send buffer ue
0 20,0 20,0 0 0
0,5 20,3 +0,3 0,3
1,0 19,8 -0,2 0,1
1,5 20,2 +0,2 0,3
2,0 20,5 +0,5 0,8
2,5 20,3 +0,3 1,1
3,0 20,4 +0,4 1,5
3,5 20,5 20,5 +0,5 2,0
4,0 20,4 -0,1 -0,1
4,5 20,1 -0,4 -0,5
5,0 19,9 -0,6 -1,1
5,5 20,1 -0,4 -1,5
6,0 19,9 19,9 -0,6 -2,1
In this example, a value of 2.0 was configured for the threshold value trigger.
With the changes in the process value shown in the example, the threshold value trigger fires
twice, if the value 2.0 is reached:
At the time 3.5 s: The value of the integrated deviation is at 2.0. The new process value
stored in the send buffer is 20.5.
At the time 6.0 s: The value of the integrated deviation is at 2.1. The new process value
stored in the send buffer is 19.9.
In this example, if a deviation of the process value of approximately 0.5 should fire the trigger,
then with the behavior of the process value shown here a threshold value of approximately
1.5 ... 2.5 would need to be configured.
Note
Threshold value trigger: Calculation only after "Analog value preprocessing"
Note that the analog value preprocessing is performed before the check for a configured
threshold value.
This affects the value that is configured for the threshold value trigger.
Restricted preprocessing options if mean value generation is configured
If you configure mean value generation for an analog value event, the following preprocessing
options are not available:
Unipolar transfer
Fault suppression time
Smoothing
No Threshold value trigger if Mean value generation is configured
If mean value generation is configured, no threshold value trigger can be configured for the
analog value event involved.
Analog inputs that are configured as an event are processed on the CP in the following
sequence:
Unipolar transfer
With unipolar transfer, negative values are corrected to zero. This can be desirable if values
from the underrange should not be transferred as real measured values.
Exception: The value -32768 / 8000h for wire break of live zero inputs is transferred.
Unipolar transfer cannot be configured at the same time as mean value generation.
Note
Fault suppression time > 0 configured
If you have configured an error suppression time and then enable mean value generation, the
value of the error suppression time is grayed out but no longer used. If mean value generation
is enabled, the error suppression time is set to 0 (zero) internally.
Smoothing factor
Analog values that fluctuate quickly can be evened out using the smoothing function.
The smoothing factors are calculated according to the following formula as with S7 analog
input modules.
xn + ( k 1) yn 1
yn =
k
where
yn = smoothed value in the current cycle
The "OVER_RANGE" bit of the status identifier of the data point is set as follows when the
relevant analog value is transferred:
Limit value 'high':
If the limit value is exceeded: OVER_RANGE = 1
If the value falls below the limit value: OVER_RANGE = 0
Limit value 'low':
If the value falls below the limit value : OVER_RANGE = 1
If the value then exceeds the limit value: OVER_RANGE = 0
Division Raw value of the of PLC tags * Module output [mA] Measuring
Decimal Hexadeci 0 20 -20 +20 4 20 range [%]
mal (unipolar) (bipolar) (life zero)
16 bits 32 bits 16 bits
Overflow 32767 2147483647 7FFF > 23.515 > 23.515 > 22.810 > 117.593
Overrange 32511 2130769779 7EFF 23.515 23.515 22.810 117.593
... ... ... ... ... ... ...
27649 1812067105 6C01 20.001 20.001 20.001 100.004
Nominal range 27648 1811994624 6C00 20 20 100
(unipolar / life zero) ... ... ... ... ... ...
0 0 0000 0 4 0
Nominal range (bipo 27648 1811994624 6C00 20 100
lar) ... ... ... ... ...
0 0 0000 0 0
... ... .... ... ...
-27648 -1811994625 9400 -20 -100
Underrange -1 -1 FFFF -0.001 3.999 -0.004
(unipolar / life zero) ... ... ... ... ... ...
-4864 -318729855 ED00 -3.518 1.185 -17.59
Division Raw value of the of PLC tags * Module output [mA] Measuring
Decimal Hexadeci 0 20 -20 +20 4 20 range [%]
mal (unipolar) (bipolar) (life zero)
16 bits 32 bits 16 bits
* The raw values of the measured values relate to the values of 16-bit or 32-bit PLC tags.
Note
Evaluation of the value even when the option is disabled
If you enable one or both options and configure a value and then disable the option later, the
grayed out value is nevertheless evaluated.
To disable the two options, delete the previously configured values limit values from the input
boxes and then disable the relevant option.
Status Meaning
0000 Transfer completed free of errors
8001 Error in the transfer, possible causes:
SIM card invalid.
No network
Wrong destination phone number (number not reachable)
Table 10-75 E-mails: Meaning of the processing status output in hexadecimal format
Status Meaning
0000 Transfer completed free of errors
82xx Other error message from the e-mail server
Apart from the leading "8", the status corresponds to the three-digit error number of the SMTP
protocol.
8401 No channel available
Possible cause: There is already an e-mail connection via the CP. A second connection
cannot be set up at the same time.
8403 No TCP/IP connection could be established to the SMTP server.
8405 The SMTP server has denied the login request.
8406 An internal SSL error or a problem with the structure of the certificate was detected by the
SMTP client.
8407 Request to use SSL was denied.
8408 The client could not obtain a socket for creating a TCP/IP connection to the mail server.
8409 It is not possible to write via the connection. Possible cause: The communications partner
reset the connection or the connection aborted.
8410 It is not possible to read via the connection. Possible cause: The communications partner
terminated the connection or the connection was aborted.
8411 Sending the e-mail failed. Cause: There was not enough memory space for sending.
8412 The configured DNS server could not resolve specified domain name.
8413 Due to an internal error in the DNS subsystem, the domain name could not be resolved.
8414 An empty character string was specified as the domain name.
8415 An internal error occurred in the cURL module. Execution was aborted.
8416 An internal error occurred in the SMTP module. Execution was aborted.
8417 Requests to SMTP on a channel already being used or invalid channel ID. Execution was
aborted.
8418 Sending the e-mail was aborted. Possible cause: Execution time exceeded.
8419 The channel was interrupted and cannot be used before the connection is terminated.
8420 Certificate chain from the server could not be verified with the root certificate of the CP.
8421 Internal error occurred. Execution was stopped.
8450 Action not executed: Mailbox not available / unreachable. Try again later.
84xx Other error message from the e-mail server
Apart from the leading "8", the status corresponds to the three-digit error number of the SMTP
protocol.
8500 Syntax error: Command unknown.
This also includes the error of having a command chain that is too long. The cause may be
that the e-mail server does not support the LOGIN authentication method.
Try sending e-mails without authentication (no user name).
8501 Syntax error. Check the following configuration data:
Message configuration > Message parameters:
Recipient address ("To" or "Cc").
8502 Syntax error. Check the following configuration data:
Message configuration > Message parameters:
Email address (sender)
Status Meaning
8535 SMTP authentication incomplete. Check the "User name" and "Password" parameters in the
CP configuration.
8550 SMTP server cannot be reached. You have no access rights. Check the following configura
tion data:
CP configuration > E-mail configuration:
User name
Password
Email address (sender)
Message configuration > Message parameters:
Recipient address ("To" or "Cc").
8554 Transfer failed
85xx Other error message from the e-mail server
Apart from the leading "8", the status corresponds to the three-digit error number of the SMTP
protocol.
Time-of-day synchronization
NTP mode
In NTP mode, the CP sends time-of-day queries at regular intervals to one or more NTP
servers. From the responses of the servers, the CP selects the most accurate time of day.
The advantage of this mode is that it allows the time to be synchronized across subnets.
In NTP mode, it is generally UTC (Universal Time Coordinated) that is transferred. This
corresponds to GMT (Greenwich Mean Time).
NTP - configuration
5. Click on the "Connect" icon next to the "PG/PC interface" drop-down list.
The "Establish remote connection" dialog box opens.
6. Make the necessary settings in the "Establish remote connection" dialog.
Details of this are contained in the tooltip cascade of STEP 7.
The following details are required to successfully establish a connection:
Status
Authentication at S7 station
The S7 station has established an IP connection with the engineering station via GPRS
and Internet and is checking the received logon and authentication data.
Connected
The station has successfully established the connection to the engineering station.
Configuring SCALANCE X / W / M
Legal notice
Qualified personnel
The product/system belonging to this documentation may only be handled by qualified
personnel for the intended purpose taking into account the documentation relating to the
intended purpose and, in particular, the safety and warning notices it contains. Due to training
and experience, qualified personnel is capable of recognizing risks and avoiding possible
dangers when handling these products/systems.
Configuring SCALANCE X
Useful information
VLAN
See also
General (Page 1012)
GVRP (Page 1014)
Port-based VLAN (Page 1015)
Protocol-based VLAN group (Page 1016)
Protocol-based VLAN port (Page 1017)
IPv4 subnet-based VLAN (Page 1017)
VLAN tagging
Note
The VLAN tag increases the permitted total length of the frame from 1518 to 1522 bytes. With
the IE switches, the standard MTU size is 1536 bytes. The MTU size can be changed to values
from 64 to 9216 bytes.
The end nodes on the networks must be checked to find out whether they can process this
length / this frame type. If this is not the case, only frames of the standard length may be sent
to these nodes.
The additional 4 bytes are located in the header of the Ethernet frame between the source
address and the Ethernet type / length field:
[
The additional bytes contain the tag protocol identifier (TPID) and the tag control information
(TCI).
The prioritization of the data packets is possible only if there is a queue in the components in
which they can buffer data packets with lower priority.
The device has eight parallel queues in which the frames with different priorities can be
processed. First, the frames with the highest priority ("Strict Priority" method) are processed.
This method ensures that the frames with the highest priority are sent even if there is heavy
data traffic.
Value Meaning
0 The format of the MAC address is canonical. In the canonical representation of the MAC
address, the least significant bit is transferred first. Standard-setting for Ethernet switches.
1 The format of the MAC address is not canonical.
VLAN ID
In the 12-bit data field, up to 4096 VLAN IDs can be formed. The following conventions apply:
VLAN ID Meaning
0 The frame contains only priority information (priority tagged frames) and no valid
VLAN identifier.
1 - 4094 Valid VLAN identifier, the frame is assigned to a VLAN and can also include priority
information.
4095 Reserved
SNMP
Introduction
With the aid of the Simple Network Management Protocol (SNMP), you monitor and control
network elements from a central station, for example routers or switches. SNMP controls the
communication between the monitored devices and the monitoring station.
Tasks of SNMP:
Monitoring of network components
Remote control and remote parameter assignment of network components
Error detection and error notification
In versions v1 and v2c, SNMP has no security mechanisms. Each user in the network can
access data and also change parameter assignments using suitable software.
For the simple control of access rights without security aspects, community strings are used.
The community string is transferred along with the query. If the community string is correct,
the SNMP agent responds and sends the requested data. If the community string is not correct,
the SNMP agent discards the query. Define different community strings for read and write
permissions. The community strings are transferred in plain text.
SNMPv3
Compared with the previous versions SNMPv1 and SNMPv2. SNMPv3 introduces an
extensive security concept.
SNMPv3 supports:
Fully encrypted user authentication
Encryption of the entire data traffic
Access control of the MIB objects at the user/group level
Spanning Tree
By directly linking the devices, a status change (reconfiguration of the ports) can be made
without any delays.
Alternate port (substitute for the root port)
A substitute for the root port is configured. If the connection to the root bridge is lost, the
device can establish a connection over the alternate port without any delay due to
reconfiguration.
Reaction to events
Rapid spanning tree reacts to events, for example an aborted connection, without delay.
There is no waiting for timers as in spanning tree.
Counter for the maximum bridge hops
The number of bridge hops a package is allowed to make before it automatically becomes
invalid.
In principle, therefore with rapid spanning tree, alternatives for many parameters are
preconfigured and certain properties of the network structure taken into account to reduce
the reconfiguration time.
Note
Default setting
HTTP is enabled as default on the device.
Routing function
Introduction
The term routing describes the specification of routes for communication between different
networks; in other words, how does a data packet from subnet A get to subnet B.
SCALANCE X supports the following routing functions:
Static routing
With static routing, the routes are entered manually in the routing table.
Router redundancy
With standardized VRRP (Virtual Router Redundancy Protocol), the availability of important
gateways is increased by redundant routers.
Dynamic routing
The entries in the routing table are dynamic and are updated continuously. The entries are
created with one of the following dynamic routing protocols:
OSPFv2
RIPv2
Static routing
The route is entered manually in the routing table. Enter the route in the routing table on the
"Layer 3 > Routes" page.
OSPFv2
Areas in OSPF
The following areas exist:
Backbone
The backbone area is area 0.0.0.0. All other areas are connected to this area. The backbone
area is connected either directly or via virtual connections with other areas.
All routing information is available in the backbone area. As a result, the backbone area is
responsible for forwarding information between different areas.
Stub Area
This area contains the routes within its area within the autonomous system and the standard
route out of the autonomous system. The destinations outside this autonomous system are
assigned to the standard route.
Totally Stubby Area
This area knows only the routes within its area and the standard route out of the area.
Not So Stubby Area (NSSA)
This area can forward (redistribute) packets from other autonomous systems into the areas
of its own autonomous system. The packets are further distributed by the NSSA router.
Routers of OSPF
OSPF distinguishes the following router types:
Internal router (IR)
All OSPF interfaces of the router are assigned to the same area.
Area Border Router (ABR)
The OSPF interfaces of the router are assigned to different areas. One OSPF interface is
assigned to the backbone area. Where possible, routes are grouped together.
Backbone Router (BR)
At least one of the OSPF interfaces is assigned to the backbone area.
Autonomous System Area Border Router (ASBR)
One interface of the router is connected to a different AS, for example an AS that uses the
routing protocol RIP.
Virtual connection
Each area must be connected to the backbone area. In some situations a direct physical
connection is not possible. In this case, a router of the relevant area must be connected to a
backbone router via a virtual connection.
LSA types
Within the autonomous system, packets are exchanged that contain information about the
connections of a router and the connection status message. The packets are also known as
LSAs (Link State Advertisements). The LSAs are always sent from the router to the neighbor
router.
If there are changes in the network, LSAs are sent to all routers in the network. The information
depends on the LSA type.
166$
$6%5
166$
$UHD
$%5
%DFNERQH
$UHD 6WXE$UHD ,5
6WXE$UHD
$%5 '5
%5
,5 $%5
$%5
,5
$%5
6WXE$UHD
$6%5
RIPv2
Link aggregation
Link aggregation
With link aggregation, several parallel physical connections with the same transmission speed
are grouped together to form a logical connection with a higher transmission speed. This
method based on IEEE 802.3ad is also known as port trunking or channel bundling.
Link aggregation works only with full duplex connections with the same transmission speed in
point-to-point mode. This achieves multiplication of the bandwidth or transmission speed. If
part of the connection fails, the data traffic is handled via the remaining parts of the connection.
To control and monitor, the Link Aggregation Control Layer (LACL) and the Link Aggregation
Control Protocol (LACP) are used.
Authentication
Authentication method
You can configure the authentication methods "802,1x" and "MAC Authentication" as well as
the "Guest VLAN" option separately for each port.
The functions have a hierarchical order. If all three functions are enabled, an attempt is made
initially to authenticate the end device using "802.1x". If this authentication is unsuccessful,
"MAC Authentication" is started. If this authentication is also unsuccessful, the end device is
enabled for communication in the "Guest VLAN". ""Guest VLAN" can only be used if at least
one authentication method is active.
The two authentication methods depend on the end device. If the end device supports EAP
(Extensible Authentication Protocol), it can be authenticated using the "802.1x" method. If the
end device does not support EAP, it can be authenticated using "MAC Authentication". In this
case, the IE switch adopts the role of the end device and uses the MAC address of the device
as the authentication parameter.
802.1x
The "802.1x" authentication method works as follows:
An end device that supports EAP sends authentication information to the IE switch. The IE
switch forwards the information to the authentication server. The authentication server checks
the information and allows or denies the end device access to the network.
MAC Authentication
The "MAC Authentication" authentication method works as follows:
As soon as the IE switch receives a frame from the end device, the IE switch sends a query
to the RADIUS server to allow or deny the end device access to the network.
Editing options
You have the following options for editing properties and parameters:
Hardware and network editor
Once you have inserted the network component, you can edit the properties and
parameters, for example the device name. You will find more detailed information in
"Hardware and network editor".
Web Based Management (WBM)
The parameters and properties are accessible using the supplied HTML pages (WBM
pages). Each WBM page has its own help page that describes the properties and
parameters. For further information, refer to the configuration manual "SCALANCE XM400/
X-500 Web Based Management". You will find the MIB at Siemens Industry Automation
and Drives Service & Support on the Internet under the entry ID 67428305 (http://
support.automation.siemens.com/WW/view/en/67428305).
Command Line Interface
All the configuration settings for the device can be made using the CLI. The CLI provides
the same options as Web Based Management (WBM). For further information, refer to the
configuration manual "SCALANCE XM400/X-500 Command Line Interface". You will find
the MIB at Siemens Industry Automation and Drives Service & Support on the Internet
under the entry ID 67430663 (http://support.automation.siemens.com/WW/view/en/
67430663).
Availability
The availability of the settings depends
on the port type
on the configuration mode
SCALANCE X distinguishes the following port types:
Switch port
Router port
The following configuration modes are available:
Offline configuration
You can configure a PC station the first time offline. In this mode only the settings that
require no connection to the device are available.
Online configuration mode
If there is a connection to the device, there are additional pages available in the Inspector
window. These pages include the note "This page is only available if there is an online
connection to the device". With some settings, the additional information "only available
online" is included.
Configuration options
When shipped and after restoring to the factory settings, the device does not have an IP
address.
The following options are available to assign an IP address to the device:
DHCP (default setting)
Primary Setup Tool
For further information, refer to the configuration manual "Primary Setup Tool". You will find
the MIB at Siemens Industry Automation and Drives Service & Support on the Internet
under the entry ID 19440762 (http://support.automation.siemens.com/WW/view/en/
19440762).
STEP 7
CLI via the serial interface
For further information, refer to the configuration manual "SCALANCE XM-400/XR-500
Command Line Interface". You will find the configuration manual on the Internet pages of
Siemens Industry Automation and Drives Service & Support (http://
support.automation.siemens.com/WW/view/en/48805144/133300).
Requirement
"Set IP address on device" is enabled in the properties of the device. You will find more
detailed information in "Addressing PROFINET devices".
Show information
Versions
Note
The page is only available if there is an online connection to the device.
This page shows the versions of the hardware and software of the device.
Description
Table 1 has the following columns:
Hardware
Shows the device being used.
Name
Shows the name of the device or module.
Revision
Shows the hardware version of the device.
Order ID
Shows the order number of the device or module.
I&M
Note
The page is only available if there is an online connection to the device.
This page contains information about device-specific vendor and maintenance data such as
the order number, serial number, version number etc. You cannot configure anything on this
page.
Function tag
Shows the function tag (plant designation) of the device. The plant designation (HID) is
created during configuration of the device with HW Config of STEP 7.
Location tag
Shows the location tag of the device. The location identifier (LID) is created during
configuration of the device with HW Config of STEP 7.
ARP table
Note
The page is only available if there is an online connection to the device.
Displayed values
The table has the following columns:
Interface
Shows the interface via which the row entry was learnt.
MAC address
Shows the MAC address of the target device.
IP address
Shows the IP address of the target device.
Media Type
Shows the type of connection.
Dynamic
The device recognized the address data automatically.
Static
The addresses were entered as static addresses
Log table
Logging events
Note
The page is only available if there is an online connection to the device.
The device allows you to log events that occur, some of which you can specify in " System >
Events". This, for example, allows you to record when an authentication attempt failed or when
the connection status of a port has changed. The content of the events log table is retained
even when the device is turned off.
Settings
Severity Filters
You can filter the entries in the table according to severity. To display all the entries, enable
or disable all settings.
Info
Information (6)
Warning
Warnings (4)
Critical
Critical (2)
Displayed values
The table has the following columns:
Restart
Counts the number of restarts since you last reset to factory settings and shows the device
restart after which the corresponding event occurred.
System up time
Shows the time the device has been running since the last restart when the described event
occurred.
If the system time is set, the time is also displayed at which the event occurred.
System Time
Shows the date and time of the device.
Severity
Shows the severity.
Log Message
Displays a brief description of the event that has occurred.
Buttons
Delete
Click this button to delete the content of the event log file. The display is also cleared. The
restart counter is only reset after you have restored the device to the factory settings and
restarted the device.
Note
The number of entries in this table is restricted to 400. When this number is reached, the
oldest entries are overwritten. The table remains permanently in memory.
Fault
Error status
Note
The page is only available if there is an online connection to the device.
This page displays any errors that occur. If there are no more unanswered error/fault
messages, the fault LED goes off.
The time calculation always begins after the last system start. When the system is restarted,
a new entry with the type of restart is created in the fault memory.
Redundancy
Spanning Tree
Note
The page is only available if there is an online connection to the device.
The page shows the current information about the Spanning Tree and the settings of the root
bridge.
If Spanning Tree is turned off, only the basic information about this device is displayed.
If Spanning Tree is activated, the following is displayed:
Parameters of the selected instance
Parameters for the ports of the selected instance
The information depends on the selected Spanning Tree mode.
Displayed values
Spanning Tree Mode
Shows the set mode. You specify the mode in "Layer 2 > MSTP > General".
The following values are possible:
'-'
STP
RSTP
MSTP
Instance ID
Shows the number of the instance. The parameter depends on the configured mode.
Bridge Priority / Root Priority
Which device becomes the root bridge is decided by the bridge priority. The bridge with the
highest priority (in other words, with the lowest value for this parameter) becomes the root
bridge. If several devices in a network have the same priority, the device whose MAC
address has the lowest numeric value will become the root bridge. Both parameters, bridge
priority and MAC address together form the bridge identifier. Since the root bridge manages
all path changes, it should be located as centrally as possible due to the delay of the frames.
The value for the bridge priority is a whole multiple of 4096.
Bridge address / root address
The bridge address shows the MAC address of the device and the root address shows the
MAC address of the root bridge.
Root Cost
Shows the path costs from the device to the root bridge.
In MSTP mode, the path costs as far as the root bridge of the CIST are displayed.
Bridge Status
Shows the status of the bridge, e.g. whether or not the device is the root bridge.
Regional root priority (available only with MSTP)
For a description, see Bridge priority / Root priority.
Regional root address (available only with MSTP)
Shows the MAC address of the device.
Regional root costs (only available with MSTP)
The path costs from this device to the regional root bridge.
Path costs
This parameter is used to calculate the path that will be selected. The path with the lowest
value is selected. If several ports of a device have the same value, the port with the lowest
port number will be selected.
If the value "Cost Calc." is "0", the automatically calculated value is displayed. Otherwise,
the value of "Cost Calc." is displayed.
The calculation of the path costs is largely based on the transmission speed. The higher
the achievable transmission speed is, the lower the value of the path costs.
Typical values for path costs with rapid spanning tree:
10,000 Mbps = 2,000
1000 Mbps = 20,000
100 Mbps = 200,000
10 Mbps = 2,000,000.
Edge type
Shows the type of the connection. The following values are possible:
Edge Port
VRRP statistics
Introduction
Note
The page is only available if there is an online connection to the device.
This page shows the statistics of the VRRP protocol and all configured virtual routers.
Ring Redundancy
Note
The page is only available if there is an online connection to the device.
Automatic Redundancy Detection (ARD) is the default when the device ships. If you want to
use the previous High Speed Redundancy Protocol (HRP), HRP must be configured.
Reconfiguration time of the frame traffic following a failover in MRP: 200 ms
Reconfiguration time of the frame traffic following a failover in HRP: 300 ms
This page informs you about the values currently set for the device.
Description
The following fields are displayed:
Redundancy Function
The following values are shown:
Disabled
Ring redundancy is disabled on the device.
MRP Manager
The device is operating as MRP manager.
MRP Client
The device is operating as MRP client.
HRP Client
The device is operating as HRP client.
HRP Manager
The device is operating as HRP manager.
RM Status
The "RM Status" column shows whether or not the IE switch is operating as redundancy
manager and whether it has opened or closed the ring in this role.
Passive
The IE switch is operating as redundancy manager and has opened the ring; in other
words, the line of switches connected to the ring ports is operating problem free. The
passive status is also displayed if the IE switch is not operating as the redundancy
manager (RM Function Disabled).
Active
The IE switch is operating as redundancy manager and has closed the ring; in other
words, the line of switches connected to the ring ports is interrupted (problem). The
redundancy manager connects its ring ports through and restores an uninterrupted
linear topology.
If media redundancy in ring topologies is completely disabled, ring ports configured last
are displayed and the text "Ring Redundancy disabled" is displayed.
Observer Status
Shows the current status of the observer.
Ring ports
Ring ports 1 and ring port 2 show the ports used for redundancy.
No. of Changes to RM Active State
Shows how often the device as redundancy manager switched to the active status, i.e.
closed the ring.
If the redundancy function is disabled or the device is not the HRP/MRP manager, the text
"Redundancy manager disabled" appears.
Max. delay of the RM test frames [ms]
Shows the maximum delay for test frames of the redundancy manager.
If the redundancy function is disabled or the device is not the HRP/MRP manager, the text
"Redundancy manager disabled" appears.
Standby
Note
The page is only available if there is an online connection to the device.
Description
The following fields are displayed:
Standby ports
Shows the ports being used.
Standby name
Shows the name for the standby connection. The master/slave device pair is defined by
this name (both must be in the same ring). This is achieved by entering the same name on
two devices in the ring. You can select any name to suit your purposes, however, you can
only use the name for one pair of devices in the entire network.
Standby Function
Shows whether the standby connection is activated or deactivated.
Master
The device has a connection to the partner device and is operating as master. In normal
operation, the standby port of this device is active.
Slave
The device has a connection to the partner device and is operating as slave. In normal
operation, the standby port of this device is inactive.
Disabled
The standby link is disabled. The device is operating neither as master nor slave. The
port configured as a standby port works as a normal port without standby function.
Waiting for Connection...
No connection has yet been established to the partner device. The standby port is
inactive. In this case, either the configuration on the partner device is inconsistent (for
example incorrect connection name, standby link disabled) or there is a physical fault
(for example device failure, link down).
Connection Lost
The existing connection to the partner device has been lost. In this case, either the
configuration on the partner device was modified (for example a different connection
name, standby link disabled) or there is a physical fault (for example device failure, link
down).
Standby status
Shows the status of the standby port:
Active
The standby port of this device is active; in other words is enabled for frame traffic.
Passive
The standby port of this device is inactive; in other words is blocked for frame traffic.
"-"
The standby function is disabled.
No. of Changes to Standby Active State
Shows how often the IE switch has changed the standby status from "Passive" to "Active".
If the connection of a standby port fails on the standby master, the IE switch changes to
the "Active" status.
Following each restart on the device, the counters are automatically reset.
Ethernet Statistics
Interface statistics
Interface statistics
The page shows the statistics from the interface table of the Management Information Base
(MIB).
Note
The page is only available if there is an online connection to the device.
Displayed values
The table has the following columns:
Received bytes
Shows the number of received bytes.
Sent bytes
Shows the number of sent bytes.
Received unicast frames
Shows the number of received unicast frames.
Received non-unicast frames
Shows the number of received frames that are not of the type unicast.
Sent unicast frames
Shows the number of sent unicast frames.
Sent non-unicast frames
Shows the number of sent frames that are not of the type unicast.
Frame length
Note
The page is only available if there is an online connection to the device.
Displayed values
The table has the following columns:
Port
Shows the available ports and link aggregations.
Note
Display of frame statistics
In the statistics relating to frame lengths, note that both incoming and outgoing frames are
counted.
Frame lengths
The other columns after the port number contain the absolute numbers of frames according
to their frame length.
The following frame lengths are distinguished:
64 bytes
65 - 127 bytes
128 - 255 bytes
256 - 511 bytes
512 - 1023 bytes
1024 - max.
Button
Reset Counter
Click "Reset Counter" to reset all counters. The counters are also reset by a restart.
Frame type
Note
The page is only available if there is an online connection to the device.
Displayed values
The table has the following columns:
Port
Shows the available ports and link aggregations.
Unicast / Multicast / Broadcast
The other columns after the port number contain the absolute numbers of the incoming
frames according to their frame type "unicast", "multicast" and "broadcast".
Button
Reset Counter
Click "Reset Counter" to reset all counters. The counters are also reset by a restart.
Packet Errors
Note
The page is only available if there is an online connection to the device.
Displayed values
The table has the following columns:
Port
Shows the available ports and link aggregations.
Error types
The other columns after the port number contain the absolute numbers of the incoming
frames according to their error type.
In the columns of the table, a distinction is made according to the following error types:
CRC
Frames whose content does not match the CRC checksum.
Undersize
Frames with a length less than 64 bytes.
Oversize
Frames discarded because they were too long.
Fragments
Frames with a length less than 64 bytes and a bad CRC checksum.
Jabbers
VLAN-tagged frames with an incorrect CRC checksum that were discarded because
they were too long.
Collisions
Collisions that were detected.
Button
Reset Counter
Click "Reset Counter" to reset all counters. The counters are also reset by a restart.
History
Note
The page is only available if there is an online connection to the device.
Settings
Port
Select the port for which the history will be displayed.
Displayed values
Entries
Maximum number of samples that can be saved at the same time.
Interval [s]
Interval after which the current status of the statistics will be saved as a sample.
The table has the following columns:
Sample
Number of the sample
Time for the Sample
System up time at which the sample was taken.
Unicast
Number of received unicast frames.
Multicast
Number of received multicast frames.
Broadcast
Number of received broadcast frames.
CRC
Number of frames with a bad CRC checksum.
Undersize
Number of frames that are shorter than 64 bytes.
Oversize
Number of frames discarded because they were too long.
Fragments
Number of frames that are shorter than 64 bytes and have a bad CRC checksum.
Jabbers
Number of frames with a VLAN tag that have a bad CRC checksum and will be discarded
because they are too long.
Collisions
Number of collisions of received frames.
Utilization
Utilization of the port during a sample.
Unicast
This page shows the learnt and static unicast MAC addresses.
Description
VLAN ID
Shows the VLAN-ID assigned to this MAC address.
MAC Address
Shows the MAC address of the node that the device has learned or the user has configured.
Status
Shows the status of each address entry:
Learnt
The specified address was learned by receiving a frame from this node and will be
deleted when the aging time expires if no further packets are received from this node.
Static
Configured by the user. Static addresses are stored permanently; in other words, they
are not deleted when the aging time expires or when the switch is restarted.
Port
Shows the port via which the node with the specified address can be reached. Frames
received by the device whose destination address matches this address will be forwarded
to this port.
Multicast
This page shows the learnt and static multicast MAC addresses.
Description
VLAN ID
Shows VLAN ID of the VLAN to which the MAC multicast address is assigned.
MAC Address
Shows the MAC multicast address that the device has learned or the user has configured.
Status
Shows the status of each address entry. The following information is possible:
static
The address was entered statically by the user. Static addresses are stored
permanently; in other words, they are not deleted when the aging time expires or when
the device is restarted. These must be deleted by the user.
IGMP
The destination port for this address was obtained by IGMP configuration.
GMRP
The destination port for this address was registered by a received GMRP frame.
LLDP
Note
The page is only available if there is an online connection to the device.
Routing
Routing table
This page shows the routing table of the device.
Description
The table has the following columns:
Destination network
Shows the destination address of this route.
Subnet mask
Shows the subnet mask of this route.
Gateway
Shows the gateway for this route.
Interface
Shows the interface for this route.
Metric
Shows the metric of the route. The higher value, the longer the packets require to their
destination.
Routing protocol
Shows the routing protocol from which the entry in the routing table originates. The following
entries are possible:
Connected: Connected routes
Static: Static routes
RIP: Routes using RIP
OSPF: Routes using OSPF
other: Other routes
OSPFv2 interfaces
Overview
Note
The page is only available if there is an online connection to the device.
Interface Status
Shows the status of the WLAN interface:
Down
The interface is not available.
Loopback
Loopback interface
Waiting
Startup and negotiation of the interface.
Point to Point
Point-to-point connection
Designated Router
The router is a designated router and generates a network LSA.
Backup D. Router
The router is backup for the designated router.
Other D. Router
The interface is started up. The router is neither a designated router nor a backup
designated router.
OSPF status
Shows the status of OSPF.
Enabled: OSPF is enabled on the interface.
Disabled: OSPF is disabled on the interface.
Designated Router
Shows the IP address of the designated router for this OSPF interface.
Backup Designated Router
Shows the IP address of the designated backup router for this OSPF interface.
Events
Shows the number of status changes of OSPF.
OSPFv2 neighbors
Note
The page is only available if there is an online connection to the device.
This page shows the dynamically detected neighbor routers in the relevant networks.
Status
Shows the status of the neighbor router. The status can adopt the following values:
unknown
Status of the neighbor router is unknown.
down
The neighbor router cannot be reached.
attempt and init
Short-lived statuses during initialization
two-way
Two-way receipt of Hello packets. Specification of the designated router and the
designated backup router.
exchangestart, exchange and loading
Status during exchange of the LSAs
full
The database is complete and synchronized within the area. The routes can now be
detected.
Note
Normal status
If the partner router is a designated router or a designated backup router, the status is
"full". Otherwise the status is "two-way".
Note
The page is only available if there is an online connection to the device.
Overview
The table has the following columns:
IP address
Shows the IP address of the virtual neighbor router in this network.
Router ID
Shows the router ID of the virtual neighbor router.
Status
Shows the status of the neighbor router. The status can adopt the following values:
unknown
Status of the neighbor router is unknown.
down
The neighbor router cannot be reached.
attempt and init
Short-lived statuses during initialization
two-way
Two-way receipt of Hello packets. Specification of the designated router and the
designated backup router.
exchangestart, exchange and loading
Status during exchange of the LSAs
full
The database is complete and synchronized within the area. The routes can now be
detected.
Note
Normal status
If the partner router is a designated router or a designated backup router, the status is
"full". Otherwise the status is "two-way".
Trans. Area ID
Shows the ID of the area via which the virtual neighborhood relation exists.
Hello Suppr.
Shows whether there are suppressed Hello packets to the virtual neighbor router.
no: There are no suppressed Hello packets (default)
yes: There are suppressed Hello packets.
Hello Queue
Shows the length of the queue with Hello packets still to be transmitted.
Events
Shows the number of status changes.
OSPFv2 LSDB
Overview
Note
The page is only available if there is an online connection to the device.
The link state database is the central database for managing all links within an area. It consists
of the link state advertisements (LSAs). The most important data of these LSAs is shown on
the this WBM page.
RIPv2 statistics
Overview
Note
The page is only available if there is an online connection to the device.
Configuration
On this page, you specify the services with which the device can be accessed. With some
services, there are further configuration pages on which more detailed settings can be made.
Settings
Telnet Server
Enable or disable the "Telnet Server" service for unencrypted access to the CLI.
SSH server
Enable or disable the "SSH Server" service for encrypted access to the CLI.
HTTPS server only
Enable or disable access using HTTP.
DNS client
Enable or disable depending on whether the IE switch should operate as a DNS client. You
can configure other settings in "System > DNS Client".
SMTP Client
Enable or disable the SMTP client. You can configure other settings in "System > SMTP
Client".
Syslog Client
Enable or disable the system event client. You can configure other settings in "System >
Syslog client".
DCP Server
Specify whether or not the device can be accessed with DCP (Discovery and Configuration
Protocol):
"-" (disabled)
DCP is disabled. Device parameters can neither be read nor modified.
Read/write access
With DCP, device parameters can be both read and modified.
Read-Only
With DCP, device parameters can be read but cannot be modified.
Time
Select the required setting. The following settings are possible:
Manual
The system time is set manually.
SNTP Client
The system time is set via an SNTP server. You can configure other settings in "System
> System time > SNTP client".
NTP Client
The system time is set via an NTP server. You can configure other settings in "System
> System time > NTP client".
SIMATIC Time
The system time is set using a SIMATIC time transmitter. You can configure other
settings in "System > System Time SIMATIC Time Client".
PTP Client
The system time is set via a PTP server. You can configure other settings in "System >
System Time > PTP Client".
This function is only available for SCALANCE X500.
SNMP
Select the required protocol. The following settings are possible:
"-" (SNMP disabled)
Access to device parameters using SNMP is not possible.
SNMPv1/v2c/v3
Access to device parameters is possible with SNMP versions 1, 2c or 3. You can
configure other settings in "System > SNMP > General".
SNMPv3
Access to device parameters is possible with SNMP version 3. You can configure other
settings in "System > SNMP > General".
SNMPv1/v2 Read-Only
Enable or disable write access to SNMP variables with SNMPv1/v2c.
SNMPv1 traps
Enable or disable the sending of SNMP traps (alarm frames). You can configure other
settings in "System > SNMP > Traps".
General
Device
This page contains the general device information.
Settings
Current System Time(Only available online)
Shows the current system time. The system time is either set by the user or by a time-of-
day frame: either SINEC H1 time-of-day frame, NTP or SNTP. (readonly)
System Up Time(only available online)
Shows the operating time of the device since the last restart. (readonly)
Device Type(only available online)
Shows the type designation of the device. (readonly)
System Name
You can enter the name of the device. The entered name is displayed in the selection area.
A maximum of 255 characters are possible. The system name is also displayed in the CLI
input prompt. The number of characters in the CLI input prompt is limited. The system name
is truncated after 16 characters.
System Contact
You can enter the name of a contact person responsible for managing the device.
Location
You can enter the location of the device. The entered installation location is displayed in
the selection area.
Note
The ASCII characters 0x20 to 0x7e are used in the input boxes.
At the start and end of the input boxes"System Name", "System Contact" and "System
Location", the characters "<", ">" and "space" are not permitted.
Coordinates
On this page, you configure the geographic coordinates (latitude, longitude and the height
above the ellipsoid according to WGS84). These boxes are purely for information with a
maximum length of 32 characters.
Getting the coordinates
Use suitable maps for obtaining the geographic coordinates of the device.
The geographic coordinates can also be obtained using a GPS receiver. The geographic
coordinates of these devices are normally displayed directly and only need to be entered in
the input boxes of this page.
Settings
Latitude
Enter the north or south latitude for the location of the device.
For example, +49 1 31.67" means that the device is located at 49 degrees, 1 arc minute
and 31.67 arc seconds north latitude.
A south latitude is shown by a preceding minus character.
You can also append the letters N (north latitude) or S (south latitude) to the numeric
information (49 1 31.67" N).
Longitude
Enter the value of the eastern or western longitude of the location of the device.
For example, +8 20 58.73" means that the device is located at 8 degrees, 20 minutes and
58.73 seconds east.
A western longitude is indicated by a preceding minus sign.
You can also add the letter E (eastern longitude) or W (western longitude) to the numeric
information (8 20 58.73" E).
Height
Enter the value of the height above sea level in meters.
For example, 158 m means that the device is located at a height of 158 m above sea level.
Heights below sea level (for example the Dead Sea) are indicated by a preceding minus
sign.
Agent IP
Note
The page is only available if there is an online connection to the device.
Note
The IP address of the in-band port and the out-band port must belong to different subnets.
Settings
IP Address
In the input boxes under "In band", enter the IP address, subnet mask and the default
gateway. In the input boxes under "Out band", enter the IP address, subnet mask and the
default gateway.
If you change the IP address, the Web browser should automatically set itself to the new
address. If this does not happen, enter the new address in the Web browser manually.
Subnet mask
Here, in "In-band", you enter the subnet mask of the in-band port and in "Out-band" the
subnet mask of the out-of-band port.
Default Gateway
If the device is required to communicate with devices (diagnostics stations, e-mail servers
etc.) in another subnet, enter the IP address of the default gateway here. The out-of-band
port it is not accessible from a different subnet.
Agent VLAN ID
From the drop-down list, select the VLAN ID for the in-band management. You can only
select VLANs that have already been configured.
Note
Changing the agent VLAN ID
If the configuration PC is connected directly to the device via Ethernet and you change the
agent VLAN ID, the device is no longer reachable via Ethernet following the change.
MAC Address
Shows the MAC address of the device. The MAC address is linked to the hardware and
cannot be modified.
DNS client
The DNS () server (Domain Name System) assigns a domain name to an IP address so that
a device can be uniquely identified.
If this function is enabled, the IE switch can communicate with a DNS server as a DNS client.
Note
The DNS client function can only be used if there is a DNS server in the network.
Description
The page contains the following boxes:
DNS Client
Enable or disable depending on whether the IE switch should operate as a DNS client.
DNS Server IP Address
Enter the IP address of the DNS server.
Restart
On this page, there is a button with which you can restart the device and various options for
resetting to the device defaults.
Note
The page is only available if there is an online connection to the device.
Note
Note the following points about restarting a device:
You can only restart the device with administrator privileges.
A device should only be restarted with the buttons of this page or with the appropriate CLI
commands and not by a power cycle on the device.
Any modifications you have made only become active on the device after clicking the "Set
Values" button on the relevant page. If the device is in "Trial Mode", configuration
modifications must be saved manually before a restart. In "Automatic Save" mode, the last
changes are saved automatically before a restart.
Settings
The following options are available for restarting:
Restart
Click this button to restart the system. You must confirm the restart in a dialog box. During
a restart, the device is reinitialized, the internal firmware is reloaded, and the device runs
a self-test. The learned entries in the address table are deleted. You can leave the browser
window open while the device restarts. You then need to log in again:
Restore Factory Defaults and Restart
Click this button to restart the system. You must confirm the restart in a dialog box. During
a restart, the device is reinitialized, the internal firmware is reloaded, and the device runs
a self-test. The learned entries in the address table are deleted. You can leave the browser
window open while the device restarts. You then need to log in again.
Note
By resetting all the defaults to the factory settings, the IP address and the passwords are
also lost. Following this, the device can only be accessed using the Primary Setup Tool or
using DHCP.
With the appropriate attachment, a previously correctly configured device can cause
circulating frames and therefore the failure of the data traffic.
Note
The page is only available if there is an online connection to the device.
This page is available both for connections using HTTP and for connections using HTTPS.
Note
Incompatibility with previous firmware versions with/without PLUG inserted
During the installation of a previous version, the configuration data can be lost. In this case,
the device starts up with the factory settings after the firmware has been installed.
In this situation, if a PLUG is inserted in the device, following the restart, this has the status
"Not Accepted" since the PLUG still has the configuration data of the previous more up-to-date
firmware. This allows you to return to the previous, more up-to-date firmware without any loss
of configuration data. If the original configuration on the PLUG is no longer required, the PLUG
can be deleted or rewritten manually using System > PLUG.
Note
Configuration files and Trial mode/Automatic Save
In "Automatic Save" mode, the data is saved automatically before the configuration files
(ConfigPack and Config) are transferred.
In Trial mode, although the changes are adopted, they are not saved in the configuration files
(ConfigPack and Config). Use the "Write Startup Config" button on the "System >
Configuration" WBM page to save changes in the configuration file.
Settings
The table has the following columns:
Type
Shows the file type.
Description
Shows the short description of the file type.
Load
With this button, you can upload files to the device. The button can be enabled, if this
function is supported by the file type.
Save
With this button, you can save files from the device. The button can only be enabled if this
function is supported by the file type and the file exists on the device.
Delete
With this button, you can delete files from the device. The button can only be enabled if this
function is supported by the file type and the file exists on the device.
Loading new firmware
After successfully downloading the firmware, you will be requested to restart the device.
Restart the device and continue to configure the newly started firmware.
Procedure
Loading files using HTTP
1. Start the upload function by clicking the one of the "Load" buttons.
The dialog for uploading a file opens.
2. Go to the file you want to upload.
3. Click the "Open" button in the dialog.
The file is now uploaded.
4. When the message "Restart required" appears, click the "Yes" button to trigger the restart.
If you click the "No" button, there is no device restart. The changes only take effect after a
restart.
Note
Incompatibility with previous firmware versions with/without PLUG inserted
During the installation of a previous version, the configuration data can be lost. In this case,
the device starts up with the factory settings after the firmware has been installed.
In this situation, if a PLUG is inserted in the device, following the restart, this has the status
"Not Accepted" since the PLUG still has the configuration data of the previous more up-to-date
firmware. This allows you to return to the previous, more up-to-date firmware without any loss
of configuration data. If the original configuration on the PLUG is no longer required, the PLUG
can be deleted or rewritten manually on the "System > PLUG page.
Note
Configuration files and Trial mode/Automatic Save
In "Automatic Save" configuration mode, the data is saved automatically before the
configuration files (ConfigPack and Config) are transferred.
In the "Trial" configuration mode, although the changes are adopted, they are not saved in the
configuration files (ConfigPack and Config). Use the "Write Startup Config" button on the
"System > Configuration" WBM page to save changes in the configuration files.
Settings
TFTP Server IP Address
Here, enter the IP address of the TFTP server with which you exchange data.
TFTP Server Port
Here, enter the port of the TFTP server via which data exchange will be handled. If
necessary, you can change the default value 69 to your own requirements.
The table has the following columns:
File type
Shows the file type.
Description
Shows the short description of the file type.
File name
Enter a file name.
Select action (only available online)
Select the action from the drop-down list. The selection depends on the selected file type,
for example the log file can only be saved.
The following actions are possible:
Save file
With this selection, you save a file on the TFTP server.
Load file
With this selection, you load a file from the TFTP server.
Events
Configuration
On this page, you specify how the device reacts to events.
Settings
Signaling Contact Response
Select the behavior of the signaling contact. The following reactions are possible:
conventional
Default setting for the signaling contact. An error/fault is displayed by the fault LED and
the signaling contact is opened. When the error/fault state no longer exists, the fault
LED goes off and the signaling contact is closed.
User-defined
The way the signaling contact works does not depend on the error/fault that has
occurred. The signaling contact can be opened or closed as required by user actions.
Signaling Contact Status
Select the status of the signaling contact. The following statuses are possible:
close
Signaling contact is closed.
open
Signaling contact is opened.
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports of table 2.
E-mail/Trap/Log table/Syslog/Errors
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Severity filter
On this page, set the threshold levels for sending system event notifications.
Settings
The table has the following columns:
Client Type
Select the client type for which you want to make settings:
E-mail
Sending system event messages by e-mail
Log table
Entry of system events in the log table.
Syslog
Entering system events in the Syslog file
Severity
Select the required level. The following settings are possible:
Info
System events are processed as of the severity level "Info".
Warning
System events are processed as of the severity level "Warning".
Critical
System events are processed as of the severity level "Critical".
SMTP client
The device provides the option of automatically sending an e-mail if an alarm event occurs (for
example to the network administrator). The e-mail contains the identification of the sending
device, a description of the cause of the alarm in plain language, and a time stamp. This allows
centralized network monitoring to be set up for networks with few nodes based on an E-mail
system. When an e-mail error message is received, the WBM can be started by the Internet
browser using the identification of the sender to read out further diagnostics information.
On this page, you can configure up to three SMTP servers and the corresponding e-mail
addresses.
Note
Depending on the properties and configuration of the SMTP server, it may be necessary to
adapt the "Sender E-Mail Address input box for the e-mails. Check with the administrator of
the SMTP server.
Settings
SMTP Client
Enable or disable the SMTP client.
Email address of the sender
Enter the name of the sender to be included in the e-mail, for example the device name.
This setting applies to all configured SMTP servers.
SMTP Port
Enter the port via which your SMTP server can be reached.
SMTP Server IP Address
Enter the IP address of the SMTP server.
This table contains the following columns:
SMTP server address
Shows the SMTP server IP address.
Email address of the recipient
Enter the e-mail address to which the device sends an e-mail if a fault occurs.
DHCP client
If the DHCP mode is activated, the DHCP client starts a DHCP request to a configured DHCP
server and is assigned an IP address as the response. The server manages an address range
from which it assigns IP addresses. It is also possible to configure the server so that the client
always receives the same IP address in response to its request.
Settings
DHCP client configuration request (opt. 66, 67)
Select this option if you want the DHCP client to use options 66 and 67 to download and
then enable a configuration file.
DHCP Mode
Select the DHCP mode. The following modes are possible:
via MAC Address
Identification is based on the MAC address.
via DHCP Client ID
Identification is based on a freely defined DHCP client ID.
via System Name
Identification is based on the device name. If the device name is 255 characters long,
the last character is not used for identification.
This table contains the following columns:
Interface
Shows the available interfaces.
DHCP
Enable or disable the DHCP client.
SNMP
General
On this page, you make the basic settings for SNMP. Enable the functions you want to use.
Settings
SNMP
Select the SNMP protocol. The following settings are possible:
"-" (disabled)
SNMP is disabled.
SNMPv1/v2c/v3
SNMPv1/v2c/v3 is supported.
SNMPv3
Only SNMPv3 is supported.
SNMPv1/v2 Read-Only
If you enable this option, SNMPv1/v2c can only read the SNMP variables.
Note
Community String
For security reasons, do not use the standard values "public" or "private". Change the
community strings following the initial installation.
Traps
If an alarm event occurs, a device can send SNMP traps (alarm frames) to up to ten different
management stations at the same time. Traps are only sent if events specified in "Events >
Configuration" occur.
Note
SNMP traps are sent only when the "SNMPv1 Traps" setting was selected in "SNMP >
General".
Settings
IP Address
Enter the IP address of the stations to which the device sends SNMP traps
The table has the following columns:
IP Address
Shows the IP addresses of the stations to which the device sends SNMP traps.
Trap
Enable or disable the sending of SNMP traps. Stations that are entered but not selected
do not receive SNMP traps.
v3 Groups
Settings
Group Name
Enter the name of the group. This name must have at least two characters, the maximum
length is 32 characters.
Security Level
Select the security level (authentication, encryption) valid for the selected group. You have
the following options for the security levels:
no Auth/no Priv
No authentication enabled / no encryption enabled.
Auth/no Priv
Authentication enabled / no encryption enabled.
Auth/Priv
Authentication enabled / encryption enabled.
The table has the following columns:
Group Name
Shows the defined group names.
Note
Once a group name and the security level have been specified, they can no longer be
modified after the group is created. If you want to change the group name or the security
level , you will need to delete the group and recreate it and reconfigure it with the new name.
Security Level
Shows the configured security level.
Read
Enable or disable read access.
Write
Enable or disable write access.
Note
For write access to work, you also need to enable read access.
Persistence
Shows whether or not the group is assigned to an SNMPv3 user. If the group is not assigned
to an SNMPv3 user, no automatic saving is triggered and the configured group disappears
again after restarting the device.
Yes
The group is assigned to an SNMPV3 user.
No
The group is not assigned to an SNMPV3 user.
v3 users
Settings
User name
Enter a freely selectable user name. After you have entered the data, you can no longer
modify the name.
The table has the following columns:
User name
Shows the created users.
Group Name
Select the group to which the user will be assigned.
Authentication Protocol
Select the authentication protocol. Can only be enabled, if this group supports the function.
The following settings are available:
None
MD5
SHA
Encryption Protocol
Specify whether or not the user uses the DES algorithm. Can only be enabled, if the group
supports this function.
Authentication Password
Enter the authentication password in the first input box.
Confirm authentication password
Confirm the password by repeating the entry.
Encryption Password
Enter your encryption password.
System time
Note
The page is only available if there is an online connection to the device.
Settings
Time Manually
Enable or disable the manual time setting.
System Time
Enter the date and time in the format "MM/DD/YYYY HH:MM:SS". Can only be edited, if
manual time setting is enabled.
After a restart, the time of day begins at 01/01/2000 00:00:00
Use PC Time
Click the button to use the time setting of the PC.
DST overview
On this page, you can create new entries for the daylight saving time changeover.
The table provides an overview of the existing entries.
Settings
DST No.
Shows the number of the entry.
If you create a new entry, a new line with a unique number is created.
Name
Shows the name of the entry.
Year
Shows the year for which the entry was created.
Start Date
Shows the month, day and time for the start of daylight saving time.
End Date
Shows the month, day and time for the end of daylight saving time.
Type
Shows how the daylight saving time changeover is made:
Date
A fixed date is entered for the daylight saving time changeover.
Recurring
A rule was defined for the daylight saving time changeover.
DST configuration
On this page, you can configure the entries for the daylight saving time changeover. As result
of the changeover to daylight saving or standard time, the system time for the local time zone
is correctly set.
You can define a rule for the daylight saving time changeover or specify a fixed date.
Settings
Note
The content of this page depends on the selection in the "Type" box.
The boxes "DST No.", "Type" and "Name" are always shown.
DST No.
Select the type of the entry.
Type
Select how the daylight saving time changeover is made:
Date
You can set a fixed date for the daylight saving time changeover.
This setting is suitable for regions in which the daylight saving time changeover is not
governed by rules.
Recurring
You can define a rule for the daylight saving time changeover.
This setting is suitable for regions in which the daylight saving time always begins or
ends on a certain weekday.
Name
Enter a name for the entry.
SNTP client
SNTP (Simple Network Time Protocol) is used for synchronizing the time in the network. The
appropriate frames are sent by an SNTP server in the network.
Settings
SNTP Client
Enable or disable automatic time-of-day synchronization using SNTP.
Current System Time (only available online)
Shows the values currently set in the system for date and time.
Last Synchronization Time (only available online)
This box is read-only and shows when the last time-of-day synchronization took place. If
no time-of-day synchronization was possible, the box displays "Date/time not set".
NTP client
If you require time-of-day synchronization using NTP, you can make the relevant settings here.
Settings
NTP Client
Enable or disable automatic time-of-day synchronization using NTP.
Current System Time (only available online)
Shows the values currently set in the system for date and time.
Settings
SIMATIC Time Client
Enable or disable loop the SIMATIC Time Client.
Current System Time (only available online)
Shows the values currently set in the system for date and time.
PTP Client
On this page, you configure time synchronization with PTP (Precision Time Protocol).
This function is only available for SCALANCE X500.
Settings
PTP Client
Enable or disable time synchronization using PTP. You can configure other settings in
"Layer 2 > PTP".
Current System Time (only available online)
This box is read-only and displays the current system time.
Last Synchronization Time (only available online)
This box is read-only and shows when the last time-of-day synchronization took place. If
no time-of-day synchronization was possible, the box displays "Date/time not set".
Auto logout
On this page, set the times after which there is an automatic logout from WBM or the CLI
following user in activity.
Note
No automatic logout from the CLI
If the connection is not terminated after the set time, check the setting of the "keepalive"
mechanism on the Telnet client.
If the interval is shorter than the configured time, the connection is kept alive although no user
data is transferred. Example: you selected 300 seconds for the automatic logout and 120
seconds is set for the keepalive function. In this case, a packet is sent every 120 seconds that
keeps the connection up.
Disable the keepalive mechanism (interval time = 0)
or
Set the interval high enough so that the underlying connection is terminated when there is
inactivity.
Settings
Web Based Management [s]
Enter the time in seconds for the automatic logout from WBM. If you enter the value 0, the
automatic logout is disabled.
CLI (TELNET, SSH, Serial) [s]
Enter the time in seconds for the automatic logout from the CLI. If you enter the value 0,
the automatic logout is disabled.
Button
The "Select/Set" button has the following functions:
Change display mode
Enable redundancy manager
Restore to factory defaults
Fault mask and LED display
You will find a detailed description of the individual functions available with the buttons in the
operating instructions of the specific device.
Settings
Restore Factory Defaults
Enables or disables the "Restore Factory Defaults" function for the Select/Set button.
Caution
Button function "Restore Factory Defaults" active during startup
If you have disabled this function in your configuration, disabling is only valid during
operation. When restarting, for example after power down, the function is active until the
configuration is loaded so that the device can inadvertently be reset to the factory settings.
This may cause unwanted disruption in network operation since the device needs to be
reconfigured if this occurs. An inserted PLUG is also deleted and returned to the status as
shipped
Redundancy Manager
Enables or disables the redundancy manager function for the Select/Set button.
Set Fault Mask
Enable or disable the function "Define fault mask via the LED display" with the Select/set
button. This function only works in display mode D.
Syslog client
Syslog according to RFC 3164 is used for transferring short, unencrypted text messages over
UDP in the IP network. This requires a system log server.
Settings
Syslog Client
Enable or disable the system log function.
Syslog Server IP Address
Enter the IP address of the system log server.
This table contains the following columns
Server address
Shows the IP address of the system log server.
Server Port
Enter the port of the Syslog server being used.
Ports
Port overview
The page shows the configuration for the data transfer for all ports of the device.
Settings
Port
Shows the configurable ports.
Port name
Shows the name of the port.
MAC Address (only available online)
Shows the MAC address of the port.
Mode (only available online)
Shows the transfer parameters of the port
Negotiation
Shows whether the automatic configuration is enabled or disabled.
Flow Ctrl. Type
Shows whether flow control is enabled or disabled for the port.
Flow Ctrl.
Shows whether or not flow control is working on this port.
MTU
Shows the maximum packet size.
Port Type (only with routing)
Shows the type of the port. The following types are possible:
Router Port
Switch Port VLAN Hybrid
Switch-Port VLAN Trunk
Status
Shows whether the port is on or off. Data traffic is possible only over an enabled port.
Configuration
On this page, you configure the ports of the device
Settings
Port
Select the port to be configured. The port is made up of the port number and the slot number,
for example port 0.1 is slot 0, port 1.
Status
Specify whether the port is enabled or disabled.
enabled
The port is enabled. Data traffic is possible only over an enabled port.
disabled
The port is disabled but the connection remains.
Link down
The port is disabled and the connection to the partner device is terminated.
Port name
Enter a name for the port.
MAC Address (only available online)
Shows the MAC address of the port.
Mode Type
Shows the transmission speed and the transmission method of the port. You make the
settings for "Autonegotiation" and "Transmission rate" in the port options.
Note
Before the port and partner port can communicate with each other, the settings must match
at both ends.
Negotiation
Shows whether the automatic configuration of the connection to the partner port is enabled
or disabled.
Flow Ctrl. Type
Shows whether or not flow control is working on this port.
Note
Turning flow control on/off with autonegotiation
Flow control can only be enabled or disabled if the "autonegotiation" function is turned off.
The function cannot enabled again afterwards.
Flow Ctrl.
Shows whether or not flow control is working on this port.
MTU
Enter the packet size.
Port Type (only with routing)
Select the type of the port:
Router Port
The port is an IP interface. It does not support layer 2 functions.
Switch Port VLAN Hybrid
The port sends tagged and untagged frames. It is not automatically a member of a VLAN.
Switch-Port VLAN Trunk
The port only sends tagged frames and is automatically a member of all VLANs.
Combo Port Media Type(SCALANCE XM400 only)
Specify the mode for the combo port:
auto
If you select this mode, the SFP transceiver port has priority. As soon as an SFP
transceiver is plugged in, an existing connection at the fixed RJ-45 port is terminated.
If no SFC transceiver is plugged in, a connection can be established via the fixed RJ-45
port.
rj45
If you select this mode, the fixed RJ-45 port is used regardless of the SFP transceiver
port.
sfp
If you select this mode, the SFP transceiver port is used regardless of the built-in RJ-45
port.
The factory setting is auto mode.
Link (only available online)
Shows the connection status to the network. With the connection status, the following is
possible:
Up
The port has a valid link to the network, a link integrity signal is being received.
Down
The link is down, for example because the connected device is turned off.
Note
Optical ports only work with the full duplex mode and at maximum transmission rate. As a
result, the following settings cannot be made for optical ports:
Automatic configuration
Transmission speed
Transmission technique
Note
With various automatic functions, the device prevents or reduces the effect on other ports and
priority classes (Class of Service) if a port is overloaded. This can mean that frames are
discarded even when flow control is enabled.
Port overload occurs when the device receives more frames than it can send, for example as
the result of different transmission speeds.
Fault monitoring
Power supply
Configure whether or not the power supply should be monitored by the messaging system.
Depending on the hardware variant, there are one or two power connectors (Supply 1 / Supply
2). With a redundant power supply, configure the monitoring separately for each individual
feed-in line.
If there is no power on one of the monitored lines (Supply 1 or Supply 2) or when the voltage
is too low, a fault is signaled by the signaling system.
Note
You will find the permitted operating voltage limits in the compact operating instructions of the
device.
An error causes the fault LED to light up on the device. Depending on the configuration, the
error may trigger a trap, an e-mail or an entry in the event log table.
Settings
Line 1
Enable or disable the monitoring of power connector 1.
Line 2
Enable or disable the monitoring of power connector 2.
Link Change
On this page, you configure whether or not an error message is triggered if there is a status
change on a network connection.
If connection monitoring is enabled, an error is signaled
when there should be a link on a port and this is missing.
or when there should not be a link on a port and a link is detected.
An error causes the signaling contact to trigger and the fault LED to light up on the device.
Depending on the configuration, the error may trigger a trap, an e-mail or an entry in the event
log table.
Settings
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns
Port
Shows the available ports.
Setting
Select the setting. You have the following options:
Up
Error handling is triggered when the port changes to the active status.
(From "Link down" to "Link up")
Down
Error handling is triggered when the port changes to the inactive status.
(From "Link up" to "Link down")
"-" (disabled)
The error handling is not triggered.
Redundancy
On this page, you configure whether or not an error message is triggered if there is a status
change on a network connection.
Setting
Redundancy loss (HRP only)
Enable or disable connection monitoring. If the redundancy of the connection is lost, an
error is signaled.
PNIO
On this page, you configure the device response to PROFINET input and output.
Description
The page contains the following boxes:
PNIO runtime mode
Shows the status of the PNIO operation.
PNIO runtime mode for next startup
Select the runtime mode that will be active the next time the device starts up.
PNIO AR status
This box shows the PROFINET IO application relation status; in other words, whether or
not the IE switch is connected "online" or "offline" with a PROFINET controller.
In this context, online means that a connection to a PROFINET IO controller exists, that
the controller has downloaded its configuration data to the IE switch and that the device
can send status data to the PROFINET IO controller. In this status known as "in data
exchange", the parameters set with the PROFINET IO controller cannot be configured on
the IE switch.
PNIO Device Name
Enter the PROFINET IO device name.
Allow PNIO Data Exchange
Enable or disable PNIO data exchange
Simulate PNIO Data Exchange
Enable or disable the simulation of PNIO data exchange.
PLUG
PLUG configuration
Note
The page is only available if there is an online connection to the device.
Notice
Do not remove or insert a C-PLUG / KEY-PLUG during operation!
A PLUG may only be removed or inserted when the device is turned off.
The device checks whether or not a PLUG is present at one second intervals. If it is detected
that the PLUG was removed, there is a restart. If a valid KEY-PLUG was inserted in the device,
the device changes to a defined error state following the restart.
Note
The action is only executed after you click the "Set Values" button.
The action cannot be undone.
If you decide against executing the function after making your selection, click the "Refresh"
button. As a result the data of this page is read from the device again and the selection is
canceled.
Note
Incompatibility with previous versions with PLUG inserted
During the installation of a previous version, the configuration data can be lost. In this case,
the device starts up with the factory settings after the firmware has been installed. In this
situation, if a PLUG is inserted in the device, following the restart, this has the status "NOT
ACCEPTED" since the PLUG still has the configuration data of the previous more up-to-date
firmware. This allows you to return to the previous, more up-to-date firmware without any loss
of configuration data.
If the original configuration on the PLUG is no longer required, the PLUG can be deleted or
rewritten manually using "System > PLUG".
Settings
The table has the following rows:
Status
Shows the status of the PLUG. The following are possible:
ACCEPTED
There is a PLUG with a valid and suitable configuration in the device.
NOT ACCEPTED
Invalid or incompatible configuration on the inserted PLUG.
NOT PRESENT
There is no C-PLUG or KEY-PLUG inserted in the device.
FACTORY
PLUG is inserted and does not contain a configuration. This status is also displayed
when the PLUG was formatted during operation.
MISSING
There is no PLUG inserted. Functions are configured on the device for which a license
is required.
Device Family
Shows the SIMATIC NET product line that used the C-PLUG or KEY-PLUG previously.
Device Type
Shows the device type within the product line that used the C-PLUG or KEY-PLUG
previously.
Configuration Revision
The version of the configuration structure. This information relates to the configuration
options supported by the device and has nothing to do with the concrete hardware
configuration. This revision information does not therefore change if you add or remove
additional components (modules or extenders), it can, however, change if you update the
firmware.
File System
Displays the type of file system on the PLUG.
Notice
New file system UBI
As of firmware version 3.0, UBI is the standard file system for the C-PLUG or KEY-PLUG.
If a C-PLUG with the previous file system IECP is detected in such a device, this C-PLUG
will be formatted for the UBI file system and the data will be rewritten to the C-PLUG.
The file system is also changed following a firmware update to V3.0. A downgrade to the
previous version of the corresponding software is then a problem. The firmware can neither
read nor write the C-PLUG or KEY-PLUG and it is not even possible to "Erase PLUG to
factory default".
PLUG license
Note
The page is only available if there is an online connection to the device.
Notice
Do not remove or insert a C-PLUG / KEY-PLUG during operation!
A PLUG may only be removed or inserted when the device is turned off.
The device checks whether or not a PLUG is present at one second intervals. If it is detected
that the PLUG was removed, there is a restart. If a valid KEY-PLUG was inserted in the device,
the device changes to a defined error state following the restart.
If the device was configured at some time with a PLUG, the device can no longer be used
without this PLUG. To be able to use the device again, reset the device to the factory settings.
Note
Incompatibility with previous versions with PLUG inserted
During the installation of a previous version, the configuration data can be lost. In this case,
the device starts up with the factory settings after the firmware has been installed. In this
situation, if a PLUG is inserted in the device, following the restart, this has the status "NOT
ACCEPTED" since the PLUG still has the configuration data of the previous more up-to-date
firmware. This allows you to return to the previous, more up-to-date firmware without any loss
of configuration data.
If the original configuration on the PLUG is no longer required, the PLUG can be deleted or
rewritten manually using "System > PLUG".
Displayed values
Status
Shows the status of the KEY-PLUG. The following are possible:
ACCEPTED
The KEY-PLUG in the device contains a suitable and valid license.
NOT ACCEPTED
The license of the inserted KEY-PLUG is not valid.
NOT PRESENT
No KEY-PLUG is inserted in the device.
MISSING
There is no KEY-PLUG or a C-PLUG with the status "FACTORY" inserted in the device.
Functions are configured on the device for which a license is required.
WRONG
The inserted KEY-PLUG is not suitable for the device.
UNKNOWN
Unknown content of the KEY-PLUG.
DEFECTIVE
The content of the KEY-PLUG contains errors.
Order ID
Shows the order number of the KEY-PLUG. The KEY-PLUG is available for various
functional enhancements and for various target systems.
Serial Number
Shows the serial number of the KEY-PLUG.
Info String
Shows additional information about the device that used the KEY-PLUG previously, for
example, order number, type designation, and the versions of the hardware and software.
The displayed software version corresponds to the version in which the configuration was
last changed. With the "NOT ACCEPTED" status, further information on the cause of the
problem is displayed.
Note
When you save the configuration, the information about whether or not a KEY-PLUG was
inserted in the device at the time is also saved. This configuration can then only work if a KEY-
PLUG with the same order number / license is inserted.
Ping
Note
The page is only available if there is an online connection to the device.
With the ping function, you can check whether a certain IP address is reachable in the network.
Settings
IP Address
Enter the IP address of the device.
Repeat
Enter the number of ping requests.
Ping
Click this button to start the ping function.
Ping Output
This box shows the output of the ping function.
Delete
Click this button to delete the ping output.
PoE
General
On this page, you specify the maximum power for the power sourcing equipment (PSE).
Setting
PSE
Shows the number of the PoE power supply.
Maximum Power
Maximum power that a PSE provides to supply PoE devices.
Allocated Power
Sum of the power reserved by the PoE devices according to the "Classification".
Used power
Sum of the power used by the end devices.
Usage Threshold [%]
When the power being used by the end devices exceeds the percentage shown here, an
event is triggered.
Port
Settings
The table has the following columns:
Port
Shows the configurable PoE ports.
The port is made up of the port number and the slot number, for example port 0.1 is slot 0,
port 1.
Setting
Enable the PoE power supply for this port or interrupt it.
Priority
Select which priority this port will have for the power supply.
The following settings are possible, in ascending order of relevance:
low
low priority
high
medium priority
critical
high priority
If the same priority is set for two ports, the port with the lower port number will be preferred
when necessary.
Type
Here, you can enter a string to describe the connected device in greater detail.
Classification
The classification specifies the class of the device. From this, it is possible to recognize the
maximum power of the device.
Status
Shows the current status of the port.
The following states are possible:
disabled
The PoE power supply is deactivated for this port.
delivering
The PoE power supply is activated for this port and a device is connected.
searching
The PoE power supply is activated for this port but there is no device connected.
Note
If a device is connected to a port with PoE capability, a check is made to determine whether
the power of the port is adequate for the connected device. If the power of the port is
inadequate, although PoE is enabled in "Setting", the port nevertheless has the status
"disabled". This means that the port was disabled by the PoE power management.
Power [mW]
Shows the power that the SCALANCE provides at this port.
Voltage [V]
Shows the voltage applied to this port.
Current [mA]
Shows the current with which a device connected to this port is supplied.
Port diagnostics
Cable tester
Note
The page is only available if there is an online connection to the device.
With this page, each individual Ethernet port can run independent fault diagnostics on the
cable. This test is performed without needing to remove the cable, connect a cable tester and
install a loopback module at the other end. Short-circuits and cable breaks can be localized to
within a few meters.
Note
Please note that this test is permitted only when no data connection is established on the port
to be tested.
Settings
Port
Select the required port from the drop-down list.
Run Test
Activates error diagnostics. The result is shown in the table.
This table contains the following columns:
Pair
Shows the wire pair in the cable.
Note
Wire pairs
Wire pairs 4-5 and 7-8 of 10/100 Mbps network cables are not used.
In 1000 Mbps or gigabit Ethernet, all 4 wire pairs are used.
The wire pair assignment - pin assignment is as follows (DIN 50173):
Pair 1 = pin 4-5
Pair 2 = pin 1-2
Pair 3 = pin 3-6
Pair 4 = pin 7-8
Status
Displays the status of the cable.
Distance [m]
Displays the distance to the cable end, cable break, or short-circuit.
SFP diagnostics
On this page, you run independent error diagnostics for each individual SFP port. This test is
performed without needing to remove the cable, connect a cable tester or install a loopback
module at the other end.
Note
Please note that this test is permitted only when no data connection is established on the port
to be tested.
If, however, there is a data connection to the port to be tested, this is briefly interrupted.
Automatic re-establishment of the connection can fail and then needs to be done manually.
Description
The page contains the following boxes:
Port
Select the required port from the drop-down list.
Configuration
The functions of layer 2 are configured on this page. With some functions, there are further
configuration pages on which more detailed settings can be made. You can also check the
settings on the configuration pages.
Settings
Protocol Based VLAN
Enable or disable protocol-based VLAN. You can configure other settings in "Layer 2 >
VLAN".
Subnet Based VLAN
Enable or disable subnet-based VLAN. You can configure other settings in "Layer 2 >
VLAN".
Dynamic MAC Aging
Enable or disable the "Aging" mechanism. You can configure other settings in "Layer 2 >
Dynamic MAC Aging".
Redundancy Type
The following settings are available:
"-" (disabled)
The redundancy function is disabled.
Ring
Enables ring redundancy. You can configure other settings in "Layer 2 > Ring
Redundancy > Ring".
Spanning Tree
If you select this option, you specify the required redundancy mode in "Redundancy
Mode".
Redundancy Mode
If you select "Spanning Tree" for the "Redundancy Type", the following options are then
available:
STP
Enables the Spanning Tree Protocol (STP). Typical reconfiguration times with spanning
tree are between 20 and 30 seconds. You can configure other settings in "Layer 2 >
Spanning Tree".
RSTP
Enables the Rapid Spanning Tree Protocol (RSTP). If a spanning tree frame is detected
at a port, this port reverts from RSTP to spanning tree. You can configure other settings
in "Layer 2 > Spanning Tree".
Note
When using RSTP (Rapid Spanning Tree Protocol), loops involving duplication of frames
or frames being overtaken may occur briefly. If this is not acceptable in your particular
application, use the slower standard spanning tree mechanism.
MSTP
Enables the Multiple Spanning Tree Protocol (MSTP). You can configure other settings
in "Layer 2 > Spanning Tree".
If you select "Ring" for the "Redundancy Type", the following options are then available:
Automatic Redundancy Detection
Select this setting to create an automatic configuration of the redundancy mode. In this
mode, the device automatically detects whether or not there is a device with the "HRP
Manager" role in the ring. If this is the case, the device adopts the role of "HRP Client".
If no HRP manager is found, all devices with the "Automatic Redundancy Detection" or
"MRP Auto Manager" setting negotiate among themselves to establish which device
adopts the role of "MRP Manager". The device with the lowest MAC address will always
become "MRP Manager". The other devices automatically set themselves to
redundancy type "MRP Client".
MRP Auto-Manager
Automatic media redundancy manager
MRP Client
Media redundancy client
HRP Client
High Speed Redundancy Protocol client
HRP Manager
High Speed Redundancy Protocol manager
Standby
Enable or disable the "Standby redundancy" function. You can configure other settings in
"Layer 2 > Ring Redundancy > Standby".
Passive Listening
Enable or disable the "passive listening" function.
RMON
If you select this check box, Remote Monitoring (RMON) allows diagnostics data to be
collected on the device, prepared and read out using SNMP by a network management
station that also supports RMON. This diagnostic data, for example port-related load trends,
allow problems in the network to be detected early and eliminated.
Dynamic Multicast
The following settings are possible:
"-" (disabled)
IGMP Snooping
Enables IGMP (Internet Group Management Protocol). You can configure other settings
in "Layer 2 > Multicast > IGMP".
GMRP
Enables GMRP (GARP Multicast Registration Protocol). You can configure other
settings in "Layer 2 > Multicast > GMRP".
Note
GMRP and IGMP cannot operate at the same time.
GVRP
Enable or disable "GVRP" (GARP VLAN Registration Protocol). You can configure other
settings in "Layer 2 > VLAN > GVRP".
Mirroring
Enable or disable port mirroring. You can configure other settings in "Layer 2 > Mirroring >
Port".
Loop Detection
Enable or disable loop detection. You can configure other settings in "Layer 2 > Loop
Detection".
PTP
Specify how the device will process PTP messages. You can configure other settings in
"Layer 2 > PTP".
Off
The device does not process any PTP messages. PTP messages are, however,
forwarded according to the rules of the switch.
transparent
The device adopts the function of a transparent clock and forwards PTP messages to
other nodes while at the same time making entries in the correction field of the PTP
message.
QoS
CoS map
On this page, CoS priorities are assigned to certain queues (traffic queues).
Settings
CoS
Shows the CoS priority of the incoming packets.
Queue
Select the forwarding queue (send priority) that is assigned the CoS priority.
The higher the number of the queue, the higher the send priority.
DSCP map
On this page, DSCP settings are assigned to various queues (traffic queues).
Settings
DSCP
Shows the DSCP priority of the incoming packets.
Queue
Select the forwarding queue (send priority) that is assigned the DSCP value. The higher
the queue number, the higher the send priority.
Load limitation
Settings
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports.
Limit Ingress Unicast (DLF) / Limit Ingress Broadcast / Limit Ingress Multicast
Select the required setting.
enabled: Enables the function.
disabled: Disables the function
No Change: The setting in table 2 remains unchanged
Total Ingress Rate [pkts/s]
Specify the maximum number of incoming packets processed by the device. If "No Change"
is entered, the entry in table 2 remains unchanged.
VLAN
General
On this page, you define the VLAN and specify the use of the ports.
Note
Changing the "Agent VLAN ID"
If the configuration PC is connected directly to the device via Ethernet and you change the
"agent VLAN ID", the device is no longer reachable via Ethernet following the change.
Settings
VLAN ID
Enter the VLAN ID.
The table has the following columns:
VLAN ID
Shows the VLAN ID. The VLAN ID is assigned once when you create a new data record
and can then no longer be changed. To make a change, the entire data record must be
deleted and created again.
Name
Enter a name for the VLAN. The name only provides information and has no effect on the
configuration.
The VLAN name can be a maximum of 32 characters long.
Status
Shows the status of the entry. Here, static means that the address was entered as a static
address by the user. The entry GVRP means that the configuration was registered by a
GVRP frame. This is, however, only possible if GVRP was enabled for the device.
List of ports
Specify the use of the port. The following options are available:
"-"
The port is not a member of the specified VLAN.
With a new definition, all ports have the identifier "-".
M
The port is a member of the VLAN. Frames sent in this VLAN are forwarded with the
corresponding VLAN tag.
R
The port is a member of the VLAN. A GVRP frame is used for the registration.
U (upper case)
The port is an untagged member of the VLAN. Frames sent in this VLAN are forwarded
without the VLAN tag. Frames without a VLAN tag are sent from this port.
u (lower case)
The port is an untagged member of the VLAN, but the VLAN is not configured as a port
VLAN. Frames sent in this VLAN are forwarded without the VLAN tag.
F
The port is not a member of the specified VLAN and it is not possible for the VLAN to
be registered dynamically at this port using GVRP. You can configure other settings in
"Layer 2 > VLAN > Port-based VLAN".
GVRP
Settings
GVRP
Enable or disable the "GVRP" function.
Port-based VLAN
Settings
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports.
Priority / Port VID / Acceptable Frames / Ingress Filtering
Select the setting. If "No Change" is selected, the entry in table 2 remains unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Settings
Protocol Based VLAN
Enable or disable the protocol-based VLAN assignment.
Protocol Value
Enter the hexadecimal protocol value.
A few examples are shown below:
PROFINET: 88:92
IP: 08:00
Novell: 81:37
netbios: f0:f0
appletalk: 80:9b
Group ID
Enter the ID of the group.
The table has the following columns:
Protocol Value
Shows the file value.
Group ID
Shows the group ID.
Settings
Port
Select the required port. All available ports and the link aggregations can be selected.
Group ID
Select the group ID from the drop-down list. Specify the ID in "Layer 2 > VLAN > Protocol
Based VLAN Group".
The table has the following columns:
Port
All available ports and the link aggregations are shown.
Group ID
Shows the group ID assigned to the port.
VLAN ID
Select the required VLAN ID to be assigned to the port.
Settings
Subnet Based VLAN
Enable or disable the subnet-based VLAN assignment
Port
Select the port. All available ports and the link aggregations can be selected.
Subnet Address
Enter the IP address of the subnet.
Example: 192.168.10.0 for the network 192.168.10.x with nodes 192.168.10.1 to
192.168.10.254.
Subnet Mask
Enter the subnet mask.
The table has the following columns:
Port
All available ports and the link aggregations are shown.
Subnet Address
Shows the subnet assigned to the port.
Subnet Mask
Shows the subnet mask.
VLAN ID
Select the VLAN ID you want to assign to the port or the subnet.
Mirroring
Basics
Mirroring
The device provides the option of simultaneously channeling incoming or outgoing data
streams via other interfaces for analysis or monitoring. This has no effect on the monitored
data streams. This procedure is known as mirroring. In this menu section, you enable or disable
mirroring and set the parameters.
Mirroring ports
Mirroring a port means that the data traffic at a port (mirrored port) of the IE switch is copied
to another port (monitor port). You can mirror one or more ports to a monitor port.
If a protocol analyzer is connected to the monitor port, the data traffic at the mirrored port can
be recorded without interrupting the connection. This means that the data traffic can be
investigated without being affected. This is possible only if a free port is available on the device
as the monitor port.
General
On this page, you can enable or disable the mirroring function and make the basic settings.
Note
If the maximum data rate of the mirrored port is higher than that of the monitor port, data may
be lost and the monitor port no longer reflects the data traffic at the mirrored port. Several ports
can be mirrored to one monitor port at the same time.
Mirroring a port does not work beyond switch core boundaries.
Disable port mirroring if you want to connect a normal end device to the monitor port.
Settings
Mirroring
Enable or disable mirroring of the data traffic.
Monitor Barrier
Enable or disable the option to restrict communication via the monitor port.
Note
Monitor Barrier
If you enable the monitor barrier, the data traffic on the destination port is automatically
blocked (broadcast, multicast, unicast, DCP forwarding, LLDP) so that only the mirrored
traffic is present. To be able to allow other data traffic again, you need to configure this.
The previous statuses of these options are not restored after stopping the monitor barrier
and must be reconfigured.
enabled
The monitor port is taken out of normal frame switching.
disabled
Communication via the monitor port is unrestricted.
Port
Mirroring ports
You can only configure the settings on this page if you have already generated a session ID
with the session type "Port Based" on the "General" tab.
Settings
Session ID
Select the session ID. Only session IDs of the session type "Port Based" are available.
The table has the following columns:
Port
Shows the port to be monitored.
Ingress Mirroring
Enable or disable mirroring of incoming packets at the required port.
Egress Mirroring
Enable or disable mirroring of outgoing packets at the required port.
VLAN
Settings
Session ID
Select the session ID. Only session IDs of the session type "VLAN" are available.
VLAN ID
Enter a VLAN ID. The VLAN ID can only be assigned once when you create a new data
record and can then no longer be changed. To make a change, the entire data record must
be deleted and created again.
The table has the following columns:
VLAN ID
Shows the VLAN ID.
MAC Flow
You can only configure the settings on this page if you have already generated a session ID
with the session type "MAC ACL" on the "General" tab.
The MAC ACL filter decides which data is available at the monitor port.
Settings
Session ID
Select the session ID. Only session IDs of the session type "MAC ACL" are available.
The table has the following columns:
ACL Filter Number
Shows the number of the ACL filter. You configure the MAC ACL filter in "SecurityPort ACL
MAC".
Ingress Mirroring
Shows whether incoming packets are mirrored.
Note
Rules
A rule selected for ingress mirroring only becomes active if it was configured as a port
ingress rule on at least one port. You configure the port ingress rules in "Security> Port
MAC IP > Port Ingress Rules".
Source MAC
Shows the MAC address of the sender.
Dest. MAC
Shows the MAC address of the recipient.
Ingress Port
Shows a list of all ports to which this rule applies.
Egress Port
Shows a list of all ports to which this rule applies.
IP Flow
You can only configure the settings on this page if you have already generated a session ID
with the session type "IP ACL" on the "General" tab.
The IP ACL filter decides which data is mirrored to the monitor port.
Settings
Session ID
Select the session ID. Only session IDs of the session type "IP ACL" are available.
The table has the following columns:
ACL Filter Number
Shows the number of the ACL filter. You configure the IP ACL filter in "Security > Port ACL
IP".
Ingress Mirroring
Shows whether incoming packets are mirrored.
Note
Rules
A rule selected for ingress mirroring only becomes active if it was configured as a port
ingress rule on at least one port. You configure the port ingress rules in "Security> Port
ACL IP > Port Ingress Rules".
Source IP
Shows the IP address of the sender.
Source Subnet Mask
Shows the subnet mask of the sender.
Dest. IP
Shows the IP address of the recipient.
Dest. Subnet Mask
Shows the subnet mask of the recipient.
Ingress Port
Shows a list of all ingress ports to which this rule applies.
Egress Port
Shows a list of all egress ports to which this rule applies.
Settings
Dynamic MAC Aging
Enable or disable the function for automatic aging of learned MAC addresses:
Aging Time [s]
Enter the time in seconds. After this time, a learned address is deleted if the device does
not receive any further frames from this sender address.
Ring Redundancy
Ring
On this page, you can select the required mode for fast ring redundancy. The "Automatic
Redundancy Detection" ring redundancy mode is the default when the device ships.
Note
The ring redundancy cannot be enabled if Spanning Tree is still enabled on the device.
Settings
Ring Redundancy
Enable or disable ring redundancy.
Ring redundancy mode
Specify the ring redundancy mode. The following options are available:
"-" (disabled)
The redundancy function is disabled.
Automatic Redundancy Detection
Select this setting to create an automatic configuration of the redundancy mode. In this
mode, the device automatically detects whether or not there is a device with the "HRP
Manager" role in the ring. If this is the case, the device adopts the role of "HRP Client".
If no HRP manager is found, all devices with the "Automatic Redundancy Detection" or
"MRP Auto Manager" setting negotiate among themselves to establish which device
adopts the role of "MRP Manager". The device with the lowest MAC address will always
become "MRP Manager". The other devices automatically set themselves to
redundancy mode "MRP Client".
MRP Auto Manager
Devices with the setting "Automatic Redundancy Detection" or "MRP Auto Manager"
negotiate among themselves which device will adopt the "MRP Manager" role. The
device with the lowest MAC address will always become "MRP Manager". In contrast
to the setting "Automatic Redundancy Detection", the devices are not capable of
detecting whether or not an HRP manager is in the ring. This means that they never
adopt the role of HRP client.
MRP Client
In a ring whose devices are configured with MRP, at least one device must be set to the
"Automatic Redundancy Detection" or "MRP Auto Manager" mode. You can set the
"MRP Client" role for all other devices. If all devices except one are configured as "MRP
Client", this one device automatically adopts the role of "MRP Manager".
Select "MRP Client" mode if you want to operate the device along with components that
do not originate from Siemens in the ring.
HRP Client
Here, you can select the role "HRP Client".
HRP Manager
When you configure an HRP ring, one device must be set as HRP manager. All other
devices must be configured as HRP clients.
Ring ports
Specify the ports to be used as ring ports in media redundancy in ring topologies.
The ring port you select in the upper drop-down menu is the "Isolated Port" in HRP.
Note
If you restore the factory defaults, the default redundancy mode "Automatic Redundancy
Detection" becomes active.
The ring port configuration is also reset to the factory default ports. If other ports were used
previously as ring ports, with the appropriate attachment, a previously correctly configured
device can cause circulating frames and therefore the failure of the data traffic.
Observer
Enable or disable the observer. The "Observer" function is only available in HRP rings.
The ring port selected in the upper drop-down menu is connected to the "Isolated Port" of
an HRP manager.
The observer monitors malfunctions of the redundancy manager or incorrect configurations
of an HRP ring.
If the observer is enabled, it can interrupt the connected ring if errors are detected. To do
this, the observer switches a ring port to the "blocking" status. When the error is resolved,
the observer enables the port again.
Restart Observer (only available online)
If numerous errors occur in quick succession, the observer no longer enables its port
automatically. The ring port remains permanently in the "blocking" status. This is signaled
by the error LED and a message text.
After the errors have been eliminated, you can enable the port again using the "Restart
Observer" button.
Standby
Standby manager
The standby manager allows the redundant linking of two HRP rings. To do this, two
neighboring devices within a ring must be configured as standby partners. Enable the standby
manager for both standby partners and select the port via which the device is connected to
the ring you want to link to. For the "Standby Connection Name", a name unique within the
ring must be assigned for both partners. This identifies the two modules as standby partners
that belong together.
Note
To be able to use the function, HRP must be activated.
Settings
Standby
Enable or disable the standby manager.
Note
If two devices are linked by the standby function, the "Standby" function must be enabled
on both devices.
Note
The standby manager always requires an activated HRP client.
Spanning Tree
General
Settings
Spanning Tree
Enable or disable Spanning Tree.
Protocol Compatibility
Select the compatibility mode of Spanning Tree. If, for example, you select RSTP, Spanning
Tree behaves like RSTP.
The following settings are available:
STP
RSTP
MSTP
CIST general
On this page, you configure CIST.
Settings
Bridge Priority / Root Priority (only available online)
Which device becomes the root bridge is decided based on the bridge priority. The bridge
with the highest priority becomes the root bridge. The lower the value, the higher the priority.
If several devices in a network have the same priority, the device whose MAC address has
the lowest numeric value will become the root bridge. Both parameters, bridge priority and
MAC address together form the bridge identifier. Since the root bridge manages all path
changes, it should be located as centrally as possible due to the delay of the frames.
Bridge Address / Root Address(only available online)
The bridge address shows the MAC address of the device and the root address shows the
MAC address of the root bridge.
Root Port (only available online)
Shows the port via which the switch communicates with the root bridge.
Root Cost (only available online)
The path costs from this device to the root bridge.
In MSTP mode, path costs up to the root bridge are shown.
Topology Changes / Last Topology Change (only available online)
The entry for the device shows the number of reconfigurations due to the spanning tree
mechanism since the last startup. For the root bridge, the time since the last reconfiguration
is displayed as follows:
Seconds: sec unit after the number
Minutes: min unit after the number
Hour: hr unit after the number
Bridge Hello Time / Root Hello Time (only available online)
Each bridge regularly sends configuration frames (BPDUs). The interval between two such
frames is the Hello time. The default for this parameter is 2 seconds.
Bridge Forward Delay / Root Forward Delay
New configuration data is not used immediately by a bridge but only after the period
specified in the parameter. This ensures that operation is only started with the new topology
after all the bridges have the required information.
Bridge Max Age / Root Max Age (only available online)
Bridge Max Age defines the maximum "age" of a received BPDU for it to be accepted as
valid by the switch.
Bridge Max Hop Count
This parameter specifies how many MSTP nodes a BPDU may pass through. If an MSTP
BPDU is received and has a "Bridge Max Hop Count" that exceeds the value configured
here, it is discarded.
Regional root priority (only available online)
For a description, see Bridge Priority / Root Priority
Regional root address (only available online)
The MAC address of the device.
Regional root costs (only available online)
Shows the path costs from this device to the regional root bridge.
Region Name
Enter the name of the MSTP region to which this device belongs. As default, the MAC
address of the device is entered here. This value must be the same on all devices that
belong to the same MSTP region.
Region Version
Enter the version number of the MSTP region in which the device is located. This value
must be the same on all devices that belong to the same MSTP region.
Reset Counter (only available online)
Click this button to reset the counters on this page to zero.
CIST port
Settings
Table 1 has the following columns:
1st column
Shows that the setting is valid for all ports of table 2.
MSTP Status
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the available ports.
MSTP Status
Specify whether or not the port is integrated in the spanning tree.
Note
If you disable the "MSTP Status" option for a port, this may cause the formation of loops.
The topology must be kept in mind.
Priority
Enter the priority of the port. The priority is only evaluated when the path costs are the same.
The value must be divisible by 16. If the value that cannot be divided by 16, the value is
automatically adapted.
Cost Calc.
Enter the path cost calculation. If you enter the value "0" here, the automatically calculated
value is displayed in the "Path Costs" box.
The port only receives and is not involved in STP, MSTP and RSTP.
Discarding
In the "Discarding" mode, BPDU frames are received. Other incoming or outgoing
frames are discarded.
Listening
In this status, BPDUs are both received and sent. The port is involved in the spanning
tree algorithm.
Learning
Stage prior to the forwarding status, the port is actively learning the topology (in other
words, the node addresses).
Forwarding
Following the reconfiguration time, the port is active in the network; it receives and
forwards data frames.
P.t.P. Type
Select the required option. The selection depends on the port that is set.
"-"
Point to point is calculated automatically. If the port is set to half duplex, a point-to-point
link is not assumed.
P.t.P.
Hello Time
Enter the interval after which the bridge sends configuration BPDUs
Note
The port-specific setting of the Hello time is only possible in MSTP compatible mode.
MST General
Settings
MSTP Instance ID
Enter the number of the MSTP instance.
The table has the following columns:
MSTP Instance ID
Shows the number of the MSTP instance.
Root Address
Shows the MAC address of the root bridge
Root Priority
Shows the priority of the root bridge.
Bridge Priority
Enter the bridge priority. The value for the bridge priority is a whole multiple of 4096.
VLAN ID
Enter the VLAN ID. Here, you can also specify ranges with Start ID, "-", End ID. Several
ranges or IDs are separated by ",".
MST port
Settings
MSTP Instance ID
Select the ID of the MSTP instance.
Table 1 has the following columns
1st column
Shows that the setting is valid for all ports.
MSTP Status
Select the setting. If "No Change" is selected, the entry in table 2 remains unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2
Table 2 has the following columns:
Port
Shows all available ports and link aggregations.
MSTP Instance ID
ID of the MSTP instance.
MSTP Status
Enable or disable MSTP for this port.
Priority
Enter the priority of the port. The priority is only evaluated when the path costs are the same.
The value must be divisible by 16. If the value that cannot be divided by 16, the value is
automatically adapted.
Cost Calc.
Enter the path cost calculation in the input box. If you enter the value "0" here, the
automatically calculated value is displayed in the next box "Path Costs".
The port only receives and is not involved in STP, MSTP and RSTP.
Discarding
In the "Discarding" mode, BPDU frames are received. Other incoming or outgoing
frames are discarded.
Listening
In this status, BPDUs are both received and sent. The port is involved in the spanning
tree algorithm.
Learning
Stage prior to the forwarding status, the port is actively learning the topology (in other
words, the node addresses).
Forwarding
Following the reconfiguration time, the port is active in the network; it receives and
forwards data frames.
Fwd. Trans (only available online)
Specifies the number of changes from the "Discarding" status to the "Forwarding" status
Settings
Enhanced Passive Listening Compatibility
Enable or disable this function for the entire device.
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports of table 2.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
Displays the port of the device.
Setting
enabled
Enables the function for all ports of the device.
disabled
Disables the function for all ports of the device.
Loop detection
With the "Loop Detection" function, you specify the ports for which loop detection will be
activated. The ports involved send special test frames - the loop detection frames. If these
frames are sent back to the device, there is a loop.
A "local loop" involving this device means that the frames are received again at a different port
of the same device. If the sent frames are received again at the same port, there is a "remote
loop" involving other network components.
Note
A loop is an error in the network structure that needs to be eliminated. The loop detection can
help to find the errors more quickly but does not eliminate them. The loop detection is not
suitable for increasing network availability by deliberately including loops.
Note
Note that loop detection is only possible at ports that were not configured as ring ports or
standby ports.
Settings
Loop Detection
Enable or disable loop detection.
VLAN Loop Detection
Enable or disable loop detection in a VLAN.
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports of table 2
Threshold / Remote Reaction / Local Reaction
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the available ports.
Setting
Specify how the port handles loop detection frames.
Note
Test frames create additional network load. We recommend that you only configure
individual switches, for example at branch points of the ring, as "sender" and the others as
"forwarder".
sender
Loop detection frames are sent out and forwarded.
forwarder
Loop detection frames from other devices are forwarded.
blocked
The forwarding of loop detection frames is blocked.
Threshold
Specify the number of received loop detection frames as of which a loop is assumed.
Remote Reaction
Specify how the port will react if a remote loop occurs. Select one of the two options from
the drop-down list:
no action
A loop has no effect on the port.
disable
The port is blocked.
Local Reaction
Specify how the port will react if a local loop occurs. Select one of the two options from the
drop-down list:
no action
A loop has no effect on the port.
disable
The port is blocked
Status (only available online)
This box shows whether loop detection is enabled or disabled for this port.
Source Port (only available online)
Shows the output port of the loop detection frame that triggered the last reaction
Source VLAN (only available online)
Shows the VLAN ID of the loop detection frame that triggered the last reaction.
This is only possible if "VLAN Support Enabled" was selected earlier on the "Loop Detection
Configuration" page.
Reset (only available online)
After a loop in the network has been eliminated, click this button to reset the port again
Link aggregation
Settings
The table has the following columns:
Port
Shows the virtual port number of this link aggregation. This identifier is assigned internally
by the firmware.
Link Aggregation Name
Enter the name for the link aggregation. This name can be specified by the user during
configuration. The name is not absolutely necessary but can be useful to distinguish
between the various link aggregations.
MAC Address
Shows the MAC address.
Status
Enable or disable link aggregation.
MTU
Specify the packet size.
LACP
on
Enables the sending of LACP frames.
off
Disables the sending of LACP frames.
Frame Distribution
Set the type of distribution of packets on the individual links of an aggregation.
Destination&Source Mac
The distribution is based on a combination of the destination and source MAC address.
Destination&Source IP-MAC
The distribution is based on a combination of the destination and source IP address and
MAC address.
VLAN Mode
Specify how the link aggregation is entered in a VLAN:
Hybrid
The link aggregation sends tagged and untagged frames. It is not automatically a
member of a VLAN.
Trunk
The link aggregation only sends tagged frames and is automatically a member of all
VLANs.
Port
Shows the ports that belong to this link aggregation. The following values can be selected
from the drop-down list:
"-" (disabled)
Link aggregation is disabled.
"a" (active)
The port sends LACP frames and is only involved in the link aggregation when LACP
frames are received.
"p" (passive)
The port is only involved in the link aggregation when LACP frames are received.
"o" (on)
The port is involved in the link aggregation and does not send any LACP frames.
Note
Within a "link aggregation", only ports with the following configuration are possible:
all ports with "o"
all ports with "a" or "p".
DCP forwarding
Applications
The DCP protocol is used by STEP 7 and the PST Tool for configuration and diagnostics.
When shipped, DCP is enabled on all ports; in other words, DCP frames are forwarded at all
ports. With this option, you can disable the sending of these frames for individual ports, for
example to prevent individual parts of the network from being configured with the PST Tool or
to divide the full network into smaller parts for configuration and diagnostics.
Settings
Table 1 has the following columns:
1st column
Shows that the setting is valid for all ports of table 2.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the available ports.
Setting
Specify whether the port should block or forward outgoing DCP frames. The following
options are available:
forward
DCP frames are forwarded via this port.
block
No outgoing DCP frames are forwarded via this port. It is nevertheless still possible to
receive via this port.
LLDP
Applications
PROFINET uses the LLDP protocol for topology diagnostics. In the default setting, LLDP is
enabled for all ports; in other words, LLDP frames are sent and received on all ports. With this
function, you have the option of enabling or disabling sending and/or receiving per port.
Settings
Table 1 has the following columns:
1st column
Shows that the setting is valid for all ports of table 2.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the port.
Setting
Specify the LLDP functionality. The following options are available:
Rx
This port can only receive LLDP frames.
Tx
This port can only send LLDP frames.
Rx & Tx
This port can receive and send LLDP frames.
"-" (disabled)
This port can neither receive nor send LLDP frames.
Unicast
Filter
Address filtering
This page shows the current content of the unicast filter table. This table lists the source
addresses of unicast address frames. The displayed entries were made statically, in other
words, the user set them.
On this page, you also define the static unicast filters.
Settings
VLAN ID
Select the VLAN ID in which you configure a new static MAC address. If nothing is set,
"VLAN1" is set as the basic setting.
MAC Address
Enter the MAC address here.
Learning
Starting/stopping learning
Note
The page is only available if there is an online connection to the device.
With the automatic learning function, all connected devices are automatically entered in the
unicast filter table. As long as the "Start learning" function is enabled, all learned unicast
addresses are created immediately as static unicast entries.
The learning process is ended only after clicking the "Stop learning" button. With this method,
learning can take a few minutes or several hours in larger networks before all nodes have
really been learned. Only nodes that send packets during the learning phase are found.
By subsequently enabling the Port Lock function, only packets from the nodes known after the
end of the learning phase (static unicast entries) will be accepted at the relevant ports.
Note
If the Port Lock function was already active on individual ports prior to the automatic learning
phase, no addresses will be learned on these ports. This makes it possible to restrict learning
to certain ports. To do this, first enable the Port Lock function of the ports that are not intended
to learn addresses.
Settings
Start learning
Click the "Start learning" button to start the learning phase.
The device now enters the addresses of connected devices until you stop the function.
Stop learning
Click the "Stop Learning" button to stop the learning phase.
The learned entries are stored.
Deleting all static unicast addresses
Click the "Clear all static unicast addresses" button to delete all static entries.
In large networks with numerous nodes, automatic learning may lead to a lot of undesired
static entries. To avoid having to delete these individually, this button can be used to delete
all static entries. This function is disabled during automatic learning.
Note
Depending on the number of entries involved, deleting may take some time.
Locked ports
Settings
Table 1 has the following columns:
1st column
Shows that the setting is valid for all ports of table 2.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the available ports.
Setting
Enable or disable access the port lock function for the port.
Blocking
Settings
Table 1 has the following columns:
1st column
Shows that the setting is valid for all ports of table 2.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the available ports.
Setting
Enable or disable the blocking of unicast frames
Note
Ring redundancy / standby
If ring redundancy or standby is enabled, the ports configured for this are not included in
the blocking.
Multicast
Groups
Multicast applications
In the majority of cases, a frame is sent with a unicast address to a particular recipient. If an
application sends the same data to several recipients, the amount of data can be reduced by
sending the data using one multicast address. For some applications, there are fixed multicast
addresses (NTP, IETF1 Audio, IETF1 Video etc.).
Settings
VLAN ID
Select the VLAN ID to be assigned to the MAC multicast address.
MAC Address
Here you enter a new MAC multicast address you want to configure.
The table has the following columns:
VLAN ID
Shows VLAN ID of the VLAN to which the MAC multicast address is assigned.
MAC Address
Shows the MAC multicast address that the device has learned or the user has configured.
Status
Shows the status of each address entry. The following information is possible:
static
The address was entered statically by the user. Static addresses are stored
permanently; in other words, they are not deleted when the aging time expires or when
the device is restarted. These must be deleted by the user.
IGMP
Function
IE switches support "IGMP snooping" and the IGMP querier function. If "IGMP snooping" is
enabled, IGMP frames are evaluated and the multicast filter table is updated with this
information. If "IGMP Querier is also enabled, IE switches also send IGMP queries that trigger
responses from IGMP-compliant nodes.
Settings
IGMP Snooping
Enable or disable IGMP (Internet Group Management Protocol). The function allows the
assignment of IP addresses to multicast groups. If the check box is selected, IGMP entries
are included in the table and IGMP frames are forwarded.
IGMP Snooping Aging Time
Enter the value for the aging time in seconds in this box.
IGMP Querier
Enable or disable "IGMP Querier". The device sends IGMP queries.
GMRP
Enabling GMRP
By selecting the check box, you specify whether or not GMRP is used for each individual port.
If "GMRP" is disabled for a port, no registrations are made for it and it cannot send GMRP
frames.
Settings
GMRP
Enable or disable the GMRP function.
Blocking
On this page, you can block the forwarding of unknown multicast frames for individual ports.
Settings
Table 1 has the following columns:
1st column
Shows that the setting is valid for all ports of table 2.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the available ports.
Setting
Enable or disable the blocking of multicast frames.
Broadcast
Note
Some communication protocols work only with the support of broadcast. In these cases,
blocking can lead to loss of data communication. Block broadcast only when you are sure that
you do not need it.
Settings
Table 1 has the following columns:
1st column
Shows that the setting is valid for all ports of table 2.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Transfer to table
If you click the button, the setting is adopted for all ports of table 2.
Table 2 has the following columns:
Port
All available ports and the link aggregations are shown.
Setting
Enable or disable the blocking of broadcast frames.
PTP
General
Note
PTP is only available with SCALANCE X500.
The Precision Time Protocol (PTP) complying with IEEE 1588v2 allows the time-of-day
synchronization of devices connected to the ports of a device. These devices forward the
synchronization frames through the network using the "Transparent Clock" (TC) mechanism.
The connection mechanisms "end-to-end" and "peer-to-peer" are supported.
To use IEEE 1588v2, enable this function and configure every port that is on the
synchronization path as well as ports that are blocked due to redundancy mechanisms. IEEE
1588v2 can also be used with redundancy mechanisms in the ring such as HRP, standby
linking of rings, MRP and RSTP.
Setting
1588 Mode
You can make the following settings:
off
The device does not process any PTP messages. PTP messages are, however,
forwarded according to the rules of the device.
transparent
The device adopts the function of a transparent clock and forwards PTP messages to
other nodes while at the same time making entries in the correction field of the PTP
message.
TC general
Settings
Delay Mechanism
Specify the delay mechanism the device will work with:
End-to-end(delay request response mechanism will be used)
Peer-to-peer (peer delay mechanism will be used)
Domain Number
Enter the identification number for the time domain. Synchronization is only for the devices
within the domain. The device ignores PTP messages with a different domain number. A
SCALANCE device can only be assigned to one synchronization domain.
TC port
On this page, you specify the ports that can process PTP messages.
Settings
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports of table 2.
Setting / Transport Mechanism
Select the setting. If "No Change" is selected, the entry in table 2 remains unchanged.
Transfer to table
If you click the button, the settings are adopted for all ports of table 2.
RMON
Statistics
Statistics
On this page you can specify the ports for which statistics are displayed.
Settings
RMON
If you select this check box, Remote Monitoring (RMON) allows diagnostics data to be
collected on the device, prepared and read out using SNMP by a network management
station that also supports RMON. This diagnostic data, for example port-related load trends,
allow problems in the network to be detected early and eliminated.
Port
Select the ports for which statistics will be displayed.
The table has the following columns:
1st column
Select the check box of the ports for which no more statistics will be displayed.
Port
Shows the ports for which statistics will be displayed.
History
Settings
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports.
Setting
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Entries
Enter the maximum number of samples to be stored at the same time. If "No Change" is
entered, the entry in table 2 remains unchanged.
Interval [s]
Enter the interval after which the current status of the statistics will be saved as a sample.
If "No Change" is entered, the entry in table 2 remains unchanged.
Transfer to table
If you click the button, the settings are adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the port to which the settings relate.
Setting
Enable the port for which the history will be displayed.
Entries
Enter the maximum number of samples to be stored at the same time.
Interval [s]
Enter the interval after which the current status of the statistics will be saved as a sample.
Configuration
The page contains the overview of the layer 3 functions of the device. To use the "Routing",
"VRRP", "OSPF" and "RIP" functions, the device requires a KEY-PLUG.
Settings
Routing (only available on layer 3)
Enable or disable the "Routing" function.
DHCP Relay Agent
Enable or disable the DHCP relay agent. You can configure other settings in "Layer 3 >
DHCP Relay Agent".
VRRP (only available on layer 3)
Enable or disable routing using VRRP. To use VRRP, first enable the "Routing" function.
You can configure other settings in "Layer 3 > VRRP".
OSPF (only available on layer 3)
Enable or disable routing using OSPF. To use OSPF , first enable the "Routing" function.
You can configure other settings in "Layer 3 > OSPFv2".
RIP (only available on layer 3)
Enable or disable routing using RIP. To use RIO , first enable the "Routing" function. You
can configure other settings in "Layer 3 > RIPv2".
Subnets
Overview
Subnet
The page shows the subnets for the selected interface. If more than one subnet is available
on an interface, the first entry of this interface is of the address type "Primary". All other subnets
have the address type "Secondary".
On this page, you can create further subnets "Layer 3 > Subnets > Overview". In "Layer 3 >
Subnets > Configuration", you configure the settings of the created subnets.
Settings
The following settings are possible for subnets of the "Secondary" address type:
Interface
Select the interface on which you want to configure another subnet.
The table has the following columns:
Interface
Shows the interface.
TIA Interface
Shows whether or not the entry is a TIA interface.
Interface Name
Shows the name of the interface.
MAC Address
Shows the MAC address.
IP Address
Shows the IP address of the subnet.
Subnet Mask
Shows the subnet mask.
Address Type
Shows the address type. The following values are possible:
Primary
The first IP address that was configured on an IP interface.
Secondary
All other IP addresses that were configured on an interface.
IP Assignment Method
Shows how the IP address is assigned.
Static
The IP address is static. You enter the IP settings in "IP Address" and "Subnet Mask".
Automatic (DHCP)
The device obtains a dynamic IP address from a DHCP server.
Address Collision Detection Status
Shows the status of the "Detection of address collisions" function.
Idle
The interface is not enabled and does not have an IP address.
Starting
This status indicates the start-up phase. In this phase, the device initially sends a query
as to whether the planned IP address already exists. If the address is not yet been
assigned, the device sends the message that it is using this IP address as of now.
Conflict
The interface is not enabled. The interface is attempting to use an IP address that is
already been assigned.
Defending
The interface uses a unique IP address. Another interface is attempting to use the same
IP address.
Active
The interface uses a unique IP address. There are no collisions.
Not supported
The function for detection of address collisions is not supported.
Configuration
On this page, you configure the subnet. You create the subnet in "Layer 3 > Subnets >
Overview".
Settings
Interface (Name)
Select the required interface.
Interface Name
Enter the name of the interface, e.g. eth0; P3.
MAC Address (only available online)
Shows the MAC address of the selected interface
DHCP
Enable or disable the DHCP client for this interface.
IP Address
Enter the IP address of the subnet. The IP address must not be used more than once.
Subnet Mask
Enter the subnet mask of the subnet you are creating. Subnets on different interfaces must
not overlap.
Address Type
Shows the address type. The following values are possible:
Primary
The first subnet of the interface.
Secondary
All other subnets of the interface.
Address Collision Detection
Enable or disable the function.
If new IP addresses become active in the network, this function checks whether this can
result in address collisions.
With this function, IP addresses that will be assigned twice can be detected.
Note
The function does not run a cyclic check.
TIA Interface
Enable or disable the setting.
The following conditions apply to the TIA interface:
Only interfaces with the address type "Primary" can be enabled as the TIA interface.
There must only ever be one TIA interface.
There can only be one TIA interface.
A TIA interface is always a VLAN interface.
TIA Interface
The TIA interface is the interface via which all PROFINET functions of the IE switch are handled.
TIA interface is the name of the IP address for PROFINET from the perspective of the IE switch.
PROFINET interface
You make the IP setting of the PROFINET device in TIA under PROFINET interface.
PROFINET interface is the name of the IP address for PROFINET from the perspective of the
TIA Portal.
Routes
Static route
On this page, you create the static routes. During automatic adaptations, static routes are not
taken into account and need to be adapted manually.
Settings
Destination Network
Enter the network address of the destination.
Subnet Mask
Enter the corresponding subnet mask.
Gateway
Enter the IP address of the next gateway.
Metric
Enter the metric for the route. The metric corresponds to the quality of a connection, for
example speed, costs.
The table has the following columns:
Destination Network
Shows the network address of the destination.
Subnet mask
Shows the corresponding subnet mask.
Gateway
Shows the IP address of the next gateway.
Interface (only available online)
Shows the interface of the route.
Metric
Enter the metric for the route. When creating the route, "not used" is entered automatically.
The metric corresponds to the quality of a connection, for example speed, costs. If there
are several equal routes, the route with the lowest metric value is used.
Status (only available online)
Shows the status of the route.
Route maps
General
Route maps
With route maps, you control how routing information is further processed. You can filter routing
information and specify whether the information is further processed, modified or discarded.
Route maps operate according to the following principle:
Routing information is compared with the filters of the route maps.
The comparison is continued until the filters of a route map match the properties of an item
of information.
The information is then processed according to the route map settings:
The routing information is discarded.
The properties of the routing information are changed.
Settings
Name
Enter the name for the route map.
Sequence No
Enter a number for the route map.
The number specifies the order in which the route maps are processed.
The table has the following columns:
Name
Shows the name of the route map.
Sequence No
Shows the sequence number of the route map.
Action
Specify what happens to the routing information that matches the settings of the route map:
permit
The routing information is further processed according to the settings you make in the
"Settings" tab.
deny
The routing information is discarded.
Settings
Route Map (name/seq. no.)
Select a route map.
The created route maps are available to you.
Type
Select the basis for the filtering:
Interface
Metric
Tag
Interface
Select an interface.
This box is active only if you have selected the "Interface" entry in the "Type" drop-down
list.
Metric
Enter a value for the metric.
This box is active only if you have selected the "Metric" entry in the "Type" drop-down list.
Tag
Enter a value for the tag.
This box is active only if you have selected the Tag entry in the "Type" drop-down list.
The table has the following columns:
Type
Shows the selected type:
Interface
Metric
Tag
Value
Shows the selected interface or the value of the metric.
Destination match
On this page, you specify whether or not the routing information for a route map is filtered
based on the destination IP address.
Settings
Route Map (name/seq. no.)
Select a route map.
IP Address
Enter the IP address of the destination on which the filtering is based.
Subnet Mask
Enter the subnet mask of the destination on which the filtering is based.
Settings
Route Map (name/seq. no.)
Select a route map.
IP Address
Enter the IP address of the router to which the routing information will be sent next.
The table has the following columns:
IP Address
Shows the IP address of the next router.
Settings
On this page, you specify whether or not the routing information for a route map will be changed.
If, for example, you have filtered based on a certain metric, you can change the value of the
metric here. The routing information is then forwarded with the new value.
Settings
Route Map (name/seq. no.)
Select a route map.
The table has the following columns:
Name
Shows the name of the route map.
Sequence No
Shows the sequence number of the route map.
Metric
Enter the new value for the metric with which the routing information will be forwarded.
Tag
Enter the new value for the tag with which the routing information will be forwarded.
General
If the DHCP server is in a different network, the device cannot reach the DHCP server. The
DHCP relay agent intercedes between a DHCP server and the device. The DHCP relay agent
forwards the port number of the device with the DHCP query to the DHCP server. If a DHCP
server is unreachable, the device can switch to a different DHCP server.
Settings
DHCP Relay Agent (Opt. 82)
Enable or disable the DHCP relay agent.
Server IP Address
Enter the IP address of the DHCP server.
The table has the following columns:
Server IP address
Shows the IP address of the DHCP server.
Option
Settings
Global configuration
Circuit ID router index
When enabled, the router index is added to the generated circuit ID.
Circuit ID recipient VLAN ID
When enabled, the VLAN ID is added to the generated circuit ID.
Circuit ID receiving port
When enabled, the receiving port is added to the generated circuit ID.
Note
You need to select a least one option.
Remote ID
Shows the device ID.
Interface-specific configuration
Interface
Select the required interface.
The table has the following columns:
Interface
Shows the selected interface.
Remote ID type
Select the type of the device ID. You have the following options:
IP Address
The current IP address of the interface will be used as the device identifier and copied
to the "Remote ID" box.
Note
No automatic updating
There is no link between the "Remote ID" box and the currently set IP address.
If the IP address is changed, the new IP address is not entered in the "Remote ID" box
automatically. Only the value of the "Remote ID Type" box changes to "Free Text". To
use the current IP address again, select "IP Address" again in the "Remote ID Type"
box.
MAC Address
The MAC address of the device is used as the device ID.
Free Text
If you use "Free Text", you can enter the device name as the device identifier in the
"Remote ID" box.
Remote ID
The box can only be edited if you select the entry "Free Text" for "Remote ID Type".
The remote IP must be unique.
Circuit ID Type
Select the type of circuit ID from the drop-down list. You have the following options:
Predefined
The circuit ID is created automatically based on the router index, VLAN ID or port.
Free Number
If you use "Free Number", you can enter the ID for "Circuit ID".
Circuit ID
Enter the circuit ID.
The box can only be edited if you select the "Free Number" entry for the "Circuit ID Type".
VRRP
Router
On this page, you create virtual routers. You can configure other parameters in "Layer 3 >
VRRP > Configuration".
Note
VRRP is available only on layer 3.
VRRP can only be used in conjunction with VLAN interfaces. Router ports are not supported.
Select "VRRP" to configure VRRP
Settings
The following settings are available:
VRRP
Enable or disable routing using VRRP.
React to pings on virtual interfaces
When enabled, the virtual IP addresses also reply to the ping.
Interface
Select the interface operating as virtual router.
VRID
Enter the ID of the virtual router in the input box. This ID defines the group of routers that
form a virtual router (VR). In the group, this is the same. it can no longer be used for other
groups.
The table has the following columns:
Interface
Shows the Interface that functions as the virtual router.
VRID
Shows the ID of the virtual router.
Virtual MAC Address
Shows the virtual MAC address of the virtual router.
Primary IP Address
Shows the primary IP address in this VLAN. The entry 0.0.0.0 means that the "Primary"
address on this VLAN is used. Otherwise all IP addresses configured in this VLAN in "Layer
3 > Subnets" are valid values.
Router Status
Shows the current status of the virtual router. Possible values are as follows:
Master
The router is the master router and handles the routing functionality for all assigned IP
addresses.
Backup
The router is the backup router. If the master router fails, the backup router takes over
the tasks of the master router.
Initialize
The virtual router has just been turned on. It will soon change to the "Master" or "Backup"
status.
Master IP Address (only available online)
Shows the IP address of the master router.
Priority
Shows the priority of the virtual router.
The current master router is automatically given 255. All other priorities can be distributed
freely among the VRRP routers. The higher the priority, the earlier the VRRP router
becomes "Master".
Advert. Internal
Shows the interval at which the master router sends VRRP packets.
Preempt
Shows the precedence of a router when changing roles between backup and master.
yes
This router has precedence when changing roles.
no
This router does not have precedence when changing roles.
Configuration
Introduction
On this page, you configure the virtual router.
Note
VRRP is available only on layer 3.
Master
If this option is enabled, the primary IP address is entered for "Associated IP Address". This
means that the highest priority IP address of the VRRP router is used as the virtual IP
address of the virtual master router. The option must be disabled for the backup routers in
this group and the IP address of the router in "Assigned IP address" must be used.
Priority
Enter the priority of this virtual router.
The current master router is always given 255. All other priorities can be distributed freely
among the redundant routers. The higher the priority, the earlier the router becomes
"Master".
Advertisement Interval [s]
Enter the interval in seconds after which a master router sends a VRRP packet again.
Preempt lower priority master
Allow the precedence when changing roles between Backup and Master based on the
selection process.
Address overview
Overview
This page shows which IP addresses the virtual router monitors.
Note
VRRP is available only on layer 3.
Settings
The table has the following columns:
Interface
Shows the Interface that functions as the virtual router.
VRID
Shows the ID of this virtual router.
Number of Addresses
Shows the number of IP addresses.
Associated IP Address (1) ... Associated IP Address (4)
Shows the router IP addresses monitored by this virtual router. If a router takes over the
role of master, the routing function is taken over by this router for all these IP addresses.
Address configuration
Note
VRRP is available only on layer 3.
Settings
The following settings are possible:
Interface / VRID
Select the required virtual router.
Associated IP Address
Enter the IP address that the virtual router will monitor.
The table has the following columns:
Associated IP Address
Shows the IP addresses that the virtual router monitors.
OSPFv2
Configuration
Introduction
On this page, you configure routing with OSPF.
Note
OSPF is available only on layer 3.
Settings
OSPFv2
Enable or disable routing using OSPF.
Router ID
Enter the name of one of the OSPF interfaces. The name is entered in the IP address format
and does not need to match the local IP address.
OSPFv2 RFC1583 Compatibility
Enable the option if you still have old OSPF routers in operation that are not compatible
with RFC 2328.
Border Router
Shows the status of the OSPF router. If the local system is an active member in at least 2
areas, this is an area border router.
AS Border Router
Specify whether the router is an AS border router. An AS border router intercedes between
multiple autonomous systems, for example if you have an additional RIP network. An AS
border router is also necessary to add and to distribute static routes.
New LSA Received (only available online)
Shows the number of received LSAs.
Updates and local LSAs are not counted.
New LSA Configured (only available online)
Number of different LSAs sent by this local system.
External LSA Maximum
To limit the number of entries of external LSAs in the database, enter the maximum number
of external LSAs.
Exit Interval [s]
Enter the interval after which the OSPF router once again attempts to come out of the
overflow status. A 0 means that the OSPF router attempts to exit the overflow status only
following a restart.
Inbound Filter
Select a route map that filters inbound routes.
Redistribute Routes
Specify which known routes are distributed using OSPF.
The following types of route exist:
Default
Connected
Static
RIPv2
Note
The settings can only be enabled on an AS border router. Enabling "Default" and "Static",
in particular, can cause problems if they are enabled at too many points in the network, for
example, forwarding loops.
Route Map
Select a route map that filters which routes are forwarded using OSPF.
Areas
Overview
An autonomous system can be divided into smaller areas.
On this page, you can view, create, modify or delete the areas of the router.
Note
OSPF is available only on layer 3.
Settings
Area ID
Enter the ID of the area. The database is synchronized for all routers of an area.
Input format: x.x.x.x
x = 0 ... 255
This table contains the following columns:
Area ID
Shows the ID of the area.
Area Type
Select the area type from the drop-down list.
Normal
Stub
NSSA
Backbone
Summary
Specify whether summary LSAs are generated for this area.
Summary: Summary LSAs are sent to the area.
No Summary: Summary LSAs are not sent to the area.
Metric
Shows the costs of the default route for the area types "Stub" and "NSSA". The initial value
depends on the assigned OSPF interface.
The metric can be edited for the area types "Stub" and "NSSA". It specifies the costs
for the default route via which external networks can be reached.
The metric cannot be edited for the area type "Normal".
Area range
Note
OSPF is available only on layer 3.
Settings
Area ID
Select the area ID. You configure the ID in "Layer 3 > OSPFv2 > Areas".
Subnet Address
Enter the address of the network that will be grouped.
Subnet Mask
Enter the subnet mask of the network that will be grouped.
This table contains the following columns:
Area ID
Shows the ID of the area.
Subnet Address
Shows the address of the network that will be grouped with other networks.
Subnet Mask
Shows the subnet mask of the network that will be grouped with other networks.
Advertise
Enable this option to advertise the grouped network.
Interfaces
Overview
On this page, you can configure OSPF interfaces.
Note
OSPF is available only on layer 3.
Settings
IP Address
Select the IP address of the OSPF interface.
Area ID
Select the area ID of the area with which the OSPF interface is connected.
Note
For secondary address types, select the same Area ID as for the corresponding primary
address type.
The information whether an address type is primary or secondary can be found in the
"Address Type" column on the "Subnets > Overview" page.
Retrans. Delay
Enter the time after which an OSPF packet is transferred again if no confirmation was
received.
Hello Interval
Enter the interval between two Hello packets.
Dead Interval
Enter the interval after which the neighbor router is marked as "failed" if no more Hello
packets are received from it during this time.
Interface authentication
Note
OSPF is available only on layer 3.
Settings
OSPF Interface
Select the OSPF interface for which you want to configure authentication.
Authentication type
Select the authentication method of the OSPF interface. You have the following options:
None: No authentication
simple: Authentication using an unencrypted password
MD5: Authentication using MD5
Simple authentication
Password
For "Simple authentication, enter the password if you have selected this type of
authentication.
Confirmation
Confirm the entered password.
MD5 authentication
Authentication Key ID
If you have selected this type of authentication, enter the ID for the MD5 authentication
under which the password is used as the key. Since the key ID is transferred with the
protocol, the same key must be stored under the same key ID on all neighboring routers.
Virtual links
Overview
Due to the protocol, each area border router must have access to the backbone area. If a
router is not connected directly to the backbone area, a virtual link to it is created.
Note
OSPF is available only on layer 3.
Note
Note that when creating a virtual link both the transit area and the backbone area must already
be configured.
the virtual link must be configured identically at both ends.
Note
Virtual links are not effective unless the device is an ABR. (only available online)
This is displayed when at least one virtual link entry is configured and the device is not an
area border router.
Settings
Neighbor Router ID
Enter the ID of the neighbor router at the other end of the virtual connection.
Transit Area ID
Select the ID of the area that connects the two routers.
This table contains the following columns:
Transit Area ID
Shows the ID via which the two routers are connected.
Neighbor Router ID
Shows the ID of the neighbor router at the other end of the virtual connection.
Note
OSPF is available only on layer 3.
Settings
Virtual link (area/neighbor)
Select the virtual link for which you want to configure authentication.
Authentication type
Select the authentication method of the OSPF interface. You have the following options:
None: No authentication
simple: Authentication using an unencrypted password.
MD5: Authentication using MD5
Simple authentication
Password
Enter the password for "simple authentication".
Confirmation
Confirm the entered password.
MD5 authentication
Authentication Key ID
Enter the ID for MD5 authentication with which the password will be used as a key. Since
the key ID is transferred with the protocol, the same key must be stored under the same
key ID on all neighboring routers.
The table has the following columns:
Authentication Key ID
Can only be edited if you set the MD5 authentication method. It is only possible to use
several keys there.
MD5 Key
Enter the MD5 key.
Confirm MD5 Key
Confirm the entered key.
Youngest Key ID
Shows whether or not the MD5 key is the latest key ID.
RIPv2
Configuration
On this page, you configure routing with RIP.
Note
RIPv2 is available only on layer 3.
Settings
RIPv2
Enable or disable routing using RIPv2.
Inbound Filter
Select a route map that filters inbound routes.
Redistribute Routes
Specify which known routes are distributed using RIPv2.
The following types of route exist:
Static Default
Connected
Static
OSPF
Route Map
Select a route map that filters which routes are forwarded using RIPv2.
Interfaces
Overview
On this page, you can configure RIPv2 interfaces.
Note
RIPv2 is available only on layer 3.
Settings
IP Address
Select the IP address of the RIPv2 interface.
This table contains the following columns:
IP Address
Displays the IP address of the RIPv2 interface.
Send Updates
Select the way in which updates are sent:
no send
No updates are sent.
RIPv1
Updates for RIPv1 are sent.
RIPv1-compat.
RIPv2 updates are sent as broadcasts according to the rules of RIPv1.
RIPv2
Updates for RIPv2 are sent as multicasts.
RIPv1 demand/RIPv2 demand
RIP packets are sent only as a response to an explicit query.
Receive Updates
Select the form in which received updates are accepted:
no receive
No updates are received.
RIPv1
Only updates of RIPv1 are received.
RIPv2
Only updates of RIPv2 are received.
RIPv1/v2
Updates of RIPv1 and RIPv2 are received.
Default Metric
Enter the costs for the RIPv2 interface.
Passwords
Note
The page is only available if there is an online connection to the device.
Only the administrator can change the device passwords for administrator and users.
The factory settings for the passwords when the devices ship are as follows:
Administrator: admin
User: user
Note
If you log on the first time or log on after a "Reset to factory defaults and restart", you will be
prompted to change the password.
Note
Changing the password in "Trial" configuration mode
Even if you change the password in "Trial" configuration mode, this change is saved
immediately.
Settings
Current Admin Password
Enter the valid administrator password.
User name
Select the required user. The following options are available:
Administrator: admin
User: user
New Password
Enter the new password.
Password Confirmation
Confirm the new password.
AAA
General
The term "AAA" used in the menu stands for "Authentication, Authorization, Accounting" and
is used to identify and allow network nodes, to provide them with the appropriate services and
to determine the amount of use.
Settings
Login Authentication
Specify how the login is made:
Local
Login with local user name and password.
RADIUS
Login using a RADIUS server.
RADIUS client
The term "AAA" used in the menu stands for "Authentication, Authorization, Accounting" and
is used to identify and allow network nodes, to provide them with the appropriate services and
to determine the amount of use.
Settings
The table has the following columns:
Server IP Address
Enter the IP address of the RADIUS server.
Server Port
Here, enter the input port on the RADIUS server. As default, input port 1812 is set.
Shared Secret
Enter your access ID.
Confirm Shared Secret
Enter your access ID again as confirmation.
Max. Retrans
Enter the maximum number of query attempts before another configured RADIUS server
is queried or the login counts as having failed. As default, 3 is set.
Primary Server
Specify whether or not this server is the primary server. You can select one of the options
"yes" or "no".
Status
Enable or disable the RADIUS server.
Note
You can configure a maximum of three servers on this page.
802.1x-Authenticator
The term "AAA" used in the menu stands for "Authentication, Authorization, Accounting" and
is used to identify and allow network nodes, to provide them with the appropriate services and
to determine the amount of use.
Settings
MAC Authentication
Enable or disable MAC authentication for the device.
Guest VLAN
Enable or disable the "Guest VLAN" function for the device.
Table 1 has the following columns:
1st column
Shows that the settings are valid for all ports of table 2.
802.1x Auth. Control
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
802.1x Re-authentication
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
MAC Authentication
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Adopt RADIUS VLAN Assignment
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
MAC Auth. Max Permitted Addresses
Enter how many end devices are allowed to be connected to the port at the same time. If
"No Change" is entered, the entry in table 2 remains unchanged.
Guest VLAN
Select the required setting. If "No Change" is selected, the entry in table 2 remains
unchanged.
Guest VLAN ID
Enter the VLAN ID of the port. If "No Change" is entered, the entry in table 2 remains
unchanged.
Guest VLAN max. Permitted Addresses
Enter how many end devices are allowed in the guest VLAN at the same time.
Transfer to table
If you click the button, the settings are adopted for all ports of table 2.
Table 2 has the following columns:
Port
Shows the port to which the setting relates.
If a configuration is not possible for a port, it is displayed grayed out and you cannot modify
the settings.
802.1x Auth. Control
Specify the authentication of the port:
Force Unauthorized
Data traffic via the port is blocked.
Force Authorized
Data traffic via the port is allowed without any restrictions.
Default setting
Auto
End devices are authenticated on the port with the "802.1x" method.
The data traffic via the port is permitted or blocked depending on the authentication
result.
802.1x Re-authentication
Enable this option if you want reauthentication of an already authenticated end device to
be repeated cyclically.
MAC Authentication
Enable this option if you want end devices to be authenticated with the "MAC
Authentication" method.
Adopt RADIUS VLAN Assignment
The RADIUS server informs the IE switch of the VLAN to which the port belongs.
Enable this option if you want the information of the server to be taken into account. The
port then belongs to the corresponding VLAN.
If the option is disabled, the VLAN information is discarded.
MAC Auth. Max Permitted Addresses
Enter how many end devices are allowed to be connected to the port at the same time.
Guest VLAN
Enable this option if you want the end device to be permitted in the guest VLAN if
authentication fails.
Guest VLAN ID
Enter the VLAN ID of the port.
Rule configuration
On this page, you specify the ACL rules for the MAC-based ACL.
Settings
The table has the following columns:
Rule Number
Shows the number of the ACL rule. When you create a rule, a new row with a unique number
is created.
Source MAC
Enter the unicast MAC address of the source.
Dest. MAC
Enter the unicast MAC address of the destination.
Action
Select the action. The following is possible:
Forward
If the frame complies with the ACL rule, the frame is forwarded.
Discard
If the frame complies with the ACL rule, the frame is not forwarded.
Ingress Port
Shows a list of all ingress ports to which this rule applies.
Egress Port
Shows a list of all egress ports to which this rule applies.
Note
If you enter the address "00:00:00:00:00:00" for the source and/or destination MAC address,
the rule created in this way applies to all source or destination MAC addresses.
Settings
Ports
Select the required port.
Add Rule
Select the ACL rule to be assigned to the port. You specify the ACL rule on the "Rules
Configuration" page.
Add
To permanently assign the ACL rule to the port, click the "Add" button. The configuration
is shown in the table.
Remove Rule
Select the ACL rule to be deleted.
Remove
To remove the ACL rule from the port, click the "Remove" button.
The table has the following columns:
Rule Order
Shows the order of the ACL rules.
Rule Number
Shows the number of the ACL rule. When you create a rule, a new row with a unique number
is created.
Source MAC
Shows the unicast MAC address of the source.
Dest. MAC
Shows the unicast MAC address of the destination.
Action
Select the action. The following is possible:
Forward
If the frame complies with the ACL rule, the frame is forwarded.
Discard
If the frame complies with the ACL rule, the frame is not forwarded.
Description
Ports
Select the required port.
Add Rule
Select the ACL rule to be assigned to the port. You specify the ACL rule on the "Rules
Configuration" page.
Add
To permanently assign the ACL rule to the port, click the "Add" button. The configuration
is shown in the table.
Remove Rule
Select the ACL rule to be deleted.
Remove
To remove the ACL rule from the port, click the "Remove" button.
The table has the following columns:
Rule Order
Shows the order of the ACL rules.
Rule Number
Shows the number of the ACL rule. When you create a rule, a new row with a unique number
is created.
Source MAC
Shows the unicast MAC address of the source.
Dest. MAC
Shows the unicast MAC address of the destination.
Action
Select the action. The following is possible:
Forward
If the frame complies with the ACL rule, the frame is forwarded.
Discard
If the frame complies with the ACL rule, the frame is not forwarded.
Port ACL IP
Rule configuration
On this page, you specify the rules for the IP-based ACL.
Settings
The table has the following columns:
Rule Number
Shows the number of the ACL rule. When you create a rule, a new row with a unique number
is created.
Source IP
Enter the IP address of the source.
Source Subnet Mask
Enter the subnet mask in which the source is located.
Dest. IP
Enter the IP address of the destination.
Dest. Subnet Mask
Enter the subnet mask in which the destination is located.
Action
Select the action from the drop-down list. The following is possible:
Forward
If the frame complies with the ACL rule, the frame is forwarded.
Discard
If the frame complies with the ACL rule, the frame is not forwarded.
Ingress Port
Shows a list of all ingress ports to which this rule applies.
Egress Port
Shows a list of all egress ports to which this rule applies.
Protocol configuration
On this page, you specify the rules for protocols.
Settings
The table has the following columns:
Rule Number
Shows the number of the protocol rule. When you create a rule, a new row with a unique
number is created.
Protocol
Select the protocol for which this rule is valid.
Protocol Number
Enter a protocol number to define further protocols.
This box can only be edited if you have set "Other Protocol" for the protocol.
Source Port Min.
Enter the lowest possible port number of the source port.
This box can only be edited if you have set "TCP" or "UDP" for the protocol.
Settings
Ports
Select the required port.
Add Rule
Select the ACL rule to be assigned to the port. You specify the ACL rule on the "Rules
Configuration" page.
Add
To permanently assign the ACL rule to the port, click the "Add" button. The configuration
is shown in the table.
Remove Rule
Select the ACL rule to be deleted.
Remove
To remove the ACL rule from the port, click the "Remove" button.
The table has the following columns:
Rule Order
Shows the order of the ACL rules.
Rule Number
Shows the number of the ACL rule. When you create a rule, a new row with a unique number
is created.
Protocol
Shows the protocol for which this rule is valid.
Protocol Number
Shows the protocol number.
Source IP
Shows the IP address of the source.
Source Subnet Mask
Shows the subnet mask in which the source is located.
Dest. IP
Enter the IP address of the destination.
Dest. Subnet Mask
Enter the subnet mask in which the destination is located.
Action
Select the action. The following is possible:
Forward
If the frame complies with the ACL rule, the frame is forwarded.
Discard
If the frame complies with the ACL rule, the frame is not forwarded.
Source Port Min.
Shows the lowest possible port number of the source port.
Source Port Max.
Shows the highest possible port number of the source port.
Dest. Port Min.
Shows the lowest possible port number of the destination port.
Dest. Port Max.
Shows the highest possible port number of the destination port.
Message Type
Shows the message type.
Message Code
Shows the message code.
DSCP
Shows the value for classifying the priority.
Settings
Ports
Select the required port.
Add Rule
Select the ACL rule to be assigned to the port. You specify the ACL rule on the "Rules
Configuration" page.
Add
To permanently assign the ACL rule to the port, click the "Add" button. The configuration
is shown in the table.
Remove Rule
Select the ACL rule to be deleted.
Remove
To remove the ACL rule from the port, click the "Remove" button.
The table has the following columns:
Rule Order
Shows the order of the ACL rules.
Rule Number
Shows the number of the ACL rule. When you create a rule, a new row with a unique number
is created.
Protocol
Shows the protocol for which this rule is valid.
Protocol Number
Shows the protocol number.
Source IP
Shows the IP address of the source.
Source Subnet Mask
Shows the subnet mask in which the source is located.
Dest. IP
Enter the IP address of the destination.
Dest. Subnet Mask
Enter the subnet mask in which the destination is located.
Action
Select the action from the drop-down list. The following is possible:
Forward
If the frame complies with the ACL rule, the frame is forwarded.
Discard
If the frame complies with the ACL rule, the frame is not forwarded.
Source Port Min.
Shows the lowest possible port number of the source port.
Source Port Max.
Shows the highest possible port number of the source port.
Management ACL
On this page, you can increase the security of your device. To specify which station with which
IP address is allowed to access your device, configure the IP address or an entire address
range.
You can select the protocols and the ports of the station with which it is allowed to access the
device. You define the VLAN in which the station may be located. This ensures that only certain
stations within a VLAN have access to the device.
Note
Note that a bad configuration may mean that you can no longer access the device.
Settings
Management ACL
Enable or disable the function.
IP Address
Enter the IP address or the network address to which the rule will apply. If you use the IP
address 0.0.0.0, the settings apply to all IP addresses.
Subnet Mask
Enter the subnet mask. The subnet mask 255.255.255.255 is for a specific IP address. If
you want to allow a subnet, for example a C subnet, enter 255.255.255.0. The subnet mask
0.0.0.0 applies to all subnets.
The table has the following columns:
Rule Order
Shows the number of the ACL rule. When you create a rule, a new row with a unique number
is created.
IP Address
Shows the IP address.
Subnet Mask
Shows the subnet mask.
VLANs Allowed
Enter the number of the VLAN from which access is allowed.
Only stations located in these VLANs can access the device. If this input box remains empty,
there is no restriction.
You can enter several individual VLANs and VLAN ranges separated by commas, for
example 1,5,10-12.
SNMP
Specify whether the station or the IP address can access the device using the SNMP
protocol.
TELNET
Specify whether the station or the IP address can access the device using the TELNET
protocol.
HTTP
Specify whether the station or the IP address can access the device using the HTTP
protocol.
HTTPS
Specify whether the station or the IP address can access the device using the HTTPS
protocol.
SSH
Specify whether the station or the IP address can access the device using the SSH protocol.
Px.y
Specify whether the station or the IP address can access this device via this port.
Distributed I/O
DP master systems that consist of a DP master and DP slaves which are connected via a bus
and communicate with one another via the PROFIBUS DP protocol are referred to as
distributed I/O.
Additional information
Observe additional information on the scope of functions in the manuals of the respective
device.
Introduction
A DP/DP coupler connects two PROFIBUS DP networks as a gateway so that the DP master
from one network can transfer data to the DP master of the other network.
The maximum amount of data that can be transferred is 244 bytes input data and 244 bytes
output data.
Mono-master system
The configuration with only one DP master is also described as mono-master system. A single
DP master with its associated DP slaves is connected to a physical PROFIBUS DP subnet.
'3PDVWHUV\VWHP
'3PDVWHU
Definition
DP slaves that feature their own preprocessing program are referred to as intelligent DP slaves
(I-slaves).
CM 1242-5 is an intelligent DP slave.
'3PDVWHUV\VWHP
'3PDVWHU
'DWDH[FKDQJH
Requirements
DP master and DP slaves are placed in the network view.
4. Select the shortcut menu "Assign to new master" and select the corresponding DP interface
for the DP master in the subsequent dialog.
5. The DP slaves are automatically networked with the DP master and combine with it to form
a DP master system.
Note
When a DP master system is highlighted, you can double-click on a DP slave in the
hardware catalog and thereby quickly add additional DP slaves. This will result in the DP
slave being added to the highlighted DP master system automatically.
Introduction
To create a DP master system, you need to have one DP master and at least one DP slave.
As soon as you connect a DP master to a DP slave, a master-slave link is established.
DP master
You can use any of the following devices as a DP master:
CM 12435
Requirement
You must be in the network view.
The hardware catalog is open.
Procedure
To create a DP master system, follow these steps:
1. Select a DP master from the hardware catalog.
2. Pull the DP master onto the free area within the network view.
3. Right-click on the DP master's DP interface.
4. Select "Create master system" from the shortcut menu.
A DP master system with one DP master will be created as a single node.
If you connect a DP slave's DP interface to that of the DP master, the DP slave will be added
to the master system.
Assuming that you have already placed both a DP master and a DP slave within the network
view, you can drag-and-drop to connect the two and thereby create a DP master system. To
do so, follow these steps:
1. Click on the DP interface of either the DP master or DP slave.
2. Hold down the mouse button and draw a connecting line between this DP interface and
that of the desired communication partner.
This will create a subnet with one DP master system between the DP master and DP slave.
Introduction
Once you have created a DP master system, you also have the option of disconnecting the
DP master system from its components. This can result in subnets with DP slaves but without
DP master.
Generally, there is no need to edit the interfaces of a DP master.
You can change the name and number on the DP master system.
Requirement
You must be in the network view.
There has to be a DP master system with one DP master and at least one DP slave.
DP slaves
For configuration purposes, DP slaves are broken down into the following categories:
Compact DP slaves
(Modules with integrated digital/analog inputs and outputs, for example, ET 200L)
Modular DP slaves
(interface modules with S5 or S7 modules assigned, for example ET 200M)
Intelligent DP slaves (I slaves)
(CM 12425 or ET 200S with IM 151-7 CPU)
Rules
Your DP master system should only contain one DP master, but it may contain one or or
more DP slaves.
You may only configure as many DP slaves in a DP master system as are permitted for the
specific DP master.
Note
When configuring the DP master system, remember to observe the DP master technical
data (max. number of nodes, max. number of slots, max. quantity of user data). User data
restrictions may possibly prevent you from being able to use the maximum number of nodes
that is theoretically possible.
Requirements
You must be in the network view.
A DP master system must have been created.
Note
When a DP master system is highlighted, you can double-click the required DP slave in the
hardware catalog. This will result in the DP slave being added to the highlighted DP master
system automatically.
Configuring a DP slave
To configure a DP slave, follow these steps:
1. Switch to the DP slave's device view.
2. Select the module you want.
3. Configure the DP slave in the Inspector window.
Introduction
One of the characteristics of an intelligent DP slave (I-slave) is that the DP master is not
provided with I/O data directly by a real I/O, but by a preprocessing CPU. Together with the
CP, this preprocessing CPU forms the I-slave.
'3PDVWHU ,QWHOOLJHQW'3VODYH
2SHUDQGDUHD,4 7UDQVIHUDUHD 2SHUDQGDUHD,4
&0 &38 &0 &38
352),%86
Note
The I/O areas configured for data exchange between the DP master and DP slaves must not
be used by I/O modules.
Applications
Configurations involving intelligent DP slaves: I-slave <> DP master data exchange
Procedure
To add an I-slave to a DP master system, follow these steps:
1. In the network view, drag from the hardware catalog to a station one CM 1242-5 as an I-
slave and one CM 1243-5 as a DP master.
2. Draw a connecting line between the DP interfaces of both devices.
This way you connect the I-slave with a DP master in a DP master system.
Result: You have now set up a DP master system with one DP master and one I-slave.
Data access
The following applies to the CP 1242-5 in its function as I-slave: The addresses for the data
transfer area and the address for the I/O modules in the I-slave differ. This means that the start
address occupied by an I/O module can no longer be used for the transfer memory. If the
higher-level DP master is to access the data of an I/O module in the I-slave, you must configure
this data exchange between the I/O module and transfer area in the I-slave user program.
'3PDVWHU ,QWHOOLJHQW'3VODYH
2SHUDQGDUHD,4 7UDQVIHUDUHD 2SHUDQGDUHD,4
&0 &38 &0 &38 ,2
352),%86
Configuring an ET 200S
7KHUPRFRXSOH
5HIHUHQFHMXQFWLRQ
7HPSHUDWXUHPHDVXULQJ 7HPSHUDWXUHPHDVXULQJ
PRGXOH$,7& PRGXOH$,57'
5HIHUHQFHMXQFWLRQ
&RPSHQVDWLRQ
Additional information
For additional information on the various types and uses of ET 200S modules, please refer to
the operating instructions and the manual titled "ET 200S Distributed I/O System".
For additional information on analog value processing, please see the documentation for the
ET 200S distributed I/O system.
Packing addresses
Introduction
DP slaves and I/O devices from the ET 200S family are configured in the same way as other
modular DP slaves and I/O devices. As well as supporting all the standard modular DP slave
and I/O device functions, the ET 200S also offers the "Pack addresses" function:
When digital electronics modules requiring an address space of 2 or 4 bits are inserted into
the device view, they will initially be spread over a total area of 1 byte. However, the address
area actually occupied can be compressed after configuration using the "Pack addresses"
function.
Requirements
You are in the device view.
An ET 200S, for example an IM 151-1, must be present.
A pair of digital electronics modules, for example 2DI AC120V ST, must be inserted into
the slots.
Packing addresses
To pack addressed, follow these steps:
1. Select the electronics modules whose addresses are to be packed. The following options
are available for selecting multiple electronics modules:
Press and hold down <Shift> or <Ctrl> while clicking the relevant electronics modules.
Click off the rack and select the required electronics modules by drawing round them
with the mouse.
2. Click "Pack addresses" in the shortcut menu for the selected electronics modules.
The address areas for inputs, outputs and motor starters are packed separately. The packed
addresses will be displayed in the I address and Q address columns of the device overview.
Unpacking addresses
To unpack addressed, follow these steps:
1. Select one or more electronics modules with packed addresses.
2. Click "Unpack addresses" in the shortcut menu for the selected electronics modules.
The packing groups of the selected electronics modules will be disbanded and the packed
addresses for the relevant electronics modules unpacked.
The packing group will also be disbanded and the packed addresses unpacked in the following
cases: if you delete electronics modules from a packing group, move electronics modules out
of a packing group or insert electronics modules on a free slot within a packing group.
The start addresses of the unpacked electronics modules will be assigned to the next available
byte addresses in each case.
Note
The ET 200S can be completely factory-wired with the master cabling, as no connection exists
between a standby module and the terminals of the terminal module (and, in turn, to the
process).
Requirement
ET 200S interface module
IM 151-1 STANDARD (6ES7 151-1AA03-0AB0 or higher)
IM 151-1 FO STANDARD (6ES7 151-1AB02-0AB0 or higher)
Power module with option handling
PM-E DC24..48V
PM-E DC24..48V/AC24..230V
Procedure
To activate option handling, follow these steps:
1. Select the IM 151-1 in the device view and enable it in "Option handling" check box under
"Properties > General > Option handling" in the inspector window.
2. Select the numbered check boxes for the slots that are initially to accommodate the standby
modules prior to the future electronics modules.
3. Select the power module in the device view and enable it in the "Option handling" check
box under "Properties > Addresses" in the inspector window. Reserve the necessary
address space for the control and check-back interface in the process image output (PIQ)
and process image input (PII).
The assembled standby modules can be replaced with the configured modules at a later date
without having to modify the configuration.
Note
The addresses for these interfaces are reserved as soon as you activate option handling on
the power module. The "Option handling" function must also be activated on the DP slave
(IM 151-1 STANDARD Interface Module). If it is not activated, the addresses reserved for the
control and check-back interface will be released again.
Note that activating and deactivating the option handling function repeatedly can change the
address of the control and check-back interface.
Option handling may be activated for one PM-E DC24..48V or one PM-E DC24..48V/
AC24..230V Power Module only.
Additional information
For additional information on the assignment and significance of bytes within the process
image, option handling with PROFIBUS and the use of standby modules, please refer to the
documentation for the ET 200S distributed I/O system.
See also
Which modules support option handling? (http://support.automation.siemens.com/WW/view/
en/22564754)
Note
ET 200S with PROFINET interface
This description refers to the ET 200S with PROFIBUS interface. In principle, option handling
for ET 200S with PROFINET interface functions as described here without standby modules.
PN interface modules are to be used instead of the DP interface modules listed here. You can
find additional information about option handling for ET 200S with PROFINET interface in the
corresponding manuals.
Requirement
ET 200S interface module
IM 151-1 HIGH FEATURE (6ES7151-1BA02 or higher)
IM 151-1 STANDARD (6ES7 151-1AA05-0AB0 or higher)
Power module with option handling
PM-E DC24..48V
PM-E DC24..48V/AC24..230V
Procedure
To activate option handling, follow these steps:
1. Select the IM 151-1 in the device view and enable it in "Option handling" check box under
"Properties > General > Option handling" in the inspector window.
2. Select the power module in the device view and enable it in the "Option handling" check
box under "Properties > Addresses" in the inspector window. Reserve the necessary
address space for the control and check-back interface in the process image output (PIQ)
and process image input (PII).
3. Configure the slave's maximum configuration. The selection/clearing of options is controlled
via the user program.
Note
The addresses for these interfaces are reserved as soon as you activate option handling
on the power module. The "Option handling" function must also be activated on the DP
slave (IM 151-1 interface module). If it is not activated, the addresses reserved for the
control and check-back interface will be released again.
Note that activating and deactivating the option handling function repeatedly can change
the address of the control and check-back interface.
Option handling may be activated for one PM-E DC24..48V or one PM-E DC24..48V/
AC24..230V Power Module only.
Additional information
For additional information on the assignment and significance of bytes within the process
image, option handling with PROFIBUS and the use of standby modules, please refer to the
documentation for the ET 200S distributed I/O system.
See also
Sample applications for ET 200S, option handling without standby module (http://
support.automation.siemens.com/WW/view/en/29430270)
Requirement
You must be in network view.
A DP master with DPV1 functionality must be available.
A master-slave connection must be established with PROFIBUS.
Procedure
To switch the DP slave over to DPV1, follow these steps:
1. Select the DP slave.
2. Under "Properties > Module parameters" in the Inspector window, select "DPV1" mode
from the "DP interrupt mode" drop-down list.
or
1. Select the DP master.
2. In the I/O communications table, select the row with the connection between the DP master
and the desired DP slave.
3. Under "Properties > Module parameters" in the Inspector window, select "DPV1" mode
from the "DP interrupt mode" drop-down list.
Special characteristics
The parameters are subject to interdependencies, which are outlined below:
Note
When the module addresses are packed, the insert/remove interrupt for the ET 200S is
unavailable.
GSD revisions
Introduction
A GSD file (generic station description file) contains all the DP slave properties. If you want to
configure a DP slave that does not appear in the hardware catalog, you must install the GSD
file provided by the manufacturer. DP slaves installed via GSD files are displayed in the
hardware catalog and can then be selected and configured.
Requirement
The hardware and network editor is closed.
You have access to the required GSD files in a directory on the hard disk.
Procedure
To install a GSD file, follow these steps:
1. In the "Options" menu, select the "Install general station description file (GSD)" command.
2. In the "Install general station description file" dialog box, select the folder in which the GSD
files are stored.
3. Choose one or more files from the list of displayed GSD files.
See also
Overview of hardware and network editor (Page 535)
Introduction
You can delete installed DP slaves using GSD files. These DP slaves are then no longer
displayed in the hardware catalog.
Requirement
The hardware and network editor is closed.
The hardware catalog contains DP slaves installed via GSD files.
Procedure
To delete a GSD file, follow these steps:
1. In the "Options" menu, select the "Install general station description file (GSD)" command.
2. In the "Install general station description file" dialog box, select the folder in which the GSD
file is stored.
3. Select the file that is to be deleted from the list of displayed GSD files.
4. Click the "Delete" button.
The selected GSD file was deleted and the DP slave is no longer located in the hardware
catalog.
Requirement
You have installed a DP slave using a GSD file.
You have inserted the head module in the network view in the usual manner.
Procedure
To add the modules of a GSD-based DP slave, proceed as follows:
1. In the hardware catalog, navigate to the modules of the GSD-based DP slave.
GSD-based DP slaves, also referred to as DP standard slaves, can be found in the "Other
field devices" folder of the hardware catalog.
2. Select the desired module.
3. Use drag-and-drop to move the module to a free space in the device overview.
4. Select the module in the device overview to edit parameters.
You have now inserted the module in a free slot of the GSD-based DP slave and can edit its
parameters.
Note
You can see only the GSD-based DP slave in the graphic area of the device view. The added
modules of GSD-based DP slaves are only found in the device overview.
Preset configuration
For modules with an adjustable preset configuration, you can change this configuration in the
inspector window under "Properties > Preset configuration".
PROFINET IO
PROFINET is an Ethernet-based automation standard of PROFIBUS Nutzerorganisation e.V.
(PNO) which defines a manufacturer-neutral communication, automation and engineering
model.
Objective
The objective of PROFINET is:
Integrated communication via field bus and Ethernet
Open, distributed automation
Use of open standards
Architecture
The PROFIBUS User Organisation e.V. (PNO) has designated the following aspects for
PROFINET architecture:
Communication between controllers as components within distributed systems.
Communication between field devices, such as I/O devices and drives.
Implementation by Siemens
The demand for "Communication between controllers as components within distributed
systems" is implemented by "Component Based Automation" (CBA). Component Based
Automation is used to create a distributed automation solution based on prefabricated
components and partial solutions.
The demand for "Communication between field devices" is implemented by Siemens with
"PROFINET IO". Just as with PROFIBUS DP, the complete configuration and programming
of the components involved is possible using the Totally Integrated Automation Portal.
The following sections deal with the configuration of communication between field devices
using PROFINET IO.
Overview of RT classes
RT classes in PROFINET IO
PROFINET IO is a scalable, real-time communication system based on Ethernet technology.
The scalable approach is reflected in several real-time classes:
RT: Transmission of data in prioritized, non-isochronous Ethernet frames. The required
bandwidth is within the free bandwidth area for TCP/IP communication.
IRT: Isochronous transmission of data with high stability for time-critical applications (for
example, motion control). The required bandwidth is from the area of bandwidth reserved
for cyclic data.
Depending on the device, not all real-time classes are supported.
,QGXVWULDO(WKHUQHW
352),%86
PROFINET devices
PROFINET device with proxy functions (for example, IE/PB link)
PROFIBUS devices
PROFINET device with proxy functions used as proxy for a PROFIBUS device
The PROFINET device with proxy functions is the proxy for a PROFIBUS device on the
Ethernet. The proxy functionality enables a PROFIBUS device to communicate with all devices
on the PROFINET and not just with its master.
Existing PROFIBUS systems can easily be integrated into PROFINET communication using
the proxy functions.
If, for instance, you connect a PROFIBUS device via an IE/PB link to PROFINET, the IE/PB
link acts as a proxy for the PROFIBUS components for communicating via PROFINET.
Restrictions
The following restrictions apply to DP slaves configured as described above on the PROFIBUS
subnet of an IE/PB link:
No pluggable IE/PB link
No pluggable DP/PA link
No pluggable Y link
Not CiR-compliant
No pluggable redundant slaves
No isochronous transmission / constant bus cycle time can be configured
SYNC/FREEZE instructions ("DPSYC_FR") of a CPU on the the Ethernet subnet for DP
slaves behind the IE/PB-Link are not supported.
See also
Connect the DP slave via the IE/PB Link to a PROFINET IO system (Page 1138)
Special feature
If several IWLAN/PB links are located within a segment, they have to share the bandwidth that
is available for wireless transmission. This leads to a lengthening of the update time for these
devices.
Example
In the following example there are two IO devices (IWLAN/PB link) with a segment.
If no more than a maximum of two IWLAN/PB links are present in a IWLAN segment at the
same time, enter a "2".
Segment 1
Segment 2
Configure PROFINET IO
IP addresses
All PROFINET devices work with the TCP/IP protocol and therefore require an IP address for
Ethernet operation.
You can set the IP addresses in the module properties. If the network is part of an existing
company Ethernet network, ask your network administrator for this data.
The IP addresses of the IO devices are assigned automatically, usually at CPU startup. The
IP addresses of the IO devices always have the same subnet mask as the IO controller and
are assigned in ascending order, starting at the IP address of the IO controller.
Device names
Before an IO device can be addressed by an IO controller, it must have a device name. This
procedure was chosen for PROFINET because names are easier to administer than complex
IP addresses.
Both the IO controller as well as IO devices have a device name. When the "Generate
PROFINET device name automatically" option is activated, the device name is automatically
derived from the name configured for the device (CPU, CP or IM):
The PROFINET device name is made up of the name of the device (for example, the CPU),
the name of the interface (only with multiple PROFINET interfaces) and optionally the name
of the IO system:
<CPU name>.<Name of the interface>.<IO system name>
You cannot change this name directly. You change the PROFINET device name indirectly,
by changing the name of the affected CPU, CP or IM in the general properties of the module.
This PROFINET device name is also displayed, for example, in the list of accessible
devices. If you want to set the PROFINET device name independently of the module name,
you have to deactivate the "Generate PROFINET device name automatically" option.
A "converted name" is generated from the PROFINET device name. This is the device
name that is actually loaded into the device.
The PROFINET device name is only converted if it does not comply to the rules of IEC
61158-6-10. You cannot change this name directly either.
Device number
In addition to the device name, a device number is also automatically assigned when an IO
device is plugged in. You can change this number.
See also
Assigning the device name and IP address (Page 1116)
Retentivity of IP address parameters and device names (Page 1124)
Assigning an IP address and subnet mask for an IO controller the first time
There are various options for this.
During parameter assignment of the PROFINET interface you must specify if the IP address
is set in the project (which means in the hardware configuration) or if the IP address is to be
set on the device.
Assignment of device name for IO devices when the "Support device replacement without exchangeable
medium" option is selected
For IO controllers with the "Support device replacement without exchangeable medium" option
selected, you do not have to assign device names to the IO devices locally, for example in the
event of device replacement. Another application is automatic commissioning, in which the
CPU automatically assigns the device name and IP address parameters to the IO devices
during startup.
Requirement: The ports of the devices are interconnected, and the devices involved support
LLDP. The devices have been put into delivery state or - for S7-1500 CPUs version V1.5 and
higher - the "Permit overwriting device names of all assigned IO devices" option is selected
for the IO controller ("Ethernet addresses" area, "PROFINET" section of the properties of the
PROFINET interface).
6,0$7,&
(WKHUQHW352),QHW6\VWHP
85
&38
; ,(
,0 ,0 ,0 ,0
',['&9
'2['&9
9HQWLO 9HQWLO .ODSSH 6FKQHFNH
,2FRQWUROOHU
352),1(7
,QGXVWULDO(WKHUQHW
,2GHYLFHV
0$&$GU 0$&$GU
Requirement for additional procedures when assigning IP address and device name
If the IO device, as described above, should not obtain the IP address or device name from
the IO controller, proceed as follows:
1. Select device or network view.
2. Open the properties of the respective PROFINET device and select the area "PROFINET
interface [X1]" > "Ethernet addresses".
3. Select the option "IP address is set directly at the device" under "IP parameters" or the
option "Permit setting of PROFINET device name directly on the device" under
"PROFINET".
Rules
If the "IP address/device name is set directly at the device" option is used for a PROFINET
device, note the following:
The subnet part of the IP address of the IO device must match the subnet part of the IP
address of the IO controller.
The corresponding PROFINET device cannot be used as a gateway.
See also
Assigning a name in the online and diagnostics view opened via "Accessible devices"
(Page 1392)
Enabling device replacement without exchangeable medium (Page 1137)
Requirement
You must be in the network view.
A CPU 1214C (V2.0 or higher) must be available in the network view.
An interface module IM 151-3PN exists.
The PROFINET interfaces of both modules are networked.
Procedure
To assign the names, follow these steps:
1. Select the CPU.
Make sure that you have selected only the CPU and not the complete device!
2. Assign the name "myController" in the Inspector window, under "General".
6. Assign the name "Plant_section1" to the IO system and select the check box "Use name
as extension for PROFINET device names".
7. You can find the automatically generated PROFINET device names at the selected device
in the Inspector window, at "PROFINET interface".
The PROFINET device name corresponds to the name of the module (with the name of
the IO system as extension) with the difference that only lower case text is used.
Background: No distinction is made between upper and lower case ("case insensitive") for
the storing of the name.
If you want to specify the device name independently of the module name, you have to
deactivate the "Generate PROFINET device name automatically" option. The PROFINET
device name can be edited in this case.
The converted name is displayed below. This is the name that is automatically generated
from the PROFINET device name and satisfies the DNS conventions. If you work with STEP
7, you do not require this name. This name is displayed here as a check and corresponds
to the name that is stored in the device. If you work with other tools that are able to record
the data exchange and read the actual device names, then you find the converted names.
Introduction
You can configure the device names of PROFINET IO devices offline. To do this, store a
configured device name on a memory card and then insert the card into the appropriate IO
device.
If an IO device has to be completely replaced due to a device defect, the IO controller
automatically reconfigures the new device. Using the memory card, a device can be replaced
without a programming device.
Requirements
The programming device has a card reader for memory cards.
The IO device must support the assignment of the device name via memory card.
The station and its PROFINET IO system is configured.
Procedure
To store a device name on a memory card, follow these steps:
1. Insert the memory card into the card reader.
2. Select the IO device whose device name is to be assigned by the memory card.
3. Select the "Card reader > Save Device Name to Memory Card" command in the "Project"
menu.
If the memory card is not empty, a message will be issued informing you of this and you
will have the option to delete the card.
Recommendation
If possible, use the "Set IP address in project" option and specify an appropriate IP address.
In this case, the IP address is assigned retentively.
Note
Consequences of reassignment of IP address parameters on top of existing IP parameters
The temporary assignment of IP address parameters/device names results in a reset of
any retentively saved IP address parameters/device names.
With a fixed assignment of IP address parameters/device names, previously retentively-
saved parameters are replaced by the newly assigned parameters.
Note
Reuse of devices
Execute the "Reset to factory settings" before you install a device with retentive IP address
parameters and device name in another subnet or system or before you place it in storage.
Procedure
To create a PROFINET IO system, proceed as follows:
1. Use drag-and-drop to pull an IO controller from the hardware catalog (for example, CPU
1214C) into the free area of the network view.
The IO controller is created in the project.
2. Use drag-and-drop to move an IO device from the hardware catalog (for example, ET 200S)
into the free area of the network view.
3. Click on the PROFINET interface of the IO controller or the IO device.
4. Hold down the mouse button and draw a connecting line between this selected interface
and that of the partner device.
A subnet with an IO system between the IO controller and the IO device is created.
5. If required, adapt the properties of the Ethernet subnet or the IO controller (for example, IP
address) under "Properties" in the inspector window.
You can create a new IO systems and can assign each of the non-assigned IO devices to an
IO controller.
Requirements
IO controller and IO devices are placed in the network view.
4. Select the shortcut menu "Assign new IO controller" and select the corresponding IO
interface of the IO controller in the subsequent dialog.
5. The IO devices are automatically networked with the IO controller and combine with it to
form an IO system.
Note
When an IO system is highlighted, you can double-click on an IO device in the hardware
catalog and thereby quickly add additional IO devices. Result: The IO device is
automatically added to the highlighted IO system.
Interconnecting ports
If an IO device is assigned to an IO controller, this does not yet specify how the ports are
connected to each other.
Although a port interconnection is not required to make use of the Ethernet/PROFINET
functions, it does offer the following advantages:
A target topology is specified with the port interconnection. Based on an online-offline
comparison, it is possible to conduct a target-actual comparison with all devices that support
this function.
Only with IRT communication: If a port interconnection is configured, STEP 7 can determine
the required bandwidth more precisely. As a rule, this leads to a higher performance.
Make sure that no invalid ring structures occur through the interconnection of ports.
Port interconnection is only advisable for devices that support the topology configuration.
Note
Interconnecting an electric with an optical port
If you want to interconnect an electric and an optical port, you have to decide between RT and
IRT communication:
With RT communication, it is not necessary to configure a media converter.
With IRT communication, you have to make the interconnection via a media converter.
See also
Overview (Page 669)
Procedure
To set the send clock on the PROFINET device, follow these steps:
1. Select the PROFINET IO controller in the device or network view.
2. Change the value for the shortest possible update interval in the properties of the
PROFINET interface under "PROFINET Interface > Advanced options > Real-time settings
> IO communication > Send clock".
The send clock is valid for all PROFINET devices at the IO system. If the synchronization role
is set to a value other than "Unsynchronized", you can only set the send clock in the sync
domain, in other words, centrally at the PROFINET IO system.
Update time
An IO device / IO controller in the PROFINET IO system is supplied with new data from the
IO controller / IO device within this time period. The update time can be separately configured
for each IO device and determines the time interval in which data is transmitted from the IO
controller to the IO device (outputs) as well as data from the IO device to the IO controller
(inputs).
STEP 7 calculates the update time automatically in the default setting for each IO device of
the PROFINET IO system, taking into account the volume of data to be exchanged as well as
the set send clock.
Watchdog time
You can configure the watchdog time for PROFINET IO devices.
If the IO device is not supplied with input or output data (IO data) by the IO controller within
the watchdog time, it switches to the safe state.
Do not enter the watchdog time directly, but as "Accepted number of update cycles when IO
data is missing". This makes setting easier because the update time can be shorter or longer,
depending on the power of the IO device or the setting.
The resulting watchdog time is automatically calculated from the "Accepted number of update
cycles when IO data is missing".
Note
The default setting should only be changed in exceptional cases, for example, during the
commissioning phase.
"Monitor" option
This option is used to activate or deactivate the port diagnostics. Examples of port diagnostics:
The link status is monitored, in other words, the diagnostics are generated during link-down
and the system reserve is monitored in the case of fiber optic ports.
Note
When a local port is interconnected, STEP 7 makes the setting for the partner port if the partner
port supports the setting. If the partner port does not support the setting, an error message is
generated.
See also
Wiring rules for disabled autonegotiation (Page 1135)
Boundaries at the port (Page 1136)
Requirement
You have made the following settings for the port in question, for example, to accelerate the
startup time of the IO device:
Fixed transmission speed
Autonegotiation incl. autocrossing disabled
This saves you the time required to negotiate the transmission rate during startup.
If you have disabled autonegotiation, you must observe the wiring rules.
6ZLWFKRU
352),1(7GHYLFH ,2GHYLFH ,2GHYLFH
3 3 3 3 3 3
3DWFKFDEOHV 3DWFKFDEOHV
6ZLWFKSRUW
(QGGHYLFHSRUW
Requirement
To use boundaries, the respective device must have more than one port. If the device for
PROFINET does not support boundary settings, the corresponding parameters are disabled.
This applies, for example, to the 1215C CPUs V3; although these have more than one port,
they do not support boundary settings.
Enable boundaries
"Boundaries" are limits for transmission of certain Ethernet frames. The following boundaries
can be set at a port:
"End of detection of accessible devices"
DCP frames for detection of accessible devices are not forwarded. Devices located behind
this port are no longer displayed in the project tree under "Accessible devices". Devices
located behind this port can no longer be reached by the CPU.
"End of topology discovery"
LLDP frames (Link Layer Discovery Protocol) for topology detection are not forwarded.
"End of sync domain"
Sync frames transmitted for synchronization of devices within a sync domain are not
forwarded.
For example, if you operate a PROFINET device with more than two ports in a ring, you
should prevent the sync frames from being fed into the ring by setting a sync boundary (at
the ports not inside the ring).
Additional example: If you want to use several sync domains, configure a sync domain
boundary for the port connected to a PROFINET device of the other sync domain.
Restrictions
The following restrictions must be observed:
The individual check boxes can only be used if the port supports the function in question.
If a partner port has been defined for the port, the following check boxes cannot be used:
"End of detection of accessible devices"
"End of topology discovery"
If autonegotiation is disabled, none of the check boxes can be used.
Requirements
A port interconnection is already configured.
The affected IO devices in the automation system must support device replacement without
exchangeable medium (LLDP protocol).
If the individual IO devices in the automation system do not support device replacement
without exchangeable medium, a corresponding alarm is output for the IO device.
Note
Use only new IO devices as replacement devices, or restore IO devices with an existing
parameter assignment to delivery state prior to commissioning.
For S7-1500 CPUs with firmware version V1.5 or higher, it is not necessary to reset IO
devices with an existing parameter assignment to delivery state. The condition for this is
that the "Permit overwriting of device name" option is enabled for the IO controller ("Ethernet
addresses" area, "PROFINET" section of the properties of the PROFINET interface).
Procedure
In order to enable the replacement of an IO device without exchangeable medium, proceed
as follows:
1. In the device or network view, select the PROFINET interface of the corresponding IO
controller.
2. In the interface properties under "Advanced settings > Interface options", select the
"Support device replacement without exchangeable medium" check box.
The option "Support device replacement without exchangeable medium" also permits
automatic commissioning, which means you can commission the IO system with the IO devices
without assigning their device names in advance.
See also
Assigning the device name and IP address (Page 1116)
Components with the the device replacement without exchangeable medium function (http://
support.automation.siemens.com/WW/view/en/36752540)
Requirements
STEP 7 as of V12
S71500 CPU as of firmware version 1.7
ET 200SP CPU as of firmware version 1.7
S7-1500 software controller
S7-300/400 CPU
8. In the PROFINET device number area, you can assign a PROFINET device number for
the DP slave.
If you have selected the "Device number = PB address" check box (default), STEP 7
automatically assigns the device number according to the PROFIBUS address of the slave.
In addition, you no longer need to update the device number if the PROFIBUS address
changes.
See also
Configuration using IE/PB link PN IO (Page 1112)
Functional enhancements may result in a new version of the GSDML schema. A new version
of a GSDML schema might only be supported with restrictions.
Introduction
A GSD file (general station description file) contains all properties of an IO device. If you want
to configure an IO device that is not available in the hardware catalog, you must install the
GSD file provided by the manufacturer. IO devices installed via GSD files are displayed in the
hardware catalog and can then be selected and configured.
Requirement
The hardware and network editor is closed.
You have access to the required GSD files in a directory on the hard disk.
Procedure
To install a GSD file, follow these steps:
1. In the "Options" menu, select the "Install general station description file (GSD)" command.
2. In the "Install general station description file" dialog box, select the folder in which the GSD
files are stored.
3. Choose one or more files from the list of displayed GSD files.
4. Click on the "Install" button.
5. To create a log file for the installation, click on the "Save log file" button.
Any problems during the installation can be tracked down using the log file.
You will find the new IO devices installed by means of GSD files in the hardware catalog under
"Additional field devices > PROFINET".
See also
Overview of hardware and network editor (Page 535)
Introduction
You can delete installed DP slaves using GSD files. These DP slaves are then no longer
displayed in the hardware catalog.
Requirement
The hardware and network editor is closed.
You will find the new IO devices installed by means of GSD files in the hardware catalog
under "Additional field devices > PROFINET".
Procedure
To delete a GSD file, follow these steps:
1. In the "Options" menu, select the "Install general station description file (GSD)" command.
2. In the "Install general station description file" dialog box, select the folder in which the GSD
file is stored.
3. Select the file that is to be deleted from the list of displayed GSD files.
4. Click the "Delete" button.
The selected GSD file was deleted and the DP slave is no longer located in the hardware
catalog.
Requirement
The I/O data is the same for all IO devices whose revision is to be changed.
The article number has not changed.
The number of submodules is identical.
The configuration data has not changed.
There must be no module or submodule in a slot that is invalid after the new GSD file has
been created.
Procedure
To change the revision of one or more IO devices, proceed as follows:
1. Select the IO device whose GSD file revision is to be changed.
2. Click on the "Change revision" button under "General> Catalog information" in the
properties of the IO device.
The "Change revision" dialog box opens.
3. Select the GSD revision you want to use in the "Available revisions" table.
4. Under "Use selected revision for", select the devices whose version are to be changed:
Only for the current IO device
For all suitable IO devices in the IO system
For all suitable IO devices in the project
5. Click the "Apply" button.
Application
The PN/PN coupler is used to link two Ethernet subnets with one another and to exchange
data. That way use data about input or output address areas or datasets can be used. The
maximum size of the transferable input and output data is 1024 bytes. The division into input
and output data is preferable, so that e.g. 800 byte input data and 200 byte output data can
be configured.
As a device, the PN/PN coupler has two PROFINET interfaces, each of which is linked to one
subnet.
In the configuration, two IO Devices are produced from this one PN/PN coupler which means
that there is one IO Device for each station with its own subnet. The other part of PN/PN coupler
in each case is known as the bus node. Once configuring is complete, the two parts are joined.
352),1(7,QGXVWULDO(WKHUQHW
Figure 10-3 Coupling two PROFINET IO subnets with one PN/PN coupler
Additional information
For additional information on "PN/PN couplers", refer to Service & Support on the Internet
(http://support.automation.siemens.com/WW/view/en/44319532).
Introduction
Tools external to STEP 7 ("Device Tools") with a special call interface (Tool Calling Interface)
can be used to configure distributed devices. Such devices are also referred to as "TCI
capable".
The performance range of these tools exceeds the possibilities provided within GSD
configuration, for example, they can provide expanded graphical input options.
Distributed devices can be as follows:
PROFIBUS DP slaves
Modules within a DP slave
PROFINET IO devices
Modules within an IO device
Note
Warranty and liability
Siemens accepts no liability for third-party software (device tools) called with the TCI (Tool
Calling Interface) or for proper interaction with the associated devices.
Requirement
The call interface of the tool complies with the TCI specification. Parameters and commands
are forwarded to the distributed device via this call interface.
Such tools have to be installed using a setup provided by the manufacturer. The "S7-PCT"
(Port Configuration Tool) device tool for IO-Link master modules and IO-Link devices is an
exception; this is supplied with STEP 7. Special note: After the installation, the tool is not shown
in the list of installed software or in the list of software products in the project.
The GSD file of the distributed device that is to be configured with the Device Tool must be
installed.
See also
Starting the SIMATIC S7-PCT (Page 1145)
Introduction
The "S7-PCT" (Port Configuration Tool) device tool is installed with STEP 7.
The tool is used to assign parameters to the ports of IO-Link modules such as 4SI IO-Link
(S7-1200, ET 200S) or 4IOL+8DI+4DO (ET 200eco PN).
Requirement
You have configured the corresponding CPU, the DP slave or the IO device with an IO-Link
module.
Procedure
To start via the graphical device view, follow these steps:
1. Select the IO-Link module in the device view.
2. Select "Start device tool" from the shortcut menu.
OR, to start with the tabular device view, follow these steps:
1. Select the IO-Link module in the device view.
2. Arrange the areas in the work area in such a way that the tabular device overview is visible
(it is located between the device view and the inspector window).
3. Select the row with the IO-Link module in the device overview.
4. Select "Start device tool" from the shortcut menu.
Result
The tool starts and you can configure the ports.
See also
Integrating S7-external tools (Page 1144)
See also
Uploading project data from a device (Page 399)
General information on loading (Page 394)
Downloading a configuration to a device (Page 1147)
Downloading project data to a device (Page 396)
Warning
Perform load operation only in STOP mode
Following loading, the machine or process may behave unexpectedly if the parameter
assignment is incorrect. A CPU must be set to STOP mode for the load operation to rule out
possible damage to equipment or personal injury.
See also
General information on loading (Page 394)
Introduction
If you bring your PG/PC to a plant and the STEP 7 project used to create the configuration of
this plant is not available, load the configuration to a new project on your PG/PC, for example.
Use the "Online > Loading the device as new station (hardware and software) (Page 399)"
menu command for this.
The list of accessible devices in the project tree is always used when loading a device to your
programming device. You can select multiple devices and load them to the project at the same
time.
Requirements
The hardware configuration in the device must be created in TIA Portal, V12 or higher. A
hardware configuration present in the device that was created with an older version cannot
be loaded and must be upgraded (Page 380).
Modules present in the device from GSD (ML), HSPs, or service packs must be installed
in TIA Portal on the PG/PC.
A project must be open. This project can be a new (empty) project or an existing project.
The opened project is in offline mode.
Note
The hardware configuration loaded to PG/PC is not completely identical to the configuration
originally loaded to the device. Note the additional information on loading, in particular with
regard to partially loaded configuration data in the case of cross-device communication.
Loading PC systems, such as WinAC or PC-based automation, is not possible.
See also
General information on loading (Page 394)
Information on loading
When device configurations are loaded to the PG/PC, all assigned parameters are transferred
from the device to the project. If the CPU is connected to a subnet, all parameters of the device
are loaded and the CPU is displayed in the network view as networked.
Note
CPUs reset to their factory settings do not have any hardware configuration. Therefore, nothing
is loaded in this case after "Load to PG/PC" is selected in the "Online" menu.
Note
All types of PC systems, such as WinAC, Embedded Controller, CP 1616 or PC CPs, do not
support loading to PG/PC.
Loading subnets and devices with MPI, PROFIBUS, Ethernet, and PtP
The following special considerations apply to loading subnets and end points of connections
for MPI, PROFIBUS, Ethernet, and PtP with their respective connection properties:
If a device with PROFIBUS interface is loaded, the bus parameters of the device will initially
be different from the settings in the original project. The bus parameters will only match
those of the original project after all devices involved are loaded and no additional devices
are on the same bus.
Passive communication devices that are not connected as DP slaves or IO devices to a
corresponding master system or IO system do not participate in the data exchange. They
are therefore not loaded.
All devices involved should therefore be loaded for cross-device configurations. A warning
is output during compiling of the project for missing network stations. Missing routing
information due to communication stations that are not loaded is displayed as warning
during compilation. If the configuration is loaded from the PG/PC back to the device,
different routing information results.
When you compile the project after loading devices to the PG/PC, STEP 7 checks if all devices
to which communication relationships have been configured are available. If devices are
missing, you receive an alarm with the number of missing communication stations.
Notice
Cross-device communication
When you load a configuration with cross-device communication to the PG/PC, you must also
load all corresponding network stations to the PG/PC. If required network stations are missing
and the configuration is loaded back to the device, there is no guarantee that cross-device
communication is working again.
See also
Upgrading projects (Page 380)
Information on loading
The hardware configuration of a CPU also contains the Web server settings. A number of
restrictions apply to loading a Web server configuration to the PG/PC:
The assignment of the Web server language and project language is not loaded for
S7-300/400. The project texts are not loaded and an alarm is output that no project
languages are assigned. The languages assigned in STEP 7 are loaded without restriction
for S7-1200/1500 CPU.
User administration data of the S7-1200/1500 can be loaded but not edited. You can use
a check box to select whether you want to use the existing data as read-only data or discard
these data and enter new data.
Watch tables of the Web server are not loaded.
The source files of the user-defined web pages (HTML pages, Java scripts, etc.) are not loaded.
The program blocks generated during loading can only be edited if you enter the properties
and the HTML page yourself.
See also
Information about the web server (Page 853)
Information on loading
A DP master is loaded to PG/PC. The DP master system and all connected DP slaves are
inserted into the project. The respective settings remain unchanged. If a suitable PROFIBUS
subnet has already been created, the loaded devices with PROFIBUS interface are connected
to the existing subnet.
As a prerequisite for loading DP master systems with standard slaves, the corresponding GSD
files must be installed in the TIA Portal and available in the hardware catalog. If a required
GSD file is not available in the same version as in the device, differences are identified during
the consistency check.
Note
Direct data exchange in a configuration is only loaded if all communication partners involved
in the direct data exchange are loaded to the PG/PC.
Isochronous mode
Note the following when loading DP master systems with activated PROFIBUS functionality
"Isochronous mode":
Bus parameters and the settings for isochronous mode are only identical after the device
is loaded to the PG/PC if all devices relevant for calculation of isochronous mode are loaded.
Only mono-master systems with isochronous mode are supported. Therefore, only
configurations with just one DP master on the PROFIBUS subnet are loaded.
I-slave
Master-slave relations between DP master and I slave are only established in the project if
both the DP master and the I slave are downloaded to the PG. It does not matter whether you
load the DP master or the I-slave first. If you load the DP master from a DP master system
with connected I-slave, the DP master and its DP slaves are loaded. An I-slave proxy is loaded
as dummy module for an involved I-slave.
Note
The replacement of I-slave proxy devices is only possible if the required I-device is available
in the hardware catalog.
Information on loading
If you have selected a CPU in the list of accessible devices and perform an load operation to
PG/PC, all IO controllers and IO devices associated with this device along with their IO systems
will be loaded. Settings for the topology are also transferred. If there is already a suitable
Ethernet network in the project, the loaded devices are integrated into the existing network.
Relationships between the IO controllers and IO devices are only established within the project
if both the IO controller as well as the I-device are loaded to the PG. It does not matter whether
you load the IO controller or the I-devices first.
Supported functions
The following functionalities and settings are loaded:
PROFINET configurations (RT and IRT) in IO systems with the associated IO controllers
(CPUs and CPs), IO devices, and the modules used
Logical addresses and interface properties
Port interconnections
Isochronous mode
Sync domains/MRP domains
Redundancy role "Client" or "Manager" for MRP configurations
Note
Empty Sync domains and MRP domains are not included in the loading.
GSD-based IO devices
As a prerequisite for loading GSD-based IO devices, the corresponding GSD files must be
installed in the TIA Portal and available in the hardware catalog. If a required GSD file is not
available in the same version as in the device, differences are identified during the consistency
check.
I-device
If you load the IO controller from an IO system with connected I-device, the IO controller and
its IO devices will be loaded. An I-device proxy is loaded as dummy module for an involved I-
device. The CPU parameter assignment, including the parameter assignment of the CPU's
"own" (subordinate) IO system, is missing in the I-device proxy. Only the interface to the higher-
level IO controller is loaded.
6,0$7,&&38&3
,2FRQWUROOHU
,QGXVWULDO(WKHUQHW
HJ(7 HJ(7 352),1(7,2
/RDGHG,2V\VWHPZLWK
,GHYLFHSUR[\
,2GHYLFH ,2GHYLFH
,GHYLFH
SUR[\
6,0$7,&&38&3
DV,GHYLFH
+LJKOHYHO
,2GHYLFH
,2V\VWHP
,2FRQWUROOHU
8VHUSURJUDP
LQWHOOLJHQWSUHSURFHVVLQJ
,QGXVWULDO(WKHUQHW
HJ(7 HJ(7 352),1(7,2 8QORDGHGORZHUOHYHO,2
V\VWHP
,2GHYLFH ,2GHYLFH
/RZHUOHYHO
,2V\VWHP
In order to edit the I-device in the project, you must load the I-device from the device to the
PG/PC. This replaces the I-device proxy with the complete I-device along with its subordinate
IO devices.
It is possible to load an IO controller with connected I-device proxy from the PG/PC to the
device.
Note
The replacement of I-device proxy devices is only possible if the required I-device is available
in the hardware catalog.
An I-device proxy representing a SIMOTION I-device cannot be loaded and replaced.
Note
If the IE/PB link is not operated as a PROFINET IO proxy but rather as a gateway in standard
mode, the IE/PB link functions as a CPU and can be loaded separately.
Information on loading
We distinguish between the following cases when loading HMI devices to PG/PC:
HMI devices connected to a DP master as DP slave or to an IO controller as IO device are
loaded as DP slave or IO device respectively (for example, PP 17-I PROFIsafe).
HMI devices in a master system as I-slave or in an IO system as I-device are loaded as I-
slave proxies or I-device proxies (Page 1153) (for example, SIMATIC Comfort Panels). The
settings of the device proxy are read-only.
HMI devices are not loaded if they are connected to a subnet (PROFIBUS or PROFINET)
but not to a master system or IO system (for example, KP600 Basic color DP).
Requirement
The hardware configuration loaded from the device to the PG/PC has been compiled. The
statuses of the central and distributed modules are only correctly displayed after compilation.
Note
If you go online before compiling, the diagnostics icon ? is displayed (diagnostics not
possible). A corresponding alarm is displayed under "Info > General" in the Inspector window.
Dependencies
Depending on how completely the hardware configuration was loaded to the PG, restrictions
apply to going online and to diagnostics:
Completely loaded device with all associated central and distributed modules, such as DP
slaves or IO devices:
Going online and diagnostics are possible.
Loaded device with connected I-devices/I-slaves:
I device/I slave is not loaded: Going online for the device and its modules is possible.
For the dependent components of the configuration that are not loaded, device proxies
are handled with only minimum diagnostics support. The online status is represented
as an icon. The standard diagnostics is shown in the online and diagnostics view. I&M
data are not loaded.
I device/I slave is also loaded: Going online is possible for all devices; diagnostics is
fully supported.
Icons
The following table shows the icons and their functions:
Icon Function
Shows the alarms located in the archive.
Archive view
Shows the currently active (pending) alarms.
Alarms that must be acknowledged are shown in
Active alarms blue lettering.
Ignores the arrival of alarms, These alarms are
neither shown in the window nor stored in the ar
Ignore chive.
Confirms the selected alarm as read. Alarms re
quiring acknowledgment are shown in blue letter
Acknowledge ing.
Deletes all alarms in the archive.
Clear archive
Icon Function
Exports the current alarm archive to a file in xml
format.
Export archive
Shows the alarms with multiple lines.
Multiple lines
Always show the last incoming alarm first.
Table structure
All attributes of the alarms can be shown as columns. You can show or hide individual columns
as well as modify the width and order of the columns. These settings are saved when the
project is closed.
You can sort the columns in ascending or descending order. However, this setting is not saved
when you close the project.
The alarms can be displayed in one or more rows. In the single row display, only the first row
of the multiple-row alarm data is displayed.
The alarms either require acknowledgment or do not require acknowledgment. The alarms
requiring acknowledgment that have not yet been acknowledged are highlighted in blue
lettering and can be acknowledged either with the button in the toolbar for the particular context
or with the shortcut menu command "Acknowledge alarm(s)".
Procedure
Toe receive alarms, follow these steps:
1. Double-click on the "Online & Diagnostics" folder of the relevant CPU in project navigation.
2. Click the "Online access" group in the area navigation.
3. Select the option "Receive alarms".
Note
If you select this procedure, alarms are only received after you have re-established an
online connection to the device.
Or:
1. Select the relevant CPU in the device, network, or topology view.
2. Select the command "Receive alarms" in the "Online" menu or in the shortcut menu.
Or:
1. Select the CPU in project navigation.
2. Select the command "Receive alarms" in the "Online" menu or in the shortcut menu.
Note
If you select one of the two above-named procedures, you must have first established an
online connection to the device.
Result
The archive is saved as an xml file at the location you selected.
Procedure
To clear the archive, follow these steps:
1. Click the "Clear archive" button in the toolbar of the alarm display.
Table structure
All attributes of the alarms can be shown as columns. You can show or hide individual columns
as well as modify the width and order of the columns. These settings are saved when the
project is closed.
You can sort the columns in ascending or descending order. However, this setting is not saved
when you close the project.
The alarms can be displayed in one or more rows. In the single row display, only the first row
of the multiple-row alarm data is displayed.
The alarms either require acknowledgment or do not require acknowledgment. The alarms
requiring acknowledgment that have not yet been acknowledged are highlighted in bold print
and can be acknowledged either with the button in the toolbar for the specific context or with
the shortcut menu command "Acknowledge alarm(s)".
Procedure
To acknowledge an alarm, follow these steps:
1. Select the required alarm or alarms from the table.
2. Click the "Acknowledge" button.
Note
You can select more than one alarm to acknowledge at the same time. To do this, hold
down the <Ctrl> key and then select the alarms you want to acknowledge.
Result
The selected alarm was acknowledged and is then shown in normal characters.
Note
In the "Active alarms" view, acknowledged alarms that have already gone are no longer
displayed.
Ignoring alarms
To ignore alarms, follow these steps:
1. Click the "Ignore" button.
The icon is shown on a gray background.
Result
From this point onwards, all alarms will be ignored. A message is created in the archive view
indicating that the display of alarms and events is disabled.
Result
All alarms, in other words, even the alarms currently pending on the CPU while the "Ignore
alarms" function was active, are displayed again from this point onwards. A message is created
in the archive view indicating that the display of alarms and events is enabled again.
Alarm display
Operating modes
Introduction
Operating modes describe the behavior of the CPU. The following operating modes are
possible:
STARTUP
RUN
STOP
In these operating modes, the CPU can communicate via the PN/IE interface, for example.
See also
STOP mode (Page 1168)
RUN mode (Page 1168)
Overview
The following figure shows the operating modes and the operating mode transitions of S7-1200
CPUs:
32:(5
21 67$5783
6723 581
The following table shows the conditions under which the operating modes will change:
Function
After turning on the CPU, it executes a startup program before starting to execute the cyclic
user program.
By suitably programming startup OBs, you can specify certain initialization variables for your
cyclic program in the startup program. There is no rule in terms of the number of startup OBs.
That is, you can set up one or several startup OBs in your program, or none at all.
Special characteristics
Note the following points regarding the "STARTUP" mode:
The startup OBs are executed. All startup OBs you have programmed are executed,
regardless of the selected startup mode.
No time-based program execution can be performed.
Interrupt controlled program execution limited to:
OB 82 (diagnostics interrupt)
The outputs on the modules are disabled.
The process image is not updated; direct I/O access to inputs is possible.
See also
Editing properties and parameters (Page 574)
Principles of the operating modes of S7-CPUs (Page 1163)
Organization blocks for startup (Page 1213)
Warm restart (Page 1165)
Warm restart
Function
During a warm restart, all non-retentive bit memory is deleted and non-retentive DB contents
are reset to the initial values from load memory. Retentive bit memory and retentive DB
contents are retained.
See also
Retentive memory areas (Page 1173)
Startup activities
Overview
The following table shows which activities the CPU performs at STARTUP:
Sequence
The following figure shows the activities of the CPU in "STOP", "STARTUP", and "RUN" modes.
You can use the following measures to specify the state of the I/O outputs in the first cycle of
the user program:
Use assignable output modules to be able to output substitute values or to retain the last
value.
Set default values for outputs in startup OBs.
During the startup, all interrupt events are entered in a queue so that they can be processed
later during RUN mode. In RUN mode, hardware interrupts can be processed at any time.
6723
67$5783
5HVHWSURFHVVLPDJHLQSXW
'LVDEOH,2RXWSXWV
WXUQRIIUHWDLQODVWYDOXH
RUVXEVWLWXWHDYDOXH
5XQVWDUWXS2%V
7UDQVIHU,2LQSXWVWRWKH
SURFHVVLPDJHLQSXW
(QDEOH,2RXWSXWV
581
2XWSXWSURFHVVLPDJH
RXWSXW
7UDQVIHU,2LQSXWVWRWKH
SURFHVVLPDJHLQSXW
5XQF\FOLF2%V
2SHUDWLQJV\VWHP
DFWLYLWLHVFRPPXQLFDWLRQ
VHOIWHVWHWF
Canceling a STARTUP
If errors occur during startup, the startup is canceled and the CPU remains in "STOP" mode.
Under the following conditions, a startup will not be performed or will be canceled:
If an invalid SD card is inserted.
If no hardware configuration has been downloaded.
See also
Overview of the CPU properties (Page 1185)
RUN mode
Function
In "RUN" mode the cyclic, time-driven, and interrupt-driven program sections execute:
The process image output is read out.
The process image input table is read.
The user program is executed.
Active data exchange between S7-1200 CPUs by means of Open User Communication is only
possible in "RUN" mode.
See also
Principles of the operating modes of S7-CPUs (Page 1163)
Events and OBs (Page 1177)
STOP mode
Function
In "STOP" mode, the user program is not executed. All outputs are disabled or react according
to the parameter settings: They provide a substitute value as set in the parameters or retain
the last value output and bring the controlled process to a safe status.
See also
Principles of the operating modes of S7-CPUs (Page 1163)
Function
A memory reset on the CPU is possible only in STOP mode.
When memory is reset, the CPU is changed to an "initial status". This means:
An existing online connection between your programming device/PC and the CPU is
terminated.
The content of the work memory and the retentive and non-retentive data are deleted.
The diagnostic buffer, the time, the IP address, the hardware configuration, and active force
jobs are retained.
The load memory (code and data blocks) is then copied to work memory. As a result, the
data blocks no longer have current values but their configured initial values.
Memory areas
See also
Replacing a hardware component (Page 574)
Useful information on CPU firmware versions and STEP 7 versions (Page 1235)
Displaying properties of memory cards (Page 469)
Load memory
Function
Each CPU has an internal load memory. The size of this internal load memory depends on the
CPU used.
This internal load memory can be replaced by using external memory cards. If there is no
memory card inserted, the CPU uses the internal load memory; if a memory card is inserted,
the CPU uses the memory card as load memory.
However, the size of the usable external load memory cannot be greater than the internal load
memory even if the inserted memory card has more free space.
See also
Using memory cards (Page 467)
Work memory
Function
Work memory is a non-retentive memory area for storing elements of the user program that
are relevant for program execution. The user program is executed exclusively in work memory
and system memory.
System memory
Function
System memory contains the memory elements that each CPU makes available to the user
program, such as the process image and bit memory.
By using appropriate operations in your user program, you address the data directly in the
relevant operand area.
The following table shows the operand areas of the system memory:
Operand area Description Access via units of the following size: S7 notation
Process image output The CPU writes the values Output (bit) Q
from the process image out Output byte QB
put table to the output mod
ules at the start of the cycle. Output word QW
Output double word QD
Process image input The CPU reads the inputs Input (bit) I
from the input modules and Input byte IB
saves the values to the proc
ess image input table at the Input word IW
start of the cycle. Input double word ID
Bit memory This area provides storage Bit memory (bit) M
for intermediate results cal Memory byte MB
culated in the program.
Memory word MW
Memory double word MD
Data block Data blocks store informa Data bit DBX
tion for the program. They Data byte DBB
can either be defined so that
all code blocks can access Data word DBW
them (global DBs) or as Data double word DBD
signed to a specific FB or
SFB (instance DB).
Requirement: The block at
tribute "Optimized block ac
cess" is not enabled.
Operand area Description Access via units of the following size: S7 notation
Local data This area contains the tem Local data bit L
porary data of a block while Local data byte LB
the block is being processed.
Local data word LW
Requirement: The block at
tribute "Optimized block ac Local data double word LD
cess" is not enabled.
Recommendation: Access
local data (temp) symbolical
ly.
I/O input area The I/O input and output I/O input bit <tag>:P
areas permit direct access to I/O input byte
central and distributed input
and output modules. I/O input word
I/O input double word
I/O output area I/O output bit
I/O output byte
I/O output word
I/O output double word
See also
Diagnostics buffer (Page 1176)
Basic principles of process images (Page 1174)
Access to the I/O addresses (Page 1177)
See also
Warm restart (Page 1165)
Function
When the user program addresses the input (I) and output (O) operand areas, it does not query
or change the signal states on the digital signal modules. Instead, it accesses a memory area
in the system memory of the CPU. This memory area is referred to as the process image.
Sequence
The operating system updates the process images at cyclic intervals unless defined otherwise
in your configuration. The process image input/output is updated in the following order:
1. The internal tasks of the operating system are performed.
2. The process image output (PIQ) table is written to the outputs of the module.
3. The status of inputs is read to the process image input (PII) table.
4. The user program is executed with all the blocks that are called in it.
The operating system automatically controls the writing of the process image output to the
outputs of the modules and the reading of the process image input.
Special characteristics
You have the option of accessing inputs or outputs directly using direct I/O access.
If an instruction accesses an output directly and the output address is located in the process
image output, the process image of the relevant output is updated.
If an instruction accesses an output directly and the output address is not located in the
process image output, the process image of the relevant output is not updated.
029(
4
, (1 (12
0: ,1 287 4:
Update QW10 in the I/O output area with the value from MW0.
See also
Start address of a module (Page 1176)
Access to the I/O addresses (Page 1177)
Startup activities (Page 1166)
Diagnostics buffer
Function
The diagnostics buffer is part of the system memory of the CPU. It contains the errors detected
by the CPU or modules with diagnostics capability. It includes the following events:
Every mode change of the CPU (for example, POWER UP, change to STOP mode, change
to RUN mode)
Every diagnostics interrupt
The diagnostics buffer of the S7-1200-CPU has a capacity of 50 entries of which the last (most
recent) 10 entries are retained following power cycling.
Those entries can only be cleared by restoring the CPU to factory defaults.
You can read the content of the diagnostics buffer with the help of the Online and Diagnostics
view.
See also
Basic information on the diagnostics buffer (Page 1398)
Definition
The start address is the lowest byte address of a module. It acts as the initial address of the
module user data area.
I/O addresses
If you insert a module in the device view, its user data is located in the process image of the
S7-1200 CPU (default). The CPU handles the data exchange between the module and the
process image area automatically during the update of the process images.
Append the suffix ":P" to the I/O address if you want the program to access the module directly
instead of using the process image.
This could be necessary, for example, during execution of a time-sensitive program which also
has to control the outputs within the same cycle.
The following table describes events which do not trigger an OB start, including the
corresponding reaction of the operating system. The table is sorted based on event priority.
is processed. Once this OB has been completed, processing of the interrupted OB continues.
Specifically, this means:
Any OB with priority >= 2 will interrupt cyclic program execution.
An OB of priority 2 to 25 can be interrupted by any event whose priority is higher than that
of the running OB. This is also true for time errors: A time error (priority 26) will interrupt
any OB.
OB start information
Certain OBs have start information, while others do not. This is explained in greater detail in
the description of the relevant OB.
See also
Event-based program execution (Page 1180)
ATTACH: Attach an OB to an interrupt event (Page 3216)
DETACH: Detach an OB from an interrupt event (Page 3218)
:ULWH3,4
5HDG3,,
%HJLQ
2%
,QWHUUXSWLRQ
%HJLQ
2%[[
(QG
5HVXPH
2%
,QWHUUXSWLRQ
%HJLQ
2%[\
,QWHUUXSWLRQ
%HJLQ
2%
7LPHHUURU
LQWHUUXSW
5HVXPH (QG
2%[\
(QG
%HJLQ
2%[]
(QG
5HVXPH
2%
(QG
%HJLQ
2%[]
(QG
Notes on queues
Every priority class (OBs of the same priority to be called) is assigned a separate queue.
The size of those queues is set by default.
Any new event leading to the overflow of a queue is discarded and therefore lost. A "time
error interrupt event" is generated simultaneously. Information identifying the OB that
caused the error is included in the start information of the time error interrupt OB (OB 80).
A corresponding reaction such as an alarm trigger can be programmed in the time error
interrupt OB.
&38 0RGXOH
%HJLQ
2%[
',
&38 0RGXOH
:$,7
%HJLQ
2%[
',
&38 0RGXOH
:$,7
%HJLQ
2%[
',
(QG
%HJLQ
2%[
A hardware interrupt-triggering event such as a rising edge at the input calls the OB to
which it is assigned.
If a new event occurs that triggers a hardware interrupt while the OB is executing, this
event is entered in a queue.
The new event that triggers a hardware interrupt starts the hardware interrupt OB as
signed to the event.
The started OB can interrupt a cycle OB at every instruction. Consistent data access is
secured up to dword size.
You can parameterize module-specific interrupt-triggering events such as a rising and the
falling edge at the input.
Assign the interrupt-triggering event and the OB to be started in the configuration of the
interrupt-triggering module. However, within the started hardware interrupt OB you can
override this assignment using the DETACH instruction, or assign the same event to a
different OB using the ATTACH instruction. This functionality allows a flexible reaction to
external process signals.
Default settings
When they leave the factory, all hardware components with parameters have default settings
suitable for standard applications. These default values allow the hardware components to be
used immediately without making any additional settings.
You can, however, modify the behavior and the properties of the hardware components to suit
the requirements and circumstances of your application. Hardware components with settable
parameters include, for example, communications modules and several analog and digital
modules.
Cycle time
Communications load
The entry possibilities specify what is adjustable and in which value ranges. Fields that cannot
be edited are disabled or are not shown in the properties window.
Requirement
You have already arranged the hardware components for which you want to change properties
on a rack.
Procedure
To change the properties and parameters of the hardware components, follow these steps:
1. In the device or network view, select the hardware component or interface that you want
to edit.
2. Edit the settings for the selected object:
For example in the device view you can edit addresses and names.
In the Inspector window additional setting possibilities are available.
You do not need to confirm your entries, the changed values will be applied immediately.
See also
Editing properties and parameters (Page 574)
Introduction to loading a configuration (Page 1146)
CPU properties
Overview
The following table provides you with an overview of the CPU properties:
See also
Specifying input and output addresses (Page 849)
Assigning parameters to hardware interrupt OBs (Page 1230)
Access to the I/O addresses (Page 1177)
Addressing modules (Page 848)
Special features during startup (Page 1167)
Function
The cycle time is the time that the operating system requires to execute the cyclic program
and all the program sections that interrupt this cycle. The program execution can be interrupted
by:
Time errors and 2xMaxCycleTime errors
System activities, e.g., process image updating
The cycle time (Tcyc) is therefore not the same for every cycle.
The following schematic shows an example of different cycle times (TZ1 TZ2) for S7-1200
CPUs:
'LIIHUHQWF\FOHWLPHVIRU6&38V
7] 7]
2%
8SGDWLQJWKH 8SGDWLQJWKH3,, 2% 2% 2% 8SGDWLQJWKH 8SGDWLQJWKH 2% 2% 8SGDWLQJWKH
3,2 3,2 3,, 3,2
3,,3URFHVVLPDJHLQSXW
3,23URFHVVLPDJHRXWSXW
In the current cycle, the cyclic OB used here (e.g. OB 1) will be interrupted by a time error (e.g.
OB 80). Following the cyclic OB, the next cycle OB 201 is processed.
Function
The cycle time of the CPU can be extended due to communications processes. These
communications processes include for example:
Transferring data to another CPU
Loading of blocks initiated by a programming device
You can control the duration of these communications processes to some extent using the
CPU parameter "Cycle load due to communication".
In addition to communications processes, test functions also extend the cycle time. The "Cycle
load due to communication" parameter can be used to influence the duration.
&\FOHORDGGXHWRFRPPXQLFDWLRQ
The formula does not take into account the effect of asynchronous events such as hardware
interrupts or cyclic interrupts on the cycle time.
If the cycle time is extended due to communication processes, more asynchronous events
may occur within the cycle time of the cyclic organization block. This extends the cycle still
further. The extension depends on how many events occur and how long it takes to process
them.
Note
Observe the following:
Check the effects of changing the value of the "Cycle load due to communication" parameter
while the system is running.
You must always consider the communication load when setting the minimum cycle time
as time errors will otherwise occur.
Recommendations
Increase this value only if the CPU is used primarily for communication purposes and the
user program is not time critical.
In all other situations you should only reduce this value.
Time-of-day functions
Time-of-day format
The clock always shows the time of day with a resolution of 1 millisecond and the date including
the day of the week. The time adjustment for daylight-saving time is also taken into account.
Manual setting
You can also read and set the time-of-day manually in the online and diagnostics view under
"Functions > Set time-of-day".
See also
WR_SYS_T: Set time-of-day (Page 2981)
RD_SYS_T: Read time-of-day (Page 2983)
RD_LOC_T: Read local time (Page 2985)
SET_TIMEZONE: Set time zone (Page 2989)
Clock parameters
The clock parameters allow you to make the following settings:
Enable time synchronization via NTP server
Select this check box if you want the internal clock to be synchronized using the NTP
synchronization mode.
Network time server
The IP addresses of up to four NTP servers need to be configured.
Update interval
The update interval defines the interval between time queries.
High-speed counters
Introduction
High-speed counters are typically used to drive counting mechanisms in which a shaft turning
at a constant speed is equipped with an incremental step encoder. The incremental step
encoder ensures a certain number of count values per rotation and a reset pulse once per
rotation. The clock memory bit(s) and the reset pulse of the incremental step encoder supply
the inputs for the high-speed counter.
The various S7-1200 CPUs have differing numbers of high-speed counters available:
How it works
The first of several default values is loaded on the high-speed counter. The required outputs
are enabled for the time during which the current value of the counter is lower than the default
value. The counter is set up so that an interrupt occurs if the current value of the counter is
equal to the default value or when the counter is reset.
If the current value is equal to the default value and an interrupt event results, a new default
value is loaded and the next signal state is set for the outputs. If an interrupt event occurs
because the counter is reset, the first default value and the first signal states of the outputs
are set and the cycle repeated.
Since the interrupts occur much less frequently than the high-speed counter counts, a precise
control of the fast operations can be implemented with only a slight influence on the overall
cycle of the automation system. Since you can assign specific interrupt programs to interrupts,
each new default can be loaded in a separate interrupt program allowing simple control of the
state.
Note
You can also process all interrupt events in a single interrupt program.
See also
Configuring high-speed counters (Page 1196)
Interdependency of the counter mode and counter inputs (Page 1194)
* HSC3 can only be used for CPU 1211 without a reset input
** HSC5 can be also be used for CPU 1211/12 if a DI2/DO2 signal board is used
See also
General information on high-speed counters (Page 1193)
Configuring high-speed counters (Page 1196)
Requirement
An S7-1200 CPU has been inserted in the hardware configuration.
Procedure
To configure a high-speed counter, follow these steps:
1. Select an S7-1200 CPU in the device or network view.
2. Click on the required high-speed counter under "Properties > High-speed counter" in the
inspector window:
CPU 1211C: HSC1 to HSC3 (also HSC5 with a DI2/DO2 signal board)
CPU 1212C: HSC1 to HSC4 (also HSC5 with a DI2/DO2 signal board)
CPU 1214C / 1215C / 1217C: HSC1 to HSC6
3. Enable the high-speed counter in the "General" parameter group using the relevant check
box.
Note
If you use a CPU 1211C or CPU 1212C with a DI2/DO2 signal board, you can also enable
the high-speed counter HSC5.
Note
If you activate the pulse generators and operate them as PTO1 or PTO2, they use the
associated high-speed counter HSC1 or HSC2 with "Motion axis" counting mode to
evaluate the hardware outputs. If you configure high-speed counter HSC1 or HSC2 for
other counting tasks, these cannot be used by pulse generator PTO1 or PTO2, respectively.
If required, you can enter a name and a comment for the high-speed counter here.
4. Define the functionality of the high-speed counter in the "Function" parameter group:
Count mode: Select what you want to be counted from the drop-down list.
Operating phase: Select the count algorithm from the drop-down list.
Input source: Select the onboard CPU inputs or the inputs of an optional digital signal
board as the input source for the count pulses from the drop-down list.
Count direction is specified by: If you have selected a single-phase operating phase,
open the drop-down list and select whether the count direction is set internally by an
SFB parameter of the user program or externally via a digital input.
Initial count direction: If the user program is set as the internal direction control for the
count direction, you can select the count direction at the start of counting from the drop-
down list.
Frequency meter period: If frequency is set as the count mode, you can select the
duration of the frequency meter periods in the drop-down list.
5. Specify the initial values and reset condition of the high-speed counter in the "Reset to initial
values" parameter group:
Initial counter value: Enter a start value for the high-speed counter.
Initial reference value: Enter a maximum value for the high-speed counter.
Here, you can also specify whether the high-speed counter will use a reset input and the
set the corresponding signal level for the reset input from the drop-down list.
6. Configure the reaction of the high-speed counter to certain events in the "Event
configuration" parameter group. The following events can trigger an interrupt:
The counter value matches the reference value.
An external reset event was generated.
A change of direction was triggered.
Enable an interrupt reaction using the check box, enter a name and select a hardware
interrupt for the interrupt from the drop-down list.
7. Assign the start address for the high-speed counter in the "I/O/Diagnostics addresses"
parameter group.
Note
In the "Hardware inputs" parameter group, you can only see which hardware inputs and
values are being used for the clock, direction determination, reset pulse, and maximum
count speed.
Result
You have now adapted the parameters of the high-speed counter to the requirements of your
project.
See also
General information on high-speed counters (Page 1193)
Interdependency of the counter mode and counter inputs (Page 1194)
Point-to-point communication
See also
Configuring a communications port (Page 1199)
Note
If you use the user program to change the port setting, the settings of the graphic configuration
are overwritten.
You should also keep in mind that the settings made by the user program are not retained if
there is a power down.
Requirement
A communications module is already plugged in.
You are in the device view.
Procedure
To configure the communications port, proceed as follows:
1. Select the interface in the graphic representation in the device view.
The properties of the interface are displayed in the Inspector window.
2. Select the "Port configuration" group in the area navigation of the Inspector window.
The settings of the port are displayed.
3. From the "Transmission speed" drop-down list, select the speed for the data transmission.
With user-programmed communication, remember the influence of the transmission speed
on the changeover time.
4. From the "Parity" drop-down list, select the type of detection of bad information words.
5. Using the "Data bits" drop-down list, decide whether a character consists of eight or seven
bits.
6. From the "Stop bit" drop-down list, select how many bits will identify the end of a transmitted
word.
7. From the "Flow control" drop-down list, select the method for ensuring a trouble-free data
stream between sender and receiver. This parameter can only be set for the RS-232
interface.
Enter a HEX value in the "XON character" box that will cause the transmission of the
message to be continued when it is detected. This parameter can only be set for
software-controlled data flow control.
Enter a HEX value in the "XOFF character" box that will cause the transmission of the
message to be suspended for the set wait time. This parameter can only be set for
software-controlled data flow control.
8. In the "Wait time" box, enter a wait time in ms that must be kept to after the end of the
message before the next transmission can start.
Note
You can configure the interface in the network view as well. To do so, you must first select the
communication module in the tabular network view and then select the interface in the
Inspector window. Then you can continue as described above.
See also
Setting data flow control (Page 1200)
the receiving device can accept data. If the CTS signal is active, the module can transfer data
until the CTS signal becomes inactive. If the CTS signal is inactive, the data transfer must be
suspended for the set wait time. If the CTS signal is still inactive after the set wait time, the
data transfer is aborted and an error is signaled back to the user program.
See also
Configuring a communications port (Page 1199)
User-programmed communication
You can control the data traffic between a communications module and a device connected
externally via the serial interface using your own mechanisms. If you want to do this, you will
need to define a communications protocol yourself. In freely programmable communication,
ASCII and binary protocols are supported for message transfer.
Within the communications protocol, you will need to specify the criteria by which the start and
end of a transferred message can be recognized in the data stream.
User-programmed communication can only be activated in RUN mode. If there is a change to
STOP mode, the user-programmed communication is stopped.
See also
User-programmed communication with RS-232 devices (Page 1202)
Making the settings for sending (Page 1204)
Specifying the start of the message (Page 1204)
Specifying the end of the message (Page 1205)
The cable returns to receive mode when the RS-232 send line is idle for a certain time that is
defined as the changeover time of the cable. The set transmission speed influences the
changeover time as shown in the table.
See also
Configuration of message transfer (Page 1201)
Making the settings for sending (Page 1204)
Specifying the start of the message (Page 1204)
Specifying the end of the message (Page 1205)
Sending messages
You can program pauses between individual messages.
The following table shows which pauses can be set:
Parameter Definition
RTS ON delay You can set the time that must elapse after the send request RTS
(request to send) before the actual data transfer starts.
RTS OFF delay You can set the time that must elapse after the complete transfer be
fore RTS signal is deactivated.
Send pause at the start of the You can specify that a pause is sent at the start of every message
message transfer when the RTS ON delay has elapsed.
The pause is specified in bit times.
Send Idle Line after a pause You can make a setting so that following a selected pause at the start
of the message, the "Idle Line" signal is output to signal that the line
is not in use. To enable the parameter, "Send pause at message start"
must be set.
The duration of the "Idle Line" signal is specified in bit times.
See also
Specifying the start of the message (Page 1204)
Specifying the end of the message (Page 1205)
User-programmed communication with RS-232 devices (Page 1202)
There are two different methods for identifying the start of a message:
Starting with any character:
Any character can defined the start of a message. This is the default method.
Starting with a specific condition:
The start of a message is identified based on selected conditions.
Parameter Definition
Recognize start of message The receiver recognizes a line break when the received data stream is
by line break interrupted for longer than one character. If this is the case, the start of
the message is identified by the line break.
Recognize start of message The start of a message is recognized when the send transmission line is
by idle line in the idle state for a certain time (specified in bit times) followed by an
event such as reception of a character.
Recognize start of message The start of a message is recognized when a certain character occurs.
with individual characters You can enter the character as a HEX value.
Recognize start of message The start of a message is detected when one of the specified character
by a character string sequences arrives in the data stream. You can specify up to four char
acter sequences each with up to five characters.
See also
Making the settings for sending (Page 1204)
User-programmed communication with RS-232 devices (Page 1202)
Parameter Definition
Recognize end of message by The end of a message is recognized automatically when a selected
message timeout maximum duration for a message is exceeded. Values from 0 to 65535
ms can be set.
Recognize end of message by The end of a message is recognized when there is no reply within a
reply timeout set time after transferring data. Values from 0 to 65535 ms can be set.
Parameter Definition
Recognize end of message by The end of a message is detected when the time between two char
timeout between characters acters specified in bit times is exceeded. Values from 0 to 2500 bit
times can be set.
The S7-1200 CPU only accepts a maximum time of eight seconds
even if the value that is set results in a duration of more than eight
seconds.
Recognize end of message by The end of a message is recognized when the maximum length of a
maximum length message is exceeded. Values from 1 to 1023 characters can be set.
Read message length from The message itself contains information about the length of the mes
message sage. The end of a message is reached when the value taken from the
message is reached. Which characters are used for the evaluation of
the message length is specified with the following parameters:
Offset of the length field in the message
The value decides the position of the character in the message that
will be used to indicate the message length.
Values from 1 to 1022 characters can be set.
Size of the length field
This value specifies how many characters starting at the first
evaluation position will be used to indicate the message length.
Values of 0, 1, 2 and 4 characters can be set.
The data following the length field
(does not belong to the message length)
The value specifies the number of bytes after the length field that
must be ignored in the evaluation of the message length.
Values from 0 to 255 characters can be set.
Recognize message end with The end of a message is detected when the specified character se
a character sequence quence arrives in the data stream. You can define up to five characters
in the character string that are to be checked. If the specified charac
ters appear at the correct location in the message, the message end
is recognized. To recognize the message end when character 1 and
character 3 have a certain value, for example, you have to activate the
check box for character 1 and character 3 and enter a character value.
See also
Making the settings for sending (Page 1204)
User-programmed communication with RS-232 devices (Page 1202)
System memory
A system memory is a bit memory with defined values.
You decide which memory byte of the CPU will become the system memory byte when
assigning the system memory parameters.
Benefits
You can use system memory in the user program, for example to run program segments in
only the first program cycle after start-up. Two system memory bits are constant 1 or constant
0.
Note
The selected memory byte cannot be used for intermediate storage of data.
Clock memory
A clock memory is a bit memory that changes its binary status periodically in the pulse-no-
pulse ratio of 1:1.
You decide which memory byte of the CPU will become the clock memory byte when assigning
the clock memory parameters.
Benefits
You can use clock memory, for example, to activate flashing indicator lamps or to initiate
periodically recurring operations such as recording of actual values.
Available frequencies
Each bit of the clock bit memory byte is assigned a frequency. The following table shows the
assignment:
Note
Clock memory runs asynchronously to the CPU cycle, i.e. the status of the clock memory can
change several times during a long cycle.
The selected memory byte cannot be used for intermediate storage of data.
Protection
Protection level
The following section describes how to use the various protection levels of the S7-1200 CPUs
V1 to V3.
Access authorization to the protected data is in effect for the duration of the online connection
or until the access authorization is manually rescinded with "Online > Delete access rights".
Access authorization will also expire when the project is closed.
Note
You can not restrict functions for process control, monitoring, and communications.
Some functions are still protected due to their use as online data. RUN/STOP in the "Online
Tools" task card or "Set the time" in the diagnostics and online editor is therefore write-
protected.
Protection level
The following section describes how to use the various access levels of the S7-1200 CPUs as
of V4.
S7-1200 CPUs provide various access levels to limit the access to specific functions.
The parameters for the access levels are assigned in a table. The green checkmarks in the
columns to the right of the respective access level specify which operations are possible
without knowing the password of this access level. If you want to use the functions of check
boxes that are not selected, a password has to be entered.
Notice
Configuring an access level does not replace know-how protection
Configuring access levels prevents unauthorized changes to the CPU by restricting download
privileges. However, blocks on the memory card are not write- or read-protected. Use know-
how protection to protect the code of blocks on the memory card.
Default characteristics
The default access level is "Full access (no protection)". Every user can read and change the
hardware configuration and the blocks. A password is not set and is also not required for online
access.
The passwords are entered in a table in such a way that exactly one access level is assigned
to each password.
The effect of the password is visualized in the "Access" column and explained in the text below
the table.
Example
You select the "No access (complete protection)" access level for a standard CPU (in other
words, not an F-CPU) and enter a separate password for each of the access levels that lie
above it in the table.
For users who do not know any of the passwords, the CPU is completely protected. Not even
HMI access is possible.
For users who know one of the set passwords, the effect depends on the table row in which
the password occurs:
The password in row 1 (Full access (no protection)) allows access as if the CPU were
completely unprotected. Users who know this password have unrestricted access to the
CPU.
The password in row 2 (read access) allows access as if the CPU were write-protected.
Users who know this password have read-only access to the CPU.
The password in row 3 (HMI access) allows access as if the CPU were write-protected and
read-protected so that only HMI access is possible for users who know this password.
Procedure
To configure the access levels of an S7-1200 CPU, follow these steps:
1. Open the properties of the module in the inspector window.
2. Open the "Protection" entry in the area navigation.
A table with the possible access levels appears in the inspector window.
3. Activate the required access level in the first column of the table. The green checkmarks
in the columns to the right of the respective protection level show you which operations are
still available without entering the password.
4. In the "Password" column, specify a password for full access in the first row. In the
"Confirmation" column, enter the selected password again to protect against incorrect
entries.
Ensure that the password is sufficiently secure, in other words, that is does not follow a
machine-recognizable pattern!
You must enter a password in the first row "Full access (no protection)". This enables
unrestricted access to the CPU for those who know the password, regardless of the
selected protection level.
5. Assign additional passwords as needed to other access levels if the selected protection
level allows you to do so.
6. Download the hardware configuration so that the access level takes effect.
Result
The hardware configuration and the blocks are protected against unauthorized access
according to the set access level. If an operation cannot be executed without a password due
to the set access level, a dialog for entering a password is displayed.
Introduction
The CPU can be the server for a number of communication services. This means that other
communication participants can access CPU data even if you have not configured and
programmed connections for the CPU.
The local CPU as a server thus does not have the possibility to control communication to the
clients.
The parameter "Connection mechanisms" in the "Protection" area of the CPU parameters is
used to specify whether this type of communication is permitted or not for the local CPU during
operation.
If you want to allow access to CPU data from the client side, meaning that you do not want to
restrict the communication services of the CPU, activate the "Permit access with PUT/GET
communication from remote partners" option.
Organization blocks
Description
You can determine the boundary conditions for the startup characteristics of your CPU, for
example, the initialization values for "RUN". To do this, write a startup program. The startup
program consists of one or more startup OBs (OB numbers 100 or >= 123).
The startup program is executed once during the transition from "STOP" mode to "RUN" mode.
Current values from the process image of the inputs are not available for startup program, nor
can these values be set.
After the complete execution of the startup OBs, the process image of the inputs is read in and
the cyclic program is started.
There is no time limit for executing the startup routine. Therefore the scan cycle monitoring
time is not active. Time-driven or interrupt-driven organization blocks cannot be used.
Start information
A startup OB has the following start information:
See also
Events and OBs (Page 1177)
Introduction
For the program execution to start, at least one program cycle OB must be present in the
project. The operating system calls this program cycle OB once in each cycle and thereby
starts the execution of the user program. You can use multiple OBs (OB numbers >= 123).
When multiple program cycle OBs are used, these are called in one after the other in the order
of their OB numbers. The program cycle OB with the lowest OB number is called first.
The program cycle OBs have the priority class 1. This corresponds to the lowest priority of all
OBs. The cyclic program can be interrupted by events of any other event class.
Start information
None
Optimized start information:
See also
Events and OBs (Page 1177)
Function
Organization blocks for time-of-day interrupt (OB number >=123) can be processed as follows:
One time to a preset time (date with time of day)
Periodically with preset start time and the following intervals:
Every minute
Hourly
Daily
Weekly
Monthly
Yearly
End of month
Time-of-day interrupt-OBs are therefore used to run parts of the user program on a time-
controlled basis.
Status Meaning
Cancelled The one-time processing has already taken place, or the start event of an not yet processed time-of-day
interrupt has been deleted with the extended instruction CAN_TINT.
Set You have scheduled the time or start time for processing.
Activated You have scheduled whether processing takes place one time or periodically, and in the case of periodic
processing, you have scheduled the interval.
Note
If you configure a time-of-day interrupt in such a way that the corresponding OB is to be
processed once, the start time must not be in the past (relative to the real-time clock of the
CPU).
If you configure a time-of-day interrupt in such a way that the corresponding OB is to be
processed periodically, but the start time is in the past, then the time-of-day interrupt will be
processed the next time it is due.
Condition Result
The extended instruction CAN_TINT is called in the user pro The operating system deletes the start event (date and time)
gram. of the time-of-day interrupt. You must reset and reactivate the
time-of-day interrupt if you are going to call the corresponding
time-of-day interrupt OB again.
By synchronizing or correcting the CPU system clock, the The operating system calls the time error interrupt OB (OB
time of day will be set ahead. With this, the start time for a 80) and records the start event, the number, and the priority
time-of-day interrupt OB will be bypassed. of the first bypassed time-of-day interrupt OB in its start infor
mation. After completion of the OB 80, the operating system
processes the bypassed time-of-day interrupt OB only once.
By synchronizing or correcting the CPU system clock, the The time-of-day interrupt OB is repeated.
time of day will be set back. The corrected clock time is before
the start time of an already processed time-of-day interrupt
OB.
A time-of-day interrupt OB is still being processed when the The operating system then calls time error interrupt OB 80.
start event for its next execution occurs. The requested OB is processed only after the processing and
further execution of the current time-of-day interrupt OB has
completed.
Start information
A time-of-day interrupt OB has the following start information:
Description
When it receives a status interrupt, the operating system of the S7-1200 CPU calls the status
interrupt OB from a DP master or IO controller. This may be the case if a module of a slave
changes its operating mode, for example, from "RUN" to "STOP". For more detailed information
on events that trigger a status interrupt, refer to the documentation of the slave or device
manufacturer.
See also
Events and OBs (Page 1177)
Description
When it receives a status interrupt, the operating system of the S7-1200 CPU calls the update
interrupt OB from a DP master or IO controller. This may be the case if you changed a
parameter on a slot of a slave or device. For more detailed information on events that trigger
an update interrupt, refer to the documentation of the slave or device manufacturer.
See also
Events and OBs (Page 1177)
Description
When it receives a manufacturer-specific or profile-specific interrupt from a DP master or IO
controller, the operating system of the S7-1200 CPU calls OB 57. For more detailed information
on events that trigger this type of interrupt, refer to the documentation of the slave or device
manufacturer.
See also
Events and OBs (Page 1177)
Description
A time-delay interrupt OB is started after a configurable time delay of the operating system.
The delay time starts after the SRT_DINT instruction is called.
You can use up to four time-delay interrupt OBs or cyclic OBs (OB numbers >= 123) in your
program. If, for example, you are already using two cyclic interrupt OBs, you can insert a
maximum of two further time-delay interrupt OBs in your program.
You can use the CAN_DINT instruction to prevent the execution of a time-delay interrupt that
has not yet started.
You can disable and re-enable time-delay interrupts using the DIS_AIRT and EN_AIRT
instructions.
Note
If you disable an interrupt with DIS_AIRT after executing SRT_DINT, this interrupt executes
only after it has been enabled with EN_AIRT. The delay time is extended accordingly.
Start information
None
Optimized start information:
See also
SRT_DINT: Start time-delay interrupt (Page 3230)
CAN_DINT: Cancel time-delay interrupt (Page 3231)
Events and OBs (Page 1177)
Description
Cyclic interrupt OBs serve to start program in periodic time intervals independently of the cyclic
program execution. The start times of a cyclic interrupt OB are specified using the time base
and the phase offset.
The time base defines the intervals at which the cyclic interrupt OB is started and is an integer
multiple of the basic clock cycle of 1 ms. The phase offset is the time by which the start time
is offset compared with the basic clock cycle. If several cyclic interrupt OBs are being used,
you can use this offset to prevent a simultaneous start time if the time bases of the cyclic
interrupt OBs have common multiples.
You can specify a time period between 1 ms and 60000 ms as the time base.
You can use up to four cyclic interrupt OBs or time-delay OBs (OB numbers >= 123) in your
program. If, for example, you are already using two time-delay interrupt OBs, you can insert a
maximum of two further cyclic interrupt OBs in your program.
Note
The execution time of each cyclic interrupt OB must be noticeably smaller than its time base.
If a cyclic interrupt OB has not been completely executed but execution is again pending
because the cycle clock has expired, the time error OB is started. The cyclic interrupt that
caused the error is executed later or discarded.
Start information
None
Optimized start information:
See also
Assigning parameters to cyclic interrupt OBs (Page 1229)
Events and OBs (Page 1177)
Description
You can use hardware interrupt OBs to react to specific events. You can assign an event that
triggers an alarm to precisely one hardware interrupt OB. A hardware interrupt OB in contrast
can be assigned to several events.
Hardware interrupts can be triggered by high-speed counters and input channels. For each
high-speed counter and input channel that should trigger a hardware interrupt, the following
properties need to be configured:
The process event that should trigger the hardware interrupt (for example, the change of
a count direction of a high-speed counter)
The number of the hardware interrupt OB which is assigned to this process event
You can use up to 50 hardware interrupt OBs (OB numbers >= 123) that are independent of
each other in your program.
Start information
None
Optimized start information:
See also
Assigning parameters to hardware interrupt OBs (Page 1230)
Events and OBs (Page 1177)
Description
The operating system calls the time error OB (OB 80) if one of the following events occurs:
The cyclic program exceeds the maximum cycle time.
The OB called is currently still being executed (possible for time-delay interrupt OBs and
cyclic interrupt OBs).
A time-of-day interrupt was missed because the clock time was set forward by more than
20 seconds.
A time-of-day interrupt was missed during a STOP.
An overflow has occurred in an interrupt OB queue.
An interrupt was lost due to the excessive interrupt load.
If you have programmed no time error OB, the S7-1200 CPU reacts as follows:
CPUs with firmware version V1.0: The CPU remains in RUN mode.
CPUs with firmware version V2.0:
The CPUs goes to STOP mode when the maximum cycle time is exceeded.
With all other start events of the time error OB, the CPU remains in RUN mode.
With CPUs with firmware version V1.0, the two-time overshooting of the maximum cycle time
does not lead to the calling of an OB, but to the STOP of the CPU. You can avoid the second
violation by restarting the cycle monitoring of the CPU with the RE_TRIGR instruction.
You can use only one time error OB in your program.
Start information
The time error OB has the following start information:
See also
Events and OBs (Page 1177)
Description
You can enable the diagnostic error interrupt for diagnostics-capable modules so that the
module detects changes in the I/O status. As a result, the module triggers a diagnostic error
interrupt in the following cases:
A fault is present (incoming event)
A fault is no longer present (outgoing event)
If no other interrupt OB is active, then the diagnostic interrupt OB (OB 82) is called. If another
interrupt OB is already being executed, the diagnostic error interrupt is placed in the queue of
its priority group.
You can use only one diagnostic interrupt OB in your program.
Start information
The diagnostic interrupt OB has the following start information:
IO_state tag
The following table shows the possible I/O states that the IO_state tag can contain:
IO_state Description
Bit 0 Configuration correct:
= 1, if the configuration is correct
= 0, if the configuration is no longer correct
Bit 4 Error:
= 1, if an error is present, e.g., a wire break
= 0, if the error is no longer present
Bit 5 Configuration not correct:
= 1, if the configuration is not correct
= 0, if the configuration is correct again
Bit 6 I/O cannot be accessed:
= 1, if an I/O access error has occurred
In this case, laddr contains the hardware identifier of the I/O with the access error.
= 0, if the I/O can be accessed again
See also
Events and OBs (Page 1177)
Description
The S7-1200 CPU operating system calls the pull/plug interrupt OB (OB 83) if a configured
and non-disabled distributed I/O module or submodule (PROFIBUS, PROFINET, AS-i) is
removed or inserted.
Note
The removal or insertion of a central module leads to the STOP of the CPU.
Start information
The pull/plug interrupt OB has the following start information:
The following table shows which event caused the start of the pull/plug interrupt OB.
See also
Events and OBs (Page 1177)
Description
The S7-1200 CPU operating system calls the OB 86 in the following cases:
The failure of a DP master system or of a PROFINET IO system is detected (in the case
of either an incoming or an outgoing event).
The failure of a DP slave or of an IO device is detected (in the case of either an incoming
or an outgoing event).
Failure of some of the submodules of a PROFINET I-device is detected.
The following table shows which event caused the start of OB 86.
See also
Events and OBs (Page 1177)
Introduction
Several organization blocks (OBs) have properties with which you can control their behavior
or their assignment to specific events. You can influence these properties by assigning
parameters.
Overview
You can assign parameters to the properties for the following organization blocks:
Time-of-day interrupt OBs
Cyclic interrupt OBs
Hardware interrupt OBs
See also
Assigning parameters to hardware interrupt OBs (Page 1230)
Assigning parameters to cyclic interrupt OBs (Page 1229)
"Execution" parameter
Use the drop-down list "Execution" to define the periods at which the time-of-day interrupt OB
is to be executed. The time intervals relate to the settings for "Start date" and "Time-of-day".
The following values are possible for "Execution":
Never
Once
Every minute
Hourly
Daily
Weekly
Monthly
Yearly
End of month
Note
With the value "End of month", the value specified under "Start date" is irrelevant.
Note
If you set the "Execution" parameter to "Monthly", the start date cannot be set to the 29th, the
30th, or the 31st. If you want the time-of-day interrupt OB to start at the end of the month, you
should set the parameter "Execution" to "End of month".
Introduction
You can use cyclic interrupt OBs to start programs at regular time intervals. To do so you must
enter a scan time and a phase shift for each cyclic interrupt OB used.
You can use up to four cyclic interrupt OBs or time-delay OBs (OB numbers >= 200) in your
program. If, for example, you are already using two time-delay interrupt OBs, you can insert a
maximum of two further cyclic interrupt OBs in your program.
Note
If you assign multiple cyclic OBs, make sure that you assign a different cycle time or phase
offset to each cyclic interrupt OB to avoid them executing at the same time or having to queue.
When you create a cyclic interrupt OB, the cycle time 100 and the phase offset 0 are entered
as start value.
Procedure
To enter a scan time and a phase shift for a cyclic interrupt OB, proceed as follows:
1. Open the "Program blocks" folder in the project tree.
2. Right-click on an existing cyclic interrupt OB.
3. Select the "Properties" command in the shortcut menu.
The "<Name of the cyclic interrupt OB>" dialog box opens.
4. Click the "Cyclic interrupt" group in the area navigation.
The text boxes for the scan time and the phase shift are displayed.
5. Enter the scan time and the phase shift.
6. Confirm your entries with "OK".
See also
Basics of block parameters (Page 1227)
Organization blocks for cyclic interrupts (Page 1220)
Introduction
You must select the corresponding event and assign the following parameters for every input
channel and high-speed counter that should trigger a hardware interrupt:
Event name
Number of the hardware interrupt OB that is assigned to this process event
The parameters of the hardware interrupt are assigned in the properties of the corresponding
device. You can assign parameters for up to 50 hardware interrupt OBs.
You can create the hardware interrupt OB to be assigned parameters either before or during
activation of an event.
Procedure
To configure a hardware interrupt event, follow these steps:
1. Double-click the "Devices & Networks" command in the project tree.
The hardware and network editor opens in the network view.
2. Change to the device view.
3. If the Inspector window closed in the device view, select the "Inspector window" check box
in the "View" menu.
The Inspector window opens.
4. Click the "Properties" tab.
5. In the device view, select the module for which you want to a assign a hardware interrupt.
6. Select the corresponding event that will trigger a hardware interrupt, e.g., a positive edge.
A system constant of data type Event_HwInt is created automatically for the event identified
by the explicit event name. The system constants are displayed in the standard tag table.
See also
Basics of block parameters (Page 1227)
Organization blocks for hardware interrupts (Page 1221)
Events and OBs (Page 1177)
Description
The instructions from the task card are comprised of functions (FC), function blocks (FB),
system functions (SFC) and system function blocks (SFB) that are identified internally by
numbers.
The following tables show the assignment of numerical and symbolic names.
Functions (FCs)
Compatibility between memory card content and firmware version of the CPU
Memory cards (transfer cards or program cards) with configuration and program for an S7-1200
CPU V1, V2 or V3 do not work with an S7-1200 CPU V4.
Memory cards with configuration and program for an S7-1200 CPU V4 do not work with an
S7-1200 CPU V1, V2 or V3.
You must change an S7-1200 CPU V1 to V3 configuration to an S7-1200 CPU V4 configuration
(device replacement) and then download it to the CPU. A gradual device replacement is
required for an S7-1200 CPU V1-V2 (see below).
When you insert the memory card into a CPU with an incompatible firmware version, the CPU
does not start up. When you insert a memory card for a CPU V1, V2 or V3 into an S7-1200
CPU V4, this CPU outputs a version error.
You may have to transfer the latest HMI Runtime version by means of the WinCC engineering
software.
You must compile the HMI configuration once again and download it to the HMI device for the
CPU-HMI communication to work.
See also
Useful information on memory cards (Page 1169)
RFID systems
"Diagnostics" parameter
Parameter assignment options:
None
Apart from standard diagnostics messages, no other diagnostics messages are generated.
Hard Errors
Extended diagnostics messages are generated if the following events occur.
Hardware error (memory test)
Firmware error (checksum)
Connection to reader lost
Short-circuit fault/interruption if supported by the hardware
Further information
For further information on diagnostics, refer the documentation for the RF120C
communications module with application blocks for S7-1200 and S7-1500.
The following parameters are system specific according to the selection you made in the
"Reader" parameter group.
RF200
RF300
RF600
Fast detection
Tag hold On Off Enable/disable "Tag hold" 1)
Off
Scanning mode On Off Enable/disable the "Scanning mode" 1)
Off
Channel assignment (only - - Selection of the wireless channels to be used 1)
with wireless profile ETSI)
1)
You will find further information in the "Configuration manual RF620R/RF630R". *
2)
The values for the transmit/radiated power of the antennas can be found in the following table.
SLG D10S
SLG D11S/D12S
MOBY U
General Reader
ASM 475
Introduction
Up to eight ASM 475 interface modules can be plugged in and operated in a rack of the
SIMATIC S7-300. If you have a configuration with several racks (max. four racks), the ASM
475 can be plugged in and operated in each rack. This means that with the maximum
configuration of a SIMATIC S7-300, 32 ASM 475 modules can be operated.
A maximum of two SLGs (write/read devices) can be connected to the ASM 475. The
processing of the connected SLGs is parallel. FC45 allows simple programming using the
SIMATIC S7 tools.
FC45 can be used both in the S7-300 and S7-400.
With S7-400, the ASM 475 is connected via an ET 200M.
Note that the
IM 153-1 must have at least order number 6ES7 153-1AA03-0XB0 or 6ES7
153-1AA83-0XB0 and
IM 153-2 at least order number 6ES7 153-2AA02-0XB0 or 6ES7 153-2AB01-0XB0.
The following table provides an overview of I/O devices for use in the control cabinet:
The following table provides an overview of I/O devices for use without a control
cabinet:
See also
Documentation on ET 200L (http://support.automation.siemens.com/WW/view/de/1142908/0/
en)
Documentation on ET 200S (http://support.automation.siemens.com/WW/view/en/1144348)
Documentation on ET 200M (http://support.automation.siemens.com/WW/view/de/1142798/0/
en)
Documentation on ET 200pro (http://support.automation.siemens.com/WW/view/de/
21210852/0/en)
Documentation on ET 200iSP (http://support.automation.siemens.com/WW/view/de/
28930789/0/en)
Documentation on ET 200R (http://support.automation.siemens.com/WW/view/de/
11966255/0/en)
Introduction
Numerous HART field devices make available additional measured quantities (e.g. sensor
temperature). These can be read if they are set accordingly in the field device configuration.
Using the HART variables. it is possible to apply the set measured values directly from the
field device into the I/O area of your automation system.
Regardless of the number of configured channels, a maximum of 8 HART variables can be
assigned for HART modules and no more than 4 HART variables per channel. You assign the
HART variables to a channel in the properties for the module ("HART variable settings" area).
To do this, check the manual of the corresponding module.
Address assignment
By default, the HART modules occupy 16 input/output bytes (user data). If you configure HART
variables, the modules occupy an additional 5 bytes for each HART variable.
If you use all 8 HART variables, the HART input module occupies a total of 56 input/output
bytes (16 bytes + 8 x 5 bytes = 56 bytes).
The "None" configuration occupies no additional input bytes.
%\WHQ
%\WHQ
+$57YDULDEOH
%\WHQ
%\WHQ
%\WHQ 4XDOLW\FRGH
9DOXHLQ+(;IRUPDW
The quality code can accept different values depending on the module. To do this, check the
manual of the corresponding module.
See also
Documentation for HART analog modules (http://support.automation.siemens.com/WW/view/
en/22063748)
ET 200iSP
Definition
The ET 200iSP distributed I/O station is a highly modular and intrinsically safe DP slave with
degree of protection IP 30.
Area of application
The ET 200iSP distributed I/O station can be operated in potentially explosive atmospheres
characterized by gas and dust:
The ET 200iSP distributed I/O station can, of course, also be used in the safety area.
You can insert almost any combination of ET 200iSP I/O modules directly next to the interface
module that transfers the data to the DP master. This means you can adapt the configuration
to suit your on-site requirements.
Every ET 200iSP consists of a power supply module, an interface module and a maximum of
32 electronic modules (for example digital electronics modules). Remember not to exceed the
maximum current consumption.
DP master
All ET 200iSP modules support communication with DP masters that are compliant with
IEC 61784-1:2002 Ed1 CP 3/1 and operate with "DP" transmission protocol (DP stands for
distributed peripherals or distributed I/O).
See also
Documentation on ET 200iSP (http://support.automation.siemens.com/WW/view/de/
28930789/0/en)
Properties
Analog electronic modules 4 AI I 2WIRE/HART, 4 AI I 4WIRE/ HART and 4 AO I HART support
up to four IEEE tags.
The process input image (PII) provides up to 20 bytes per module for the IEEE tags. Thus,
four blocks of 5 bytes each are available for the four IEEE tags within the PII.
Requirements
The HART field device must support the assigned number of IEEE tags.
IL[HGDVVLJQPHQWRIDQDORJYDOXHVLQWKH3,,
DQ\DVVLJQPHQWRI,(((YDULDEOHVLQWKH3,,
3,,RID+$57LQSXW
PRGXOHZLWKFRQILJXUD
WLRQ: HJ+$57
LQSXWPRGXOH
,%[
$QDORJ
,%[ YDOXH
,%[ $QDORJ
,%[ YDOXH
,%[ $QDORJ
,%[ YDOXH +$57ILHOGGHYLFHRQFKDQQHO
,%[ $QDORJ $QDORJYDOXHFRUUHVSRQGVWR+9
,%[ YDOXH ,(((YDULDEOH+9
6HFRQGDU\YDOXH ,(((YDULDEOH
,%[ ,(((YDULDEOH
,%[ ,((( ,(((YDULDEOH
,%[ YDULDEOH
IURP +$57ILHOGGHYLFHRQFKDQQHO
,%[ FKDQQHO
,%[ $QDORJYDOXHFRUUHVSRQGVWR+9
,(((YDULDEOH+9
6HFRQGDU\YDOXH
,%[ ,(((YDULDEOH
,%[ ,((( ,(((YDULDEOH
,%[ YDULDEOH ,(((YDULDEOH
IURP
,%[
FKDQQHO
,%[ +$57ILHOGGHYLFHRQFKDQQHO
$QDORJYDOXHFRUUHVSRQGVWR+9
6HFRQGDU\YDOXH
,(((YDULDEOH+9
,%[
,((( ,(((YDULDEOH
,%[
YDULDEOH ,(((YDULDEOH
,%[
IURP ,(((YDULDEOH
,%[ FKDQQHO
,%[
+$57ILHOGGHYLFHRQFKDQQHO
6HFRQGDU\YDOXH $QDORJYDOXHFRUUHVSRQGVWR+9
,%[ ,(((YDULDEOH+9
,%[ ,(((
YDULDEOH ,(((YDULDEOH
,%[ ,(((YDULDEOH
IURP
,%[ FKDQQHO ,(((YDULDEOH
,%[
+9 PDLQYDULDEOH
See also
Documentation on ET 200iSP (http://support.automation.siemens.com/WW/view/de/
28930789/0/en)
See also
Documentation on ET 200iSP (http://support.automation.siemens.com/WW/view/de/
28930789/0/en)
Properties
Time stamping is possible with the IM 152 in customer applications using FB 62 (FB
TIMESTMP).
Principle of operation
A modified input signal is assigned a time stamp and stored in a buffer (data record). If time
stamped signals exists or a data record is full, a hardware interrupt is generated to the DP
master. The buffer is evaluated with "Read data record". Special messages are generated for
events that influence the time stamping (communication with the DP master interrupted, frame
failure of time master, ...).
Parameter Assignment
With the parameter assignment you define which IM 152 user data will be monitored. For the
time stamping these are digital inputs that are monitoring for signal changes.
Counting
Count properties
Counting functions
The 8 DI NAMUR electronics module has configurable counting functions:
2 x 16-bit up counters (standard counting function) or
2 x 16-bit down counters (standard counting function) or
1 x 32-bit down counter (cascading counter function)
Setting a setpoint with the PIQ
GATE function
You can configure the control signals of the counters:
Configuration channel 0..1: "Counter", channel 2..7: "DI": Two counters are configured.
The control signals of the counters are stored in the PIQ (process image output).
Configuration channel 0..1: "Counter", channel 2..7: "Control": Two counters are
configured. The control signals of the counters are stored in the PIQ (process image
output). They are also controlled by the digital inputs of the 8 DI NAMUR.
See also
Principle of operation (Page 1253)
Configuring counters (Page 1256)
Assigning parameters to counters (Page 1258)
Principle of operation
With each count pulse at the digital input, the count is incremented by 1. Once the count limit
is reached, the counter is reset to 0 and it counts up again from this value.
If there is counter overflow, the corresponding output is set in the PII.
A positive edge of the Reset output control signal resets the output in the PII. This does not
affect the current count value.
In 16-bit up counting operations, the system does not set any outputs in the PIQ. These are
always reset.
The positive edge of the Reset counter control signal sets the counter to 0 and resets the set
counter output.
The GATE control signal pauses the counting on a positive edge. Count pulses are processed
at the digital input again, but only at the negative edge. The Reset counter control signal is
also effective when GATE is active.
$FWXDOYDOXHRIWKHFRXQWHU
&RXQWLQJOLPLW
7LPH
&RXQWHURXWSXWLQ
3,,
7LPH
&RQWUROVLJQDO5HVHW
RXWSXW
7LPH
&RQWUROVLJQDO5HVHW
FRXQWHU
7LPH
&RQWUROVLJQDO
*$7(
7LPH
3XOVHVDWGLJLWDO
LQSXW
7LPH
The GATE control signal pauses the counting on a positive edge. At the same time, the
assigned output in the PII is reset. Count pulses are processed at the digital input again, but
only at the negative edge. The Reset output and Reset counter control signals are also effective
when GATE is active.
The setpoint of the counter is set and changed using the PIQ. The setpoint is adopted on a
positive edge of the Reset counter control signal or when the counter has reached zero.
$FWXDOYDOXHRIWKH
FRXQWHU
6SHFLILHGYDOXH
&RXQWHURXWSXW 7LPH
LQ3,,
7LPH
&RQWUROVLJQDO
5HVHWRXWSXW
7LPH
&RQWUROVLJQDO
5HVHWFRXQWHU
7LPH
&RQWUROVLJQDO
*$7(
7LPH
3XOVHVDW
GLJLWDOLQSXW
7LPH
See also
Count properties (Page 1253)
Configuring counters
Procedure
1. Using the mouse, pull module 8 DI Namur from the hardware catalog into distributed I/O
station ET 200iSP.
2. Select the required configuration (channel 0..1: "Counter", channel 2..7: "DI" or "Control").
In the module properties (inspector window), you can find this setting under "Parameters
> Inputs > Configuration".
Table 10-91 Assignment of digital inputs for channel 0..1: "Counter", channel 2..7: "DI":
(%[
&RXQWHURXWSXW
&RXQWHURXWSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
6IRUPDW
(%[
(%[ 1RWDVVLJQHG
9DOXHVWDWXVIRUFKDQQHOVWR
%,QSXWVLJQDOLVYDOLG
%,QSXWVLJQDOLVLQYDOLG
$%[
1RWDVVLJQHG
1RWDVVLJQHG
&RQWUROVLJQDO*$7(
&RQWUROVLJQDO*$7(
&RQWUROVLJQDO5HVHWFRXQWHU
&RQWUROVLJQDO5HVHWFRXQWHU
&RQWUROVLJQDO5HVHWFRXQWHURXWSXW
&RQWUROVLJQDO5HVHWFRXQWHURXWSXW
See also
Count properties (Page 1253)
See also
Count properties (Page 1253)
Frequency measurement
Properties
The electronic module 8 DI NAMUR allows the frequencies to be measured on channel 0 and
1:
2 frequency meters from 1 Hz to 5 kHz
Configurable metering window (GATE)
The signals of the frequency meter are read in by means of the digital inputs of the electronic
module.
See also
Principle of operation (Page 1259)
Configuring frequency meters (Page 1260)
Assigning parameters for the frequency meters (Page 1262)
Principle of operation
Frequency measurement
The signal frequencies are identified from the input signals of channel 0 or 1 of the electronic
module. To calculate the frequency the signals are measured within a configurable gate.
The frequency is displayed as 16-bit value in fixed-point format and transferred to the PII.
The frequency meter calculates the frequency according to the follow formula:
1XPEHURIULVLQJHGJHVDWGLJLWDOLQSXW
)UHTXHQF\>+]@
0HDVXULQJZLQGRZ>V@
See also
Frequency measurement properties (Page 1259)
Procedure
1. Using the mouse, pull module 8 DI Namur from the hardware catalog into distributed I/O
station ET 200iSP.
2. Select the required configuration (channel 0..1: "Trace", channel 2..7: "DI"). In the module
properties (inspector window), you can find this setting under "Parameters > Inputs >
Configuration".
Assignment of process image input (PII) for configuration of channel 0..1: "Trace", channel
2..7: "DI"
(%[
1RWDVVLJQHG
1RWDVVLJQHG
'LJLWDOLQSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
'LJLWDOLQSXW
6IRUPDW
(%[
(%[ 1RWDVVLJQHG
9DOXHVWDWXVIRUFKDQQHOVWR
%,QSXWVLJQDOLVYDOLG
%,QSXWVLJQDOLVLQYDOLG
Assignment of the process image output (PIQ): The PIQ is not assigned.
See also
Frequency measurement properties (Page 1259)
See also
Frequency measurement properties (Page 1259)
ET 200eco PN
Definition
The ET 200eco PN distributed I/O device is a compact PROFINET IO device in degree of
protection IP 65/66 or IP 67 and UL Enclosure Type 4x, Indoor use only.
Field of application
The fields of application of the ET 200eco PN are derived from its special properties.
A robust design and degree of protection IP 65/66 or IP 67 make the ET 200eco PN
distributed I/O device suitable in particular for use in rugged industrial environments.
The compact design of the ET 200eco PN is particularly favorable for applications in
confined areas.
The easy handling of ET 200eco PN facilitates efficient commissioning and maintenance.
Properties
The ET 200eco PN has the following properties:
Integrated switch with 2 ports
Supported Ethernet services:
ping
arp
Network diagnostics (SNMP)
LLDP
Interrupts
Diagnostics interrupts
Maintenance interrupts
Port diagnostics
Isochronous real-time communication
Prioritized startup
Device replacement without programming device
Media redundancy
Connection to intelligent sensors/actuators via IO link master interface module.
IO Controller
The ET 200eco PN can communicate with all IO Controllers that conform to IEC 61158.
ET 200eco PN can be configured on a CPU with advanced diagnostics.
See also
Documentation on ET 200eco PN (http://support.automation.siemens.com/WW/view/en/
29999018)
Group diagnostics
You can generally enable and disable the diagnostics function of the device with this parameter.
The "Fault" and "Parameter assignment error" diagnostics functions are always independent
of the group diagnostics.
Temperature unit
Specify the unit of the temperature measurement here.
Measuring range
With this parameter, you set the measuring range of the selected measurement type.
Smoothing
Smoothing of the analog values produces a stable analog signal for further processing. The
smoothing of analog values is useful when handling wanted signals (measured values) with a
slow rate of change, for example, temperature measurements.
The measured values are smoothed by digital filtering. To achieve smoothing, the device
generates a mean value from a specified number of converted (digitized) analog values.
You assign a maximum of four levels for the smoothing (none, weak, medium, strong). The
level determines the number of module cycles, from which the mean value is generated.
The stronger the smoothing, the more stable the smoothed analog value and the longer it takes
until the smoothed analog value is applied following a signal change (see the example below).
The figure below shows the number of cycles a module requires to apply the smoothed analog
value at almost 100% after a step response, based on the smoothing function settings. The
figure applies to all signal changes at the analog input. The smoothing value defines the
number of cycles a module requires to reach 63% of the end value of the changed signal.
6LJQDO
FKDQJH
[ [ [
0RGXOHF\FOHV
Smoothing, weak
Smoothing, medium
Smoothing, strong
Observe the rules outlined below to handle a wire break in the 1 to 5 V and 4 to 20 mA
measuring ranges:
Diagnostics, underflow
If you enable this parameter, the Underflow diagnostics event is generated when the measured
value reaches the underflow range.
Diagnostics, overflow
If you enable this parameter, the Overflow diagnostics event is generated when the measured
value reaches the overflow range.
Group diagnostics
You can generally enable and disable the diagnostics function of the device with this parameter.
The "Fault" and "Parameter assignment error" diagnostics functions are always independent
of the group diagnostics.
Type of output
With this parameter, you set the output type, for example, voltage. For any unused channels,
select the disabled setting. For a disabled channel, the conversion time and integration time
of the channel = 0 s, and the cycle time is optimized.
Output range
With this parameter, you set the output range of the selected output type.
Diagnostics, overload
If you enable this parameter, the diagnostics event is generated in the event of an overload.
Substitute values
With this parameter, you enter a substitute value that the module is to output in CPU-STOP
mode. The substitute value must be in the nominal range, overrange, or underrange.
ET 200SP
Definition
The ET 200SP distributed I/O system is a scalable, highly flexible distributed I/O system for
connection of process signals to a central controller via a field bus.
Application area
The ET 200SP is a multi-functional distributed I/O system for various fields of application. The
scalable design allows you to configure the system exactly to the specific requirements on
location.
The ET 200SP is approved for degree of protection IP 20 and for installation in a control cabinet.
Structure
The ET 200SP is mounted on a mounting rail and comprises:
An interface module which can communicate with all IO controllers that conform to the
PROFINET standard IEC 61158
Up to 32 I/O modules which can be inserted on passive BaseUnits in any combination
A server module that completes the design of the ET 200SP.
Introduction
The ET 200SP is a distributed I/O system for installation in a control cabinet.
The system can be expanded with modules of the ET 200AL series with IP65/67 degree of
protection. ET 200AL modules can be mounted on site, for example on a machine.
The following section describes how you expand an ET 200SP station with ET 200AL modules
in STEP 7.
Procedure
Follow the steps below to configure an ET 200SP with ET 200AL modules:
1. Drag an interface module (PROFINET or PROFIBUS) from the ET 200SP series to the
network view.
2. Go to the device view. You do this by clicking twice on the icon of the module you have just
inserted.
3. Insert the module "BA Send 1xFC" into slot 1 of the ET 200SP.
STEP 7 now generates an ET-Connection rack with 16 slots for ET 200AL modules (figure
below).
An ET-Connection rack is a virtual rack that sets the order of the connected ET 200AL
modules.
Question marks are displayed above the slots as an ET 200AL module has yet to be
connected to BA-Send.
4. From the hardware catalog (subfolder ET 200AL in the ET 200SP folder), select the first
ET 200AL module to be connected to the ET 200SP: Drag this module to the 1st slot in the
ET-Connection rack.
From this module, STEP 7 generates a line to the "BA-Send 1xFC" module and allocates
the slot numbers 66 to 81 (figure below).
If you configure the ET 200SP with a DP interface module, STEP 7 assigns the slot numbers
34 to 49 for the ET 200AL modules.
5. Now drag all other ET 200AL modules into the free slots in the ET-Connection rack.
STEP 7 automatically inserts the ET-Connection between the individual ET 200AL modules
(green loops).
In the configuration below, five ET 200AL modules are connected in series.
6. Complete the configuration of the ET 200SP: Drag all ET 200SP modules from the hardware
catalog to the slots in the ET 200SP.
Five ET 200SP modules are plugged in the configuration example below: The PN interface
module in slot 0, the module "BA-Send 1xFC" in slot 1, one input module each in slots 2
and 3, and a server module in slot 4:
Rules
The module "BA-Send 1xFC" must be plugged in slot 1 of the ET 200SP if the ET 200SP
is to be expanded with ET 200AL modules
The ET 200AL modules must be configured with no gaps.
See also
Configuration control with ET 200AL (Page 1316)
Status bytes
Status bytes
If you enable the "Status bytes" option, 4 bytes of input data are reserved for the status of the
supply voltage of each I/O module.
%\WH ,2PRGXOHVORWV
%\WH %LW /RDGYROWDJHPLVVLQJRU,2PRGXOHQRW
%\WH SUHVHQW
%\WH %LW /RDGYROWDJHDQG,2PRGXOHSUHVHQW
Note
An inserted or missing server module always reports for the slot bit = 0.
Requirements for the correct operation of the group diagnostics for missing supply voltage L+:
I/O modules or BU covers must be inserted on the light-colored and dark-colored BaseUnits.
If no I/O module is inserted on a light-colored BaseUnit, the start of this potential group will
not be detected by the interface module; the I/O modules of this potential group will thus
belong to the previous potential group. A supply voltage L+ group error will then be assigned
to the wrong potential group.
When an I/O module is inserted on the light-colored BaseUnit, the interface module detects
the new potential group, re-evaluates the status, and reports a new group diagnostics in
the case of an error.
The server module must be inserted.
The server module itself does not influence the missing supply voltage L+ group diagnostics.
Operating principle
Configuration control allows you to operate various real configurations (options) with a single
configuration of the distributed I/O device ET 200SP.
Configuration control provides you with the option of configuring the ET 200SP distributed I/
O device with its maximum configuration and nevertheless operating it with missing modules.
If missing modules are retrofitted later, no new configuration is required and the hardware
configuration does not have to be reloaded either.
Using control data record 196, which is transferred to the interface module in the user program,
you define a current preset configuration.
The configured module is not present on a slot.
A BU cover can be inserted in this slot instead of the configured I/O module. As there
is no configured module on the slot, the term "Configuration control with empty slots" is
also used.
The module that is configured to the right of the missing module can be inserted on this
slot instead of the configured module. The missing module makes the actual
configuration appear pushed together. As the configured module is missing but no gap
arises in the configuration, this is also referred to as a "Configuration without empty
slots".
The configuration is extended by an already configured module.
In the case of configuration control with empty spaces, you extend the configuration by
inserting the configured module on the corresponding empty slot.
In the case of configuration control without empty spaces, insert the configured module
on the right-hand side next to the last module of the ET 200SP.
Requirement
STEP 7 Professional version V13 SP1 or higher
The CPU startup parameter "Compare preset to actual configuration" is set to Startup even
if mismatch (default setting). This setting is also selected for the startup parameters of the
individual modules of the ET 200SP.
If you configure an ET 200SP in STEP 7 with more modules, the data block will be longer. The
data record for the maximum configuration with 65 modules is 134 bytes long (configuration
with PN interface module).
There are two bytes in the data record for each module.
The positions of these two bytes in the data record each code a module in the original
configuration with STEP 7:
"slot_1" and "info_slot_1" (bytes 4 and 5 in the data record, see figure below) correspond
to the module in slot 1 in configuration with STEP 7.
"slot_2" and "info_slot_2" (bytes 6 and 7) correspond to the module in slot 2 in configuration
with STEP 7.
"slot_3" and "info_slot_3" (bytes 8 and 9) correspond to the module in slot 3 in configuration
with STEP 7.
etc.
"slot_x" byte
The current slot is coded by the figure that is assigned to "slot_x" (by its value). Examples:
The value "1" in byte 4 means you are assigning the module originally inserted in slot 1 to
slot 1 in the current configuration (slot_1 = 1).
The value "2" in byte 4 means you are assigning the module originally inserted in slot 1 to
slot 2 in the current configuration (slot_1 = 2).
The value "3" in byte 4 means you are assigning the module originally inserted in slot 1 to
slot 3 in the current configuration (slot_1 = 3).
etc.
The value "1" in byte 6 means you are assigning the module originally inserted in slot 2 to
slot 1 in the current configuration (slot_2 = 1).
The value "2" in byte 6 means you are assigning the module originally inserted in slot 2 to
slot 2 in the current configuration (slot_2 = 2).
The value "3" in byte 6 means you are assigning the module originally inserted in slot 2 to
slot 3 in the current configuration (slot_2 = 3).
etc.
If a BU cover can be inserted instead of a module, code this by adding 128 to the slot (bit 7 of
the "slot_x" byte is set). Examples:
The value "129" in slot_1 means you are also assigning the module originally inserted in
slot 1 to slot 1 in the current configuration. A BU cover can also be used instead of this
module. In the real plant configuration, either the module or a BU cover is inserted.
The value "130" in slot_1 means you are assigning the module originally inserted in slot 1
to slot 2 in the current configuration. A BU cover can also be used instead of this module.
In the real plant configuration, either the module or a BU cover is inserted.
The value "131" in slot_1 means you are assigning the module originally inserted in slot 1
to slot 3 in the current configuration. A BU cover can also be used instead of this module.
In the real plant configuration, either the module or a BU cover is inserted.
"info_slot_x" byte
If a new potential group is opened with the module, assign the "info_slot_x" byte the value 1
(bit 0 of the byte is set). Examples:
The value "1" in the "info_slot_2" byte means that a new potential group is opened with
module 2.
The value "1" in the "info_slot_3" byte means that a new potential group is opened with
module 3.
The value "1" in the "info_slot_4" byte means that a new potential group is opened with
module 4.
Exception: A new potential group is automatically assigned to the first module in the original
configuration in STEP 7. This is not coded in the data record. You can enter any value in
"info_slot_1".
You can choose any name for the components of the control data record (for example "slot_1").
Example of control data record 196 for ET 200SP
The figure below shows control data record 196 for an ET 200SP with four modules.
The module inserted in slot 2 in the configuration in STEP 7 can also be inserted in slot 2 in
this configuration. It can also be inserted in slot 2 of a BU cover. Otherwise, nothing has
changed compared to the original configuration.
This readback data record allows you to check the real configuration of the ET 200SP (actual
configuration). The readback data record for each configured module specifies whether or not
it is actually available.
The value "1" means that the correct module is inserted in the correct slot.
The value "0" codes all other options (wrong module, empty slot, BU cover).
Configuration details:
The configuration of the data block corresponds to the original configuration of the ET 200SP
with STEP 7.
There are two bytes in the data record for each module. The position of these two bytes in the
data record corresponds to the position of a module in the original configuration with STEP 7.
Sequence of bytes:
"status_slot_1" and "reserve_1" (bytes 4 and 5 in the data record) correspond to the module
in slot 1 in the configuration,
"status_slot_2" and "reserve_2" (bytes 6 and 7) correspond to the module in slot 2 in the
configuration
"status_slot_3" and "reserve_3" (bytes 8 and 9) correspond to the module in slot 3 in the
configuration,
etc.
Example
The original configuration in STEP 7 has been changed by a control data record 196 (see
example above): In the modified configuration, module 2 can either be inserted in slot 2 or be
replaced by a BU cover.
The figure below shows readback data record 197 which ET 200SP outputs to indicate that
there is a module in slot 2: The "status_slot_2" byte has the value "1".
The other modules are also available and are inserted in the correct slots.
The figure below displays the readback data record 197 which ET 200SP outputs to indicate
that a BU cover is being used in slot 2: The "status_slot_2" byte has the value "0".
The other modules are available and are inserted in the correct slots.
See also
Configuration control with ET 200AL (Page 1316)
Configuration control for ET 200SP with integrated ET 200AL modules (Page 1278)
The following help text describes control data record 196 and the readback data record 197
for an ET 200SP expanded with ET 200AL modules.
8 slot_3 Real slot for SP mod The configured SP module 3 can 3. Slot for
ule 3 be inserted in any real slot from SP modules
Possible values: 2 to slot 65 (2 to 33 for a DP in Assignment
terface module). for the con
2 to 65
figured SP
(not 66 to 81, re
Slots 66 to 81 are for AL modules module 3 to
served for AL mod
(34 to 49 with DP interface mod a real slot
ules)
ule).
0 (if the configured
module 3 is not avail
able)
9 info_slot_3 1 The value "1" means that a new
potential group is opened with
this module.
.
: : : : :
132 slot_65 Real slot for SP mod The configured SP module 65 65. Slot for
ule 65 can be inserted in any real slot SP modules
Possible values: from 2 to slot 65 (2 to 33 for a DP Assignment
interface module). for the con
2 to 65
figured SP
(not 66 to 81, re
Slots 66 to 81 are for AL modules module 65
served for AL mod
(34 to 49 with DP interface mod to a real slot
ules)
ule)
0 (if the configured
module 65 is not
available)
133 info_slot_65 0 or 1 The value "1" means that a new
potential group is opened with
this module (the value is not eval
uated in this slot).
134 slot_66 Real slot for AL mod The configured AL module 1 can 1. Slot for
ule 1 be inserted in any slot from 66 to AL modules
Possible values: slot 81 (34 to 49 for PROFIBUS). Assignment
66 to 81 for the con
figured AL
(not 1 to 65, re
module 1 to
served for SP mod
a real slot
ules)
0 (if the configured
AL module 1 is not
available)
135 info_slot_66 - Reserve
: : : : :
164 slot_81 Real slot for AL mod The configured AL module 16 16. Slot for
ule 16 can be inserted in any slot from AL modules
Possible values: 66 to slot 81 (34 to 49 for DP in Assignment
terface module). for the con
66 to 81
figured AL
(not 1 to 65, re
module 16
served for SP mod
to a real slot
ules)
0 (if the configured
AL module 16 is not
available)
165 info_slot_81 - Reserve
Rules
If the "BA Send 1xFC" module is being used, it must be inserted in slot 1.
ET 200SP modules are inserted in slots 2 to 65 (slots 2 to 33 for DP interface module).
AL modules are inserted in slots 66 to 81 (slots 34 to 49 for DP interface module).
If you expand an ET 200SP with ET 200 AL modules, the 1st AL module is always coded
in bytes 134 and 135 of the control data record, the 2nd AL module in bytes 136 and 137,
etc., even if not all SP slots are to be assigned SP modules. Non-assigned SP slots are
coded with the value "0".
Error messages
The following error messages are returned if an error occurs when writing control data record
196:
There are two bytes in the data record for each module. The position of these two bytes in the
data record codes a module in the original configuration with STEP 7.
In the figure below:
The components "status_slot_1" and "reserve_1" (bytes 4 and 5 in the data record)
correspond to the module in slot 1 in the configuration with STEP 7,
"status_slot_2" and "reserve_slot_2" (bytes 6 and 7) correspond to the module in slot 2,
"status_slot_3" and "reserve_slot_3" (bytes 8 and 9) correspond to the module in slot 3,
etc.
The following data record is structured for configuration with 65 SP modules and 16 AL
modules. The value "166" therefore appears in the "block_length" element of the data record.
If you configure an ET 200SP in STEP 7 with fewer AL modules, the data block will be shorter.
If you use fewer SP modules in a configuration, this has no effect on the length of data record
197 (with an expansion of ET 200SP with ET 200AL modules).
The "reserve_x" component of readback data record 197 is reserved for future applications.
You can choose any name for the components of the readback data record (for example
"status_slot_1").
The figure below shows the start of readback data record 197 for reading the actual
configuration of an ET 200SP with AL modules.
The figure below shows part of readback data record 197 for reading the actual configuration
of an ET 200SP with AL modules (and PN interface module). ET 200SP modules are inserted
up to slot 65, and then the AL modules. For example, a value of "1" in the byte
"status_slot_66_AL" means that the 1st AL module is actually available in the plant and inserted
in the correct slot.
See also
Configuration control with ET 200SP (Page 1274)
Configuration control with ET 200AL (Page 1316)
0
/
Encoder supply
Short-circuit
Diagnostics short-circuit to L+
Enabling of the diagnostics if a short-circuit of the encoder supply to L+ occurs.
0
/
Encoder supply
Short-circuit
Operating mode
Determines whether a channel is enabled or disabled.
Setting Description
No reference channel operation Temperature value at channel 0 can be used as module-wide reference value
if the parameters of the other channels are assigned accordingly.
Reference channel of Group x The channel acts as sender for the reference junction temperature of Group x.
Distribution is performed via the interface module.
Setting Description
Reference channel of the module The corresponding TC channel uses the channel 0 of the same module as ref
erence junction temperature. This must be set as "Thermal resistor Pt 100 cli
matic range Celsius" and "No reference channel operation"; otherwise, refer
ence junction diagnostics is triggered.
Internal reference junction The reference junction temperature is read by an internal temperature sensor
on the BaseUnit. Reference junction diagnostics is triggered if there is a wrong
BaseUnit type.
Reference channel of Group x With the setting "TC" (thermocouple...), the channel acts as receiver for the
reference junction temperature of Group x.
Fixed reference temperature No temperature compensation occurs. The linearization is executed with an
assumed reference junction temperature of 0 C.
Overflow
Enabling of the diagnostics if the measured value exceeds the overflow range.
Underflow
Enabling of the diagnostics if the measured value falls below the underflow range.
Wire break
Enabling of the diagnostics if the module has no current flow or too low a current flow for the
measurement on the corresponding configured input.
Smoothing
The individual measurements are smoothed using digital filtering. The smoothing can be set
in 4 stages, whereby the smoothing factor k multiplied by the cycle time of the I/O module
corresponds to the time constant of the smoothing filter. The larger the smoothing, the larger
the time constant of the filter.
The following figure shows the step response for the various smoothing factors depending on
the number of module cycles.
6WHSUHVSRQVH
[ [ [ [
Below are some examples for the selection of the limits 1 and 2.
+LJKOLPLW /RZOLPLW
/RZOLPLW
See also
Special features of AI 4xRTD/TC 2-/3-/4-wire HF (Page 1300)
The channel configured in this way (thermal resistor measurement type) works as reference
channel of Group 1 and sends the measured temperature to all channels (thermocouple
measurement type) that are configured as receivers of Group 1.
In the next section, you will learn how to assign parameters for channels that are receivers of
Group 1.
The settings below are required for the channels of the module that compensate the
temperature of the reference junction using channel 0:
"Measurement type": "Thermocouple"
"Reference junction": "Reference channel of the module"
See also
Parameters of the analog input modules (Page 1289)
these events with the appropriate program blocks (for example, hardware interrupt or cyclic
interrupt organization blocks).
Isochronous mode
Isochronous mode refers to synchronous coupling
Of signal acquisition and output via the distributed I/O
Of signal transmission via PROFIBUS or PROFINET
Of program processing with the constant bus cycle time of the PROFIBUS or PROFINET.
The result is a system that acquires its input signals in constant time intervals, processes them
and outputs the output signals. Isochronous mode guarantees reproducible and defined
process reaction times as well as equidistant and synchronous signal processing with
distributed I/O.
The bus system and the I/O modules work synchronously with configured isochronous mode.
The transmitted input and output data are linked to an "isochronous task" in the CPU. As a
result, the data of a cycle are always consistent. All data of a process image belong together
logically and in time. Jitter in the user program caused by the acquisition of outdated values
is therefore almost impossible.
Even fast processes can be perfectly controlled by the exact timely reproducibility of all
processes. Isochronous mode thus contributes to high control quality and hence to greater
manufacturing precision. While possible fluctuations of the process reaction times are
drastically reduced. The time-assured processing can be utilized to improve machine cycle
times. Shorter cycle times increase the processing speed and help to lower production costs.
Oversampling
The use of the oversampling function in analog input or analog output modules requires an
isochronous configuration.
With analog input modules, the set send clock is divided into time-equidistant sub-cycles. The
send clocks can be subdivided into 2 to 16 sub-cycles. Each sub-cycle reads in a measured
value. The read-in measured values of a data cycle are copied to the interface module (IM) in
the next send clock and are then available to the processing CPU one clock later.
With analog output modules, the set send clock is also divided into time-equidistant sub-cycles.
The send clocks can be subdivided into 2 to 16 sub-cycles. Each sub-cycle returns an output
value. The output values are copied to the interface module by the CPU within the same send
clock and are written to the process one send clock later.
The read-in and output values are transmitted in the user data of the analog module. In this
way, the address space of the module is extended from 2 bytes of user data per channel to
16 x 2 bytes of user data per channel (with 16 sub-cycles). If you subdivide the send clock into
fewer than 16 sub-cycles, the unused addresses are assigned the error value 0x7FFF during
input. For output, the values of the unused addresses are ignored.
Because the sub-cycles have to be within a send clock, oversampling needs an additional
clock to copy the data to the interface module, unlike the 3-cycle model of isochronous mode.
The result is a 5-cycle model.
,VRFKURQRXVPRGH
&38
,0 &38 ,0
&\FOH 2%[
6XEF\FOHV
Send clock is divided into sub-cycles which record the measured value (in this case: 10 sub-
cycles)
Measured values are copied to the IM
Measured values are processed and output values determined
Output values are copied by the CPU to the IM
Output values are written to the process
Example
In practice, the use of oversampling makes sense when the isochronous system works with
only one specific send clock (for example, 1 ms) due to the modules used and when faster
sampling of the process values is required. By using oversampling and subdividing the send
clock into 4 sub-cycles, for example, you can sample the process values in intervals of 250 s.
Configuring oversampling
Enable the option "Isochronous mode" in the IO device used, and set the corresponding
parameters ("Send clock", etc.).
With the distributed analog input modules (e.g. AI 2xU/I 2,4-wire HS), you specify the number
of sub-cycles using the "Sampling rate" parameter.
With the distributed analog output modules (e.g. AQ 2xU/I HS), you specify the number of sub-
cycles using the "Sampling rate" parameter.
If, for example, you configure a "Sampling rate" of 4 "Values/cycle" for a send clock of 1 ms,
the send clock is subdivided into 4 sub-cycles and the process values are sampled at intervals
of 250 s.
Reference
You can find additional information in the manuals on the high-speed analog modules and in
the Analog value processing (http://support.automation.siemens.com/WW/view/en/67989094)
function manual.
(%[
6KRUWFLUFXLW
Notes on programming
Note
Only the bits 0+2 are relevant for the evaluation in the process image inputs. You can use
the bits 0+2 to monitor the temperature, for example, of a motor.
The bits 0+2 in the process image inputs have no latching function. When you are assigning
parameters, take into consideration that a motor, for example, starts up in a controlled
manner (via an acknowledgment).
Bits 0+2 can never be set simultaneously, but are instead set consecutively.
For safety reasons, always evaluate the diagnostic entries of the AI 4RTD/TC 2-/3-/4-
wire HF, as no measurement is possible if I/O modules are unplugged, if the supply voltage
of the I/O module has failed, or if there is a wire break or short circuit of the measuring lines.
Example
The following diagram shows the temperature variation and the associated switching points.
5>@
7>r&@
1RUPDO 3UHZDUQLQJ $GUHVVDEOHUDQJH 3UHZDUQLQJUDQJH 1RUPDO 6KRUW
UDQJH UDQJH UDQJH FLUFXLW
See also
Parameters of the analog input modules (Page 1289)
What you should know about the scalable measuring range (Page 1303)
Conductor resistor:
The "Conductor resistor" parameter in the parameter assignment above is enabled only if the
"Thermal resistor (2-wire terminal)" measurement type was selected.
Here, enter the value for the resistance of the connecting cable of the thermal resistor: A 200
m long copper cable with 0.5 mm2 wire cross-section, for example, has a resistance value of
seven ohms.
Measuring range resolution:
In the parameter assignment above, a resolution of 0.01 C was selected (measuring range
resolution "2 decimal places").
Measuring range center:
The measuring range center is set to 500 C.
With a resolution of 0.01 C, this results in a scalable measuring range from 174.88 C to
825.11 C.
At a resolution of 0.01 C, the scalable measuring range covers 650.23 C.
Maximum (scalable measuring range):
This value represents the high limit of the scalable measuring range. In the example above,
825.11 .
The value is calculated by STEP 7 (at a resolution of 0.001 C, the high limit is at 532.511 C,
see figure below).
Minimum (scalable measuring range):
This value represents the low limit of the scalable measuring range. In the example above,
174.88 .
The value is calculated by STEP 7 (at a resolution of 0.001 C, the low limit is at 467.488 C;
see figure below).
Higher resolution:
The following figure shows a parameter assignment with a resolution of 0.001 C (otherwise
the same example as in the figure above):
At a resolution of 0.001 C, the scalable measuring range is between 467.488 and 532.511 C
and covers 65.023 C (a tenth of the measuring range at a resolution of 0.01 C).
The standard measuring range is the basis for the scalable measuring range.
You can set the measuring range center within the nominal range (-200 C to 850 C, see table
above).
For temperatures below and above the set measuring range center, you then obtain measured
values with a higher resolution.
The width of this range around the measured value center depends on the selected resolution.
The maximum and minimum of the scalable measuring range depend on the selected
resolution:
2 decimal places, resolution of 0.01 :
The high limit is 325.11 C above the measuring range center you have set.
The low limit is 325.11 C below the measuring range center you have set.
This means that the scalable measuring range is 650.22 C around the measuring range
center.
3 decimal places, resolution of 0.001 :
The high limit is 32.511 above the measuring range center you have set.
The low limit is 32.511 below the measuring range center you have set.
This means that the scalable measuring range is 65.022 around the measuring range
center.
Bit Bit Bit Bit Bit Bit Bit Bit Bit Bit Bit Bit Bit Bit Bit Bit
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0
0HDVXULQJUDQJH
8QGHU 2YHU
8QGHUIORZ UDQJH 1RPLQDOUDQJH UDQJH 2YHUIORZ
8QGHUIORZ 2YHUIORZ
8QGHUIORZ 2YHUIORZ
Clipping
STEP 7 limits the maximum of the scalable measuring range so that the sum of the measured
value center and the maximum measured value that the module can return is not located in
the overflow of the standard measuring range. In the same way, STEP 7 restricts the minimum
of the scalable measuring range.
See also
Special features of AI 4xRTD/TC 2-/3-/4-wire HF (Page 1300)
ET 200AL
SIMATIC ET 200AL
The SIMATIC ET 200AL distributed I/O system is a scalable and highly flexible, distributed I/
O system for connecting process signals to a superordinate control with a field bus.
Properties
Connection to PROFINET, PROFIBUS or integration in ET 200SP
Up to 32 modules on an ET 200AL
Integration in ET 200SP: Up to 16 AT modules can be connected to an ET 200AL
Connection of modules via ET-Connection
Spatially separated mounting possible
Module widths of 30 and 45 millimeters
Degree of protection IP65/IP67
Suitable for temperatures from -25 to +55 C and accelerations up to 5 g.
Installation in all positions
Color coding of the cables and connections
CA-compliant labeling of the interfaces
PROFIenergy integrated
Configuration control
Connection of sensors and actuators using M8 and M12 connection system
Area of application
The SIMATIC ET 200AL distributed I/O system is especially well suited for use in tight spaces,
moving applications and for assembly and handling technique. Thanks to its scalable
construction, you have the option precisely customize its configuration to your on site needs.
The SIMATIC ET 200AL distributed I/O system features protection type IP65/IP67 and is suited
for distributed use on a machine or assembly line.
Structure
The SIMATIC ET 200AL distributed I/O system is made up of the following components:
Interface modules (PROFINET/PROFIBUS)
Digital and analog I/O modules
Communications module
After an interface module you can configure 2 lines (ET-Connection), each with 16 modules.
Alternatively, you can configure a line with 16 I/O modules on the SIMATIC ET 200SP
distributed I/O system with BaseUnit BU-Send and the BusAdapter BA-Send 1xFC.
The ETConnection backplane bus is designed as a cable. This allows you to create spatial
distances of up to 10 m between the modules.
Configuration example
The figure below shows a configuration example of the SIMATIC ET 200AL distributed I/O
system with a PROFINET interface module.
Configuring ET 200AL
Introduction
ET 200AL is a distributed I/O system with an IP65/67 degree of protection. It is therefore
designed for use on site, for example right beside a machine (no control cabinet required).
The system includes interface and communications modules as well as input and output
modules.
Procedure
Follow the steps below to configure an ET 200AL in STEP 7:
1. Copy an interface module (PROFINET or PROFIBUS) from the ET 200SP series to the
network view (drag-and-drop operation from the hardware catalog).
2. Go to the device view. Double-click on the interface module you have just inserted.
The interface module and two ET-Connection racks are displayed in the device view (figure
below).
There are no slot numbers assigned yet, which is why question marks are displayed above
the slots.
3. Now select the modules (input, output and communication modules) from the hardware
catalog (ET 200AL folder) and drag them to the free slots (outlined in blue; not shown).
You can place up to 16 ET 200AL modules in each ET-Connection rack (figure below).
An ET-Connection rack is a virtual rack that sets the order of the connected ET 200AL
modules.
5. Double-click on a module to access the module properties and set the module parameters.
Rules
The ET 200AL modules must be configured with no gaps.
The first module in an ET-Connection rack must be connected to the interface module.
See also
ET 200AL distributed I/O system (Page 1309)
Operating principle
With configuration control, you can change the original configuration of an ET 200AL (created
by configuring with STEP 7) with a user program and operate the ET 200AL in this modified
configuration. STEP 7 is no longer required for this configuration: You use your user program
to signal to the ET 200AL the slot in which a configured module is actually inserted.
You use control data record 196 for this. In this data record, you code which modules are
missing or located in different slots in the real configuration compared to the configuration with
STEP 7. The configuration control has no effect on the parameter assignment of the modules
(for example, the enabling of diagnostic alarms).
You then call the "WRREC" instruction and use it to write the data record to the interface
module of the ET 200AL.
Configuration control gives you the flexibility to vary the configuration of an ET 200AL as long
as the real configuration can be derived from a preset maximum configuration (originally
created with STEP 7).
The following sections describe how to enable configuration control and how to structure the
required data record 196 for the ET 200AL.
Requirement
STEP 7 Professional version V13 SP1 or higher
The CPU startup parameter "Compare preset to actual configuration" is set to Startup even
if mismatch (default setting). This setting is also selected for the startup parameters of the
individual modules of the ET 200AL.
There are two bytes in the data record for each module. The position of these two bytes in the
data record codes a module in the original configuration with STEP 7.
Bytes 4 and 5 in the data record correspond to the module in slot 1 in the original
configuration.
Bytes 6 and 7 in the data record correspond to the module in slot 2 in the original
configuration.
Bytes 8 and 9 in the data record correspond to the module in slot 3 in the original
configuration.
etc.
The current (real) slot is coded by the number that is assigned to the "Slot_x" byte (by its value):
Examples:
The value "2" in byte 6 means you are assigning the module originally inserted in slot 2 to
slot 2 in the current configuration.
The value "3" in byte 6 means you are assigning the module originally inserted in slot 2 to
slot 3 in the current configuration.
The value "4" in byte 6 means you are assigning the module originally inserted in slot 2 to
slot 4 in the current configuration.
etc.
The components of control data record 196 (definition in section "Control data record 196"
below):
block_length: Note the length of the control data record here; in the example: 42 (bytes).
The length of the control data block is calculated using the following formula: 2 x "number
of modules" + 4.
block_ID: Enter the figure 196 here. This number identifies the data record as the data
record for configuration control.
version: The ET 200AL uses version 2 of control data record 196.
subversion: The ET 200AL uses subversion 1 of control data record 196.
slot_1: The ET-Connection 1 submodule is always inserted in slot 1 of the ET 200AL.
reserve_1: This byte is not used (value "0").
slot_2: The configured module 2 is inserted in slot 2 (value "2").
reserve_2: This byte is not used (value "0").
slot_3: The configured module 3 is not present in the current configuration (value "0").
reserve_3: This byte is not used (value "0").
slot_4: The configured module 4 is inserted in slot 3 in the current configuration (value "3").
reserve_4: This byte is not used (value "0").
slot_5: The configured module 5 is inserted in slot 4 in the current configuration (value "4").
reserve_5: This byte is not used (value "0").
slot_6: The configured module 6 is not present in the current configuration (value "0").
reserve_6: This byte is not used (value "0").
slot_7: The configured module 7 is not present in the current configuration (value "0").
reserve_7: This byte is not used (value "0").
etc.
slot_18: The ET-Connection 2 submodule is always inserted in slot 18 of the ET 200AL
(value "18").
reserve_18: This byte is not used (value "0").
slot_19: The configured module 19 is inserted in slot 19 in the current configuration (value
"19").
reserve_19: This byte is not used. (value "0")
(Bytes 4 Configured Real slot of module x The configured module x can be Assignment
to 70, module x Possible values: inserted in any real slot from 2 to for config
not byte slot 34. Slot 18 is reserved for ET- ured mod
2 up to the number of
39) Con 2 (bytes 39 and 40 in the ule x to a re
modules (except 18)
control data record) al slot y
0 (if there is no config
ured module x)
(Bytes 5 Reserve 0 Not used
to 71, for configured
not byte module x
40)
Rules
The ET-Connection 1 and ET-Connection 2 submodules must be treated like real modules
in configuration control. Restriction: ET-Connection 1 is always placed in slot 1 and
ETConnection 2 is always placed in slot 18 (fixed assignment).
There are no reserve modules for the ET 200AL (unlike for the ET 200S or with BU cover
modules for the ET 200SP). For this reason, bit 7 of "slot_x" must not be set (i.e. only the
values 0 to 127 may be used).
The value "0" of "slot_x" indicates that this module is not inserted in the current
configuration.
Gaps must not be left between the AL modules when configuring with STEP 7.
If no modules are connected to ET-Con2 when STEP 7 is configured, ET-Con2 is not
configured: This shortens data record 196.
If fewer than 16 modules are connected to ET-Con1 during configuration with STEP 7 and
there are also modules connected to ET-Con2, control data record 196 must contain all
unassigned slots for ET-Con 1. They are assigned zero as the value for the real slot.
Error messages
The following error messages are returned if an error occurs when writing control data record
196:
Example
The following readback data record 197 is returned by the ET 200AL that was reconfigured
with control data record 196 in the example above (section "Creating control data record 196").
See also
ET 200AL distributed I/O system (Page 1309)
Expanding ET 200SP with ET 200AL modules (Page 1268)
Configuration control with ET 200SP (Page 1274)
ET 200MP
Definition
The ET 200MP distributed I/O system is a scalable and flexible distributed I/O system for
connection of process signals to a central controller via a field bus.
Application area
The ET 200MP is a multi-functional distributed I/O system for various fields of application. The
scalable design allows you to configure the system exactly to the specific requirements on
location.
The ET 200MP complies with IP 20 degree of protection and is intended for installation in a
control cabinet.
Structure
The ET 200MP is installed on a mounting rail and comprises:
An interface module that communicates with all IO controllers conforming to the PROFINET
standard IEC 61158
Up to 30 modules (power supply modules and I/O modules from the S7-1500 I/O range)
can be inserted to the right of the interface module.
If you insert a power supply module to the left of the interface module, this yields a possible
maximum configuration of 32 modules in total.
The number of insertable I/O modules is limited by their power requirements.
Slot rules
Slot 0: Power supply module (optional)
Slot 1: Interface module
Slot 2 to 31: I/O modules or power supply modules
In this case, insert a power supply unit (PS) on the left next to the interface module that supplies
the interface module and the modules to the right of the interface module.
Note
We recommend that you always supply the interface module on the front side with 24 V DC.
If a system power supply unit (PS) is inserted and connected additionally before or on the left
next to the interface module, both the power from the system power supply unit (PS) as well
as the power from the integrated power supply of the interface module are then available to
the configuration.
In this case, you do not have to change the default setting of the parameter.
Operating principle
Configuration control allows you to operate various real configurations (options) with a single
configuration of the ET 200MP distributed I/O device.
Configuration control provides you with the option of configuring the ET 200MP distributed I/
O device with its maximum configuration and still operating it with modules missing. If missing
modules are retrofitted later, no new configuration is required and the hardware configuration
does not have to be reloaded either.
Using control data record 196, which is transferred to the interface module in the user program,
you define a current configuration. You transfer the control data record with the instruction
WRREC.
Readback data record 197 is used to read the actual configuration of an ET 200MP.
Requirements
STEP 7 Professional version V13 SP1 or higher
The CPU startup parameter "Compare preset to actual configuration" is set to Startup even
if mismatch (default setting). This setting is also selected for the startup parameters of the
individual modules of the ET 200MP.
The data block is 36 bytes long (maximum configuration with 32 modules). The value "36"
therefore appears in the "block_length" element of the data record.
If you configure an ET 200MP in STEP 7 with fewer modules, the data block will be shorter: If
there are only five modules, for example, the data record is reduced to 9 bytes (4 bytes for the
header plus one byte for each module).
There is one byte in the data record for each module. The position of this byte in the data
record codes a module in the original configuration with STEP 7:
"slot_0 power supply" (byte 4 in the data record below) corresponds to the power supply
module in slot 0 in the configuration with STEP 7.
"slot_1 interface module" (byte 5 in the data record) corresponds to the interface module
in slot 1 in the configuration.
"slot_2" (byte 6 in the data record) corresponds to the module in slot 2 in the configuration.
"slot_3" (byte 7 in the data record) corresponds to the module in slot 3 in the configuration.
"slot_4" (byte 8) corresponds to the module in slot 4 in the configuration.
etc.
Value in slot_x
The current slot is coded by the figure that is assigned to "slot_x" (by its value). Examples:
The value "2" in slot_2 means you are assigning the module originally inserted in slot 2 to
slot 2 in the current configuration (slot_2 = 2).
The value "3" in slot_2 means you are assigning the module originally inserted in slot 2 to
slot 3 in the current configuration (slot_2 = 3).
The value "4" in slot_2 means you are assigning the module originally inserted in slot 2 to
slot 4 in the current configuration (slot_2 = 4).
etc.
Example for data record 196
The following data record was created for a configuration that changes the original
configuration with STEP 7.
The modified configuration has the following properties:
The module inserted in slot 0 in the configuration (power supply module) is also inserted
in slot 0 in the current configuration (specification).
The module inserted in slot 1 in the configuration (interface module) is also inserted in slot
1 in the current configuration (specification).
The module inserted in slot 2 in the configuration (module 2) is also inserted in slot 2 in the
current configuration.
The module inserted in slot 3 in the configuration (module 3) does not exist in the current
configuration.
The module inserted in slot 4 in the configuration (module 4) is inserted in slot 3 in the
current configuration.
The module inserted in slot 5 in the configuration (module 5) is inserted in slot 4 in the
current configuration.
etc.
The bytes "slot_6" to "slot_31" are not shown in the figure below.
Rules
If a module is not available in the current configuration, this is indicated by the value 255:
"slot_x" = 255
The power supply module is always in slot 0 ("slot_0 power supply" = 0).
The interface module is always in slot 1 ("slot_1 interface module" = 1).
If this module is also really in slot 3, this is coded by the value "1" (status_slot_4 = 1).
Configuration details:
The configuration of the data block corresponds to the original configuration of the ET 200MP
with STEP 7.
There is a byte in the data record for each module. The position of this bytes in the data record
corresponds to the position of a module in the original configuration with STEP 7.
Sequence of bytes:
"status_slot_0 power supply" (byte 4 in the data record below) corresponds to the power
supply module in slot 0 in the configuration with STEP 7.
"status_slot_1 interface module" (byte 5 in the data record) corresponds to the interface
module in slot 1 in the configuration.
"status_slot_2" (byte 6) corresponds to the module in slot 2 in the configuration.
"status_slot_3" (byte 7) corresponds to the module in slot 3 in the configuration.
etc.
You can choose any name for the components (for example "status_slot_2").
Meaning of "status_slot_x":
The value "1" in status_slot_x means that module x is in the correct slot.
The value "0" in status_slot_x codes all other options (wrong module, module does not
exist).
Example:
The figure below shows readback data record 197 for the configuration of an ET 200MP in
which there is no module 3 (the module in slot 3 in the configuration).
All other modules are available and correctly plugged.
The bytes "status_slot_6" to "status_slot_31" are not shown in the figure below.
See also
Documentation on configuration control (http://support.automation.siemens.com/WW/view/en/
67295970)
Wire break
Enabling of the diagnostics if the module has no current flow or the current is too weak for the
measurement at the corresponding configured input or the applied voltage is too low.
Overflow
Enabling of the diagnostics if the measured value exceeds the overrange.
Underflow
Enabling of the diagnostics if the measured value undershoots the underrange.
Temperature coefficient
The temperature coefficient depends on the chemical composition of the material. In Europe,
only one value is used per sensor type (default value).
The correction factor for the temperature coefficient ( value) specifies how much the
resistance of a certain material changes when the temperature is raised by 1 C.
The further values facilitate a sensor-specific setting of the temperature coefficient and
enhance accuracy.
Smoothing
The individual measured values are smoothed using filtering. Smoothing can be set in 4 stages
for the analog input modules AI 8xU/I/RTD/TC ST and AI 8xU/I HS.
Smoothing time = number of module cycles (k) x cycle time of the module.
The figure below shows the number of module cycles after which the smoothed analog value
is almost 100%, depending on the set smoothing. Is valid for each signal change at the analog
input.
6LJQDOFKDQJHLQ
SHUFHQWDJH
1
3
4
0RGXOHF\FOHV
N
None (k = 1)
Weak (k = 4)
Medium (k = 16)
Strong (k = 32)
Table 10-100 Possible parameter assignments for the reference junction parameter
Setting Description
Fixed reference temperature The reference junction temperature is configured and stored in the module as
a fixed value.
Dynamic reference temperature The reference junction temperature is transferred in the user program from the
CPU to the module by data records 192 to 199 using the WRREC (SFB 53)
instruction.
Internal reference junction The reference junction temperature is determined using an integrated sensor
of the module.
Reference channel of the module The reference junction temperature is determined using an external resistance
thermometer (RTD) at the reference channel (COMP) of the module.
Note
Fixed reference temperature
During parameter assignment of a thermocouple Type B, only the setting "Fixed reference
temperature" with a temperature of 0 C is possible.
Low limit 1 or 2
Specifies the low limit threshold that triggers hardware interrupt 1 or 2.
High limit 1 or 2
Specifies the high limit threshold that triggers hardware interrupt 1 or 2.
Introduction
You have several options of measuring the reference junction temperature in order to obtain
an absolute temperature value as a function of the temperature difference between the
reference junction and the measuring point.
You can use various compensation options depending on the required location of the reference
junction.
Note
During parameter assignment of a thermocouple Type B, only the setting "Fixed reference
temperature" with a temperature of 0 C is possible.
Dynamic reference tempera The temperature of the reference junction is deter You use multiple modules at the
ture mined via a module. This temperature value is reference junction and can therefore
transferred to other modules via a data record in compensate all channels using a
the user program. common temperature value.
Procedure You require only one resistance
Connect the resistance thermometer (RTD) for the thermometer (RTD) to acquire the
reference junction to any channel. temperature value.
The reference junction temperature is communica You can use inexpensive lines, e.g.,
ted from the CPU to the module by data records
copper lines, from the reference
192 to 199 using the WRREC instruction.
junction to the module.
Fixed reference temperature The reference junction temperature is stored in the You keep the reference junction
module as a fixed value. temperature constant and know the
Procedure temperature value.
Connect the thermocouple to the supply lines at the You can use inexpensive lines, e.g.,
reference junction, either directly or with compen copper lines, from the reference
sating lines. You connect the supply lines to the junction to the module.
appropriate terminals of the module.
When configuring the module, specify a fixed tem
perature value for the reference junction (e.g.
20 C).
Short-circuit to ground
Enabling of the diagnostics if a short-circuit of the actuator supply to ground occurs.
Wire break
Enabling diagnostics if the line to the encoder is interrupted.
Overflow
Enabling of the diagnostics if the measured value exceeds the overflow range.
Underflow
Enabling of the diagnostics if the measured value falls below the underflow range.
Substitute value
The substitute values are values that the outputs (the output) issue in the event of a CPU STOP.
ET 200M
Configuring an ET 200M
Introduction
For the ET 200M series, you can find a wide range of modules in the hardware catalog under
"Distributed I/O".
ET 200M configuration
Definition
The distributed IO device, ET 200M, is a modular DP slave with an IP 20 degree of protection.
The ET 200M has the configuration technology of the S7300 automation system and consists
of an IM 153x and I/O modules of the S7300.
ET 200M supports communication with:
all DP masters compliant with IEC 61784-1:2002 Ed1 CP 3/1
all IO controllers compliant with IEC 61158
1 2 3
Introduction
The ET 200M supports the "Replace modules during operation" function and the associated
pull/plug interrupt.
The "Replace modules during operation" function makes it possible for you to pull modules
from or plug modules into the ET 200M rack during operation.
Requirement
You have configured an interface module that supports replacing modules during operation.
(as of IM 153-1, article no. 153-1AA02-0XB0).
In addition, the configured CPU must also support the function, e.g. for PROFIBUS an S7-400
with DP interface.
You must use the active backplane bus (bus rail with slots) for the hardware configuration. The
conventional profile rail with bus connectors between the modules does not support this
function.
Configuring
If the configuration requirements have been met, the "Replace modules during operation"
parameter is available for selection in the inspector window's "Module parameters" area. Below
this parameter, a table for the configured modules is displayed, which shows the required
active bus modules for the hardware configuration.
For a PROFIBUS configuration, the "Startup if preset configuration does not match actual
configuration" option is displayed. This option is automatically enabled if "Replace modules
during operation" is enabled.
Fundamentals
Introduction
Signal modules for the process automation are S7-300 models, such as SM 321; DI
16xNAMUR or SM 322; DO 16x24VDC/0.5A.
They are being operated in a DP slave (IM 153-2).
Unlike standard modules, they offer the following additional technical functions, such as pulse
extension and chatter monitoring.
See also
Changeover contact (Page 1337)
Technological parameters (Page 1338)
Changeover contact
Changeover contact
A changeover contact is an auxiliary switch with only one moving switch element with one
close setting each for closed and open switching device.
See also
Documentation on modules for process automation (http://support.automation.siemens.com/
WW/view/de/7215812/0/en)
Technological parameters
this is signaled as a flutter error. If no flutter error is detected during the monitoring window
time, the monitoring window can be restarted at the next signal change.
Note
If you set pulse extension for an input channel, this also affects the flutter monitoring enabled
for this channel. The "extended pulse" signal is the input signal for the flutter monitoring. You
should therefore make sure that the values set for pulse extension and flutter monitoring are
compatible with each other.
See also
Documentation on modules for process automation (http://support.automation.siemens.com/
WW/view/de/7215812/0/en)
IQ Sense module
Properties of 8 IQ-SENSE
Properties
The 8 IQ-SENSE module has the following properties:
Connection of sensors with IQ-SENSE, photoelectric proximity switches: for example,
reflex sensors, diffuse sensors, and laser sensors.
It can be used centrally in an S7-300 or distributed in an ET 200M.
You can connect up to 8 sensors to every module. Each sensor requires a two-wire cable.
Function reserve that can be assigned parameters.
Time functions, switching hysteresis, synchronous mode that can be assigned parameters
Sensitivity and distance values can be specified (IntelliTeach using the "IQ-SENSE Opto"
FB)
Teach-in
Sensors can be removed and inserted during operation (automatic reassignment of
parameters)
Anti-interference group
Only for optical IQ Sense devices (IQ profile ID 1).
For IQ Sense devices with IQ profile ID 128 (ultrasound), see "Multiplex/synchronous mode"
under the channel-specific parameters.
Operating principle
The diagram below explains the functioning of the anti-interference group parameter:
6ORW
[,46HQVH
$QWLLQWHUIHUHQFH
QRQH JURXS
SDUDPHWHU
Mutual interference is only possible between the optical sensors of the modules in slot 5, 6, 7
and 9 because they are in the same anti-interference group 3 or "None" is set.
Note
Sensors in the same anti-interference group must be installed to maintain the minimum
clearance (see sensor package insert) and to prevent mutual interference.
Encoder type
This parameter is used to set the sensor type per channel:
Reflex sensor or
Diffuse sensor or
Disabled
Diffuse sensor
Reflex sensor
Switching hysteresis
Faults with the diffuse sensor or in the production process can result in signal wobbles. The
measured value then changes the switching threshold by 100 % (object detected - object not
detected). You can prevent this switching threshold wobble using the switching hysteresis
parameter. This will ensure a stable output signal on the sensor.
You can assigned parameters to 5 %/10 %/20 %/50 % for switching hysteresis.
Requirements
You can only set the switching hysteresis parameter for diffuse sensors with background
fadeout.
Operating principle
5HFHLYLQJOHYHO
6ZLWFKLQJ
WKUHVKROG
'LIIHUHQWLDOWUDYHO
7LPH W
6ZLWFKLQJRXWSXWRQVHQVRU
7LPH W
Operating principle
1RQH
GHIDXOW
5HVHWGHOD\HG 7 7
7 7
3LFNXSGHOD\HG
3LFNXSDQG 7 7 7
UHVHWWLQJGHOD\
0RPHQWDU\ 7 7 7
LPSXOVH
2EMHFWGHWHFWHG
6ZLWFKLQJVWDWH
RQVHQVRU
2EMHFWQRWGHWHFWHG
7 WLPHYDOXHSDUDPHWHU
Multiplex/synchronous mode
For the prevention of mutual influence between IQ Sense ultrasound devices in spatial
proximity (devices with IQ profile ID 128), use the "Multiplex/synchronous operation"
parameter.
Multiplex: The IQ Sense ultrasound sensors determine the process value (distance) one after
another, preventing them from affecting one another. The cycle time here is the sum of the
configured synchronous cycle times of the IQ Sense ultrasound sensors that are to be
multiplexed.
Synchronization: The IQ Sense ultrasound sensors determine the process value (distance) at
exactly the same time, preventing them from affecting one another. The cycle time here
corresponds to the greatest configured synchronous cycle time from among the IQ Sense
ultrasound sensors that are to be synchronized.
You can, for example, use synchronous operation for a curtain function in which several IQ
Sense ultrasound sensors aligned in parallel share a single extended detection area. The
sensors simultaneously emit an ultrasound impulse. When an object enters the detection area,
the sensor nearest to the object receives the echo most quickly. The object can therefore not
only be detected, it can be located as well.
AFI value
Using the AFI value (application series identifier, as defined in the ISO 15693-3 international
standard), transponders can be selected for different applications. Only transponders whose
AFI value coincides with the value set on the sensor are processed. If a transponder has the
AFI value "0", it can be identified and processed regardless of the AFI value of the sensor.
This parameter is only important if it is supported by the ident system, otherwise any value
(normally "0") may be assigned.
Transponder type
Depending on the type of the transponder, you must configure whether it is an ISO transponder
or a vendor-specific type.
For transponders in accordance with international standard ISO 15693, the value "1" should
be selected; for all other types "0" is set. Based on this setting, one of the two possible air
interface drivers is selected in the sensor.
This parameter is only important if it is supported by the ID system, otherwise any value
(normally "0") may be assigned.
ET 200S
Configuring an ET 200S
Introduction
For the ET 200S series, you can find a wide range of modules in the hardware catalog under
"Distributed I/O".
Assigning parameters
For information on configuration and parameter assignment, refer to "See also".
Frequency converters
Frequency converters
The frequency converter ICU24 and ICU24F ( as fail-safe version) are modular design
frequency converters that are completely embedded in the distributed I/O system ET 200S.
For parameterization of both modules, please see the following.
Message frame
The message frame number and the operating mode of the module are only displayed and
cannot be modified.
Application ID
You indicate the saved parameters in the frequency converter as a whole with the application
ID. Enter an application ID from the value range 0 to 65535. During startup (or pull/plug), this
ID is compared with the application ID stored on the converter.
Converters that work with identical applications are usually also identically parameterized and
should be identified with the same application ID. Converters with the same application ID may
be exchanged between each other. Copying of the complete parameterization of a converter
to another converter, for example, via an MMC, is only accepted, if both have the same
application ID.
Converters that work with different applications and are parameterized differently must be
identified by different application IDs. This prevents a converter with unsuitable
parameterization from starting on an incorrect slot, i.e. on the wrong application. This also
prevents the parameterization that is saved in the converter from being accidently overwritten
with any parameteriation that is stored on an MMC.
See also
Documentation for the frequency converter (http://support.automation.siemens.com/WW/view/
en/26291825/0/en)
ET 200pro
Operating principle
Through the configuration control, it is possible to change the original configuration of an ET
200pro (created by configuring with STEP 7) and to operate the ET 200pro in this modified
configuration. STEP 7 is no longer required for this configuration: You communicate to the ET
200pro the slot in which a configured module is actually inserted by means of your user
program.
You use control data record 196 for this. In this data record, you code which modules are
missing or located on different slots in the real configuration as compared to the preset
configuration. The configuration control has no effect on the parameter assignment of the
modules (for example, the enabling of diagnostic alarms).
You then call the "WRREC" instruction and use it to write the data record to the interface
module of the ET 200pro.
Configuration control gives you the flexibility to vary the configuration of an ET 200pro as long
as the real configuration can be derived from a preset maximum configuration (originally
created with STEP 7).
The following sections describe how to enable configuration control. They also outline how
control data record 196 and readback data record 197 are structured.
Requirements
STEP 7 Professional version V13 SP1 or higher
The CPU startup parameter "Compare preset to actual configuration" is set to Startup even
if mismatch (default setting). This setting is also selected for the startup parameters of the
individual modules of the ET 200pro.
The position of this byte in the data record codes one module in the original configuration with
STEP 7:
"slot_IM" (byte 4 in the data record, figure below) corresponds to the module in slot 1 in the
configuration
"slot_2" (byte 5) corresponds to the module in slot 2 in the configuration.
"slot_3" (byte 6) corresponds to the module in slot 3 in the configuration.
etc.
"slot_x" byte
The current slot is coded by the figure that is assigned to "slot_x" (by its value). Examples:
The value "2" in byte 5 means you are assigning the module originally inserted in slot 2 to
slot 2 in the current configuration (slot_2 = 2).
The value "3" in byte 5 means you are assigning the module originally inserted in slot 2 to
slot 3 in the current configuration (slot_2 = 3).
The value "4" in byte 5 means you are assigning the module originally inserted in slot 2 to
slot 4 in the current configuration (slot_2 = 4).
etc.
There are no reserve modules for the ET 200pro (unlike for the ET 200S or with BU cover
modules for the ET 200SP). For this reason, bit 7 of "slot_x" must not be set.
The value "0" in "slot_x" indicates that this module is not inserted in the current configuration.
5 Slot_2 Coding of the actual slot: Byte 5 indicates where the module origi
2 = Slot 2 nally configured with STEP 7 in slot 2 is
actually inserted in the current configura
3 = Slot 3
tion.
4 = Slot 4
etc.
6 Slot_3 Coding of the actual slot: Byte 6 indicates where the module origi
2 = Slot 2 nally configured with STEP 7 in slot 3 is
actually inserted in the current configura
3 = Slot 3
tion.
4 = Slot 4
etc.
Example: 0
Coding for missing mod
The module originally configured with
ule:
STEP 7 in slot 3 is not present in the cur
0 = No slot, module not rent configuration (value "0").
present
7 Slot_4 Coding of the actual slot: Byte 7 indicates where the module origi
2 = Slot 2 nally configured with STEP 7 in slot 4 is
actually inserted in the current configura
3 = Slot 3
tion.
4 = Slot 4
etc.
Example: 3
Coding for missing mod
The module originally configured with
ule:
STEP 7 in slot 4 is actually located in slot
0 = No slot, module not 3 in the current configuration (value "3").
present
: : : :
Error messages
The following error messages are returned if an error occurs when writing control data record
196:
The following example is for a configuration with 4 modules. The value "8" therefore appears
in the "block_length" element of the data record.
If you configure an ET 200pro in STEP 7 with fewer modules, the data block will be shorter.
You can choose any name for the components of the control data record (for example
"status_slot_2").
Meaning of "status_slot_x":
The value "1" in status_slot_x means that module x is inserted in the correct slot
The value "0" in status_slot_x codes all other options (wrong module, module does not
exist).
Example:
The figure below shows readback data record 197 for an ET 200pro with four modules.
There is no module 3 (this was assigned in control data record 196, see section "Example
of control data record 196" above)
The three other modules are actually inserted in the ET 200pro.
See also
Configuration control with ET 200SP (Page 1274)
Frequency converters
The frequency converters ET 200pro FC and ET 200pro F-FC (as fail-safe version) are
modularly design frequency converters that are completely embedded in the distributed I/O
system ET 200pro. The following section describes how to configure the two modules.
Message frame
The message frame number and the operating mode of the module are only displayed and
cannot be modified.
Application ID
You indicate the saved parameters in the frequency converter as a whole with the application
ID. Enter an application ID from the value range 0 to 65535. During startup (or pull/plug), this
ID is compared with the application ID stored on the converter.
Converters that work with identical applications are usually also identically configured and
should be identified with the same application ID. Converters with the same application ID may
be exchanged between each other. Copying of the complete configuration of a converter to
another converter, for example, via an MMC, is only applied, if both have the same application
ID.
Converters that work with different applications and are configured differently must be identified
by different application IDs. This prevents a converter with unsuitable configuration from
starting on an incorrect slot, in other words on the wrong application. This also prevents the
configuration that is saved in the converter from being accidently overwritten with any
configuration that is stored on an MMC.
IPv6 protocol
The Internet Protocol version 6 - called IPv6 below - extends the Internet Protocol version 4
(IPv4) that is used predominantly at the current time.
See also
IPv6 with the CP 1543-1 (Page 1353)
See also
Basics on task cards (Page 326)
Inspector window (Page 324)
Determination of which of the devices that are connected online are defective
If you originate the establishment of an online connection to a device which is not reachable
or reports one or more faults or is not in RUN mode, it will rank as defective.
See also
Displaying diagnostics status and comparison status using icons (Page 1356)
Network overview
The associated diagnostic icon is displayed for every hardware component.
To start the Online and Diagnostics view (if available), double-click the diagnostic icon.
For a hardware component with lower-level components, if there is a hardware error in
at least one lower-level component, the diagnostic icon appears as follows: The
hardware component's diagnostic icon has a pale appearance and the diagnostic icon
"Hardware error in lower-level component" is also shown in the lower right corner.
The following applies to modules or submodules of a shared device with an S7-1500
CPU: A diagnostic icon is displayed. It belongs to that part of the station that is assigned
to the CPU.
Topology view
The associated diagnostic icon is displayed for every device.
To start the Online and Diagnostics view (if available), double-click the diagnostic icon.
For a hardware component with lower-level components, if there is a hardware error in
at least one lower-level component, the diagnostic icon appears as follows: The
hardware component's diagnostic icon has a pale appearance and the diagnostic icon
"Hardware error in lower-level component" is also shown in the lower right corner.
The associated diagnostic icon is displayed for every port. The meaning of the individual
colors is described further below.
Each cable between two online ports is assigned the color associated with its diagnostics
status.
The color of the cable between two ports depends on the status of the individual ports:
Color of the first port Color of the second port Color of the connecting cable
light green light green light green
light green dark green dark green
green gray gray
green red red
gray red red
Project tree
The associated diagnostic icon is displayed behind every hardware component.
For a hardware component with lower-level components (e.g., distributed I/O, Slave_1),
if there is a hardware error in at least one lower-level component, the diagnostic icon
appears as follows: The hardware component's diagnostic icon has a pale appearance
and the diagnostic icon "Hardware error in lower-level component" is also shown in the
lower right corner.
For hardware components with their own operating state, the operating state icon is also
displayed in the top right corner of the diagnostic icon.
If forcing is active on a CPU, a red F is displayed at the left margin of the diagnostic icon.
The diagnostic icon "Hardware error in lower-level component" is displayed behind the
"Local modules" folder when there is a hardware error in at least one of the associated
modules.
The diagnostic icon "Hardware error in lower-level component" is displayed behind the
"Distributed I/O" folder when there is a hardware error in at least one of the associated
modules.
The diagnostic icon "Hardware error in lower-level component" is displayed behind the
project folder when the "Hardware error in lower-level component" diagnostic icon is
displayed behind at least one of the "Local modules" or "Distributed I/O" folders.
The following applies to modules or submodules of a shared device with an S7-1500
CPU: The associated diagnostic icon is displayed for modules assigned to the CPU
(modules that are not assigned are grayed out and do not receive a diagnostic icon).
The associated diagnostic icon is displayed for plug-in submodules of an assigned
module (submodules that are not pluggable are not visible and therefore do not receive
a diagnostic icon).
Note
If the diagnostic for a hardware component is "not reachable from the CPU", the diagnostic
icon "Hardware error in lower-level component" is not additionally shown.
Icon Meaning
The connection with a CPU is currently being established.
The configured CPU and the CPU actually present are of incompatible types.
Icon Meaning
Maintenance required
Maintenance demanded
Error
The module or the device cannot be reached from the CPU (valid for modules and
devices below a CPU).
No input or output data are available, because the (sub)module has blocked its input
or output channels.
Diagnostics data are not available because the current online configuration data
differ from the offline configuration data.
The configured module or device and the module or device actually present are
incompatible (valid for modules or devices under a CPU).
The configured module does not support display of the diagnostics status (valid for
modules under a CPU).
The connection is established, but the module status has not yet been determined
or is unknown.
The configured module does not support display of the diagnostics status.
Note
Some modules, for example, the FM 450-1, are only indicated as having a problem in the case
of an error if you have enabled the diagnostic interrupt when assigning the module property
parameters.
Icon Meaning
Hardware error in lower-level component: The online and offline versions differ (only
in the project tree) in at least one lower-level hardware component.
Software error in lower-level component: The online and offline versions differ (only
in the project tree) in at least one lower-level software component.
Online and offline versions of the object are different
Note
If both a comparison icon and the "Error in lower-level component" diagnostic icon are to be
displayed at the bottom right in the device view, the following rule applies: The diagnostic icon
for the lower-level hardware component has a higher priority than the comparison icon. This
means that a comparison icon is only displayed if the lower-level hardware components have
no errors.
Icon Meaning
Folder contains objects whose online and offline versions differ (only in the project
tree)
Object only exists online
STOP
STARTUP
HOLD
DEFECTIVE
The configured module does not support display of the operating state.
Note
If forcing is active on a CPU, a red F is displayed on a pink background at the bottom right of
the operating state icon.
Color Meaning
No fault or maintenance required
Offline
Maintenance demanded
no diagnostic capability
Requirement
The project with the module to be diagnosed is open.
Note
This requirement does not apply if you call the online and diagnostics view from the project
tree after you have identified the accessible devices.
Procedure
To start the online and diagnostics view of a module, follow these steps:
1. In the project tree, open the respective device folder.
2. Double click on "Online & Diagnostics".
Or:
1. In the project tree, select the respective device folder.
2. Select the "Online & Diagnostics" command in the shortcut menu or the "Online" main menu.
Or:
1. In the project tree, open the "Online access" folder.
2. Open the folder for the interface with which you want to establish the online connection.
3. Double click on "Show/Update accessible devices".
4. Select the module to be diagnosed.
5. Select the "Online & Diagnostics" command in the shortcut menu or the "Online" main menu.
Or:
1. In the project tree, open the "Local modules" folder.
2. Select the respective device or the module that is to be diagnosed.
3. Select the "Online & Diagnostics" command in the shortcut menu or the main menu.
Or:
1. Open the device view in the device configuration.
2. Select the module to be diagnosed.
3. Select the "Online & Diagnostics" command in the shortcut menu or the "Online" main menu.
Or:
1. Open the device view in the device configuration.
2. Establish an online connection to the module to be diagnosed.
3. Double-click on the diagnostics icon above the module.
Or:
1. Open the network view in the device configuration.
2. Select the station with the module to be diagnosed.
3. Select the "Online & Diagnostics" command in the shortcut menu or the "Online" main menu.
Or:
1. Open the topology view in the device configuration.
2. Establish an online connection to the module to be diagnosed.
3. In the topology view, double-click the diagnostic icon associated with the module.
Result
The online and diagnostics view of the module to be diagnosed will be started. If an online
connection to the associated CPU had previously been created, the header bar of the Online
and Diagnostics view will now have an orange background.
Note
If no online connection exists when the online and diagnostics view is started, no online
information is displayed and the display fields remain empty.
"Module" area
This area shows the following data of the module:
Short designation, for example, CPU 1214C DC/DC/DC
Article no.
Hardware
Firmware
Racks
Slot
Structure of the "Cycle time" group in the "Diagnostics" folder of the Online and Diagnostics view
The "Cycle time" group consists of the following areas:
Cycle time diagram (graphical display of the assigned and measured cycle times)
Cycle time configured (display of the assigned cycle times as absolute values)
Cycle times measured (display of the measured cycle times as absolute values)
Structure of the "Cycle time" pane of the "Online Tools" task card
The "Cycle time" pane displays the cycle time diagram and below it the measured cycle times
as absolute values.
Identifier Meaning
0 IP address is not initialized
1 By configuration (i.e., by the configuration loaded to the device from the device or
network view)
2 Via the "Assign IP address" group of the online and diagnostics view
Identifier Meaning
3 Via the DHCP server (i.e., the IP parameters are obtained by a special service from a
DHCP server (Dynamic Host Configuration Protocol) and assigned for a limited time)
4 IP address is set by a user program
5 Source of IP address unknown
IP setting time:
Time stamp of the last change to the IP address directly through the Ethernet connection
of the module
"Ports" area
This area shows the following data for the module:
Ethernet ports
Physical properties of the PROFINET interface
If you select a line in the port table, additional help information will be provided for the
corresponding port.
"Domain" area
This area is divided into the following subareas:
Sync domain
MRP domain
"Domain" area
This area is divided into the following subareas:
Sync domain
MRP domain
Displaying firmware
You can display the currently installed firmware of a module.
Requirements
The module supports a firmware update.
The module is connected online.
Procedure
To display the current firmware, follow these steps:
1. Open the module in the Online and Diagnostics view.
2. Select the "Firmware update" group in the "Functions" folder.
3. You read off the current firmware in the "Online data" area under "Firmware".
Structure of the "Cycle time" group in the "Diagnostics" folder of the Online and Diagnostics view
The "Cycle time" group consists of the following areas:
Cycle time diagram (graphical display of the assigned and measured cycle times)
Cycle time configured (display of the assigned cycle times as absolute values)
Cycle times measured (display of the measured cycle times as absolute values)
Structure of the "Cycle time" pane of the "Online Tools" task card
The "Cycle time" pane displays the cycle time diagram and below it the measured cycle times
as absolute values.
Longest cycle time: Duration of the longest cycle since the last transition from STOP to
RUN.
This corresponds to the dashed blue arrow on the right in the diagram.
A blue band extends between the two dashed lines; this band corresponds to the entire range
of the measured cycle times. If a measured cycle time is greater than the maximum cycle time,
the portion of the band that lies outside the assigned limits will be colored red.
Display area of the "CPU control panel" pane of the "Online Tools" task card
This area contains the following displays:
Station name and CPU type (short designation)
RUN / STOP (corresponds to the "RUN / STOP" LED of the CPU)
ERROR (corresponds to the "ERROR" LED on the CPU)
MAINT (corresponds to the "MAINT" LED on the CPU)
Display area of the "Memory" group in the "Diagnostics" folder of the online and diagnostics view
This area contains the current memory utilization of the associated module and details of the
individual memory areas.
The memory utilization is shown both as a bar diagram and as a numerical value (percentage).
The following memory utilizations are shown:
Load memory
If no memory card is inserted, the internal load memory is displayed.
If a memory card is inserted, the operating system only uses the inserted load memory as
the load memory. This is displayed here.
Work memory
Retentive memory
Display area of the "Memory" pane of the "Online Tools" task card
This area contains the current memory utilization of the associated module. The available
memory is shown both as a bar diagram and as a numerical value (percentage). The numerical
value is rounded to an integer value.
Note
If less than 1% of a memory area is utilized, the available portion of this memory area is shown
as "99%".
See also
Load memory (Page 1171)
Work memory (Page 1172)
Retentive memory areas (Page 1173)
Display area of the "Memory" group in the "Diagnostics" folder of the online and diagnostics view
This area contains the current memory utilization of the associated module and details of the
individual memory areas.
The memory utilization is shown both as a bar diagram and as a numerical value (percentage).
The following memory utilizations are shown:
Load memory
Note
The load memory is located on the SIMATIC memory card.
Display area of the "Memory" pane of the "Online Tools" task card
This area contains the current memory utilization of the associated module. The available
memory is shown both as a bar diagram and as a numerical value (percentage). The numerical
value is rounded to an integer value.
Note
If less than 1% of a memory area is utilized, the available portion of this memory area is shown
as "99%".
"Status" area
The following status information is displayed in this area:
Status of the module as viewed by the CPU, for example:
Module available and OK.
Module defective.
If the module experiences a fault and you have enabled the diagnostic error interrupt
during configuration, the "Module defective" status is displayed.
Module configured, but not available.
Example: Diagnostics data is not available because the current online configuration
differs from the offline configuration.
Detected differences between the configured and the inserted module. Provided it can be
ascertained, the article number will be displayed for the set and actual type.
The scope of the displayed information depends on the selected module.
Diagnostics buffer
The diagnostics buffer is used as a log file for the diagnostics events that occurred on the CPU
and the modules assigned to it. These are entered in the order of their occurrence, with the
latest event shown at the top.
"Events" area
The "Events" area consists of the following elements:
Check box "CPU time stamp takes into account local PG/PC time"
Event table
"Freeze display" or "Cancel freeze" button
Details of the event: Event no., event ID, description, time stamp, incoming/outgoing
information
"Help on event", "Open in editor", "Save as ..." buttons
Check box "CPU time stamp takes into account local PG/PC time"
If you have not activated the check box, the diagnostics buffer entries are shown with the
module time.
If you have activated the check box, the diagnostics buffer entries are shown with the time
given by the following formula:
Displayed time = module time + time zone offset on your programming device / PC
This requires the module time to be identical to UTC.
You should use this setting if you wish to see the times of the diagnostics buffer entries for the
module expressed in the local time of your programming device / PC.
Selecting or clearing the check box immediately changes the times displayed for the
diagnostics buffer entries.
Note
If you use the "WR_SYS_T" instruction in your program or if you set the real-time clock of the
CPU using an HMI device instead of using UTC, we recommend that you clear the "CPU time
stamp takes into account local PG/PC time" check box. In this case, the module time is the
sole time of concern.
Event table
The following information is displayed in the table for each diagnostics event:
Sequential number of the entry
The first entry contains the latest event.
Date and time of the diagnostics event
If no date and time are shown, the module has no integral clock.
Short name of the event and, if applicable, the reaction of the CPU
Note
If an individual parameter of a text cannot be determined, the character string "###" is shown
in its place.
If no display text is yet available for new modules or new events, the numbers of the events
and the individual parameters are stated as hexadecimal values.
Icon Meaning
Incoming event
Outgoing event
Only for S7-1200 and S7-1500 CPUs: Icon for the severity of the event
The following table shows the available icons and their respective meaning.
Icon Meaning
No maintenance and/or no fault
Maintenance required
Maintenance demanded
Error
You can change the order of the columns, adjust the column widths and remove and add
individual columns in the event table. In addition, you can sort as follows: by sequential number,
by "Date and time" and by "Event".
The following happens when you click the "Freeze display" button:
The current display of the diagnostics buffer entries is frozen.
The labeling of the button changes to "Cancel freeze".
If an error has occurred in your system, diagnostics events can occur very quickly in
succession. This produces a high update rate on the display. Freezing the display allows you
to calmly examine the situation in more detail.
If the display is frozen and you click the "Cancel freeze" button, the following happens:
The display of the diagnostics buffer entries is updated again.
The labeling of the button changes to "Freeze display".
Note
If you freeze the diagnostics buffer display, the CPU continues to enter events in the
diagnostics buffer.
Note
For a small number of events, the "Help on event" button is grayed out.
When is the "Open in editor" button enabled? What happens when you click this button?
If the diagnostics event references the relative address of a The "Open in editor" function opens the referenced block in
block. the offline view at the programming instruction that causes
This is the address of the command that caused the event. the error. This allows you to check and, if necessary, change
the source code of the block at the specified place and then
download it again to the CPU.
If the diagnostics event was triggered by a module. The "Open in editor" function opens the Device view of the
module involved.
"Settings" area
The "Settings" area consists of the following elements:
"Display events" list
"Apply settings as default" button
"Output event information in hexadecimal format" check box
See also
Basic information on the diagnostics buffer (Page 1398)
Purpose
In the event of servicing it may be possible that the SIEMENS Customer Support requires very
special information about the state of a module of your system for diagnostic purposes.
If such a case occurs in your system, you will be asked by Customer Support to save the
service data of the module and send the resulting file to them.
Requirement
There is an online connection to the CPU whose mode you want to change.
Procedure
To change the mode of the CPU, follow these steps:
1. Enable the "Online tools" task card of the CPU.
2. Click the "RUN" button in the "CPU control panel" pane if you want to change the CPU to
RUN mode or the "STOP" button if you want to change the CPU to STOP mode.
Note
The only button active is the one that can be selected in the current operating mode of the
CPU.
Result
The CPU will be switched to the required operating mode.
Requirement
There is an online connection to the CPU on which the memory reset is to be performed.
The CPU is in STOP mode.
Note
If the CPU is still in RUN mode and you start the memory reset, you can place it in STOP
mode after acknowledging a confirmation prompt.
Procedure
To perform a memory reset on a CPU, follow these steps:
1. Enable the "Online Tools" task card of the CPU.
2. Click the "MRES" button in the "CPU control panel" pane.
3. Acknowledge the confirmation prompt with "OK".
Result
The CPU is switched to STOP mode, if necessary, and the memory reset is performed on the
CPU.
See also
Basics of a memory reset (Page 1169)
Structure of the area for reading out and setting the time of day
This area consists of the following parts:
Programming device / PC time
Here the time zone setting, the current date and the current time setting of your
programming device / PC are displayed.
Module time
Here the date and time values currently read from the module (for example the CPU), are
converted to local time and date and displayed.
If the "Take from PG/PC" check box is selected, when you click the "Apply" button, the date
and the PG/PC time converted to UTC are transferred to the module.
If the "Take from PG/PC" check box is not selected, you can assign the date and time for
the integrated clock of the module. After clicking the "Apply" button, the date and the time
recalculated to UTC time are transferred to the module.
Requirements
The module is connected online.
The module supports a firmware update.
For those modules that require a supply voltage to perform the firmware update correctly:
The supply voltage of the module is secured. For details, see the documentation of the
module.
Procedure
To perform a firmware update, follow these steps:
1. Open the module in the Online and Diagnostics view.
2. Select the "Firmware update" group in the "Functions" folder.
Note
For S7-1500-CPUs, this group is subdivided into "PLC" and "Display".
3. Click the "Browse" button in the "Firmware update" area in order to select the path to the
firmware update files.
4. Select one of these files. The table then lists all modules for which an update is possible
with the selected firmware file.
5. Optional: Select the "Run firmware after update" check box to reset the module after the
load operation and to start the new firmware.
6. Click the "Start update" button. If the selected file can be interpreted by the module, it is
downloaded to the module. If the mode of the CPU needs to be changed, you will be
prompted to do this in dialogs.
Warning
Invalid plant states possible
An S7-1500 CPU immediately goes to STOP mode when you start the firmware update, which
can have an effect on the operation of an online process or a machine.
Unexpected operation of a process or a machine can result in severe or fatal injuries and/or
damage to property.
Note
After you have run a firmware update, you will need to replace the module involved with the
same module with the current firmware version in the hardware configuration of your project.
The engineering configuration then matches the actual physical configuration again.
See also
Replacing a hardware component (Page 574)
Requirement
There is no memory card inserted in the CPU.
There is an online connection to the CPU that you want to reset to the factory settings.
The CPU is in STOP mode.
Note
If the CPU is still in RUN mode and you start the reset operation, you can place it in STOP
mode by answering the security prompt with yes.
Procedure
To reset an S7-1200 CPU to factory settings, follow these steps:
1. Open the Online and Diagnostics view of the CPU.
2. Select the "Reset to factory settings" group in the "Functions" folder.
3. Select the "Keep IP address" check box if you want to keep the IP address or the "Delete
IP address" check box if you want to delete the IP address.
Note
The two check boxes mentioned are only available if the module to be reset is able to
choose whether to retain or delete the IP address.
Result
The module is switched to STOP mode if necessary and the settings are then reset to factory
settings. This means:
The work memory and the internal load memory and all operand areas are cleared.
All parameters are reset to their defaults.
The diagnostic buffer is cleared.
The time is reset.
The IP address is kept or deleted depending on which setting you made.
Requirement
If you start a reset to factory settings from the project context, an online connection to the
relevant CPU must exist.
The relevant CPU is in STOP mode.
Note
If the CPU is still in RUN mode and you start the reset operation, you can place it in STOP
mode after acknowledging a confirmation prompt.
Procedure
To reset an S7-1500 CPU to factory settings, follow these steps:
1. Open the Online and Diagnostics view of the CPU (either from the project context or via
"Accessible devices").
2. Select the "Reset to factory settings" group in the "Functions" folder.
3. Select the "Keep IP address" check box if you want to keep the IP address or the "Delete
IP address" check box if you want to delete the IP address.
Note
With "Delete IP address", all IP addresses are deleted. This applies regardless of how you
created the online connection.
If a memory card is inserted, selecting the "Delete IP address" option causes the following:
The IP addresses are deleted and the CPU is reset to factory settings. Then, the
configuration (including IP addresses) that is stored on the memory card is transferred into
the CPU (see below). If the memory card was formatted before resetting to factory settings
or if it is empty, no IP address is transferred into the CPU.
Result
The module is switched to STOP mode if necessary and the settings are then reset to factory
settings. This means:
The work memory and the internal retentive system memory and all operand areas are
cleared.
All parameters are reset to their defaults.
The diagnostic buffer is cleared.
The time of day is reset.
The I&M data are deleted except for I&M0 data.
The runtime meters are reset.
Requirement
If you start the formatting of the memory card from the project context, an online connection
to the relevant CPU must exist.
The relevant CPU is in STOP mode.
Note
If the CPU is still in RUN mode and you start a formatting operation, you can place it in
STOP mode after acknowledging a confirmation prompt.
Procedure
To format an S7-1500 memory card, follow these steps:
1. Open the Online and Diagnostics view of the CPU (either from the project context or via
"Accessible devices").
2. Select the "Format memory card" group in the "Functions" folder.
3. Click the "Format" button.
4. Answer the safety prompt with "Yes".
Result
The memory card is formatted.
The CPU is temporarily unavailable.
The project data on the CPU are deleted with the exception of the IP address.
If you start the formatting of the memory card from the project context, the Online and
Diagnostics view remains open. If formatting is started via "Accessible devices", the Online
and Diagnostics view will close.
Overview
All PROFINET IO devices work with the TCP/IP protocol and therefore require an IP address
for operation on Industrial Ethernet. Once an IP address has been assigned to an IO device,
it can be accessed via this address. You can then download configuration data or perform
diagnostics, for example.
Requirement
The Ethernet LAN connection must already be established.
The Ethernet interface of your programming device or PC must be accessible.
The IO device that is to be assigned an IP address must be in the same IP band as the
programming device or PC.
Requirement
The devices accessible via the associated interface of the PG/PC are displayed in the
project tree (to display these, either double-click "Update accessible devices" in the project
tree or select the "Accessible devices..." command in the "Online" menu.).
You have double-clicked "Online access" -> <Selected interface> -> <PROFINET IO
device> -> "Online & Diagnostics" in the project tree to open the Online and Diagnostics
view.
Procedure
1. Open the "Functions" folder and the "Assign IP address" group inside this folder. The "MAC
address" field displays the MAC address of the PROFINET IO device. The "Accessible
devices" button is grayed out.
2. Enter the desired IP address.
3. Enter the subnet mask.
4. If a router is to be used, select the "Use router" check box and enter its IP address.
5. Click the "Assign IP address" button.
Result
The IP address is permanently assigned to the IO device or to the relevant PROFINET interface
of the IO device. It is retained even through a startup or a power failure.
Note
For an S7-1500 CPU, you can also use the above-described method to change the IP address
of a PROFINET interface, if a project has already been downloaded to the CPU via this
interface. This overwrites the IP address downloaded via the project.
See also
Retentivity of IP address parameters and device names (Page 1124)
Requirement
An online connection to the PROFINET IO device exists.
You have opened the Online and Diagnostics view of the PROFINET IO device from the
project context.
The PROFINET IO device is not assigned to any IO controller.
Procedure
1. Open the "Functions" folder and the "Assign IP address" group inside this folder.
2. Click the "Accessible devices" button in order to identify the devices that can be accessed.
Note: For an S7-1500 CPU, there are two entries here because it has two PROFINET
interfaces.
3. Select the IO device. The "IP address" field, "Subnet mask" field, "Use router" check box
and "Router address" field are grayed out and contain the node properties you used to
establish the current online access.
4. Click the "Assign IP address" button.
Result
The IP address is permanently assigned to the IO device or to the relevant PROFINET interface
of the IO device. It is retained even through a startup or a power failure.
See also
Retentivity of IP address parameters and device names (Page 1124)
Device name
Before an IO device can be addressed by an IO controller, it must have a device name. This
procedure was chosen for PROFINET because names are easier to handle than complex IP
addresses.
Assigning a device name to a PROFINET IO device is comparable to setting the PROFIBUS
address for a DP slave.
An IO device has no device name in its delivery state. For an IO controller to address an IO
device, it must first be assigned a device name using the programming device or PC. It is now
ready to transfer the configuration information including the IP address during startup or
exchange user data in cyclic operation.
See also
Assigning a name in the online and diagnostics view opened via "Accessible devices"
(Page 1392)
Assigning a name in the online and diagnostics view opened from the project context
(Page 1392)
Assigning a name in the "Assign PROFINET device name" dialog (Page 1393)
Assigning a name in the online and diagnostics view opened via "Accessible devices"
Requirement
You have opened the online and diagnostics view of the PROFINET IO device using
"Update accessible devices" (in the project tree) or "Accessible devices..." ("Online" menu).
Procedure
1. Open the "Functions" folder and the "Assign name" group inside this folder. The "Type"
field displays the module type of the PROFINET IO device.
2. Enter the required device name in the "PROFINET device name" input box.
3. Optional: Select the "Flash LED" check box in order to run an LED flash test on the
PROFINET IO device. In this way, you verify that you are naming the desired IO device.
Note
The LED flash test is not supported by all PROFINET IO devices.
The LED flash test runs until you cancel it. This is done, for example, by clearing the "Flash
LED" check box or by closing the online and diagnostics view.
4. Click "Assign name".
Result
The entered name is assigned to the PROFINET IO device.
Assigning a name in the online and diagnostics view opened from the project context
Requirement
You have opened the online and diagnostics view of the PROFINET IO device from the
project context.
The PROFINET IO device can be accessed using at least one PG/PC interface.
Procedure
1. Open the "Functions" folder and the "Assign name" group inside this folder. The
"PROFINET device name" drop-down list displays the current name in the offline project,
and the "Type" box shows the module type of the PROFINET IO device.
Note
For CPUs with several PROFINET interfaces, the names of all existing PROFINET
interfaces are displayed in the offline project.
3. In the "PG/PC interface for assignment" drop-down list, select the PG/PC interface you
want to use to establish the online connection.
4. Optional: Use the three check boxes to make a selection from all IO devices available online.
5. Click the icon for determining the IO devices present in the PROFINET subnet. The table
is then updated.
6. Select the desired IO device in the table.
7. Optional: Select the "Flash LED" check box in order to run an LED flash test on the
PROFINET IO device. In this way, you verify that you are naming the desired IO device.
Note
The LED flash test is not supported by all PROFINET IO devices.
The LED flash test runs until you cancel it. This is done, for example, by clearing the "Flash
LED" check box, by selecting another IO device in the table, or by closing the online and
diagnostics view.
8. Click "Assign name".
Result
The selected name is assigned to the PROFINET IO device or one of its PROFINET interfaces.
Requirement
You have opened the "Assign PROFINET device name" dialog from the network view (from
the shortcut menu of a PN/IE connection).
The PROFINET IO device can be accessed using at least one PG/PC interface.
Procedure
1. The following is displayed in the "PROFINET device name" drop-down list:
the name of the interface that was used to open the project in the current offline project
the names of those IO devices that are connected by means of this interface
The "Type" field displays the module type of the PROFINET IO device.
Choose a different name from the drop-down list, if necessary.
Note
In steps 2 to 4, you determine the IO devices that are present in the PROFINET subnet.
2. In the "PG/PC interface for assignment" drop-down list, select the PG/PC interface you
want to use to establish the online connection.
3. Optional: Use the three check boxes to make a selection from all IO devices available online.
4. Click the icon for determining the IO devices present in the PROFINET subnet. The table
is then updated.
5. Select the desired IO device in the table.
6. Optional: Select the "Flash LED" check box in order to run an LED flash test on the
PROFINET IO device. In this way, you verify that you are naming the desired IO device.
Note
The LED flash test is not supported by all PROFINET IO devices.
The LED flash test runs until you cancel it. This is done, for example, by clearing the "Flash
LED" check box or by selecting another IO device in the table.
7. Click "Assign name".
Result
The selected name is assigned to the PROFINET IO device or the interface that was used to
open the dialog.
Requirement
You have opened the Online and Diagnostic view of the S7-1500 analog module from the
project context and are in the "Calibrate" group of the "Functions" folder.
The associated CPU is online.
No calibration is currently running on the analog module (if you want to start the calibration)
or the last step initiated has been performed successfully (if you want to resume or complete
the calibration).
Procedure for the second to the next to last step of the calibration
Follow these steps:
1. Click the "Next" button.
The fields of the user interface described above are then updated.
Error occurrence
If an error occurs during the calibration, the module cancels the calibration. Afterwards, the
channel that was to be calibrated has the same settings as before the start of the calibration.
Except for the "Status" field, the user interface appears the same after the occurrence of an
error as before the calibration. The "Status" field displays the error that the module detected
during the calibration.
Requirement
You have opened the Online and Diagnostic view of the S7-1500 analog module from the
project context and are in the "Calibrate" group of the "Functions" folder.
The associated CPU is online.
A calibration is currently running on the analog module.
Procedure
To cancel a running calibration, follow these steps:
1. Click the "Cancel" button.
Result
The running calibration is canceled, and afterwards the channel to be calibrated has the same
settings as before the calibration.
All operator controls in the user interface are deactivated until the cancelation is complete.
Except for the "Status" field, the user interface appears the same afterwards as before the
calibration. The "Status" field displays the result of the cancelation.
Requirement
You have opened the Online and Diagnostic view of the S7-1500 analog module from the
project context and are in the "Calibrate" group of the "Functions" folder.
The associated CPU is online.
Procedure
To reset a channel of an S7-1500 analog module to factory settings, follow these steps:
1. Select the line associated with the channel to be reset in the overview table.
2. Click the "Set to factory settings" button.
Result
All operator controls in the user interface are deactivated until the reset operation is complete.
Except for the "Status" field, the user interface appears the same afterwards as before the
reset operation. The "Status" field displays the result of the reset operation.
Function
The operating system of the CPU enters the errors detected by the CPU and the diagnostics-
capable modules into the diagnostics buffer in the order in which they occurred. This includes
the following events:
Every mode change of the CPU (POWER UP, change to STOP mode, change to RUN
mode)
Every hardware and diagnostic error interrupt
The top entry contains the most recent event. The entries in the diagnostics buffer are stored
permanently. They are retained even if the power supply fails and can only be deleted by
resetting the CPU to factory settings.
A diagnostics buffer entry contains the following elements:
Time stamp
Error ID
Additional information specific to the error ID
Note
To make the best use of the time stamp information on the diagnostics buffer entries in time-
critical systems, it is advisable to check and correct the date and time of day on the CPU
occasionally.
Alternatively, it is possible to perform a time-of-day synchronization using an NTP time server.
See also
Resetting an S7-1200 CPU to factory settings (Page 1386)
Determining the cause of a STOP of a CPU (Page 1399)
Determining and setting the time of day on a CPU (Page 1383)
Assigning the clock parameters (Page 1193)
Requirement
The CPU you want to analyze is in STOP mode.
Procedure
To find out the reason why a CPU changed to STOP, follow these steps:
1. Open the online and diagnostics view of the CPU.
2. Select the "Diagnostics buffer" group from the "Diagnostics" folder.
3. Evaluate the events occurring prior to the transition to STOP mode. Use this to obtain a
picture of the possible causes or to zero in on or specify in more detail the possible causes
(depending on the error type).
Read the detailed information about the events carefully and use the "Help on event" button
to obtain additional information and possible causes of individual entries.
Result
You were able to zero in on or determine in more detail the cause of the CPU STOP.
Note
If the analysis does not enable you to overcome the problem, contact Customer Support. In
this case, use the "Save as" button to back up the content of the diagnostics data to a text file
and submit it to Customer Support.
See also
Reading out the diagnostics buffer of a CPU (Page 1376)
Requirement
The associated device can be accessed using at least one PG/PC interface.
Procedure
1. Open the online and diagnostics view for the device whose online connection status you
want to display.
2. Select the "Online access" group.
Note
The "Online access" group exists only for CPUs and some CPs. However, if you have
opened the online and diagnostics view using the "Show/update accessible devices"
function, it is not displayed.
Result
The status of the online connection is displayed in the "Status" area both graphically and in
text form.
Requirement
The associated device can be accessed using at least one PG/PC interface.
There is currently no online connection to the relevant device.
Procedure
1. Open the Online and Diagnostics view of the device to which you want to establish an online
connection.
2. Choose the "Online access" group and the "Online access" area within this group.
Note
The "Online access" group exists only for CPUs and some CPs. If you have opened the
Online and Diagnostics view using the "Show/update accessible devices" function, it is not
displayed.
3. If an online connection was established previously for the device, the associated data for
this online connection is preset in the drop-down lists. In this case, you can immediately
continue with the last step of this operating instruction, provided you have not changed the
IP address in the meantime using the Online and Diagnostics view.
4. Choose the interface type in the "Type of PG/PC interface" drop-down list.
The "PG/PC interface for online access" drop-down list then shows only the interfaces of
the programming device or PC that match the selected interface type.
5. In the "PG/PC interface for online access" drop-down list, select the programming device
or PC interface via which you want to establish the online connection.
6. Optional: Click the "Properties" button to change the properties of the associated CP.
7. In the "Connection to subnet" drop-down list, select the subnet via which the device is
connected to the PG/PC interface.
Note
The PG/PC interface is connected to an interface of a device.
If you only want to access this device, select the setting "Directly at slot <interface name>"
in the drop-down list.
If, however, you want to access another device by means of routing, create a subnet at this
interface in the device configuration and then select this subnet in the drop-down list.
8. If the device is accessible via a gateway, select the gateway that connects the two subnets
involved in the "1st gateway" drop-down list.
9. In the "Device address" entry field, enter the IP address of the device to which you want to
establish an online connection, if necessary.
Note
For CPUs with multiple IP addresses, select the IP address of the PROFINET interface you
want to use to establish an online connection from the "Device address" drop-down list.
10.Alternatively: Click the "Show accessible devices" button and choose the device from the
list of accessible devices to which you want to establish an online connection.
11.Click the "Go online" button.
Result
The online connection to the desired device is established.
Going offline
Requirement
There is currently an online connection to the relevant device.
Procedure
1. Open the online and diagnostics view of the device for which you want to disconnect the
online connection.
2. Choose the "Online access" group and the "Online access" area within this group.
Note
The "Online access" group exists only for CPUs and some CPs. However, if you have
opened the online and diagnostics view using the "Show/update accessible devices"
function, it is not displayed.
Result
The online connection to the desired device will be disconnected.
Requirement
There is currently an online connection to the relevant device.
The FORCE function is not active.
Procedure
1. Open the online and diagnostics view of the device for which you want to perform a flash
test.
2. Choose the "Online access" group and the "Status" area within this group.
Note
The "Online access" group exists only for CPUs and some CPs. However, if you have
opened the online and diagnostics view using the "Show/update accessible devices"
function, it is not displayed.
Result
On an S7-1200 CPU, the RUN/STOP, ERROR and MAINT LEDs flash.
On an S7-1500 CPU, the RUN/STOP, ERROR, and MAINT LEDs flash.
On an S7-300 or S7-400 CPU, the FRCE LED flashes.
The LEDs flash until you cancel the flash test. This is done, for example, by clearing the "LED
flash test" check box, by changing to another group of the online and diagnostics view, or by
changing settings in the "Online access" area.
See also
Displaying the status of the segment diagnostics using icons (Page 1404)
Displaying the status of the segment diagnostics using graphics and text (Page 1404)
Diagnostics icons
The following table shows the available icons and their meaning.
Icon Meaning
Segment is error-free
Segment is deactivated
Displaying the status of the segment diagnostics using graphics and text
Where is the status of the segment diagnostics displayed with graphics and text?
The status of the segment diagnostics will be displayed using graphics and text in the "DP1",
"DP2", "DP3", and "PG" groups of the "Segment diagnostics" folder in the Online and
Diagnostics view of the relevant diagnostic repeater.
In this example, the diagnostic repeater has the PROFIBUS address 2, and a line error has
occurred between the devices with PROFIBUS addresses 16 and 17. This line error is located
25 m from device 16, 4 m from device 17, and 72 m from the diagnostic repeater.
"Error" field
The error is explained in plain text in this field.
"Resolution" field
Here, you will find actions for resolving the error.
Basics
Connection diagnostics, as described below, refers to the diagnostics of communication
connections.
The connection diagnostics is started each time an online connection is established to a
module (CPU or CP) that participates in one or more communication services. The connection
status is updated automatically in the background.
In the case of one-way connections, an online connection must exist to the communication
partner that has established the communication connection.
On connections configured at both ends, a distinction between the following two situations
must be made:
If there is an online connection to only one connection endpoint, only the part of the
connection belonging to this connection endpoint can be diagnosed.
If there is an online connection to both connection endpoints, both parts of the connection
(and therefore the entire connection) can be diagnosed.
Icon Meaning
Connection setup
Icon Meaning
Connection exists online only
How do I open the "Diagnostics > Connection information" area of the Inspector window?
The following options are available for opening the "Connection information" tab of the
Inspector window.
Select the line of the relevant connection in the connection table. Click the "Diagnostics"
and "Connection information" tabs one after the other in the Inspector window.
Double-click the diagnostics icon of the relevant connection in the connection table.
This step takes you to the programming editor for a S7 communication instruction or open
user communication instruction. Double-click the diagnostic icon of the instruction
(stethoscope).
Structure or the "Diagnostics > Connection information" area of the Inspector window
Requirements: the content of the "Connection information" tab has been filled, and an online
connection to at least one end point of the relevant connection has been established.
If a module has been selected (network view), the tab will contain the following group:
Connection resources (for S7-1200 and S7-1500)
If a connection has been selected (connection table), it will contain the following groups:
Connection details
Address details of the connection (for S7-1200 and S7-1500)
Operating system
Function
The operating system is contained in every CPU and organizes all CPU functions and
sequences that are not associated with a specific control task.
The tasks of the operating system, for example, include the following:
Processing a warm restart
Updating the process image of the inputs and outputs
Calling the user program
Detecting interrupts and calling interrupt OBs
Detecting and handling errors
Managing memory areas
The operating system is a component of the CPU and is already installed there upon delivery.
See also
User program (Page 1411)
User program
Function
The user program contains all functions that are necessary for processing your specific
automation task.
See also
Operating system (Page 1411)
Linear programming
Solutions for small automation tasks can be programmed linearly in a program cycle OB. This
is only recommended for simple programs.
The following figure shows a linear program schematically: The "Main1" program cycle OB
contains the complete user program.
0DLQSURJUDP
0DLQ
Structured programming
Complex automation tasks can be more easily handled and managed by dividing them into
smaller sub-tasks that correspond to the technological functions of the process or that can be
reused. These sub-tasks are represented in the user program by blocks. Each block is then
an independent section of the user program.
Structuring the program offers the following advantages:
Extensive programs are easier to program through the structure.
Individual program sections can be standardized and used repeatedly with changing
parameters.
Program organization is simplified.
Changes to the program can be made more easily.
Debugging is simplified since separate sections can be tested.
Commissioning is simplified.
The following figure shows a structured program schematically: The "Main1" program cycle
OB calls subprograms one after the other that execute defined subtasks.
0DLQSURJUDP 6XESURJUDPV
0DLQ
%ORFNB
%ORFNB
Block types
Different BLOCK types are available to perform tasks within an automation system. The
following table shows the available block types:
Definition
Organization blocks (OBs) form the interface between the operating system and the user
program. They are called by the operating system and control, for example, the following
operations:
Startup characteristics of the automation system
Cyclic program processing
Interrupt-driven program execution
Error handling
You can program the organization blocks and at the same time determine the behavior of the
CPU. Various organization blocks are available to you depending on the CPU used.
For more information on organization blocks, refer to the descriptions of the modes of operation
of CPUs in the "Additional information on configurations" chapter in "Configuring Hardware
and Networks".
See also
Creating organization blocks (Page 1506)
Functions (FCs)
Definition
Functions (FCs) are code blocks without memory. You have no data memory in which values
of block parameters can be stored. Therefore, when a function is called, all formal parameters
must be assigned actual parameters.
Functions can use global data blocks to store data permanently.
Application
A function contains a program that is executed when the function is called by another code
block. Functions can be used, for example, for the following purposes:
To return function values to the calling block, e.g. for mathematical functions
To execute technological functions, e.g. individual controls using bit logic operations
A function can also be called several times at different points in a program. As a result, they
simplify programming of frequently recurring functions.
Note
Parameter transfer when calling functions
To avoid errors when working with functions, observe the information in chapter "Auto-
Hotspot".
See also
Creating functions and function blocks (Page 1507)
Definition
Function blocks are code blocks that store their input, output and in-out parameters
permanently in instance data blocks, so that they remain available even after the block has
been executed. Therefore they are also referred to as blocks "with memory".
Function blocks can also operate with temporary tags. Temporary tags are will not be stored
in the instance DB, but are available for one cycle only.
Application
Function blocks contain subroutines that are always executed when a function block is called
by another code block. A function block can also be called several times at different points in
a program. As a result, they simplify programming of frequently recurring functions.
Access modes
S7-1200 and S7-1500 offer two different access options for the instance data blocks, which
can be assigned to a function block when this is called:
Data blocks with optimized access
Data blocks with optimized access have no firmly defined memory structure. The data
elements contain only a symbolic name in the declaration, no fixed address within the block.
Data blocks with standard access (compatible with S7-300/400)
Data blocks with standard access have a fixed memory structure. The declaration elements
contain both a symbolic name in the declaration and a fixed address within the block.
Note
To avoid errors when working with function blocks, refer to the section "Auto-Hotspot".
See also
Creating functions and function blocks (Page 1507)
Multi-instances (Page 1427)
Instance data blocks (Page 1417)
Basics of block access (Page 1419)
Definition
Data blocks are used to store program data. Data blocks thus contain variable data that is
used by the user program. Global data blocks store data that can be used by all other blocks.
The maximum size of data blocks varies depending on the CPU. You can define the structure
of global data blocks anyway you please.
You also have the option of using PLC data types (UDT) as a template for creating global data
blocks.
)XQFWLRQB
*OREDO'%
$FFHVVIRUDOOEORFNV
'%B*OREDO
)XQFWLRQB
Access modes
S7-1200 and S7-1500 offer two different access options for global data blocks:
Data blocks with optimized access
Data blocks with optimized access have no fixed defined structure. In the declaration, the
data elements are assigned only a symbolic name and no fixed address within the block.
Data blocks with standard access (compatible with S7-300/400)
Data blocks with standard access have a fixed structure. In the declaration, the data
elements are assigned both a symbolic name and a fixed address within the block.
See also
Creating data blocks (Page 1508)
Basics of block access (Page 1419)
Definition
The call of a function block is referred to as an instance. The data with which the instance
works is stored in an instance data block.
The maximum size of instance data blocks varies depending on the CPU. The tags declared
in the function block determine the structure of the instance data block.
Access modes
S7-1200 and S7-1500 offer two different access options for the instance data blocks, which
can be assigned to a function block when this is called:
Data blocks with optimized access
Data blocks with optimized access have no firmly defined structure. The declaration
elements contain only one symbolic name in the declaration, and no fixed address within
the block.
Data blocks with standard access (compatible with S7-300/400)
Data blocks with standard access have a fixed structure. The declaration elements contain
both a symbolic name in the declaration and a fixed address within the block.
See also
Creating data blocks (Page 1508)
Basics of block access (Page 1419)
Definition
CPU data blocks are generated by the CPU at runtime. To this purpose, insert the
"CREATE_DB" instruction into your user program. You can use the data block that is generated
at runtime to save your data.
CPU data blocks are indicated by means of a small CPU icon in the "Program blocks" folder
of an available node. You can monitor the values of the variables of a CPU data block in online
mode, similar to those of a different data block type.
You cannot create CPU data blocks in your offline project.
See also
Deleting CPU data blocks (Page 1528)
Introduction
STEP 7 offers data blocks with different access options:
Data blocks with optimized access (S7-1200/S7-1500)
Data blocks with standard access (S7-300 / S7-400 / S7-1200 / S7-1500)
Within one program you can combine the two types of blocks.
Tags are identified by their symbolic names in these data blocks. To address the tag, enter its
symbolic name. For example, you access the "Fill Level" tag in the "Data" DB as follows:
"Data".Fill Level
Blocks with optimized access offers the following advantages:
You can create data blocks with any structure without paying attention to the physical
arrangement of the individual data elements.
Quick access to the optimized data is always available because the data storage is
optimized and managed by the system.
Access errors, as with indirect addressing or from the HMI, for example, are not possible.
You can define specific individual tags as retentive.
Optimized blocks are equipped with a memory reserve by default which lets you expand
the interfaces of function blocks or data blocks during operation. You can download the
modified blocks without setting the CPU to STOP and without affecting the values of already
loaded tags.
Note
The "Optimized block access" attribute is always enabled for the following blocks and cannot
be deselected.
GRAPH blocks
ARRAY data blocks
The options for setting the retentivity depend on the access type of the block.
In data blocks with standard access, you cannot set the retentive behavior of individual
tags. The retentivity setting is valid for all tags of the data block.
In data blocks with optimized access you can define the retentive behavior of individual
tags.
For structured data type tags, the retentivity setting always applies to the entire structure.
You cannot make any individual retentivity setting for separate elements within the data
type.
See also
Setting up block access (Page 1421)
Introduction
Block access is set up automatically when you create a block:
Blocks created on CPUs of the S7-1200/1500 product range provide optimized access by
means of a default setting.
New blocks created on CPUs of the S7-300/S7-400 product range provide standard access
by means of a default setting.
Access to a block that you copy or migrate to a CPU of a different product range is not converted
automatically. However, in certain situations it may be useful to change block access in manual
mode, e.g., in order to utilize the full functional scope of the CPU.
In most cases, you will have to recompile and load the program after block access has been
converted.
Notice
Optimized block access for GRAPH blocks
The "Optimized block access" attribute is always enabled for GRAPH blocks in S7-1500 and
cannot be deselected.
Procedure
To set the block access, proceed as follows:
1. Open the "Program blocks" folder in the project tree.
2. Right-click on the block whose block access you want to change.
3. Select the "Properties" command in the shortcut menu.
The properties dialog box of the block opens.
4. Click "Attributes" in the area navigation.
5. Enable or disable the "Optimized block access" option.
6. Confirm your entries with "OK".
Caution
The conversion of the block access has the following consequences:
Absolute addressing of the interface parameters of the block is no longer possible after
conversion of block access to the "optimized mode.
Example: #L0.1 is no longer valid.
Since conversion to the "optimized" block access mode of organization blocks also modifies
the OB interface,
you may possibly have to adapt, recompile and load the program again due to these changes.
See also: Auto-Hotspot
Caution
The conversion of the block access has the following consequences:
Since a conversion to "standard" block access mode might change the retentivity settings of
the interface parameters, you may possibly have to adapt, recompile and load the program
again due to these changes.
See also: Auto-Hotspot
See also
Basics of block access (Page 1419)
&DOOLQJEORFN &DOOLQJEORFN
2%)%)& )%RU)&
3URJUDPH[HFXWLRQ
3URJUDPH[HFXWLRQ
2SHUDWLRQWKDWFDOOV
DQRWKHUEORFN
%ORFNHQG
Parameter transfer
When a block is called, you must assign values to the parameters in the block interface. By
providing input parameters you specify the data with which the block is executed. By providing
the output parameters you specify where the execution results are saved.
See also
Call hierarchy (Page 1425)
Principles for single instances and multi-instances (Page 1426)
Call hierarchy
Definition
The order and nesting of block calls is referred to as the call hierarchy. The permissible nesting
depth depends on the CPU.
The following figure shows an example of the order and nesting of block calls within an
execution cycle:
6WDUWRI 1HVWLQJGHSWK
F\FOH
)%B )&B
2SHUDWLQJV\VWHP ,QVWDQFH'%
)&B
'%B*OREDO
See also
Principles for single instances and multi-instances (Page 1426)
Principles of block calls (Page 1424)
See also
Principles of block calls (Page 1424)
Multi-instances (Page 1427)
Single instances (Page 1427)
Call hierarchy (Page 1425)
Single instances
Definition
The call of a function block, which is assigned its own instance data block, is called a single
instance data block.
By assignment of the instance data block, you specify where the instance data of the FB is to
be stored. By assigning a different instance data block to each call, you can use the same FBs
several times with different instance data in each case.
5RWDWLRQDOVSHHG
0DLQ
'DWD
)%B0RWRU 'DWD
'DWD
See also
Principles for single instances and multi-instances (Page 1426)
Multi-instances (Page 1427)
Multi-instances
Definition
Multi-instances enable a called function block to store its data in the instance data block of the
calling function block.
This allows you to concentrate the instance data in one instance data block and thus make
better use of the number of instance data blocks available.
One instance data block for the instances of different function blocks
The following figure shows how multiple different function blocks store their data in a calling
block. The FB_Workpiece calls the following on after the other: FB_Grid, FB_Punch and
FB_Conveyor. The called blocks store their data in the DB_Workpiece, the instance data block
of the calling block.
)%B*ULG
)%B:RUNSLHFH '%B:RUNSLHFH
&RQWUROOLQJ
0DLQ
VWDW)%B*ULG DJULG 'DWDIRU
'%B:RUNSLHFH VWDW)%B3XQFK JULG
VWDW)%B&RQYH\RU
)%B:RUNSLHFH
)%B3XQFK
)%B*ULG 'DWDIRU
&RQWUROOLQJ SXQFK
DSXQFK
)%B3XQFK
)%B&RQYH\RU )%B&RQYH\RU
'DWDIRU
FRQYH\RU
&RQWUROOLQJ
DFRQYH\RUb
,QVWDQFH'%RI)%B:RUNSLHFH
)%B0RWRUV '%B0RWRU'DWD
)%B0RWRUB
0DLQ
'DWDIRU
VWDW)%B0RWRUB
0RWRUB
VWDW)%B0RWRUB
'%B0RWRU'DWD
VWDW)%B0RWRUB
)%B0RWRUV
)%B0RWRUB
)%B0RWRUB
)%B0RWRUB 'DWDIRU
0RWRUB
,QVWDQFH'%RI)%B0RWRUV
The function block FB_Motors calls three instances of the FB_Motor. The instances are
"Motor_1", "Motor_2" and "Motor_3". Each call uses different instance data. However, all
instance data are located in a single instance data block, DB_MotorData.
See also
Principles for single instances and multi-instances (Page 1426)
Single instances (Page 1427)
Introduction
The calling block gives the called block the values with which it is to work. These values are
referred to as block parameters. The input parameters provide the called block with the values
that it has to process. The block returns the results via the output parameters.
Block parameters are therefore the interface between the calling and the call block.
You use input parameters when you want to only query or read values, and output parameters
when you want to set or write these values. If block parameters are read and written you have
to create these as in-out parameters.
See also
Parameter assignment to function blocks (Page 1433)
Parameter assignment to functions (Page 1431)
General rules for assigning parameters (Page 1430)
Using tags within the program (Page 1447)
Keywords (Page 1442)
Introduction
When you call a block with block parameters, assign actual parameters to its formal
parameters. The rules described below apply here.
Transferring ARRAYs
You can transfer ARRAYs as parameters. If a block has an input parameter of ARRAY type,
you must transfer as actual parameter an ARRAY with identical structure. This means the data
type, the number of dimensions and the number of field components must be identical. You
can also transfer individual elements of an ARRAY as actual parameter if the element
corresponds to the data type of the formal parameter.
Note
We recommend programming structures as PLC data types. PLC data types make
programming easier, since they can be used multiple times and modified centrally.
See also
Parameter assignment to function blocks (Page 1433)
Parameter assignment to functions (Page 1431)
Basics of block parameters (Page 1429)
PLC data types (Page 1954)
See also
Parameter assignment to function blocks (Page 1433)
Basics of block parameters (Page 1429)
General rules for assigning parameters (Page 1430)
Calling functions (Page 1685)
Examples for calling functions in SCL (Page 1688)
See also
Basics of block parameters (Page 1429)
General rules for assigning parameters (Page 1430)
Parameter assignment to functions (Page 1431)
Parameter types (Page 1953)
Introduction
When a block is called, you transfer data to the parameters in the block interface. At the input
parameters, you transfer the data with which the block is to work. At the output parameters,
you specify where the results of the processing are saved. In/out parameters are used to
transfer data to the called block as well as to return results.
Internally, STEP 7 recognizes two different methods of parameter transfer: The data is
transferred either as pointer or as copy, depending on the transfer range and data type of the
parameter.
FC / FB
"My_int"
IN
value: 31
value: 31
FC/FB
"My_string"
IN/OUT
value: 'Test'
Reference to"My_string"
Note
Declare structured data types in the "InOut" area
If possible, use the "InOut" area in the block interface for structured tags (e.g., of data type
ARRAY, STRUCT, STRING, ). As structured in/out parameters are always transferred as
pointer, the required data memory is not increased more than necessary.
Note
Parameter transfer between blocks with optimized access and blocks with standard access
When optimized data is transferred to a block with the property "Standard access", it is always
transferred as copy. If the block contains numerous structured parameters, this can quickly
lead to the temporary memory area (local data stack) overflowing.
You can avoid this by setting the same access type for both blocks.
See also: Auto-Hotspot
* Exception: Operands from the memory areas I, Q, M, P, L and partly qualified DB addresses
(for example, "DW 2") are transferred as pointer.
Note
Special aspects of transfer as pointer in S7-300/400
In cases in which the parameters are transferred via a pointer, it is not possible to forward
output parameters or in/out parameters from the calling block to the input parameters of the
called block.
Introduction
Definition
The "Forwarding" of block parameters is a special type of parameter use. In this case the block
parameters of the calling block are forwarded to the parameters of the called block. The called
block uses the values that are currently present at the block parameters of the calling block
as the actual parameters.
The following figure shows how the parameters of the function FC_10 are forwarded to the
function FC_12:
)&B )&B
7DJGHFODUDWLRQ 7DJGHFODUDWLRQ
)&B
$B3DUDP 3DUDPB
%B3DUDP 3DUDPB
&B3DUDP 3DUDPB
See also
Calling a function by another function (Page 1438)
Call of a function by a function block (Page 1439)
Call of a function block by a function (Page 1440)
Call of a function block by another function block (Page 1440)
See also
Basic information on forwarding block parameters (Page 1437)
See also
Basic information on forwarding block parameters (Page 1437)
See also
Basic information on forwarding block parameters (Page 1437)
Permissible data types for the call of a function block by another function block
Specific rules apply to the forwarding of formal parameters. The following table shows the rules
according to which parameters can be forwarded in the various CPU families:
See also
Basic information on forwarding block parameters (Page 1437)
Introduction
When you program instructions you must specify which data values the instruction should
process. These values are referred to as operands. You can, for example, use the following
elements as operands:
PLC tags
Constants
Tags in instance data blocks
Tags in global data blocks
See also
Displaying symbolic and absolute addresses (Page 1539)
Basics of block access (Page 1419)
Keywords
SIMATIC recognizes a range of key words whose definitions are fixed and which have a certain
meaning in the program. You should not use these keywords as names for tags or constants.
Table of keywords
The following table shows all keywords.
Definition
A variable is a placeholder for a data value that can be changed in the program. The format
of the data value is defined. The use of variables makes your program more flexible. For
example, you can assign different values to variables that you have declared in the block
interface for each block call. As a result, you can reuse a block you have already programmed
for various purposes.
A variable consists of the following elements:
Name
Data type
Absolute address
PLC tags and DB tags in blocks with standard access have an absolute address.
DB variables in blocks with optimized access have no absolute address.
Value (optional)
Declaring Variables
You can define variables with different scopes for your program:
PLC tags that apply in all areas of the CPU
DB variables in global data block that can be used by all blocks throughout the CPU.
DB tags in instance data blocks that are predominantly used within the block in which they
are declared.
The following table shows the difference between the variable types:
See also
Keywords (Page 1442)
Basic information about operands (Page 1441)
Displaying symbolic and absolute addresses (Page 1539)
Valid names of PLC tags (Page 1481)
Permissible addresses and data types of PLC tags (Page 1482)
Constants
Basics of constants
Definition
Constants are data with a fixed value that you cannot change during program runtime.
Constants can be read by various program elements during the execution of the program but
cannot be overwritten. There are defined notations for the value of a constant, depending on
the data type and data format. A distinction is made between the typed and non-typed notation.
Non-typed constants
In the non-typed notation, you only enter the value of the constant without a data type. Non-
typed constants do not receive their data type until the first arithmetic or logical operation in
which they are used.
The example below shows the non-typed notation:
SCL
#My_Int1 := #My_Int2 + 12345 (*The data type of the constant "12345"
results from the addition with My_Int 2. "12345"
receives the data type INT.*)
#My_Real1 := #My_Real2 + 12345 (*The data type of the constant "12345" results
from the addition with My_Real2. "12345" re-
ceives the data type REAL.*)
Typed constants
In the typed notation, you specify a data type in addition to the value of the constant.
The example below shows the typed notation:
SCL
#My_Int1 := INT#12345 (*The data type of the constant is always
INT.*)
Note
Constants of BOOL type in LAD/FBD
Constants of the BOOL type may not be used as inputs of instructions in S7-300/400.
Constants of the BOOL type may be used as inputs of instructions which are a system-internal
function block (FB) in S7-1200/1500. These instructions are identified by the fact that the "Call
options" dialog opens when you insert the instruction into a network. Boolean constants may
not be used as inputs for all other instructions.
Additional information
Additional information on the data types of constants, their input formats and value ranges:
Data types (Page 1908)
Calculating with constants in SCL (Page 295)
See also
Layout of the block interface (Page 1551)
Symbolic constants
You have the option of declaring symbolic names for constants and thus making constant
values available under a name in the program. This makes a program more readable and
easier to maintain when changing constant values.
A symbolic constant consists of the following elements:
Name
Data type
Symbolic constants always have a data type; non-typed notation is not possible for symbolic
constants.
Constant value
You can select any value from the value range of the specified data type as constant value.
For information on the value ranges, refer to the "Data types" chapter.
Declaration of constants
You can define constants with different scopes of validity:
Global constants that apply to all areas of the CPU
Local constants that only apply within a block
The table below shows the difference between the constant types:
Note
Downloading constant declarations (S7-300/400)
Local and global constant declarations are not downloaded into the CPU. If you download a
program from a device, the constant declarations may no longer be available.
Additional information
Additional information on the procedure for declaring constants:
Overview of the valid data types (Page 1908)
Auto-Hotspot
Auto-Hotspot
Calculating with constants in SCL (Page 295)
SCL
#My_Int1 := #My_Int2 + 12345 (*The data type of the constant "12345"
results from the addition with My_Int 2. "12345"
receives the data type INT.*)
#My_Real1 := #My_Real2 + 12345 (*The data type of the constant "12345" results
from the addition with My_Real2. "12345" re-
ceives the data type REAL.*)
Note
STEP 7 always uses the data type with the highest possible precision
Unless the data type of a constant can be clearly defined in an expression, the data type with
the highest precision available on the current CPU is used.
Example:
#My_Real := #My_Int / 3.5
In this expression an integer tag is combined with a non-typed floating point constant. In
S7-300/400 the right part of the assignment is calculated in the REAL format. In S7-1200/1500,
calculation is performed using the highest possible precision, which in this case means LREAL.
As a result, the assignment to a REAL tag is invalid or generates a warning.
To precisely define the data type of a constant, use the typed notation.
Example:
#My_Real := #My_Int / REAL#3.5
Additional information
Additional information on the data types of constants, their input formats and value ranges:
Data types (Page 1908)
Calculating with constants in SCL (Page 295)
SCL
#My_Int := 3;
SCL
#My_Real1 := #My_Real2 * 3;
#My_Real1 := #My_Real2 * #My_local_const;
#My_Real1 := #My_Real2 * "My_global_const";
SCL
Array[#My_local_const1..#My_local_const2] of REAL
Array["My_global_const1".."My_global_const1"] of REAL
Note
Constants as ARRAY limits
Constants which are used as ARRAY limits cannot be changed if the memory reserve of
the block is activated. This applies to both local and global constants. To change these
constants, you must first disable the memory reserve.
Changes to global constants result in inconsistencies in the blocks which use them as
ARRAY limits. The inconsistencies are marked in red in the block used. To remedy these
inconsistencies, the data blocks have to be updated.
See also: Updating data blocks (Page 1708)
Additional information
Additional information on the data types of constants, their input formats and value ranges:
Data types
Calculating with constants in SCL (Page 295)
See also
Overview of the valid data types (Page 1908)
Addressing operands
Note
The LWORD, LINT, ULINT, LREAL, LTIME, LTOD and LDT data types can only be addressed
by means of their symbolic name.
Examples
The following examples show applications of symbolic and absolute addressing:
Addressing Description
%Q1.0 Absolute address: Output 1.0
%I16.4 Absolute address: Input 16.4
%IW4 Absolute address: Input word 4
"Motor" Symbolic address "Motor"
"Value" Symbolic address "Value"
"Structured_Tag" Symbolic address of a tag that is based on a PLC da-
ta type
"Structured_Tag".Component Symbolic address of the component of a structured
tag.
See also: Permissible addresses and data types of PLC tags (Page 1482)
See also
Displaying symbolic and absolute addresses (Page 1539)
Accessing I/O devices (Page 1455)
Description
The process image of the CPU is updated once in a cycle. In time-critical applications, however,
it can be that the current state of a digital input or output has to be read or transferred more
often than once per cycle. For this purpose you can use a suffix for I/O access identifiers on
the operand to directly access the I/O.
If you want to read the input directly from the peripherals, use the peripheral inputs memory
area (PI) instead of the process input image (I). The peripherals memory area can be read as
a bit, byte, word, or double word.
If you want to write directly to the output, use the peripheral output (PQ) memory area instead
of the process output image (Q). The peripheral output memory area can be written as a bit,
byte, word, or double word.
To read or write a signal directly from a peripheral input, you can add the suffix for I/O access
":P", to the operand.
Components of structured PLC tags can also be addressed with ":P". However, access to the
higher-level tag with ":P" is not possible.
Warning
Direct writing of the I/O
Immediate writing to the I/O can lead to hazardous states, for example when writing multiple
times to an output in one program cycle.
Syntax
<Operand>:P
Example
The following example shows applications of I/O access identifiers:
Addressing Description
"Motor" Addresses the "Motor" tag in the process image.
"Motor":P Addresses the "Motor" tag in the I/O memory area (PI
or PQ).
"Structured_Tag".Component Addresses the component of a structured PLC tag in the
process image.
Addressing Description
"Structured_Tag".Component:P Addresses the component of a structured PLC tag in the
I/O memory area (PI or PQ).
See also
Addressing global variables (Page 1454)
Description
Tags in global data blocks can be addressed in symbolic or absolute form. For symbolic
addressing, you use the name of the data block and the name of the tag, separated by a dot.
The name of the data block is enclosed in quotation marks.
For absolute addressing, you use the number of the data block and the absolute address of
the tags in the data block, separated by a dot. The address identifier % is set automatically as
prefix for the absolute address.
The S7-1200/1500 provides you with an option of accessing a data block that is not yet known
during programming. For this purpose, create a block parameter of data type DB_ANY in the
block interface of the accessing block. The data block name or data block number is transferred
to this parameter during runtime. In order to access the internal tags of the data block, use the
name of the block parameter of data type DB_ANY and the absolute address of the tag,
separated by a dot.
Note
Transfer DB with memory reserve to the parameter DB_ANY.
It is not possible to transfer a DB with memory reserve to a block parameter of data type
"DB_ANY".
Note
Addressing DB tags in absolute form
Absolute addressing is not possible for the following tags:
Tags in blocks with optimized access.
Tags of data type LWORD, LINT, ULINT, LREAL, LTIME, LTOD and LDT.
Best practice is to use the more convenient symbolic addressing for these tags.
Syntax
"<DBname>".TagName
%<DBnumber>.absoluteAddress
#<DBAny_name>.%absoluteAddress
"<ArrayDBname".THIS[#i].<Component>.<ComponentElement>
SCL:
"<ArrayDBname"."THIS"[#i].<Component>.<ComponentElement>
The following table show the possible absolute addresses of tags in data blocks:
Example
The following examples show the addressing of tags in global data blocks:
Addressing Description
"Motor".Value Symbolic addressing of the "Value" tag in the "Mo-
tor" global data block.
%DB1.DBX1.0 Absolute addressing of the "DBX1.0" tags in the
"DB1" global data block.
#MyDBAny.%DBX30.0 Absolute addressing of the "DBX30.0" tag in the
global data block that is transferred at runtime
at the "MyDBany" parameter.
"MyARRAY_DB".THIS[#MyIndex].My- Addressing an ARRAY data block. The ARRAY index
Component.MyComponentElement is specified with the "MyIndex" tag. The ARRAY el-
ement has two additional substructures: "MyCompo-
nent" and "MyComponentElement".
See also
Using the DB_ANY data type (Page 275)
Addressing structured variables (Page 1459)
Addressing areas of a tag with slice access (Page 1461)
Basics of indirect addressing (Page 1465)
Addressing instance data (Page 1458)
Description
You can address data elements from the interface of the current block. These tags are stored
in the instance data block.
Note
Tags in blocks with optimized access can only be addressed in symbolic form.
To address a tag from the interface of the current block, enter the character # followed by the
symbolic tag name.
You can also access the tags of a multiple instance block. Within the multiple instance block,
also use the character # followed by the tag name to address the data. You access the data
of the multiple instance block from the calling block using #<Multiple
instanceName.TagName>.
Syntax
Use the following syntax for addressing tags in instance data blocks:
#<TagName>
#<Multiple instanceName.TagName>
Examples
The following examples show the addressing of tags in instance data blocks:
Addressing Description
#Value Addressing the "Value" tag in the instance data block.
#On Addressing the "On" tag within the multiple instance block
#Multi.On Addressing the "On" tag of the multiple instance block from the
calling block
See also
Addressing variables in global data blocks (Page 1456)
Addressing structured variables (Page 1459)
Note
Monitoring ARRAY access errors with ENO
The enable output ENO is not set to the signal state FALSE if the ARRAY limits are violated
during execution of an instruction. The only exception is SCL blocks on CPUs of the
S7-300/400 series for which the block property "Check ARRAY limits" is set.
See also:
Array (Page 1941)
Indirect indexing of ARRAY components (Page 1467)
Examples:
The following examples show the addressing of structured data type tags:
Addressing Description
Motor.Value_1x3[2] Addressing of a one-dimensional array
Motor.Value_2x4[2,4] Addressing of a two-dimensional array
Addressing Description
Motor.Value_4x7[2,4,1,3] Addressing of a four-dimensional array
Batch_1.Temperature Addressing of the element "Temperature" in the struc-
ture "Batch_1"
Values.Temperature Addressing of the "Temperature" element in the "Values"
tag, which is based on a PLC data type.
STRING[3] Addresses the third character of the STRING.
WSTRING[3] Addresses the third character of the WSTRING.
See also
Basics of indirect addressing (Page 1465)
Description
You have the option to specifically address areas within declared tags. You can access areas
of the 1-bit, 8-bit, 16-bit, or 32-bit width. The type of access is referred to as "slice access".
Structures, constants and tags overlaying AT cannot be addressed with slice access.
Syntax
The following syntax is used for addressing:
<Tag>.X<Bit number>
<Tag>.B<BYTE number>
<Tag>.W<WORD number>
<Tag>.D<DWORD number>
Part Description
<Tag> Tag that you access. The tag must be of the "Bit string" data type. In the
case of deactivated IEC check, access to tags of the "Integer" data type is
also possible.
X ID for the access width "Bit (1Bit)"
B ID for the access width "Byte (8 Bit)"
W ID for the access width "Word (16 Bit)"
D ID for access width "DWord (32-bit)"
<BIT number> Bit number within <tag> that is accessed. Number 0 accesses the least
significant BIT.
<BYTE number> Byte number within <tag> that is accessed.
The number 0 accesses the least significant BYTE.
Part Description
<WORD number> Word number within <tag> that is accessed.
The number 0 accesses the least significant WORD.
<DWORD number> DWord number within <tag> that is accessed.
The number 0 accesses the least significant DWORD.
Examples
The following examples show the addressing of individual bits:
Addressing Description
"Engine".Motor.X0 "Motor" is a tag of the BYTE, WORD, DWORD or LWORD data
"Engine".Motor.X7 type in the global data block "Engine".
X0 addresses the bit address 0, X7 the bit address 7 with-
in "Motor".
"Engine".Speed.B0 "Speed" is a tag of the WORD, DWORD or LWORD data type in
"Engine".Speed.B1 the global data block "Engine".
B0 addresses the byte address 0, B1 the byte address 1
within "Speed".
"Engine".Fuel.W0 "FUEL" is a tag of the DWORD or LWORD data type in the
"Engine".Fuel.W1 global data block "Engine".
W0 addresses the word address 0, W1 the word address 1
within "Fuel".
"Engine".Data.D0 "Data" is a tag of the LWORD data type in the global data
"Engine".Data.D1 block "Engine".
D0 addresses the double word address 0, D1 the double word
address 1 within "Data".
See also
Addressing with Slice access (Page 250)
Description
To access data areas within a declared tag, you can overlay the declared tags with an
additional declaration. This provides you with the option of addressing an already declared tag
with a different data type. You can, for example, address the individual bits of a tag of WORD
data type with an ARRAY of BOOL.
Rules
The following general rules are valid for tag overlaying:
Overlaying is possible in S7-1200 and S7-1500 in STL, LAD, FBD and GRAPH.
SCL supports overlaying in all CPU families.
Note
S7-1200/1500: Using AT in FCs
The data widths of the overlaying tag and the overlaid tag must be identical for FCs in
S7-1200/1500. If this is not possible in your program, check to see if you can use slice access
instead of the AT construct.
See also: Addressing areas of a tag with slice access (Page 1461)
* Structured data types consist of several data elements, e.g. ARRAY or STRUCT.
Declaration
To overlay a tag, declare an additional tag directly after the tag that is to be overlaid and identify
it with the keyword "AT".
Example
The following figure shows the declaration of an overlaid tag in the interface of a FB:
When a block is called with the shown tag declaration, the "MyByte" tag is assigned. Within
the block there are now two options for interpreting the data:
as a byte
As one-dimensional ARRAY of BOOL
Introduction
Indirect addressing offers the option of addressing operands whose address is not calculated
until during runtime. With indirect addressing, program sections can be executed several times
and a different operand can be used during each run.
Warning
Risk of access errors
Since operands are only calculated during runtime with indirect addressing, there is a risk that
access errors may occur and that the program will operate with incorrect values. In addition,
memory areas may inadvertently be overwritten with incorrect values. The automation system
can then react in unexpected manner.
Therefore, use indirect addressing only with caution.
Indirect addressing
See also
Addressing variables in global data blocks (Page 1456)
POKE: Write memory address (Page 2852)
POKE_BOOL: Write memory bit (Page 2853)
Description
For indirect addressing, a special data format is required that contains the address and possibly
also the range and the data type of an operand. This data format is referred to as pointer. The
following types of pointers are available to you:
POINTER (S7-1500)
ANY (S7-1500, only for blocks with standard access)
VARIANT (S7-1200/1500)
For more information on the pointer data types, refer to "See also".
Note
In SCL the use of the POINTER is restricted. The only option available is to forward it to the
called block.
Example
The following example shows an indirect addressing with an area-internal pointer:
The pointer P#10.0 is transferred to the operand MD20. If the operand MD20 in square brackets
is programmed, this will be replaced in runtime by the address that is contained in the pointer.
See also
Basics of indirect addressing (Page 1465)
Pointer (Page 1946)
Description
For addressing the components of an ARRAY, you can specify tags of the integer data type
as well as constants as the index. Integers with a length of up to 32 bits are allowed here.
When tags are used, the index is calculated during runtime. You can, for example, use a
different index for each cycle in program loops.
Note
When you call a block and transfer an indirectly indexed ARRAY component ("<Data
block>".<ARRAY>["i"]) to it as in/out parameter (InOut), you cannot change the value of the
index tag [i] while the block is being executed. The value is therefore always written back to
the same ARRAY component from which it was read.
Syntax
The following syntax is used for the indirect indexing of a ARRAY:
"<Data block>".<ARRAY>["i"] // one-dimensional ARRAY
"<Data block>".<ARRAY>["i"] // one-dimensional ARRAY of STRUCT
"<Data block>".<ARRAY>["i"] // multidimensional ARRAY
"<Data block>".<ARRAY>["i"] // multidimensional ARRAY of STRUCT
Part Description
Data block Name of the data block in which the ARRAY is located
ARRAY Tag of the ARRAY data type
i, j PLC tags of the integer data type that are used as pointers
a Additional partial tag of the structure
Examples
The following example shows indirect array indexing of an ARRAY component in STL:
Several axes traverse at different angles. The values for axis number and angle are stored in
the two-dimensional ARRAY "control_axis".
You can use the "SEL" instruction to select the components of the "control_axis" ARRAY to
be written at the "#out" output parameter.
Addressing in STL
CALL SEL
value_type:=Int
G :="Select"
IN0 :=#control_axis["Constant_Axis_NoX", #Angle]
IN1 :=#control_axis["Constant_Axis_NoY", #Angle]
OUT :=#out
The following examples are based on SCL and demonstrate indirect indexing of an ARRAY
component. "MOTOR" is a one-dimensional ARRAY_of_INT with three rows. "VALUES" is a
PLC tag of data type "Integer".
The following example shows the indirect indexing of an ARRAY component as an example
of LAD. "ARRAY" is a three-dimensional ARRAY. "Tag_1", " "Tag_2" and ""Tag_3" are PLC
tags of the "Integer" data type. Depending on their values, one of the "ARRAY" components
will be copied to the "MyTarget" tag.
0\'%$55$<>7DJB
7DJB7DJB@ ,1 287 0\7DUJHW
Additional information
For more information on the ARRAY data type, refer to "See also".
See also
Basics of indirect addressing (Page 1465)
Array (Page 1941)
Addressing structured variables (Page 1459)
Description
For addressing the individual characters of a STRING or WSTRING, you can specify constants
and also tags as the index. The tags must be of the Integer data type. When tags are used,
the index is calculated during runtime. You can, for example, use a different index for each
cycle in program loops.
If you transfer a STRING or WSTRING with variable index to an in/out parameter during a
block call, please note that: The index tag [i] is read once at the start of the block call and
cannot be changed by the called block while it is being executed.
Note
Monitoring STRING access in runtime
When a STRING or WSTRING that exceeds the defined length is written in runtime, unwanted
reactions may occur in the program. Violation of the STRING or WSTRING length is monitored
in S7-1200/1500. On read access to the STRING, you receive the character '$00' or '$0000';
write access to the STRING is not executed. If the instruction has the enable output ENO, ENO
is set to the signal state FALSE. The CPU does not change to STOP.
Syntax
The following syntax is used for the indirect indexing of a STRING or WSTRING:
"<Data block>".<STRING>["i"]
"<Data block>".<WSTRING>["i"]
Example
The example below shows indirect indexing of a STRING using SCL as an example. "STRING",
"WSTRING", "CHAR" and "WCHAR" are tags. "Tag_1" is a PLC tag of the "Integer" data type.
Additional information
You can find additional information on the STRING and WSTRING data types under "See also".
See also
STRING (Page 1937)
WSTRING (Page 1939)
Introduction
Two address registers are available for the indirect addressing of operands: address register
1 (AR1), and address register 2 (AR2). The address registers are equal and are 32 bits in
length. You can store area-internal and cross-area pointers in the address registers. To define
the address of an operand, you can call the stored data in the program.
Data is exchanged between the registers and the other available memory areas with the
assistance of load and transfer instructions.
Note
In S7-1500, special rules apply to data exchange via address register and data block register:
The values in the registers do not remain in existence beyond the block limits.
The registers are reset when the language is changed within a block.
You can only reference data in blocks with optimized access if these have the retain setting
"Set in IDB".
It is not possible to reference local data in blocks with optimized access with the help of the
address registers (across areas).
Additional information
For more information on the statements that address registers use and on indirect addressing,
refer to "See also".
See also
Indirect addressing in STL (Page 1471)
Addressing areas of a tag with slice access (Page 1461)
Memory-indirect addressing
In the case of memory-indirect addressing, you store the address in a tag. The tag can be of
WORD or DWORD data type. The tag can be located in the memory areas "Data" (DB or DI),
"Bit memory" (M) or "Temporary local data" (L). In S7-1500, FB parameters can also be used
to store the address. If the tag is located in a data block, it must be a data black with standard
access.
The following example shows applications of memory-indirect addressing:
When you enter register-indirect, area-internal addressing, specify an offset after the
specification of the address register. This offset is added to the contents of the address register
without changing the address register. This offset also has the format of a pointer. The
specification of a pointer is mandatory and must be entered as constant (e.g. P#0.0 or
P#2.0).
The following example shows an application of register-indirect area-internal addressing:
STL Explanation
LAR1 P#10.0 // Load pointer (P#10.0) to address register 1
L IW [AR1, P#2.0] // Increase contents of address register 1 (P#10.0) by offset
P#2.0.
// Load contents of input word IW12 into accumulator 1
L IW [AR1, P#0.0] // Increase contents of address register 1 (P#10.0) by offset
P#0.0.
// Load contents of input word IW10 into accumulator 1
Note
Special features in S7-1500
In S7-1500, special rules apply to data exchange via address register and data block register:
The values in the registers do not remain in existence beyond the block limits. The registers
are also reset when the language is changed within a block.
If you access an operand of the BYTE, WORD or DWORD type using register-indirect
addressing, the address must begin at a byte limit.
Examples:
LAR1 P#0.0
L MW [AR1, P#0.0] // P#0.0 + P#0.0 = P#0.0 - The addressing is allowed, because P#0.0
points to a byte limit.
L MW [AR1, P#2.1] // P#0.0 + P#2.1 = P#2.1 - The addressing is not allowed, because
P#2.1 does not point to a byte limit.
See also
Basics of indirect addressing (Page 1465)
Addressing structured variables (Page 1459)
Basic information about address registers (Page 1470)
EN/ENO mechanism
Introduction
Runtime errors that require a program abort can occur during the processing of instructions.
You can use the EN/ENO mechanism to avoid such program aborts. This mechanism can be
used at two levels:
EN/ENO mechanism for individual instructions
EN/ENO mechanism for block calls
The enable output ENO returns the signal state "1" if one of the following conditions applies:
No error occurred during processing.
The enable output ENO returns signal state "0" if one of the following conditions applies:
The EN input has signal state "0".
An error occurred during processing.
The EN/ENO mechanism is used for the following basic instructions:
Mathematical functions
Move operations
Conversion operations
Word logic operations
Shift + rotate
In LAD and FBD, you can switch the evaluation of the enable output ENO on and off by means
of the shortcut menu specifically for certain instructions.
See also: Example of the simulation of the EN/ENO mechanism in STL (Page 1478)
Note
When you call functions in SCL, you cannot use the release mechanism via EN. Use an IF
statement instead to call functions conditionally.
You can query the error status of the block with the enable output ENO. If the ENO has signal
"1", the block was processed without errors. If the ENO has signal "0", an error occurred during
processing. To query the state of the enable output, insert an additional output parameter with
the name ENO in the parameter list during a block call.
See also: Example of the use of the EN/ENO mechanism in SCL (Page 1477)
See also
Enabling and disabling the EN/ENO mechanism (Page 1608)
Description
The following figure shows an ADD instruction with EN and ENO protective circuit:
$''
,17
7DJ,Q 7DJ2XW
(1 (12 6
7DJB9DOXH ,1
7DJB9DOXH ,1 287 7DJB5HVXOW
After the normally open contact, the RLO contains the previous result of logic operation:
If "TagIn" signal is "0", the addition is not executed. EN and ENO both lead to the signal
state "0".
If "TagIn" signal is "1", EN is also "1" and the addition is executed. If no errors occur during
the processing of the instruction, the output ENO also has the signal state "1" and the output
""TagOut"" is set.
See also
Basics of the EN/ENO mechanism (Page 1473)
ADD: Add (Page 2303)
Description
The following figure shows an ADD instruction with EN and ENO protective circuit:
$''
,17
7DJ,Q (1
7DJB9DOXH ,1 287 7DJB5HVXOW
7DJ2XW
7DJB9DOXH ,1 (12
If "TagIn" signal is "1", EN is also "1" and the addition is executed. If no errors occur during
the processing of the instruction, the output ENO also has the signal state "1" and the output
""TagOut"" is set.
If "TagIn" signal is "0", the addition is not executed. EN and ENO both lead to the signal
state "0".
See also
Basics of the EN/ENO mechanism (Page 1473)
SCL
"MyoutputREAL" :=a/b;
IF ENO
THEN "MyOutputBool":=1;
ELSE "MyOutputBool":=0;
END_IF;
SCL
"MyDB"."MyFB"(EN:="MyTag1">"MyTag2",
in1:="MyInputBool1",
in2:="MyInputBool1",
EN0=>"MyOutputBool");
If MyTag1 is not greater than MyTag2 the block call is not processed. EN and ENO both lead
to the signal state "0".
If MyTag1 is greater than MyTag2, EN has signal "1" and the block call is executed.
If all instructions within MyFB are executed error-free, MyOutputBool has signal "1".
See also
Basics of the EN/ENO mechanism (Page 1473)
Description
The following example shows an program section for adding values with EN and ENO
connected:
STL Description
A"Tag_Input_1" // Query whether the signal state of the operand
is "1" and AND with current RLO
JNBMyLABEL // Evaluation of the EN input
// If RLO="0" jump to jump label "MyLABEL" and
save the current RLO in the BR
// Execute next instruction if RLO="1"
L"Tag_Input_2" // Load first value of addition
L"Tag_Input_3" // Load second value of addition
+I // Add values
T "Tag_Result" // Transfer sum to the operand "Tag_Result"
AN OV // Query if errors occurred
SAVE // Transfer signal state of the RLO to the BR bit
CLR // Reset RLO to "0"
MyLABEL: U BR // Jump label "MyLABEL"
// Query BR and AND with RLO
= "Tag_Output" // Assign signal state of the RLO to the operand
"Tag_Output"
The query of the operand "U" Tag_Input_1"" provides the result of the preceding logic operation
(RLO). The instruction "Jump at RLO = 0 and save RLO (SPBNB)" saves the RLO to the BR.
The instruction "Jump if RLO = 0 and save RL0" also evaluates the RLO and executes one of
the following actions depending on the evaluation:
If the RLO is "0", the processing of the program is continued at the jump label "MyLABEL"
with the query of the BR. The addition is not executed. Assign the current RLO to the
operand "Tag_Output".
If the RLO is "1", the addition is executed. A query of the overflow bit (OV) shows if an error
occurred during the addition. The query result is saved in the BR. The operation "CLR"
resets the RLO to "0". The BR is then queried for "1" and AND'd with the current RLO. The
result is assigned to the operand "Tag_Output". The signal state of the BR and of the
operand "Tag_Output" shows if the addition was carried out with any error
See also
Basics of the EN/ENO mechanism (Page 1473)
Introduction
PLC tag tables contain the definitions of the PLC tags and symbolic constants that are valid
throughout the CPU. A PLC tag table is created automatically for each CPU used in the project.
You can create additional tag tables and use these to sort and group tags and constants.
In the project tree there is a "PLC tags" folder for each CPU of the project. The following tables
are included:
"All tags" table
Standard tag table
Optional: Other user-defined tag tables
All tags
The "All tags" table gives an overview of all PLC tags, user constants and system constants
of the CPU. This table cannot be deleted or moved.
See also
Structure of the PLC tag tables (Page 1480)
Using tags within the program (Page 1447)
Basics of constants (Page 1449)
Introduction
Each PLC tag table contains a tab for tags and a tab for user constants. The default tag table
and the "All tags" table also have a "System constants" tab.
The following table shows the meaning of the individual columns. The number of columns
shown may vary. You can show or hide the columns as required.
Column Description
Symbol you can click on to drag-and-drop a tag to a program for use
as an operand.
Name Unique name for the constants throughout the CPU.
Data type Data type of the tags.
Address Tag address.
Retain Marks the tag as retentive.
The values of retentive tags are retained even after the power supply
is switched off.
Accessible from HMI Shows whether HMI can access this tag during runtime.
Visible in HMI Shows whether the tag is visible by default in the operand selection
of HMI.
Monitor value Current data value in the CPU.
This column only appears if an online connection is established and
you select the "Monitor all" button.
Tag table Shows which tag table includes the tag declaration.
This column is only available in the "All tags" table.
Comment Comment to document the tags.
The following table shows the meaning of the individual columns. You can show or hide the
columns as required.
Column Description
Symbol you can click to move a tag into a network via a drag-and-
drop operation for use as an operand.
Name Unique name for the constants throughout the CPU.
Data type Data type of the constants
Value Value of the constants
Tag table Shows which tag table includes the constant declaration.
This column is only available in the "All tags" table.
Comment Comments to document the tags.
See also
Hardware data types (Page 1957)
Using tags within the program (Page 1447)
Basics of constants (Page 1449)
Overview of PLC tag tables (Page 1479)
Show and hide table columns (Page 1502)
Editing tables (Page 347)
Permissible characters
The following rules apply to the use of names for PLC tags:
Letters, numbers, special characters are permitted.
Quotation marks are not permitted.
See also
Using tags within the program (Page 1447)
Permissible addresses and data types of PLC tags (Page 1482)
Keywords (Page 1442)
Operand areas
The following table shows the possible operand areas. The available data types depend on
the CPU you use:
Addresses
The following table shows the possible addresses of tags:
Mnemonics used
The addresses that you enter in the PLC tag table are automatically adapted to the set
mnemonics.
See also
Setting the mnemonics (Page 1539)
Using tags within the program (Page 1447)
Valid names of PLC tags (Page 1481)
Overview of the valid data types (Page 1908)
Requirement
The project view is open.
Procedure
To created a new PLC tag table, follow these steps:
1. Open the "PLC tags" folder under the CPU in the project tree.
2. Double-click the "Add new tag table" entry.
A new PLC tag table with the default name "TagTable_x" is created.
3. Select the PLC tag table in the project tree.
4. Select the "Rename" command in the shortcut menu.
5. Type in a name that is unique throughout the CPU.
Result
A new PLC tag table is created. You can now declare tag and constants in this table.
See also
Overview of PLC tag tables (Page 1479)
Structure of the PLC tag tables (Page 1480)
Requirement
Multiple user-defined tag tables are contained in the "PLC tags" folder of the CPU.
Procedure
To gather multiple PLC tag tables into a group, follow these steps:
1. Select the "PLC tags" folder under the CPU in the project tree.
2. Select the "Insert > Group" menu command.
A new group with the standard name "Group_x" is inserted.
3. Select the newly inserted group in the project tree.
4. Select the "Rename" command in the shortcut menu.
5. Assign the new group a unique name throughout the CPU.
6. Drag to the new group the tables you want to group together.
Result
The tag tables are gathered in the new group.
See also
Overview of PLC tag tables (Page 1479)
Structure of the PLC tag tables (Page 1480)
Procedure
To open the PLC tag table in a CPU, proceed as follows:
1. Open the "PLC tags" folder under the CPU in the project tree.
2. Double-click the PLC tag table in the folder.
3. Select the desired tab in the upper corner.
Result
The PLC tag table associated with the CPU opens. You can declare the required tags and
constants.
See also
Overview of PLC tag tables (Page 1479)
Structure of the PLC tag tables (Page 1480)
Requirements
The "Tags" tab of the PLC tag table is open.
Procedure
To define PLC tags, follow these steps:
1. Enter a tag name in the "Name" column.
2. Enter the required data type in the "Data type" column. You will be supported by
autocompletion during input.
An address corresponding to the data type is automatically appended.
3. Optional: Click on the arrow key in the "Address" column and enter an operand identifier,
an operand type, an address and a bit number in the dialog which then opens.
4. Optional: Enter a comment in the "Comments" column.
5. Repeat steps 1 to 4 for all the tags you require.
See also: Permissible addresses and data types of PLC tags (Page 1482)
Syntax check
A syntax check is performed automatically after each entry, and any errors found are displayed
in red. You do not have to correct these errors immediately - you can continue editing and
make any corrections later. As long as the tag declaration contains syntax errors and the tag
is used in the program, you will not be able to compile the program.
See also
Valid names of PLC tags (Page 1481)
Declaring PLC tags in the program editor (Page 1487)
Structure of the PLC tag tables (Page 1480)
Editing tables (Page 347)
Requirement
The program editor is open.
Procedure
To declare operands as global PLC tags, follow these steps:
1. Insert an instruction in your program.
The "<???>", "<??.?>" or "..." strings represent operand placeholders.
2. Replace an operand placeholder with the name of the PLC tag to be created.
3. Select the tag name.
If you want to declare multiple PLC tags, select the names of all the tags to be declared.
4. Select the "Define tag" command in the shortcut menu.
The "Define tag" dialog box opens. This dialog displays a declaration table in which the
name of the tag is already entered.
5. Click the arrow key in the "Section" column and select one of the following entries:
Global Memory
Global Input
Global Output
6. In the other columns, enter the address, data type, and comments.
See also: Permissible addresses and data types of PLC tags (Page 1482)
7. If the CPU contains multiple PLC tag tables, you can use an entry in the "PLC tag table"
column to indicate in which table the tag is to be inserted. If you make no entry in the column,
the new tag will be inserted in the default tag table.
8. Click the "Define" button to complete your entry.
Result
The tag declaration is written to the PLC tag table and is valid for all blocks in the CPU.
See also
Valid names of PLC tags (Page 1481)
Editing tables (Page 347)
Declaring tags in the PLC tag table (Page 1487)
To avoid data loss during power failure, you can save specific PLC tags to this memory area.
You specify the retain setting of PLC tags in the PLC tag table.
Depending on the CPU family, the retentive memory area can accommodate various type of
PLC tags. The following table provides an overview of the options of the various CPUs:
CPU type Retentive bit memories Retentive SIMATIC timers Retentive SIMATIC counters
S7-300/400 series - -
S7-1200 series - -
S7-1500 series
See also
Setting the retentive behavior of PLC tags (Page 1489)
Introduction
In the PLC tag table you can specify the width of the retentive memory area for PLC tags. All
tags with addresses in this memory area are then designated as retentive. You can recognize
the retentivity setting of a tag by the check mark set in the "Retain" column of the PLC tag
table.
Requirement
The "PLC tags" tab of the PLC tag table is open.
Procedure
To define the width of the retentive memory area for PLC tags, follow these steps:
1. On the toolbar, click the "Retain" button.
The "Retain memory" dialog will open.
2. Specify the width of the retentive memory area by entering the number of retentive bytes,
timers or counters in the input field.
3. Click the "OK" button.
Result
The width if the retentive memory area is defined. In the "Retain" column of the tag table a
check mark is automatically set for all tags that are located within the retentive memory area.
See also
Retentive behavior of PLC tags (Page 1488)
Editing tables (Page 347)
Principle of operation
To create a structured PLC tag, you initially define a PLC data type (UDT). In it you declare
the necessary data elements and specify their names and data types.
Then, you switch to the PLC tag table and specify the higher-level PLC tag there. As a data
type for the tag, you select your PLC data types. The system now reserves a certain number
of input or output addresses starting from the start address of the higher-level tag. The number
of reserved addresses depends on the length of your PLC data type.
If you call a block that requires the reserved inputs or outputs for program execution, you
transfer the higher-level tag as a block parameter.
You can address the individual PLC tags like structure elements in the program code.
A detailed description of the individual handling steps can be found in the following chapters.
Application example
You can use structured PLC tags in order to group the inputs or outputs of a function module.
The following figure shows the schematic representation of a motor: A component was created
in the "Datatype_Motor" PLC data type for each of the three inputs.
The memory areas of the declared tags must not overlap. In the example, you see that the
"Speed" component has the data type "Integer" and therefore must start at a word address.
For this reason, the first input word has been filled with the "Dummy" fill tag. This means that
"Speed" is located on the second input word.
0RWRU
2Q
2II
6SHHG
The following figure shows the higher-level "Motor" PLC tag that is based on the "Data
type_Motor" data type. With the declaration of "Motor", the addresses IW0 and IW1 are
reserved on the input module.
The following figure shows the transfer of the "Motor" PLC tag as an input parameter of the
"Motor_Control" block.
You can address the individual components of the tag in the "Motor_Control" block.
Addressing Description
"Motor" Addressing the higher-level PLC tag.
"Motor".On Addressing a component of a structured PLC tag.
"Motor".On:P Addressing an I/O input or output (PI or PQ).
Do not group inputs or outputs from different modules in a PLC data type because it is not
guaranteed that the process images of the modules are updated synchronously.
In the lower-level PLC data types, all data types are permitted except for "STRING" and
"WSTRING".
See also
Creating structured PLC tags (Page 1492)
Rules
Note the following rules when creating structured PLC tags:
Use separate PLC data types for the "Inputs" and "Outputs" operand areas.
Structured tags are not permitted in the bit memory address area.
Do not group inputs or outputs from different modules in a PLC data type because it is not
guaranteed that the process images of the modules are updated synchronously.
Procedure
To create a structured PLC tag, follow these steps:
1. Double-click the "Add new data type" command in the "PLC data types" folder in the project
tree.
A new declaration table for creating a PLC data type will be created and opened.
2. Declare all the necessary components in the PLC type. All data types except for "STRING"
and "WSTRING" are permitted.
3. Select the PLC data type in the project tree and select the "Compile > Software (only
changes)" command from the shortcut menu.
The PLC data type is compiled and can then be used in the PLC tag table.
Even when you make changes to existing PLC data types, you must recompile the program.
This updates all locations of use of the PLC data type.
4. Open a PLC tag table within the same CPU.
5. Declare a new tag or select an existing tag.
6. In the "Data type" column, select the PLC data type and assign it to the PLC tag.
The PLC tag receives the structure of the PLC data type. A suitable address is assigned
automatically. Structured PLC tags always start at word addresses.
The highest structure element is displayed without its subelements in the table.
Note
Assignment rules and default values
For the declaration of the PLC data type, note that the memory areas of the individual tags
must not overlap. For example, tags of data type "Integer" must start at a word limit. If
necessary, insert "fill tags" to prevent overlaps.
See also: Permissible addresses and data types of PLC tags (Page 1482)
It is not possible to assign default values for the individual components. Values that you
enter in the "Default value" column are not evaluated. Tags of data types "DT" and "DTL"
may therefore contain invalid values.
See also
Other useful information regarding structured PLC tags (Page 1490)
Permitted characters
Names of global constants may consist of the following characters:
Letters, numbers, special characters are permitted.
Quotation marks are not permitted.
Permitted values
You can select any value from the value range of the specified data type as constant value.
For information on the value ranges, refer to the "Data types" chapter.
See also
Basics of constants (Page 1449)
Declaring global constants (Page 1495)
Definition
System constants are global constants, unique throughout the CPU, that are required and
automatically created by the system. System constants can, for example, be used to address
and identify hardware objects.
Rules
System constants are assigned automatically when components are inserted in the device or
network view, and entered in the default tag table ("System constants" tab). A system constant
is created for each module, but also for each submodule. An integrated counter, for example,
therefore receives a system constant as well. System constants consist of a symbolic name
and a numeric HW identifier and cannot be changed.
Example
A system constant with the name "Local~PROFINET_interface_1~Port_1" designates
Port 1 of the PROFINET interface 1 of the local CPU.
See also:
Auto-Hotspot
Auto-Hotspot
Instructions for address conversion (Page 3358)
Introduction
You declare constants in the "User constants" tab of a PLC tag table. During declaration you
have to to enter a symbolic name, a data type and a fixed value for each constant. You can
select any value from the value range of the specified data type as constant value. For
information on the value ranges, refer to the "Data types" chapter.
See also: Auto-Hotspot
Procedure
To declare constants, follow these steps:
1. Open a PLC tag table.
2. Open the "User constants" tab.
The constants table opens.
3. Enter a constant name in the "Name" column.
4. Enter the required data type in the "Data type" column. You will be supported by
autocompletion during input.
5. Enter a constant value in the "Value" column; this constant value must be valid for the
selected data type.
6. If you want, enter comments on the constants in the "Comments" column. The entry of a
comment is optional.
7. If you want to declare additional constants, place the cursor in the next row and repeat
steps 3 to 6.
Syntax check
A syntax check is performed automatically after each entry, and any errors found are displayed
in red. You do not have to correct these errors immediately - you can continue editing and
make any corrections later. As long as the tag declaration contains syntax errors and the
constant is used in the program, you will not be able to compile the program.
See also
Opening the PLC tag table (Page 1486)
Inserting a table row in the PLC tag table (Page 1499)
Structure of the PLC tag tables (Page 1480)
Rules for global user constants (Page 1493)
Editing tables (Page 347)
Overview
The following table provides an overview of the properties of PLC tags. The display of
properties may vary depending on the CPU type.
See also
Editing the properties of PLC tags (Page 1496)
See also
Properties of PLC tags (Page 1496)
Overview
The following table gives an overview of the properties of constants:
See also
Editing tables (Page 347)
Requirement
An online connection to the CPU exists or is possible.
Procedure
To monitor the data values, proceed as follows:
1. Open a PLC tag table.
2. Start monitoring by clicking the "Monitor all" button.
If no online connection to the CPU exists, this is established.
Monitoring is started with the trigger setting "Permanent".
The additional "Monitor value" column is displayed in the table. This shows the current
data values.
The symbol for the forcing of tags is displayed if a tag is currently being forced.
3. End the monitoring by clicking the "Monitor all" button again.
Note
Editing PLC tags during the monitoring of tags
If the editing of tags is started and the PLC tag table is edited, for example by adding new tags,
the monitoring is re-started after editing is complete.
Note
You also have the option of copying PLC tags to a monitor or force table so that you can
monitor, control or force them in the table.
See also
Structure of the PLC tag tables (Page 1480)
Introduction to testing with the watch table (Page 1854)
Introduction for testing with the force table (Page 1881)
Copying entries in the PLC tag table (Page 1499)
Procedure
Proceed as follows to insert a row above the selected row:
1. Select the row in front of which you want to insert a new row.
2. Click the "Insert row" button on the toolbar of the table.
Result
A new row is inserted above the selected row.
See also
Editing tables (Page 347)
Procedure
To copy a tag, follow these steps:
1. Select the tags you want to copy.
You can also select several tags by clicking on them one after the other while holding down
the <Ctrl> key or by pressing and holding down <Shift> and clicking on the first and last
tag.
2. Select "Copy" in the shortcut menu.
3. Position the insertion pointer at the location where you want to insert the tags.
4. Select "Paste" in the shortcut menu.
Or
1. Select the tag.
2. Hold down the left mouse button.
3. At the same time, press <Ctrl>.
4. Drag the tag to the destination.
Result
The tag is copied to the destination.
If there is a name conflict, a number is automatically appended to the tag name. For
example, "Tag" becomes "Tag(1)".
All other properties of the tag remain unchanged.
See also
Editing tables (Page 347)
Procedure
Follow the steps below to delete elements:
1. Select the row with the element to be deleted. You can also select several rows by clicking
on them one after the other while holding down the <Ctrl> key or by pressing and holding
down <Shift> and clicking on the first and last row.
2. Select the "Delete" command in the shortcut menu.
See also
Editing tables (Page 347)
Procedure
To sort the table rows, follow these steps:
1. Select the column by which you want to sort.
2. Click the column header.
The column will be sorted in order of increasing values.
An up arrow shows the sort sequence.
3. In order to change the sort sequence, click the arrow.
The column will be sorted in order of decreasing values. A down arrow shows the sort
sequence.
4. To restore the original sequence, click a third time on the column header.
See also
Editing tables (Page 347)
Procedure
To automatically fill in successive cells, follow these steps:
1. Select the cells to be loaded.
2. Click the "Fill" symbol in the bottom right corner of the cell.
The mouse pointer is transformed into a crosshair.
3. Keep the mouse button pressed and drag the mouse pointer downwards over the cells that
you want to fill in automatically.
4. Release the mouse button.
The cells are filled in automatically. If entries are already present in the cells that are to be
automatically updated, a dialog appears in which you can indicate whether you want to
overwrite the existing entries or whether you want to insert new rows for the new tags.
See also
Editing tables (Page 347)
Procedure
To show or hide table columns, follow these steps:
1. Click a column header.
2. Select the "Show/Hide" command in the shortcut menu.
The selection of available columns is displayed.
3. To show a column, select the column's check box.
4. To hide a column, clear the column's check box.
5. To hide or show several columns, click "More" and activate or deactivate the check box of
the corresponding columns in the "Show/Hide" dialog.
See also
Editing tables (Page 347)
Introduction
You can export PLC tag tables to a standardized XLSX format for editing with external table
editors. Similarly, you can import PLC tag tables created with external table editors to the TIA
Portal.
See also
Format of the export file (Page 1503)
Exporting PLC tags (Page 1503)
Importing PLC tags (Page 1504)
Introduction
During the export of PLC tag tables, a standardized XSLX format will be generated that you
can edit with external table editors.
This format is also expected during the import of tables.
Element Description
Name Name of the tags
Path Group and name of the PLC tag table
Data Type The notation of the data type corresponds to the
notation used in the PLC tag table.
Logical Address The address can be specified with German or in
ternational mnemonics.
Comment Free-form comments
Hmi Visible The value TRUE or FALSE is expected.
Hmi Accessible The value TRUE or FALSE is expected.
See also
Basics for importing and exporting (Page 1502)
Exporting PLC tags (Page 1503)
Importing PLC tags (Page 1504)
Requirement
A PLC tag table is open.
Procedure
To export PLC tags and constants, follow these steps:
1. In the PLC tag table, click the "Export" button.
The "Export to Excel" dialog opens.
2. Select the path to which you want to save the export file.
3. Select whether to export tags and/or constants.
4. Click the "OK" button.
Result
The export file will be generated. Errors and warnings generated during export are indicated
in the "Info" tab of the Inspector window.
See also
Basics for importing and exporting (Page 1502)
Format of the export file (Page 1503)
Importing PLC tags (Page 1504)
Requirement
A table exists and it conforms to format specifications.
Procedure
To import a PLC tag table, follow these steps:
1. Open the "All tags" table.
2. Click the "Import" button.
The "Import from Excel" dialog opens.
3. Select whether to import PLC tags and/or constants.
4. Select the table you want to import.
5. Click the "OK" button.
Result
The PLC tag table will be imported.
Errors and warnings generated during export are indicated in the "Info" tab of the Inspector
window.
See also
Basics for importing and exporting (Page 1502)
Format of the export file (Page 1503)
Exporting PLC tags (Page 1503)
Requirement
A PLC tag table and an external editor are opened.
Procedure
To export and import individual PLC tags, follow these steps:
1. Select one or more PLC tags.
2. Select "Copy" in the shortcut menu.
3. Switch to the external editor and paste the copied tags.
4. Edit the tags as required.
5. Copy the tags in the external editor.
6. Switch back to the PLC tag table.
7. Select "Paste" in the shortcut menu.
Note
You also have the option of export or importing PLC tags as mass data.
See also: Auto-Hotspot
Block folder
Function
You can find a "Program blocks" folder in the project tree, in which you can create and manage
the following blocks:
Organization blocks (OB)
Function blocks (FB)
Functions (FCs)
Data blocks (DB)
A "System blocks" subfolder containing another subfolder, "Program resources", is also
created in the "Program blocks" folder the first time you drag an instruction to your program
which is an internal system function block. The instance data block of the internal system
function block is also pasted to the "Program resources" folder. You can move or copy such
instance data blocks from the "Program resources" folder to any other folder and rename or
delete them. You can also move your blocks into the "Program resources" folder. Blocks in
the "Program resources" folder that are not required to run the user program are removed
during the next compilation. If the "Program resources" folder contains no more blocks then it
is also deleted with the "System blocks" folder.
A program cycle OB is automatically generated for each device and inserted in the "Program
blocks" folder.
See also
Creating functions and function blocks (Page 1507)
Creating data blocks (Page 1508)
Creating organization blocks (Page 1506)
Using blocks from libraries (Page 1510)
Requirement
The "Program blocks" folder in the project tree is open.
Procedure
To create an organization block, follow these steps:
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Organization block (OB)" button.
3. Select the type of new organization block.
4. Enter a name for the new organization block.
5. Enter the properties of the new organization block.
6. To enter additional properties for the new organization block, click "Additional information".
An area with further input fields is displayed.
7. Enter all the properties you require.
8. Activate the "Add new and open" check box if the organization block does not open as soon
as it is created.
9. Confirm your entries with "OK".
Result
The new organization block is created. You can find the organization block in the project tree
in the "Program blocks" folder. You can assign additional parameters to some organization
blocks in the inspector window or device view after they have been created. The organization
block description will state whether the newly created organization block has additional
parameters.
See also
Organization blocks (OB) (Page 1414)
Block folder (Page 1506)
Creating functions and function blocks (Page 1507)
Creating data blocks (Page 1508)
Using blocks from libraries (Page 1510)
Entering a block title (Page 1515)
Entering a block comment (Page 1516)
Requirement
The "Program blocks" folder in the project tree is open.
Procedure
To create a function (FC) or a function block (FB), follow these steps:
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Function block (FB)" or "Function (FC)" button.
3. Enter a name for the new block.
4. Enter the properties of the new block.
5. To enter additional properties for the new block, click "Additional information".
An area with further input fields is displayed.
6. Enter all the properties you require.
7. Activate the "Add new and open" check box if the block does not open as soon as it is
created.
8. Confirm your entries with "OK".
Result
The new block is created. You can find the block in the project tree in the "Program blocks"
folder.
See also
Function blocks (FB) (Page 1415)
Functions (FCs) (Page 1414)
Basics of block access (Page 1419)
Block folder (Page 1506)
Creating organization blocks (Page 1506)
Creating data blocks (Page 1508)
Using blocks from libraries (Page 1510)
Entering a block title (Page 1515)
Entering a block comment (Page 1516)
Requirement
The "Program blocks" folder in the project tree is open.
Procedure
To create a data block, follow these steps:
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Data block (DB)" button.
3. Select the type of the data block. You have the following options available to you:
To create a global data block, select the list entry "Global DB".
To create an ARRAY data block, select the "ARRAY DB" entry in the list.
To create an instance data block, select the function block to which you want to assign
the instance data block from the list. The list contains only the function blocks that were
previously created for the CPU.
To create a data block based on a PLC data type, select the PLC data type from the
list. The list contains only the PLC data types that were previously created for the CPU.
To create a data block based on a system data type, select the system data type from
the list. The list contains only those system data types that have already been inserted
to program blocks in the CPU.
4. Enter a name for the data block.
5. Enter the properties of the new data block.
6. If you have selected an ARRAY DB as the data block type, enter the ARRAY data type and
the high limit for the ARRAY.
You can change the high limit for the ARRAY at any time in the property window of the
created block. The ARRAY data type cannot be changed subsequently.
7. To enter additional properties of the new data block, click "Additional information".
An area with further input fields is displayed.
8. Enter all the properties you require.
9. Activate the "Add new and open" check box if the block does not open as soon as it is
created.
10.Confirm your entry with "OK".
Result
The new data block is created. You can find the data block in the project tree in the "Program
blocks" folder.
See also
Global data blocks (DB) (Page 1416)
Instance data blocks (Page 1417)
Block folder (Page 1506)
Creating organization blocks (Page 1506)
Creating functions and function blocks (Page 1507)
Requirement
The "Libraries" task card is displayed.
No write protection is set for global libraries.
Note
If you derive an instance from a type in a global library, the type is also inserted into the project
library. The instance is then only linked to the type in the project library.
See also
Using libraries (Page 470)
Function
You can also create new blocks by copying existing blocks and pasting the copy. Note the
following principles when copying to CPUs of the same device family:
You can copy organization blocks (OBs), functions (FCs), function blocks (FBs), and global
data blocks (DBs) without restriction.
You can copy instance data blocks only for the same function block, since the assignment
to the function block cannot be changed afterwards. However, the assignment is canceled
if you copy the instance data block to a different CPU. If a function block with the same
name exists there, the instance data block will be assigned to this function block. If you
copy the instance data block together with the function block into the other CPU, the
instance data block is assigned to the copy of the function block.
The various device families sometimes support different blocks, especially in the case of
organization blocks. However, function blocks and functions can also be programmed on the
various devices with different access types. Therefore, not all blocks are supported on all
devices. Note the following principles when copying to a different device family:
Copying to an S7-1200 CPU:
Organization blocks with "Optimized" access type can be copied to an S7-1200. If the
copied OB type is supported by the S7-1200 CPU, the copied OB retains the properties
of its event. You must, however, compile it again.
Although organization blocks with the "Standard" access type can be copied to an
S7-1200, they are not supported by the CPU.
Function blocks (FBs), functions (FCs) and global data blocks (DBs) with "Optimized"
access type can be copied to an S7-1200. However, they must be recompiled after this.
Although function blocks (FBs), functions (FCs) and global data blocks (DBs) with
"Standard" access type can be copied to an S7-1200, they are not supported by the
CPU.
Instance data blocks: If there is a function block in the target CPU with the name that
was assigned to the instance data block in the source CPU, the instance data block is
assigned to the function block in the target CPU. If you copy the instance data block
together with the function block to which it was assigned in the source CPU into the
target CPU, the instance data block is assigned to the copy of the function block.
Copying to an S7-1500 CPU:
Organization blocks with "Optimized" access type can be copied to an S7-1500. If the
copied OB type is supported by the S7-1500 CPU, the copied OB retains the properties
of its event. You must, however, compile it again. OB types that are not supported
receive a no parking symbol.
Organization blocks with "Standard" access type can be copied to an S7-1500. If the
OB derives from an S7-300/400 CPU, it receives the standard event of the
corresponding OB type. If the OB derives from an S7-1200/1500 CPU, it receives the
properties of its event. However, it must be compiled again.
Function blocks (FBs), functions (FCs) and global data blocks (DBs) with "Optimized"
access type can be copied to an S7-1500. However, they must be recompiled after this.
Although function blocks (FBs), functions (FCs) and global data blocks (DBs) with
"Standard" access type can be copied to an S7-1500, they are not supported by the
CPU.
Instance data blocks: If there is a function block in the target CPU with the name that
was assigned to the instance data block in the source CPU, the instance data block is
assigned to the function block in the target CPU. If you copy the instance data block
together with the function block to which it was assigned in the source CPU into the
target CPU, the instance data block is assigned to the copy of the function block.
Copying to S7-300/400 CPUs:
Organization blocks can be copied as required between S7-300 and S7-400.
Although organization blocks from S7-1200/1500 CPUs can be copied to S7-300/400
CPUs, they are not supported by the target CPU.
Function blocks (FBs), functions (FCs) and global data blocks (DBs) can be copied as
required between S7-300 and S7-400.
Although function blocks (FBs), functions (FCs) and global data blocks (DBs) can be
copied from S7-1200/1500 CPUs to S7-300/400 CPUs, they are not supported by the
target CPU.
Instance data blocks: If there is a function block in the target CPU with the name that
was assigned to the instance data block in the source CPU, the instance data block is
assigned to the function block in the target CPU. If you copy the instance data block
together with the function block to which it was assigned in the source CPU into the
target CPU, the instance data block is assigned to the copy of the function block.
In the project tree, blocks that are not supported are indicated by the no parking symbol. Blocks
with a no parking symbol cannot be edited, but only used again as copy source.
Note
When blocks are copied between different device families, it is possible that the copied block
needs to be recompiled. This applies also to the coping of blocks between CPUs and software
controllers. If the block has know-how protection, re-compilation is only possible with the
correct password.
Copying data
With paste, all the block data is copied and forwarded to the copy. This data includes:
Block interface tags
All networks
Comments in all existing compilations
Messages defined in the block
The entire program code of the copied block including the call instructions contained in the
block.
However, called blocks and their associated instance data blocks are not copied.
Note
Number conflicts
Number conflicts may occur, if the pasted block has the same block number as an existing
block. The block number is not automatically changed during pasting. This double number
may have an effect on block calls. When you copy blocks you should therefore check the block
number carefully and correct duplicate block numbers manually or using the block properties.
Duplicate block numbers lead to a compilation error.
See also
Copying blocks (Page 1514)
Pasting blocks (Page 1514)
Copying blocks
Requirement
The "Program blocks" folder is opened in the project tree.
Procedure
To copy a block, follow these steps:
1. Right-click the block that you want to copy.
2. Select "Copy" in the shortcut menu.
Result
A copy of the block is now on the clipboard and can be pasted either into the same CPU or
into another one.
See also
Basics of copying and pasting blocks (Page 1511)
Pasting blocks (Page 1514)
Pasting blocks
Requirement
You have copied a block.
Procedure
To paste a copied block and its data into a CPU, follow these steps:
1. In the project tree, open the folder structure for the CPU into which you want to paste the
copied block.
Note
Please note that you can only paste the copied block into a CPU which supports the block
programming language and type.
See also
Basics of copying and pasting blocks (Page 1511)
Copying blocks (Page 1514)
Requirement
A code block is available.
See also
Creating organization blocks (Page 1506)
Creating functions and function blocks (Page 1507)
Entering a block comment (Page 1516)
Requirement
A code block is available.
See also
Creating organization blocks (Page 1506)
Creating functions and function blocks (Page 1507)
Entering a block title (Page 1515)
Block properties
Each block has certain properties, which you can display and edit. These properties are used
amongst other things to:
Identify the block
Display the memory requirements and the compilation status of the block
Display the time stamp
Display the reference information
Specify the access protection
See also
Overview of block properties (Page 1518)
Block time stamps (Page 1520)
Displaying and editing block properties (Page 1523)
Setting the mnemonics (Page 1539)
Overview
The properties of the blocks are block and CPU-specific. Not all properties are therefore
available for all blocks or in all CPU families. The following table gives an overview of block
properties:
See also
Basics of block properties (Page 1517)
Block time stamps (Page 1520)
Displaying and editing block properties (Page 1523)
Basics of block access (Page 1419)
Introduction
Blocks receive a number of different time stamps which show you when the block was created
and when it was last changed. These time stamps are also used for automatic consistency
checks before compilation.
See also
Basics of block properties (Page 1517)
Overview of block properties (Page 1518)
Result
The properties of the block will be changed. The changes are not saved until the project is
saved.
See also
Basics of block properties (Page 1517)
Overview of block properties (Page 1518)
Block time stamps (Page 1520)
Opening blocks
You can open both the blocks in the project (offline blocks) and also the blocks in the device
(online blocks).
To open an offline block, you have the following options:
Open offline block directly
You can open a block directly if the corresponding block folder is open in the project tree
or in the overview window.
Find and open offline block
You can look for blocks within a project, a device or the "Program blocks" folder and then
open them.
Note the following special features when opening online blocks:
You cannot edit online blocks.
It is possible that another user can carry out a loading process on the selected CPU through
joint parallel working on a CPU. Consequently, it can happen that the online block that you
have open is deleted by the loading process if the block only exists in the device. In this
case, the online block is closed and a message is displayed in the Inspector window.
See also
Saving blocks (Page 1525)
Closing blocks (Page 1526)
Renaming blocks (Page 1526)
Deleting blocks offline (Page 1527)
Deleting blocks online (Page 1527)
Opening know-how protected blocks (Page 1806)
Saving blocks
Blocks are always saved together with the project. Faulty blocks can also be saved. This allows
the error to be resolved at a convenient time.
Procedure
To save a block, follow these steps:
1. Select the "Save" or "Save as" command in the "Project" menu.
See also: Saving projects (Page 383)
See also
Opening blocks (Page 1524)
Closing blocks (Page 1526)
Renaming blocks (Page 1526)
Deleting blocks offline (Page 1527)
Deleting blocks online (Page 1527)
Closing blocks
Procedure
To close a block, follow these steps:
1. Click the "Close" button in the title bar of the program editor.
Note
Note that the block will not be saved on closing.
See also
Opening blocks (Page 1524)
Saving blocks (Page 1525)
Renaming blocks (Page 1526)
Deleting blocks offline (Page 1527)
Deleting blocks online (Page 1527)
Renaming blocks
Requirement
The "Program blocks" folder is opened in the project tree.
Procedure
To change the name of a block, follow these steps:
1. Right-click the block that you want to rename.
2. Select the "Rename" command in the shortcut menu.
The block name in the project tree changes to an input field.
3. Input the new name for the block.
4. Confirm your entry with the Enter key.
Result
The name of the block is now changed at all points of use in the program.
See also
Opening blocks (Page 1524)
Saving blocks (Page 1525)
Closing blocks (Page 1526)
Deleting blocks offline (Page 1527)
Deleting blocks online (Page 1527)
Requirement
The "Program blocks" folder opens in the project tree.
Procedure
To delete a block that exists offline, proceed as follows:
1. In the project tree in the "Program blocks" folder, right-click on the block that you want to
delete.
2. Select the "Delete" command in the shortcut menu.
3. Confirm the safety prompt with "Yes".
The block is deleted offline from the project.
Note
If you are deleting organization blocks, note that events may be assigned to these blocks. If
you delete such organization block the program cannot respond to parameterized events.
See also
Opening blocks (Page 1524)
Saving blocks (Page 1525)
Closing blocks (Page 1526)
Renaming blocks (Page 1526)
Deleting blocks online (Page 1527)
Requirement
The "Program blocks" folder in the project tree is open.
Procedure
To delete a block that exists online, follow these steps:
1. In the "Program blocks" folder in the project tree, right-click on the block that you wish to
delete from the device.
2. Select the "Delete" command from the shortcut menu.
The "Delete" dialog opens.
3. Select the "Delete from device" check box.
4. Click "Yes".
The block will be deleted from the device online.
See also
Opening blocks (Page 1524)
Saving blocks (Page 1525)
Closing blocks (Page 1526)
Renaming blocks (Page 1526)
Deleting blocks offline (Page 1527)
See also
CPU data blocks (Page 1418)
2
5
3
6
Toolbar
Block interface
"Favorites" pane in the "Instructions" task card and favorites in the program editor
Programming window
"Instructions" task card
"Testing" task card
Toolbar
The toolbar allows you to access the principal functions of the program editor, such as:
Show and hide absolute operands
Showing and hiding favorites
Skip to syntax errors
Block interface
The block interface contains the declarations for local tags used solely within the block. The
sections available depend on the block type.
Favorites
You can save frequently used instructions as favorites. These favorites are then displayed in
the "Instructions" task card and the "Favorites" pane. You can also display favorites in the
program editor using the program editor toolbar. This allows you to access your favorites even
when the "Instructions" task card is not visible.
Programming window
The programming window is the work area of the program editor. You can enter the program
code in this window. The appearance and functionality of the program window can vary
depending on the programming language used.
See also
Layout of the block interface (Page 1551)
Enlarging the programming window (Page 1537)
Monitor program
See also
Keyboard operation in the TIA Portal (Page 339)
Using project-related functions (Page 341)
Arranging windows (Page 341)
Editing tables (Page 347)
Text editing (Page 346)
Introduction
The programming window is relatively small when all components of the application are shown.
If the program code is large, you may find you have to rearrange the work area constantly. To
avoid this problem, you can hide or minimize the display of the following components of the
application and of the program editor:
Project tree
Task cards
Block interface
Favorites
Comments
Networks
Note
You can also use the "Reduce automatically" option for the task cards, project tree, and
Inspector window. These windows will then be minimized automatically when you do not need
them.
See also: Maximizing and minimizing the work area
Note
The comments available can vary depending on the programming language used.
Note
Networks are not used in every programming language.
See also
Overview of the program editor (Page 1529)
Maximizing and minimizing the work area (Page 318)
Procedure
To set the mnemonics, follow these steps:
1. Select the "Settings" command in the "Options" menu.
The "Settings" window is displayed in the work area.
2. Select the "General" group in the area navigation.
3. In the "General settings" group, select the mnemonics that you want to use.
The mnemonics is changed in all blocks.
Requirement
The program editor is open.
Procedure
To change the representation of the operands, follow these steps:
1. Click the "Absolute/symbolic operands" button in the program editor toolbar.
Each time you click the button, the representation and the symbol on the button change.
Or:
1. Click the small arrow next to the "Absolute/symbolic operands" button in the program editor
toolbar.
A drop-down list is displayed.
2. Select the required representation from the drop-down list.
The symbol on the button changes.
See also
Basic information about operands (Page 1441)
Find instructions
You have the option of finding specific instructions in the "Instructions" task card and then
inserting them in your program. Note the following rules when entering search terms:
No distinction is made between upper and lower case text.
The search function considers parts of a search term.
You cannot use placeholders, such as "*" and "?".
If an instruction name includes underscores, the instruction is found even if you do not enter
the underscore.
The text in the columns "Name" and "Description" are taken into consideration in the search.
Requirement
A block is open.
Die "Instructions" task card is open.
Procedure
To search for a specific instruction in the "Instructions" task card, follow these steps:
1. Select a starting point for the search if you want to start the search at a specific point. If
you do not select a starting point, the search starts either at the top or bottom in the task
card, depending on the type of search you have selected.
2. Enter a search term in the text box of the task card toolbar.
3. Click "Search down" if you want to search the task card from top to bottom.
4. Click "Search up" if you want to search the task card from bottom to top.
The first match with the search term found is displayed as the result. If you want to continue
the search, click the "Search down" or "Search up" button again. If no matches are found,
you will receive a corresponding message.
See also
Overview of the program editor (Page 1529)
Note
Please note the following:
You can only ever use the same version of an instruction within a device.
If you change the version of an instruction that other instructions depend on, the versions
of the dependent instructions are also changed.
If you select a version for an instruction that can not be run on the CPU used, the instruction
is shaded out. This means that you cannot use this instruction in this version with your CPU.
The system block in the project tree displays the block version number in its properties; it
does not have to match the instruction version number of the associated instruction in the
task card.
If you change the version of an instruction in the task card, you must compile the associated
system block in the project tree before you update its block version number.
Introduction
The TIA Portal provides you with numerous instructions that you can use to program the user
program. However, you may filter out specific instructions that you do not want to use. To this
end you can create instruction profiles in which you can explicitly specify the instructions to be
listed in the "Instructions" task card. However, although you may create several instruction
profiles in a project, only one of these profiles may be active at any given time. You can
exchange instruction profiles with other users by means of shared libraries.
Note
Please note the following:
The use of instructions that are not allowed in the active profile in a block will trigger the
output of a block compilation error. Such a situation may be triggered if you drag-and-drop
a block from the library to your program.
Instructions of a profile that are not supported by the currently installed products are deleted
from the profile the next time it is edited. If you transfer this profile to an engineering system
in which these instructions are supported by the installed products, the instructions are
again present in the profile but they are disabled. You can enable these instructions as
required at any time.
If you want to make changes to the active profile, you must recompile the blocks in the
project. This is also necessary when you disable or delete the active profile or when you
enable a profile.
See also
Creating new instruction profiles (Page 1542)
Opening and editing instruction profiles (Page 1544)
Activating and deactivating instruction profiles (Page 1545)
Deleting instruction profiles (Page 1546)
Requirement
The "Common data > Instruction profiles" folder is open in the project navigation.
Procedure
Proceed as follows to create a new instruction profile:
1. Double-click the "Add new profile" command.
The Instruction Profile Editor opens and displays the new instruction profile. All instructions
are activated for the new instruction profile.
2. Edit the new instruction profile to suit your requirements.
If necessary, you can rename the new instruction profile. To do this, follow these steps:
1. Right-click on the new instruction profile.
2. Select the "Rename" command in the shortcut menu.
3. Enter a name for the new instruction profile.
Note
The first instruction profile that you create will be used as active profile. In this case, compile
all blocks in the project. If other instruction profiles are already available you must explicitly
activate the new one in order to use it as active profile. You can identify the active profile by
its icon in the project navigation.
See also
Basics of instruction profiles (Page 1542)
Opening and editing instruction profiles (Page 1544)
Activating and deactivating instruction profiles (Page 1545)
Deleting instruction profiles (Page 1546)
Requirement
The "Common data > Instruction profiles" folder is open in the project navigation.
4. Activate the instructions or instruction versions that you want to allow in the instruction
profile.
5. You may assign your own block numbers.
Note
You can assign the number up to 65535 for CPUs of the S7-1200/1500 series. For CPUs
of the S7300/400 series you find the restrictions of the number ranges in the respective
CPU manual.
Note
A new compilation process is required for all blocks in the project when you change the active
profile.
See also
Basics of instruction profiles (Page 1542)
Creating new instruction profiles (Page 1542)
Activating and deactivating instruction profiles (Page 1545)
Deleting instruction profiles (Page 1546)
Use instruction versions (Page 1541)
Note
A new compilation process is required for all blocks in the project.
Requirement
The "Common data > Instruction profiles" folder is open in the project navigation.
See also
Basics of instruction profiles (Page 1542)
Creating new instruction profiles (Page 1542)
Opening and editing instruction profiles (Page 1544)
Deleting instruction profiles (Page 1546)
Requirement
The "Common data > Instruction profiles" folder is open in the project tree.
Procedure
Proceed as follows to delete an instruction profile:
1. Right-click on the instruction profile that you want to delete.
2. Select the "Delete" command in the shortcut menu.
Note
A new compilation process is required for all blocks in the project when you delete the active
profile.
Result
The selected instruction profile is deleted. If you deleted the active instruction profile, no more
active profiles are available and the "Instructions" task card once again shows all instructions
that are available for use.
See also
Basics of instruction profiles (Page 1542)
Creating new instruction profiles (Page 1542)
Using autocompletion
Basics of autocompletion
Function
You can use autocompletion in the program window of the program editor as an easy way to
access available tags or instructions during programming. Autocompletion means a context-
specific list appears in a dialog from which you can select the tags or instructions you need.
See also
Using autocompletion in graphic programming languages (Page 1547)
Using autocompletion in textual programming languages (Page 1548)
3. Select the required tag from the list. If necessary, you can also filter the list:
For example, enter the first few letters of the name of the tag or instruction you wish to
insert. Autocompletion will be filtered further with each letter entered. If there is no tag
or instruction starting with the letters entered, autocompletion will remain at the last
match.
Enter # to access the local tags from the block interface.
Enter " to access the global tags.
Enter % to access absolute addresses.
If the tag is a structured tag, a data block or a multiple instance, then an arrow is displayed
at the end of the row. Click on the arrow to display the lower-level elements. You can
navigate to the very last level in this way. If a structure is allowed as a data type for the
operand, you can choose "None" from the list. This assigns the entire structure to the
operand as a tag. Use the <Backspace> key to return to the previous level.
4. Press the <Return> key to apply the tag.
See also
Basics of autocompletion (Page 1547)
Using autocompletion in textual programming languages (Page 1548)
See also
Basics of autocompletion (Page 1547)
Using autocompletion in graphic programming languages (Page 1547)
Overview
The following table shows the general settings that you can make:
See also
Layout of the block interface (Page 1551)
Changing the settings (Page 1550)
Permissible addresses and data types of PLC tags (Page 1482)
Overview of the print settings (Page 305)
Basics of block access (Page 1419)
Setting and canceling the IEC check (Page 2093)
Procedure
To change the settings, follow these steps:
1. Select the "Settings" command in the "Options" menu.
The "Settings" window is displayed in the work area.
2. In the area navigation, select the "PLC programming" group.
3. Change the settings.
Result
The change will be loaded directly, there is no need to save it explicitly.
See also
Overview of the general settings (Page 1549)
Introduction
The interface contains the declarations of local tags and constants that are used within the
block. The tags are subdivided into two groups:
Block parameters that form the block interface when it is called in the program.
Local data that are used for storage of intermediate results.
You use the tag declaration to define the call interface of a block in the program and the names
and data types of tags and constants that you want to use in the block.
The interface of function blocks also defines the structure of the instances that are assigned
to the function block.
Block parameters
The following table shows the types of block parameters:
Local data
The following table shows the types of local data:
Column Description
Symbol you can click on to drag-and-drop an element to a program
for use as an operand.
Name Name of the element.
Data type Data type of the element.
Offset Relative address of a tag. The column is only visible in blocks with
standard access.
Column Description
Default value Value with which you can pre-assign specific tags in the interface of
the code block, or the value of a local constant.
Specification of the default value is optional for tags. If you do not
specify any value the predefined value for the indicated data type is
used. For example, the value "false" is predefined for BOOL.
The default value of a tag is applied as the start value in the corre
sponding instance data block. You can replace these values with in
stance-specific start values in the instance data block.
Constants always have the default value declared in the block inter
face. They are not shown in instance data blocks and cannot be as
signed instance-specific values there.
Retentivity Marks a tag as retentive.
The values of retentive tags are retained even after the power supply
is switched off.
This column is only visible in the interface of the function block with
optimized access.
Visible in HMI Shows whether a tag is visible by default in the HMI selection list.
Accessible from HMI Shows whether HMI can access this tag during runtime.
Setting value Marks a tag as a setpoint. Setting values are the values that will prob
ably have to be fine tuned during commissioning.
The column is only available in the interface of function blocks.
Comment Comments on documentation of the element.
See also
Using tags within the program (Page 1447)
Keywords (Page 1442)
Valid data types in the block interface (Page 1555)
Setting the retentivity of local tags (Page 1568)
Basics of constants (Page 1449)
Using POINTER
The following rules apply to the use of block parameters within the block:
Input parameters may only be read.
Output parameters may only be written.
In/out parameters may be read and written.
Exception: In blocks with optimized access, you have the option to use PLC data types as
(1)
See also
Using tags within the program (Page 1447)
Keywords (Page 1442)
standard length 254, WSTRINGs the standard length 16832. A declaration in the format MyString[3] would not be permitted.
WSTRING is only permitted in blocks with optimized access in these sections.
(2)
Constants with the ARRAY or STRUCT data type are not permitted.
standard length 254, WSTRINGs the standard length 16832. A declaration in the format MyString[3] would not be permitted.
WSTRING is only permitted in blocks with optimized access in these sections.
(2)
In SCL, ANY is not permitted as a function value.
(3)
ANY can only be used in blocks with standard access in the "Temp" section.
(4)
The "INSTANCE" parameter type is the only exception permissible in the "TEMP" and "InOut" sections.
(5)
Constants with the ARRAY or STRUCT data type are not permitted.
Requirement
The block interface is open.
Procedure
To declare a tag or constant of the elementary data type, follow these steps:
1. Select the appropriate declaration section in the interface.
2. Enter a name for the element in the "Name" column.
3. Enter the required data type in the "Data type" column. You will be supported by
autocompletion during input.
4. For constants, enter a value in the "Default value" column.
5. Optional: Change the properties that are displayed in the other columns of the block
interface.
Result
The element is created.
Syntax check
A syntax check is performed after each entry, and any errors found are displayed in red. You
do not have to correct these errors immediately - you can continue editing and make any
corrections later. However, you will not be able to compile the program if the tag declaration
contains syntax errors.
Note
If you change the interface of a block, the calls of the block in the program will possibly become
inconsistent. The call locations are automatically updated, if possible.
If an automatic updating is not possible, the inconsistent blocks have to be updated manually.
See also:
Updating block calls in LAD (Page 1596)
Updating block calls in FBD (Page 1638)
See also
Editing tables (Page 347)
Basic information on start values (Page 1713)
Using tags within the program (Page 1447)
Keywords (Page 1442)
Properties of local tags and constants (Page 1567)
Setting the retentivity of local tags (Page 1568)
Requirement
The program editor is open.
Procedure
To declare a local tag, follow these steps:
1. Insert an instruction in your program.
The "<???>", "<??.?>" or "..." strings represent operand placeholders.
2. Replace an operand placeholder with the name of the tag to be created.
3. Select the name of the element.
If you want to declare multiple elements, select the names of all the elements to be declared.
4. Select the "Define tag" command in the shortcut menu.
The "Define tag" dialog box opens. It displays a declaration table in which the name of the
element is already entered.
Result
The declaration is written directly into the block interface and is valid within the entire block.
Note
If you change the interface of a block, the calls of the block in the program will possibly become
inconsistent. The call locations are automatically updated, if possible.
If an automatic updating is not possible, the inconsistent blocks have to be updated manually.
See also:
Updating block calls in LAD (Page 1596)
Updating block calls in FBD (Page 1638)
See also
Editing tables (Page 347)
Using tags within the program (Page 1447)
Keywords (Page 1442)
Basic information on start values (Page 1713)
Properties of local tags and constants (Page 1567)
Setting the retentivity of local tags (Page 1568)
Requirement
The block interface is open.
Procedure
To declare a tag of the ARRAY data type, follow these steps:
1. Select the appropriate declaration section in the interface.
2. Enter a tag name in the "Name" column.
3. In the "Data type" column, click the button for the data type selection.
A list of the permissible data types is opened.
4. Select the "Array" data type.
The "Array" dialog opens.
5. In the "Data type" text box, specify the data type of the array elements.
6. In the "ARRAY limits" text box, specify the high and low limit for each dimension.
Example of a one-dimensional ARRAY:
[0..3]
Example of a three-dimensional ARRAY:
[0..3, 0..15, 0..33]
7. Confirm your entry.
8. Optional: Change the properties of the tags that are displayed in the other columns of the
block interface.
Result
The tag of ARRAY data type is created.
Note
You cannot define specific default values for ARRAY elements. However, you can assign them
start values in the instance.
See also
Array (Page 1941)
Using tags within the program (Page 1447)
Keywords (Page 1442)
Properties of local tags and constants (Page 1567)
Setting the retentivity of local tags (Page 1568)
Editing tables (Page 347)
Requirement
The block interface is open.
Procedure
To declare a tag of the STRUCT data type, follow these steps:
1. Select the appropriate declaration section in the interface.
2. Enter a tag name in the "Name" column.
3. Enter "Struct" in the "Data type" column. You will be supported by autocompletion during
input.
An empty, indented row is inserted after the new tag.
4. Insert the first structural element in the first empty row.
An additional empty row is inserted after the element.
5. Select a data type for the structure element.
6. Optional: Change the properties of the structural element that is displayed in the other
columns of the block interface.
7. Repeat the step 4 to 7 for all additional structure elements.
It is not necessary to end the structure explicitly. The structure ends with the last element
that is entered.
8. To insert a new tag after the structure, leave a blank row after the end of the structure and
then start the new tag in the second empty row.
Result
The tag of STRUCT data type is created.
Note
S7-1500: A maximum of 252 structures in one data block
A maximum of 252 structures is permitted in one data block. If you need additional structures,
you must restructure your program. You can, for example, create the structures in several
global data blocks.
See also
Using tags within the program (Page 1447)
Keywords (Page 1442)
Properties of local tags and constants (Page 1567)
Setting the retentivity of local tags (Page 1568)
Editing tables (Page 347)
Requirement
A PLC data type is declared in the current CPU.
Procedure
To declare a tag based on a PLC data type, follow these steps:
1. Select the appropriate declaration section in the interface:
2. Enter the PLC data type in the "Data type" column. You will be supported by Autocomplete
during input.
Result
The tag is created.
Note
You define the default values of tags within a PLC data type when the PLC data type is created.
You cannot change these values at the point of use of the PLC data type.
If you change or delete PLC data types that are used in the block interface, the interface
becomes inconsistent. To remedy this inconsistency, the interface has to be updated.
See also: Updating the block interface (Page 1564)
See also
Editing tables (Page 347)
Basics of PLC data types (Page 1734)
Introduction
To access data areas within a declared tag, you can overlay the declared tags with an
additional declaration. This provides you with the option of addressing an already declared tag
with a different data type. You can, for example, address the individual bits of a tag of WORD
data type with an ARRAY of BOOL.
Overlaying tags
To overlay a tag with a new data type, follow these steps:
1. Open the block interface.
2. In the interface, select the tag that you want to overlay with a new data type.
3. Click "Add row" in the toolbar.
A row is inserted after the tag to be overlaid. The overlaying tag must be declared in the
row directly after the tag that is to be overlaid.
4. Enter a tag name in the "Name" column.
5. Enter the "AT" entry in the "Data type" column. You will be supported by Autocomplete in
this step.
The following is added to the entry in the "Name" column.
"AT<Name of the higher-level tag>"
6. Click the data type selection button again and select the data type for the new tag.
The tag is created. It points to the same data as the higher-level tag, however interprets
this data with the new data type.
Removing overlay
To remove the overlay of a tag, follow these steps:
1. Select the overlaid tag that you want to remove.
2. Select the "Delete" command in the shortcut menu.
3. The overlay is removed.
See also
Editing tables (Page 347)
Overlaying tags with AT (Page 1462)
Declaring multi-instances
Requirement
The function block to be called exists in project tree and is multi-instance capable.
The block interface of the calling function block is open.
Procedure
To declare a function block to be called as a multi-instance, follow these steps:
1. In the "Name" column of the "Static" section, enter a designation for the block call.
2. In the "Data type" column, enter the symbolic name for the function block to be called.
Note
The program editor will declare the multi-instance automatically if you program a block call in
a network and then specify in the "Call options" dialog that you want to call the block as a
multiple instance.
See also
Updating the block interface (Page 1564)
Introduction
If you change or delete PLC data types or multiple instances that are used in the block interface,
the interface will become inconsistent. To remedy this inconsistency, the interface has to be
updated.
You have two options for updating the block interface:
Explicit updating of the block interface.
The used PLC data types and multiple instances will be updated. The instance data blocks
that belong to the block are not implicitly updated during this process.
Implicit updating during compilation.
All used PLC data types and multiple instances as well as the related instance data blocks
will be updated.
See also
Basics of PLC data types (Page 1734)
Declaring tags based on a PLC data type (Page 1562)
Editing tables (Page 347)
Basic information on start values (Page 1713)
Using tags within the program (Page 1447)
Keywords (Page 1442)
Properties of local tags and constants (Page 1567)
Setting the retentivity of local tags (Page 1568)
Updating block calls in LAD (Page 1596)
Declaring multi-instances (Page 1563)
Description
In order to enable the editing of PLC programs that have already been commissioned and that
are running without error on a system, CPUs of the S7-1500 series and most CPUs of the
S7-1200 V4 and higher series support the option of extending the interfaces of function blocks
during runtime.
You can download the modified blocks without setting the CPU to STOP and without affecting
the values of already loaded tags.
This is a simple means of implementing program changes. This load process (download
without reinitialization) will not have a negative impact on the controlled process.
Principle of operation
Each function block is always assigned a default memory reserve. The memory reserve is not
used initially. Activate the memory reserve if you decide on loading interface changes after
having compiled and downloaded the block. All tags that you subsequently declare will be
saved to the memory reserve. The subsequent download does not influence any tags that are
already loaded or have a negative impact on runtime.
If you decide to review your program at a later time while the plant is not in operation, you are
also provided an option of reworking the memory layout of individual or several blocks in a
single pass. With this action, you move all tags from the reserve area to the regular area. The
memory reserve is now cleared and made available for further interface extensions.
Requirements
This "Download without reinitialization" function is available if the following requirements are
met:
The project is in the "TIA Portal V12" format or a higher version.
You are working with a CPU that supports "Download without reinitialization".
The blocks were created in LAD, FBD, STL, or SCL.
The blocks were created by the user, i.e. they are not included with the blocks delivered in
your package.
These blocks are assigned the optimized access attribute.
Basic steps
Perform the following steps if you want to extend the interface of a function block and then
load the block without re-initialization.
1. All blocks have a default memory reserve of 100 bytes. You can adapt this memory reserve
to suit your requirements.
2. Activate the memory reserve.
3. Extend the block interface.
4. Compile the block.
5. Download the block to the CPU as usual.
For more information on the various steps, refer to chapter "Loading blocks (S7-1200/1500) ".
Note
The full scope of the "Download without reinitialization" function is only available on CPUs of
the S7-1500 and S7-1200 V4 series.
However, all CPU families support the option of extending the interface of function blocks and
downloading newly declared tags without repercussion:
You may add new tags in the "Temp" section and download these without influencing the
process.
You may create new tags of a structured data type in the "InOut" section and download
these without influencing the process.
Properties
The table below provides an overview of the properties of local tags and constants:
See also
Setting the retentivity of local tags (Page 1568)
Changing properties of local tags and constants (Page 1569)
Keywords (Page 1442)
Introduction
Function blocks store their data in an instance. To prevent data loss in the event of power
failure, you can mark the data as retentive. This data is stored in a retentive memory area. The
option of setting the retentivity depends on the set access type of the function block.
See also
Properties of local tags and constants (Page 1567)
Basics of block access (Page 1419)
To change one of these properties for several elements, follow these steps:
1. Open the block interface.
2. Hold down the CTRL key.
3. In the required column, select each of the table cells whose value you want to change.
4. Select the "Set <property>" or "Reset <property>" command in the shortcut menu.
Note
If you change the interface of a block, the program may become inconsistent. The
inconsistencies are automatically updated, if possible.
If an automatic updating is not possible, the inconsistent calls are marked in red. You than
have to manually updated the inconsistencies.
See also:
Updating block calls in LAD (Page 1596)
Updating block calls in FBD (Page 1638)
See also
Layout of the block interface (Page 1551)
Editing tables (Page 347)
Properties of local tags and constants (Page 1567)
Setting the retentivity of local tags (Page 1568)
Basic information on start values (Page 1713)
Using tags within the program (Page 1447)
Keywords (Page 1442)
Updating the block interface (Page 1564)
Declaring PLC data types (UDT) as actual parameters for in-out parameters.
Requirements
The in/out parameter (InOut) is based on a PLC data type or a system data type.
The in/out parameter has the retentivity setting "Retain" or "Non-retain". For in/out
parameters with setting "Set in IDB", it is not possible to predefine actual parameters.
The program block is a block with optimized access.
Procedure
To predefine the actual parameter of an in/out parameter, follow these steps:
1. Open the block interface.
2. Select an in/out parameter (InOut) in the block interface.
3. Open the "Properties" tab in the Inspector window.
4. Select the "Attributes" group in the area navigation.
5. Enter the required actual parameter in the "Predefined actual parameter" input box.
6. Select the "Hidden parameter" check box (optional).
Result
An actual parameter is predefined. If you save the program block as a library element, it
thus also contains information about the actual parameter to be used.
If the library element is used in the program, a check is made to determine whether the
actual parameter you have predefined can be addressed. If so, it is automatically used as
the actual parameter.
If the actual parameter is not found in the program, a syntax error is signaled. The parameter
is not hidden and the parameter must be initialized manually.
Procedure
Proceed as follows to insert a row above the selected row:
1. Select the row in front of which you want to insert a new row.
2. Click the "Insert row" button on the toolbar of the table.
Result
A new row is inserted above the selected row.
See also
Editing tables (Page 347)
Procedure
Proceed as follows to insert a row below the selected row:
1. Select the row below which you want to insert a new row.
2. Click the "Add row" button on the table toolbar.
Result
A new empty row will be inserted below the selected row.
See also
Editing tables (Page 347)
Deleting tags
Procedure
Follow the steps below to delete elements:
1. Select the row with the element to be deleted. You can also select several rows by clicking
on them one after the other while holding down the <Ctrl> key or by pressing and holding
down <Shift> and clicking on the first and last row.
2. Select the "Delete" command in the shortcut menu.
See also
Editing tables (Page 347)
Requirement
The table is open.
Sufficient declaration rows are available.
Procedure
To automatically fill in successive cells, follow these steps:
1. Select the cells to be loaded.
2. Click the "Fill" symbol in the bottom right corner of the cell.
The mouse pointer is transformed into a crosshair.
3. Keep the mouse button pressed and drag the mouse pointer downwards over the cells that
you want to fill in automatically.
4. Release the mouse button.
The cells are filled in automatically.
5. If entries are already present in the cells that are to be automatically filled in, a dialog
appears. In this dialog you can indicate whether you want to overwrite the existing entries
or insert new rows for the new tags.
See also
Editing tables (Page 347)
Procedure
To show or hide table columns, follow these steps:
1. Click a column header.
2. Select the "Show/Hide" command in the shortcut menu.
The selection of available columns is displayed.
3. To show a column, select the column's check box.
4. To hide a column, clear the column's check box.
5. To hide or show several columns, click "More" and activate or deactivate the check box of
the corresponding columns in the "Show/Hide" dialog.
Requirements
The block interface and an external editor are opened.
Procedure
To export individual tags to an external editor and import them again, follow these steps:
1. Select one or more tags.
2. Select "Copy" in the shortcut menu.
3. Switch to the external editor and paste the copied tags.
4. Edit the tags as required.
5. Copy the tags in the external editor.
6. Select the tags in the external editor.
7. Switch back to the block interface.
8. Select "Paste" in the shortcut menu.
1HWZRUN
&RLO
LAD elements
A LAD program consists of separate elements that you can arrange in series or parallel on the
power rail of a network. Most program elements must be supplied with tags.
There is at least one rung from the power rail. Network programming starts at the left edge of
the rung. You can expand the power rail by several rungs and branches.
For example, the following figure shows elements of a LAD network:
1) Power rail
2) Rung
3) Branch
4) Contact
5) Coil
6) Box
Power rail
Each LAD network consists of a power rail that contains at least one rung. A network can be
extended by adding additional rungs. You can use branches to program parallel connections
in the specific rungs.
Contacts
You can use contacts to create or interrupt a current-carrying connection between two
elements. The current is relayed from left to right. You can use contacts to query the signal
state or the value of an operand and control it depending on the result of the current flow.
The following types of contact are available to you in a LAD program:
Normally open contact:
Normally open contacts forward the current if the signal state of a specified binary operand
is "1".
Normally closed contacts:
Normally closed contacts forward the current if the signal state of a specified binary operand
is "0".
Contact with additional function:
Contacts with additional function forward the current if a specific condition is met. With these
contacts you can also execute an additional function, such as an RLO edge detection and
a comparison.
Coils
You can use coils to control binary operands. Coils can set or reset a binary operand depending
on the signal state of the result of logic operation.
The following types of coils are available to you in a LAD program:
Standard coils:
Standard coils set a binary operand if current flows in the coil. The "Assignment" instruction
is an example of a standard coil.
Coils with additional function:
These coils have additional functions in addition to the evaluation of the logic operation
result. Coils for RLO edge detection and program control are examples of coils with
additional function.
Boxes
Boxes are LAD elements with complex functions. The empty box is an exception. You can use
the empty box as a placeholder in which you can select the required instruction.
See also
Rules for the use of LAD elements (Page 1586)
Overview
The following table shows the settings that you can make:
See also
Changing the settings (Page 1579)
Procedure
To change the settings, follow these steps:
1. Select the "Settings" command in the "Options" menu.
The "Settings" window is displayed in the work area.
2. In the area navigation, select the "PLC programming" group.
3. Change the settings.
Result
The change will be loaded directly, there is no need to save it explicitly.
See also
Overview of the settings for LAD (Page 1578)
Using networks
Function
The user program is created in the block within networks. For a code block to be programmed,
it must contain at least one network. To achieve a better overview of the user program, you
can also subdivide your program into several networks.
See also
Inserting network title (Page 1583)
Entering a network comment (Page 1584)
Navigating networks (Page 1585)
Inserting networks
Requirement
A block is open.
Procedure
To insert a new network, follow these steps:
1. Select the network after which you want to insert a new network.
2. Select the "Insert network" command in the shortcut menu.
Result
A new empty network is inserted into the block.
See also
Selecting networks (Page 1580)
Copying and pasting networks (Page 1581)
Deleting networks (Page 1582)
Expanding and collapsing networks (Page 1582)
Inserting network title (Page 1583)
Entering a network comment (Page 1584)
Navigating networks (Page 1585)
Selecting networks
Requirements
A network is available.
Selecting a network
To select a network, follow these steps:
1. Click the title bar of the network that you want to select.
See also
Inserting networks (Page 1579)
Copying and pasting networks (Page 1581)
Deleting networks (Page 1582)
Expanding and collapsing networks (Page 1582)
Inserting network title (Page 1583)
Entering a network comment (Page 1584)
Navigating networks (Page 1585)
Requirement
A network is available.
Procedure
To copy and paste a network, follow these steps:
1. Select the network or networks to be copied.
2. Select "Copy" in the shortcut menu.
3. Select the network after which you want to paste in the copied network.
4. Select "Paste" in the shortcut menu.
See also
Inserting networks (Page 1579)
Selecting networks (Page 1580)
Deleting networks (Page 1582)
Expanding and collapsing networks (Page 1582)
Inserting network title (Page 1583)
Entering a network comment (Page 1584)
Navigating networks (Page 1585)
Deleting networks
Requirement
A network is available.
Procedure
To delete a network, follow these steps:
1. Select the network that you want to delete.
2. Select the "Delete" command in the shortcut menu.
See also
Inserting networks (Page 1579)
Selecting networks (Page 1580)
Copying and pasting networks (Page 1581)
Expanding and collapsing networks (Page 1582)
Inserting network title (Page 1583)
Entering a network comment (Page 1584)
Navigating networks (Page 1585)
Requirements
A network is available.
See also
Inserting networks (Page 1579)
Selecting networks (Page 1580)
Copying and pasting networks (Page 1581)
Deleting networks (Page 1582)
Inserting network title (Page 1583)
Entering a network comment (Page 1584)
Navigating networks (Page 1585)
Note
Note the following restrictions for automatic insertion of the network title:
The network title is not adapted if you change the comment of the operand at a later time.
The network title is not adapted if you change the operand of the instruction.
The network title is only set by the writing instructions listed above.
If the operand is of the data type array, the comment of the array is used and not the
comments of the array elements.
Comments of invalid operands are not taken into consideration.
See also
Using networks (Page 1579)
Inserting networks (Page 1579)
Selecting networks (Page 1580)
Copying and pasting networks (Page 1581)
Deleting networks (Page 1582)
Expanding and collapsing networks (Page 1582)
Entering a network comment (Page 1584)
Navigating networks (Page 1585)
Requirement
A network is available.
Procedure
To enter a network comment, follow these steps:
1. Click on the right arrow before the network title.
2. If the comment area is not visible, click "Network comments on/off" in the toolbar.
The comment area is displayed.
See also
Using networks (Page 1579)
Inserting networks (Page 1579)
Selecting networks (Page 1580)
Copying and pasting networks (Page 1581)
Deleting networks (Page 1582)
Expanding and collapsing networks (Page 1582)
Inserting network title (Page 1583)
Navigating networks (Page 1585)
Navigating networks
You can navigate straight to a specific position within a block.
Procedure
To navigate to a specific position within a block, follow these steps:
1. Right-click in the code area of the programming window.
2. Select the "Go to > Network/line" command in the shortcut menu.
The "Go to" dialog will open.
3. Enter the network to which you want to navigate.
4. Enter the line number of the network to which you want to navigate.
5. Confirm your entry with "OK".
Result
The relevant line will be displayed if this is possible. If the network or line requested does not
exist, the last existing network or the last existing line in the network requested will be displayed.
See also
Using networks (Page 1579)
Inserting networks (Page 1579)
Selecting networks (Page 1580)
Copying and pasting networks (Page 1581)
Rules
Note the following rules when inserting LAD elements:
Every LAD network must terminate with a coil or a box. However, the following LAD
elements must not be used to terminate a network:
Comparator boxes
Instructions for positive and negative RLO edge detection
The starting point of the branch for a box connection must always be the power rail. Logic
operations or other boxes can be present in the branch before the box.
Only contacts can be inserted into simultaneous branches with preceding logic operations.
The contact for negating the result of logic operation (-|NOT|-) is an exception here. The
contact for negating the result of logic operation, as well as coils and boxes, can be used
in simultaneous branches if they originate directly from the power rail.
Constants (e.g. TRUE or FALSE) cannot be assigned to normally closed or normally open
contacts. Instead, use operands of the BOOL data type.
Only one jump instruction can be inserted in each network.
Only one jump label can be inserted in each network.
Instructions with positive or negative edge detection may not be arranged directly at the
left margin of the rung as they requires a prior logic operation.
See also
Prohibited interconnections in LAD (Page 1588)
Overview of the LAD elements (Page 1576)
, ,
,PSHUPLVVLEOHUDWHRIIORZ
, ,
Short-circuit
No branches may be programmed that would cause a short-circuit.
6KRUWFLUFXLWLPSHUPLVVLEOH
Logic operations
The following rules apply to logic operations:
Only Boolean inputs can be combined with preceding logic operations.
Only the first Boolean output can be combined with a further logic operation.
Only one complete logical path can exist per network. Paths that are not connected can be
linked.
See also
Rules for the use of LAD elements (Page 1586)
Requirement
A network is available.
Procedure
To insert a LAD element into a network using the "Instructions" task card, follow these steps:
1. Open the "Instructions" task card.
2. Navigate to the LAD element that you want to insert.
3. Use drag-and-drop to move the element to the desired place in the network.
If the element is an internal system function block (FB), the "Call options" dialog opens. In
this dialog you can create an instance data block of the single-instance or multiple-instance
type for the function block in which the data of the inserted element will be saved. You will
find the new instance data block created in the project tree in the "Program resources"
folder under "Program blocks > System blocks". If you have selected "multiple instance",
these are located in the block interface in the "Static" section.
Or:
1. Select the point in the network at which you want to insert the element.
2. Open the "Instructions" task card.
3. Double-click on the element you want to insert.
If the element is an internal system function block (FB), the "Call options" dialog opens. In
this dialog you can create an instance data block of the single-instance or multiple-instance
type for the function block in which the data of the inserted element will be saved. You will
find the new instance data block created in the project tree in the "Program resources"
folder under "Program blocks > System blocks". If you have selected "multiple instance",
these are located in the block interface in the "Static" section.
Result
The selected LAD element is inserted with placeholders for the parameters.
Requirement
A network is available.
Procedure
To insert an LAD element into a network using an empty box, follow these steps:
1. Open the "Instructions" task card.
2. Navigate to "General > Empty box" in the "Basic instructions" palette.
3. Use a drag-and-drop operation to move the "Empty box" element to the desired place in
the network.
4. Position the cursor over the triangle in the top right-hand corner of the empty box.
A drop-down list is displayed.
5. Select the required LAD element from the drop-down list.
If the element is an internal system function block (FB), the "Call option" dialog opens. In
this dialog you can create an instance data block of the single-instance or multiple-instance
type for the function block in which the data of the inserted element will be saved. You will
find the new instance data block created in the project tree in the "Program resources"
folder under "Program blocks > System blocks". If you have selected "multi-instance", these
are located in the block interface in the "Static" section.
Result
The empty box is changed to the respective LAD element. Placeholders are inserted for the
parameters.
Introduction
Some instructions can be executed with several different data types. If you use one of these
instructions in the program, you have to specify a valid data type for the instruction at the
specific point in the program. For some instructions, you have to select the data types for the
inputs and outputs separately.
Note
The valid data type (BOOL) for the tags on the enable input EN and the enable output ENO is
predefined by the system and cannot be changed.
The valid data types for an instruction are listed in the instruction drop-down list. You specify
the data type of the instruction by selecting an entry from the drop-down list. If the data type
of an operand differs from the data type of the instruction and cannot be converted implicitly,
the operand is displayed in red and a rollout with the corresponding error message appears.
Note
Please also observe the information on data type conversion for your device and, in particular,
the notes on the IEC check.
See also: Data type conversion (Page 2091)
See also
Defining the data type of an instruction (Page 1591)
Introduction
Some instructions can be executed with several different data types. When you insert such
instructions into your program, you must specify the data type for these instructions at the
actual point in the program.
See also
Selecting a data type (Page 1590)
Requirement
A block is open.
The multipane mode is set for the "Instructions" task card or the Favorites are also displayed
in the editor.
Procedure
To add SCL instructions to the Favorites, follow these steps:
1. Open the "Instructions" task card.
2. Maximize the "Basic instructions" pane.
3. Navigate in the "Basic instructions" pane to the instruction that you want to add to the
Favorites.
4. Drag-and-drop the instruction into the "Favorites" pane or into the Favorites area in the
program editor.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Removing LAD elements from Favorites (Page 1594)
Overview of the program editor (Page 1529)
Requirement
A block is open.
Favorites are available.
Procedure
To insert an instruction into a program using Favorites, follow these steps:
1. Drag-and-drop the desired instruction from Favorites to the desired position.
Or:
1. Select the position in the program where you want to insert the instruction.
2. In the Favorites, click on the instruction you want to insert.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Removing LAD elements from Favorites (Page 1594)
Overview of the program editor (Page 1529)
Requirement
A code block is open.
Procedure
To remove instructions from Favorites, follow these steps:
1. Right-click on the instruction you want to remove.
2. Select the "Remove instruction" command in the shortcut menu.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Adding LAD elements to Favorites (Page 1593)
Inserting LAD elements using favorites (Page 1593)
Overview of the program editor (Page 1529)
Requirement
A network is available.
The block that is to be called is available.
Result
The function or the function block is inserted with its parameters. You can then assign the
parameters.
See also: Auto-Hotspot
Note
If when calling a function block you specify an instance data block that does not exist, it will
be created. If you have called a function block as a multi-instance, this will be entered as a
static tag in the interface.
See also
Updating block calls in LAD (Page 1596)
Changing the instance type (Page 1598)
Single instances (Page 1427)
Multi-instances (Page 1427)
Note
Note that the "Update block call" command is only available provided you did not previously
update all block calls in the editor with the "Update inconsistent block calls" command.
See also
Inserting block calls using a drag-and-drop operation (Page 1595)
Changing the instance type (Page 1598)
Procedure
To change the called block of a block call, follow these steps:
1. Click on the name of the called block within the block call and press the <F2> key. Or double-
click the name of the called block.
A text box opens, and the name of the currently called block is selected.
2. Enter the name of the block you want to call or select a block in the autocompletion.
3. If you want to call an FB, create a new instance data block, if necessary, and specify it as
operand.
Instance type
There are two ways of calling function blocks:
As a single instance
As a multiple instance
See also: Auto-Hotspot
You can modify a defined instance type at any time.
Requirement
The user program contains a block call.
Procedure
To change the instance type of a function block, follow these steps:
1. Open the code block and select the block call.
2. Select the "Change instance" command in the shortcut menu.
The "Call options" dialog opens.
3. Click the "Single instance" or "Multi instance" button.
If you select the "Single instance" instance type, enter a name for the data block that is
to be assigned to the function block.
If you select "Multiple instance" as the instance type, enter in the "Name in the interface"
text field the name of the tag with which the called function block is to be entered as a
static tag in the interface of the calling block.
4. Confirm your entries with "OK".
Note
The previous single and multiple instances will not be deleted automatically.
See also
Inserting block calls using a drag-and-drop operation (Page 1595)
Updating block calls in LAD (Page 1596)
Requirement
A network is available.
Procedure
Proceed as follows to use the "Calculate" instruction:
1. Open the "Instructions" task card.
2. Navigate to "Math functions > CALCULATE" in the "Basic instructions" pane.
3. Use drag-and-drop to move the element to the desired place in the network.
The instruction "Calculate" will be inserted for the data type with a placeholder expression
and question mark.
4. Enter the data type for the calculation.
5. Enter the operands for the calculation.
Note
The calculation is run with the inputs of the "Calculate" instruction. If you want to use
constants you must also insert appropriate inputs for them.
6. Click on the "Edit 'Calculate' instruction" button to replace the placeholder expression with
the correct expression.
The "Edit 'Calculate' instruction" dialog will open.
7. Enter the required expression in the "OUT:= " text box.
Note
In the "Example" area you can find an example of a valid expression and possible
instructions that you can use.
To determine a value with the help of Pythagoras' theorem, for example, enter "OUT :=
SQRT (SQR (IN1) + SQR (IN2))".
See also
CALCULATE: Calculate (Page 2300)
Introduction
Free-form comments allow you to add comments to the source code for graphic programming
languages similar to line comments for textual languages.
Free-form comments can be used for the following elements:
Boxes
Coils
See also
Inserting free-form comments (Page 1600)
Editing free-form comments (Page 1601)
Deleting free-form comments (Page 1602)
Requirement
A network with instructions is available.
Procedure
To insert a free comment on an instruction, proceed as follows:
1. If necessary, activate the "Free-form comments on/off" button in the toolbar.
2. Right-click on the instruction for which you want to insert a free-form comment.
3. Select the "Insert comment" command in the shortcut menu.
A comment box with a standard comment opens. The comment box is connected by an
arrow to the corresponding instruction.
4. Enter the required comment in the comment box.
See also
Basic information on using free-form comments in LAD (Page 1600)
Editing free-form comments (Page 1601)
Deleting free-form comments (Page 1602)
Introduction
Free-form comments can be edited as follows:
Changing the comment text
Changing the position and size of the comment box
Attaching a comment to another element
Showing and hiding free comments
See also
Basic information on using free-form comments in LAD (Page 1600)
Inserting free-form comments (Page 1600)
Deleting free-form comments (Page 1602)
Procedure
To delete a free-form comment, proceed as follows:
1. Right-click on the free-form comment that you want to delete.
2. Select the "Delete" command in the shortcut menu.
See also
Basic information on using free-form comments in LAD (Page 1600)
Inserting free-form comments (Page 1600)
Editing free-form comments (Page 1601)
Requirement
LAD elements are available
See also
Copying LAD elements (Page 1603)
Cutting LAD elements (Page 1604)
Pasting an LAD element from the clipboard (Page 1604)
Replacing LAD elements (Page 1605)
Inserting additional inputs and outputs in LAD elements (Page 1606)
Removing inputs and outputs (Page 1607)
Enabling and disabling the EN/ENO mechanism (Page 1608)
Deleting LAD elements (Page 1609)
Requirement
An LAD element is available.
Procedure
To copy a LAD element, follow these steps:
1. Right-click the LAD element that you want to copy.
2. Select "Copy" in the shortcut menu.
Result
The LAD element will be copied and saved to the clipboard.
See also
Selecting LAD elements (Page 1602)
Cutting LAD elements (Page 1604)
Pasting an LAD element from the clipboard (Page 1604)
Replacing LAD elements (Page 1605)
Inserting additional inputs and outputs in LAD elements (Page 1606)
Removing inputs and outputs (Page 1607)
Enabling and disabling the EN/ENO mechanism (Page 1608)
Deleting LAD elements (Page 1609)
Requirement
An LAD element is available.
Cutting
To cut a LAD element, follow these steps:
1. Right-click the LAD element that you want to cut.
2. Select "Cut" in the shortcut menu.
Result
The LAD element will be cut and saved to the clipboard.
See also
Selecting LAD elements (Page 1602)
Copying LAD elements (Page 1603)
Pasting an LAD element from the clipboard (Page 1604)
Replacing LAD elements (Page 1605)
Inserting additional inputs and outputs in LAD elements (Page 1606)
Removing inputs and outputs (Page 1607)
Enabling and disabling the EN/ENO mechanism (Page 1608)
Deleting LAD elements (Page 1609)
Requirement
An LAD element is available.
Procedure
To paste an LAD element from the clipboard, follow these steps:
1. Copy a LAD element or cut a LAD element.
2. Right-click the point in the network where you want to paste the element.
3. Select "Paste" in the shortcut menu.
See also
Selecting LAD elements (Page 1602)
Copying LAD elements (Page 1603)
Cutting LAD elements (Page 1604)
Replacing LAD elements (Page 1605)
Inserting additional inputs and outputs in LAD elements (Page 1606)
Removing inputs and outputs (Page 1607)
Enabling and disabling the EN/ENO mechanism (Page 1608)
Deleting LAD elements (Page 1609)
Requirements
A network with at least one LAD element is present.
Procedure
To replace an LAD element with another LAD element, follow these steps:
1. Select the LAD element that you want to replace.
2. Position the cursor over the triangle in the top right-hand corner of the LAD element.
A drop-down list is displayed.
3. From the drop-down list, select the LAD element that you want to use to replace the existing
LAD element.
See also
Selecting LAD elements (Page 1602)
Copying LAD elements (Page 1603)
Cutting LAD elements (Page 1604)
Pasting an LAD element from the clipboard (Page 1604)
Inserting additional inputs and outputs in LAD elements (Page 1606)
Removing inputs and outputs (Page 1607)
Enabling and disabling the EN/ENO mechanism (Page 1608)
Deleting LAD elements (Page 1609)
Introduction
You can expand LAD elements which execute commutative arithmetic instructions by adding
additional inputs. Such elements are, for example, the instructions "Add" (ADD) and "Multiply"
(MUL). You can expand the MOVE and DEMUX instruction boxes by adding additional outputs.
Requirement
An LAD element is available that permits the insertion of additional inputs and outputs.
See also
Selecting LAD elements (Page 1602)
Copying LAD elements (Page 1603)
Cutting LAD elements (Page 1604)
Pasting an LAD element from the clipboard (Page 1604)
Replacing LAD elements (Page 1605)
Removing inputs and outputs (Page 1607)
Enabling and disabling the EN/ENO mechanism (Page 1608)
Deleting LAD elements (Page 1609)
Introduction
Inputs and outputs which you have added to an instruction can be removed.
Requirement
An LAD element is available to which you have added additional inputs and outputs.
Remove input
To remove an input, follow these steps:
1. Select the input that you want to remove.
2. Select the "Delete" command in the shortcut menu.
The input of the LAD element is removed.
Remove output
To remove an output, follow these steps:
1. Select the output that you want to remove.
2. Select the "Delete" command in the shortcut menu.
The output of the LAD element will be removed.
See also
Selecting LAD elements (Page 1602)
Copying LAD elements (Page 1603)
Cutting LAD elements (Page 1604)
Pasting an LAD element from the clipboard (Page 1604)
Replacing LAD elements (Page 1605)
Inserting additional inputs and outputs in LAD elements (Page 1606)
Enabling and disabling the EN/ENO mechanism (Page 1608)
Deleting LAD elements (Page 1609)
See also
Selecting LAD elements (Page 1602)
Copying LAD elements (Page 1603)
Cutting LAD elements (Page 1604)
Pasting an LAD element from the clipboard (Page 1604)
Replacing LAD elements (Page 1605)
Inserting additional inputs and outputs in LAD elements (Page 1606)
Removing inputs and outputs (Page 1607)
Deleting LAD elements (Page 1609)
Requirement
An LAD element is available.
Procedure
To delete a LAD element, follow these steps:
1. Right-click the LAD element that you want to delete.
2. Select the "Delete" command in the shortcut menu.
See also
Selecting LAD elements (Page 1602)
Copying LAD elements (Page 1603)
Cutting LAD elements (Page 1604)
Pasting an LAD element from the clipboard (Page 1604)
Replacing LAD elements (Page 1605)
Inserting additional inputs and outputs in LAD elements (Page 1606)
Removing inputs and outputs (Page 1607)
Enabling and disabling the EN/ENO mechanism (Page 1608)
Inserting operands
The character strings "<???>", "<??.?>" and "..." are inserted as placeholders for the
parameters when an LAD element is inserted. The "<???>" and "<??.?>" strings displayed in
red indicate parameters that need to be connected. The "..." string displayed in black indicates
parameters that may be connected. "<??.?>" stands for Boolean placeholders.
Note
If you position the cursor over the placeholder, the expected data type will be displayed.
Requirement
An LAD element is available.
Procedure
To connect the parameters of a LAD element, follow these steps:
1. Double-click the placeholder of the parameter.
An entry field opens, and the placeholder is selected.
2. Enter the appropriate parameter.
Note
If you enter the absolute address of a parameter that has already been defined, this absolute
address will be changed to the symbolic name of the parameter as soon as the input is
confirmed. If you have not yet defined the parameter, a new tag with this absolute address
and the default name "Tag_<n>" will be entered in the PLC tag table. When you confirm
your input, the absolute address will be replaced with the symbolic name "Tag_<n>".
Result
If the syntax is error-free, the displayed parameter is black. The editor then jumps to the
next placeholder.
If there is an error in the syntax, the cursor stays in the entry field and a corresponding error
message is displayed in the status line. If you press the Enter key again, the entry field is
closed and the faulty entry is displayed in red italics.
Introduction
Depending on the CPU used, you can use complex instructions in your program that are
included with the TIA Portal. These instructions can contain parameters that are declared as
hidden.
If an instruction contains hidden parameters, the instruction box has a small arrow on the lower
edge. You can recognize hidden parameters by their white font.
You can show and wire the hidden parameters at any time.
See also
Using libraries (Page 470)
Introduction
You can display the following information about the tags to be used in the Program editor:
Name of the tag
Address of the tag
Simple or hierarchical comments for tag documentation
The information is taken from the block interface for local tags and DB tags and from the PLC
tag table for tags that are valid CPU-wide.
You can display the tag information either for all the blocks or for individually opened blocks.
If you display the tag information for all the blocks, the tag information for all the blocks currently
opened and opened in future is shown.
You can hide the tag information at any time again. If you have hidden the tag information for
all blocks, you can display it again for individual blocks that are open.
When you select the display of tag information with hierarchical comments, the comments of
the higher structure levels are also displayed for structured tags. The comments are shown in
brackets after the tag comment; the comments of the individual levels are separated by a dot.
If there is no comment for a tag on a structure level, it is not displayed. This is indicated by two
successive dots.
Branches in LAD
Definition
You use branches to program parallel circuits with the Ladder Logic (LAD) programming
language. Branches are inserted in the main rung. You can insert several contacts into the
branch and thus achieve a parallel circuit of series connections. This allows you to program
complex ladder logic.
The figure below shows an example of the use of branches:
6 02725
5
6
6
See also
Rules for branches in LAD (Page 1613)
Inserting branches into the LAD network (Page 1614)
Closing branches in the LAD network (Page 1614)
Deleting branches in LAD networks (Page 1615)
Rules
The following rules apply to simultaneous branches:
A simultaneous branch can only be inserted if the main branch already contains an LAD
element.
Simultaneous branches are opened downwards or are connected directly to the power rail.
They are terminated upwards.
Simultaneous branches are opened after the selected LAD element.
Simultaneous branches are terminated after the selected LAD element.
To delete a simultaneous branch, you must delete all LAD elements of this branch. When
the last LAD element is removed from the branch, the rest of the branch is also removed.
See also
Basic information on branches in LAD (Page 1612)
Inserting branches into the LAD network (Page 1614)
Deleting branches in LAD networks (Page 1615)
Closing branches in the LAD network (Page 1614)
Requirement
A network is available.
The network contains elements.
Procedure
To insert a new branch in a network, follow these steps:
1. Open the "Instructions" task card.
2. Navigate to "General > Open branches" in the "Simple instructions" palette.
3. Use drag-and-drop to move the element to the desired place in the network.
If you want to connect the new branch directly to the power rail, drag the element to the
power rail.
See also
Basic information on branches in LAD (Page 1612)
Rules for branches in LAD (Page 1613)
Deleting branches in LAD networks (Page 1615)
Requirement
A branch is available.
Procedure
To close an open branch, follow these steps:
1. Select the open branch.
2. Press and hold down the left mouse button.
A dashed line will appear as soon as the cursor is moved.
3. Drag the dashed line to a suitable place on the network. Permissible connections are
indicated by green lines.
4. Release the left mouse button.
See also
Basic information on branches in LAD (Page 1612)
Rules for branches in LAD (Page 1613)
Requirement
A branch is available.
Procedure
To delete a branch, follow these steps:
1. Select the connection line that links the branch to the main branch.
2. Select the "Delete" command in the shortcut menu.
See also
Basic information on branches in LAD (Page 1612)
Rules for branches in LAD (Page 1613)
Inserting branches into the LAD network (Page 1614)
Crossings in LAD
Definition
A crossing is a place in a LAD network where one branch is closed and at the same time
another branch is opened.
7DJ,QB 7DJ,QB
&URVVLQJ
Inserting crossings
You can insert crossings in a LAD network by creating connections between the main branch
and an additional branch or between different branches.
Requirements
A branch is available.
Procedure
To insert a new crossing in an LAD network, follow these steps:
1. Open the "Instructions" task card.
2. Navigate to "General > Open branches" in the "Simple instructions" palette.
3. Drag the element behind the existing branch.
4. Insert any element into the open branch.
5. Click the arrow of the open branch after the inserted element.
6. Hold down the left mouse button and drag the dashed connecting line to the main branch.
7. Release the left mouse button.
See also
Rearranging crossings (Page 1616)
Deleting crossings (Page 1617)
Inserting branches into the LAD network (Page 1614)
Rearranging crossings
Requirement
A crossing is available.
Procedure
To rearrange a connection, follow these steps:
1. Select the connection line that defines the crossings in the respective branches.
2. Select the "Delete" command in the shortcut menu.
3. Open the "Instructions" task card.
4. Navigate to "General > Open branches" in the "Simple instructions" palette.
5. Use a drag-and-drop operation to move the element to the place in the network where you
want to insert the new crossing.
6. Click on the arrow for the open branch.
7. Hold down the left mouse button and drag the dashed connecting line to the subsidiary
branch in which you wish to insert the new crossing.
8. Release the left mouse button.
See also
Inserting crossings (Page 1616)
Deleting crossings (Page 1617)
Deleting crossings
Requirement
A crossing is available.
Procedure
To delete a crossing, follow these steps:
1. Select the connection line that defines the crossings in the respective branches.
2. Select the "Delete" command in the shortcut menu.
See also
Inserting crossings (Page 1616)
Rearranging crossings (Page 1616)
Rungs in LAD
Using rungs
The program is mapped in one or more networks. A network contains a power rail on the left
where one or more rungs originate. The binary signal scans are arranged in the form of contacts
on the rungs. The serial arrangement of the elements on a rung creates a series connection;
arrangement on simultaneous branches creates a parallel connection. A rung is closed by a
coil or a box in which the result of logic operation will be written.
The figure below shows an example of the use of several rungs within a network:
6WDUW6ZLWFKB/HIW 02725B21
6
6WDUW6ZLWFKB5LJKW
6WRS6ZLWFKB/HIW 02725B21
5
6WRS6ZLWFKB5LJKW
Rules
Remember the following rules when using several rungs:
Connections are not permitted between rungs.
Only one jump instruction is permissible per network. The positioning rules for jump
instructions remain valid.
Running rungs
Rungs and networks are executed from top to bottom and from left to right. This means that
the first instruction in the first rung of the first network is processed first. All instructions of this
rung are then processed. After this come all other rungs of the first network. The next network
is processed only after all rungs have first been run.
See also
Insert rung (Page 1618)
Deleting a rung (Page 1619)
Insert rung
Requirement
A block is open.
A network is available.
Procedure
To insert a new rung in a network, proceed as follows:
1. Insert any coil on the power rail.
A new rung will be inserted and the coil positioned at the end of the rung.
2. Insert additional instructions in the new rung.
See also
Basic information on rungs in LAD (Page 1617)
Deleting a rung (Page 1619)
Deleting a rung
Requirement
A rung is available.
Procedure
To delete a rung, proceed as follows:
1. Hold down the left mouse button and draw a frame around the rung. At the same time,
make sure that you select all instructions. Alternatively, you can hold down the <Shift> key
and select the first the last instruction of the rung.
2. Right-click on one of the instructions in the rung.
3. Select the "Delete" command in the shortcut menu.
See also
Basic information on rungs in LAD (Page 1617)
Insert rung (Page 1618)
The program is mapped in one or more networks. A network contains one or more logic
operation paths. The binary signal scans are linked by boxes. The representation of the logic
is based on the graphical logic symbols used in Boolean algebra.
1HWZRUN
!
2SHUDQG 2XWSXW
2SHUDQG
6WRS
FBD elements
An FBD program consists of separate elements that are linked by means of a binary signal
flow. Most program elements must be supplied with tags.
A FBD network is programmed from left to right.
For example, the following figure shows elements of an FBD network:
1) Binary function
2) Standard box
3) Complex box
Binary functions
You can use binary functions to query binary operands and to combine their signal states. The
following operations are examples of binary functions: "AND operation", "OR operation" and
"EXCLUSIVE OR operation".
Standard boxes:
You can use standard boxes to control binary operands, perform RLO edge detection or
execute jump functions in the program. Standard boxes generally have only one single input.
Complex boxes
Complex boxes represent program elements with complex functions. The empty box is an
exception. You can use the empty box as a placeholder in which you can select the required
instruction.
The following types of boxes are available to you in an FBD program:
Complex boxes without EN/ENO mechanism:
A box is executed independently of the signal state at the box inputs. The error status of
the processing cannot be queried.
Complex boxes with EN/ENO mechanism:
A box is only executed if the enable input "EN" has the signal state "1". If the box is
processed correctly, the "ENO" enable output has signal state "1". If an error occurs during
processing, the "ENO" output is reset.
If the EN enable input is not interconnected, the box is always executed.
Calls of code block are also shown in the network as complex boxes with EN/ENO mechanism.
Overview
The following table shows the settings that you can make:
See also
Changing the settings (Page 1622)
Procedure
To change the settings, follow these steps:
1. Select the "Settings" command in the "Options" menu.
The "Settings" window is displayed in the work area.
2. In the area navigation, select the "PLC programming" group.
3. Change the settings.
Result
The change will be loaded directly, there is no need to save it explicitly.
See also
Overview of the settings for FBD (Page 1621)
Using networks
Function
The user program is created in the block within networks. For a code block to be programmed,
it must contain at least one network. To achieve a better overview of the user program, you
can also subdivide your program into several networks.
See also
Inserting network title (Page 1626)
Entering a network comment (Page 1627)
Navigating networks (Page 1628)
Inserting networks
Requirement
A block is open.
Procedure
To insert a new network, follow these steps:
1. Select the network after which you want to insert a new network.
2. Select the "Insert network" command in the shortcut menu.
Result
A new empty network is inserted into the block.
See also
Inserting network title (Page 1626)
Entering a network comment (Page 1627)
Navigating networks (Page 1628)
Selecting networks
Requirements
A network is available.
Selecting a network
To select a network, follow these steps:
1. Click the title bar of the network that you want to select.
See also
Inserting networks (Page 1623)
Inserting network title (Page 1626)
Entering a network comment (Page 1627)
Navigating networks (Page 1628)
Requirement
A network is available.
Procedure
To copy and paste a network, follow these steps:
1. Select the network or networks to be copied.
2. Select "Copy" in the shortcut menu.
3. Select the network after which you want to paste in the copied network.
4. Select "Paste" in the shortcut menu.
See also
Inserting networks (Page 1623)
Selecting networks (Page 1623)
Inserting network title (Page 1626)
Entering a network comment (Page 1627)
Navigating networks (Page 1628)
Deleting networks
Requirement
A network is available.
Procedure
To delete a network, follow these steps:
1. Select the network that you want to delete.
2. Select the "Delete" command in the shortcut menu.
See also
Inserting networks (Page 1623)
Selecting networks (Page 1623)
Copying and pasting networks (Page 1624)
Inserting network title (Page 1626)
Entering a network comment (Page 1627)
Navigating networks (Page 1628)
Requirements
A network is available.
See also
Inserting networks (Page 1623)
Selecting networks (Page 1623)
Copying and pasting networks (Page 1624)
Deleting networks (Page 1625)
Inserting network title (Page 1626)
Entering a network comment (Page 1627)
Navigating networks (Page 1628)
Note
Note the following restrictions for automatic insertion of the network title:
The network title is not adapted if you change the comment of the operand at a later time.
The network title is not adapted if you change the operand of the instruction.
The network title is only set by the writing instructions listed above.
If the operand is of the data type array, the comment of the array is used and not the
comments of the array elements.
Comments of invalid operands are not taken into consideration.
See also
Using networks (Page 1622)
Inserting networks (Page 1623)
Selecting networks (Page 1623)
Copying and pasting networks (Page 1624)
Deleting networks (Page 1625)
Expanding and collapsing networks (Page 1625)
Entering a network comment (Page 1627)
Navigating networks (Page 1628)
Requirement
A network is available.
Procedure
To enter a network comment, follow these steps:
1. Click on the right arrow before the network title.
2. If the comment area is not visible, click "Network comments on/off" in the toolbar.
The comment area is displayed.
See also
Using networks (Page 1622)
Inserting networks (Page 1623)
Selecting networks (Page 1623)
Copying and pasting networks (Page 1624)
Deleting networks (Page 1625)
Expanding and collapsing networks (Page 1625)
Inserting network title (Page 1626)
Navigating networks (Page 1628)
Navigating networks
You can navigate straight to a specific position within a block.
Procedure
To navigate to a specific position within a block, follow these steps:
1. Right-click in the code area of the programming window.
2. Select the "Go to > Network/line" command in the shortcut menu.
The "Go to" dialog will open.
3. Enter the network to which you want to navigate.
4. Enter the line number of the network to which you want to navigate.
5. Confirm your entry with "OK".
Result
The relevant line will be displayed if this is possible. If the network or line requested does not
exist, the last existing network or the last existing line in the network requested will be displayed.
See also
Using networks (Page 1622)
Inserting networks (Page 1623)
Selecting networks (Page 1623)
Copying and pasting networks (Page 1624)
Rules
Note the following rules when inserting FBD elements:
An FBD network can consist of several elements. All elements of a logic path must be linked
to each other according to IEC 61131-3.
Standard boxes (flip flops, counters, timers, math operations, etc.) can be added as output
to boxes with binary logic operations (for example, AND, OR). Comparison boxes are
excluded from this rule.
Only Boolean inputs in an instruction can be combined with preceding logic operations.
Only the bottom Boolean output in an instruction can be combined with an additional logic
operation.
Enable input EN or enable output ENO can be connected to boxes, but this is not mandatory.
Constants (for example, TRUE or FALSE) cannot be assigned to binary logic operations.
Instead, use tags of the BOOL data type.
Only one jump instruction can be inserted in each network.
Only one jump label can be inserted in each network.
Instructions for positive or negative RLO edge detection may not be arranged right at the
left of the network as this requires a prior logic operation.
Requirement
A network is available.
Procedure
To insert FBD elements into a network using the "Instructions" task card, follow these steps:
1. Open the "Instructions" task card.
2. Navigate to the FBD element that you want to insert.
3. Use drag-and-drop to move the element to the desired place in the network.
If the element is an internal system function block (FB), the "Call options" dialog opens. In
this dialog you can create an instance data block of the single-instance or multiple-instance
type for the function block in which the data of the inserted element will be saved. You will
find the new instance data block created in the project tree in the "Program resources"
folder under "Program blocks > System blocks". If you have selected "multiple instance",
these are located in the block interface in the "Static" section.
Or:
1. Select the point in the network at which you want to insert the element.
2. Open the "Instructions" task card.
3. Double-click on the element you want to insert.
If the element is an internal system function block (FB), the "Call options" dialog opens. In
this dialog you can create an instance data block of the single-instance or multiple-instance
type for the function block in which the data of the inserted element will be saved. You will
find the new instance data block created in the project tree in the "Program resources"
folder under "Program blocks > System blocks". If you have selected "multiple instance",
these are located in the block interface in the "Static" section.
Result
The selected FBD element is inserted with dummy entries for the parameters.
See also
Rules for the use of FBD elements (Page 1629)
Requirement
A network is available.
Procedure
To insert FBD elements into a network using an empty box, follow these steps:
1. Open the "Instructions" task card.
2. Navigate to "General > Empty box" in the "Basic instructions" palette.
3. Use a drag-and-drop operation to move the "Empty box" element to the desired place in
the network.
4. Position the cursor over the triangle in the top right-hand corner of the empty box.
A drop-down list is displayed.
5. Select the desired FBD element from the drop-down list.
If the element is an internal system function block (FB), the "Call options" dialog opens. In
this dialog you can create an instance data block of the single-instance or multiple-instance
type for the function block in which the data of the inserted element will be saved. You will
find the new instance data block created in the project tree in the "Program resources"
folder under "Program blocks > System blocks". If you have selected "multi-instance", these
are located in the block interface in the "Static" section.
Result
The empty box is changed to the respective FBD element. Placeholders are inserted for the
parameters.
Introduction
Some instructions can be executed with several different data types. If you use one of these
instructions in the program, you have to specify a valid data type for the instruction at the
specific point in the program. For some instructions, you have to select the data types for the
inputs and outputs separately.
Note
The valid data type (BOOL) for the tags on the enable input EN and the enable output ENO is
predefined by the system and cannot be changed.
The valid data types for an instruction are listed in the instruction drop-down list. You specify
the data type of the instruction by selecting an entry from the drop-down list. If the data type
of an operand differs from the data type of the instruction and cannot be converted implicitly,
the operand is displayed in red and a rollout with the corresponding error message appears.
Note
Please also observe the information on data type conversion for your device and, in particular,
the notes on the IEC check.
See also: Data type conversion (Page 2091)
See also
Defining the data type of an instruction (Page 1633)
Introduction
Some instructions can be executed with several different data types. When you insert such
instructions into your program, you must specify the data type for these instructions at the
actual point in the program.
See also
Selecting a data type (Page 1632)
Requirement
A block is open.
The multipane mode is set for the "Instructions" task card or the Favorites are also displayed
in the editor.
Procedure
To add SCL instructions to the Favorites, follow these steps:
1. Open the "Instructions" task card.
2. Maximize the "Basic instructions" pane.
3. Navigate in the "Basic instructions" pane to the instruction that you want to add to the
Favorites.
4. Drag-and-drop the instruction into the "Favorites" pane or into the Favorites area in the
program editor.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Removing FBD elements from Favorites (Page 1636)
Overview of the program editor (Page 1529)
Requirement
A block is open.
Favorites are available.
Procedure
To insert an instruction into a program using Favorites, follow these steps:
1. Drag-and-drop the desired instruction from Favorites to the desired position.
Or:
1. Select the position in the program where you want to insert the instruction.
2. In the Favorites, click on the instruction you want to insert.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Overview of the program editor (Page 1529)
Removing FBD elements from Favorites (Page 1636)
Requirement
A code block is open.
Procedure
To remove instructions from Favorites, follow these steps:
1. Right-click on the instruction you want to remove.
2. Select the "Remove instruction" command in the shortcut menu.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Adding FBD elements to Favorites (Page 1635)
Inserting FBD elements using favorites (Page 1635)
Overview of the program editor (Page 1529)
Requirement
A network is available.
The block that is to be called is available.
Result
The function or the function block is inserted with its parameters. You can then assign the
parameters.
See also: Auto-Hotspot
Note
If when calling a function block you specify an instance data block that does not exist, it will
be created. If you have called a function block as a multi-instance, this will be entered as a
static tag in the interface.
See also
Updating block calls in FBD (Page 1638)
Changing the instance type (Page 1640)
Single instances (Page 1427)
Multi-instances (Page 1427)
Note
Note that the "Update block call" command is only available provided you did not previously
update all block calls in the editor with the "Update inconsistent block calls" command.
See also
Inserting block calls using a drag-and-drop operation (Page 1637)
Changing the instance type (Page 1640)
Procedure
To change the called block of a block call, follow these steps:
1. Click on the name of the called block within the block call and press the <F2> key. Or double-
click the name of the called block.
A text box opens, and the name of the currently called block is selected.
2. Enter the name of the block you want to call or select a block in the autocompletion.
3. If you want to call an FB, create a new instance data block, if necessary, and specify it as
operand.
Instance type
There are two ways of calling function blocks:
As a single instance
As a multiple instance
See also: Auto-Hotspot
You can modify a defined instance type at any time.
Requirement
The user program contains a block call.
Procedure
To change the instance type of a function block, follow these steps:
1. Open the code block and select the block call.
2. Select the "Change instance" command in the shortcut menu.
The "Call options" dialog opens.
3. Click the "Single instance" or "Multi instance" button.
If you select the "Single instance" instance type, enter a name for the data block that is
to be assigned to the function block.
If you select "Multiple instance" as the instance type, enter in the "Name in the interface"
text field the name of the tag with which the called function block is to be entered as a
static tag in the interface of the calling block.
4. Confirm your entries with "OK".
Note
The previous single and multiple instances will not be deleted automatically.
See also
Inserting block calls using a drag-and-drop operation (Page 1637)
Updating block calls in FBD (Page 1638)
Requirement
A network is available.
Procedure
Proceed as follows to use the "Calculate" instruction:
1. Open the "Instructions" task card.
2. Navigate to "Math functions > CALCULATE" in the "Basic instructions" pane.
3. Use drag-and-drop to move the element to the desired place in the network.
The instruction "Calculate" will be inserted for the data type with a placeholder expression
and question mark.
4. Enter the data type for the calculation.
5. Enter the operands for the calculation.
Note
The calculation is run with the inputs of the "Calculate" instruction. If you want to use
constants you must also insert appropriate inputs for them.
6. Click on the "Edit 'Calculate' instruction" button to replace the placeholder expression with
the correct expression.
The "Edit 'Calculate' instruction" dialog will open.
7. Enter the required expression in the "OUT:= " text box.
Note
In the "Example" area you can find an example of a valid expression and possible
instructions that you can use.
To determine a value with the help of Pythagoras' theorem, for example, enter "OUT :=
SQRT (SQR (IN1) + SQR (IN2))".
See also
CALCULATE: Calculate (Page 2575)
Introduction
Free-form comments allow you to add comments to the source code for graphic programming
languages similar to line comments for textual languages.
Free-form comments can be used for all non-binary boxes.
See also
Inserting free-form comments (Page 1642)
Editing free-form comments (Page 1643)
Deleting free-form comments (Page 1644)
Requirement
A network with instructions is available.
Procedure
To insert a free comment on an instruction, proceed as follows:
1. If necessary, activate the "Free-form comments on/off" button in the toolbar.
2. Right-click on the instruction for which you want to insert a free-form comment.
3. Select the "Insert comment" command in the shortcut menu.
A comment box with a standard comment opens. The comment box is connected by an
arrow to the corresponding instruction.
4. Enter the required comment in the comment box.
See also
Basic information on using free comments in FBD (Page 1642)
Editing free-form comments (Page 1643)
Deleting free-form comments (Page 1644)
Introduction
Free-form comments can be edited as follows:
Changing the comment text
Changing the position and size of the comment box
Attaching a comment to another element
Showing and hiding free comments
See also
Basic information on using free comments in FBD (Page 1642)
Inserting free-form comments (Page 1642)
Deleting free-form comments (Page 1644)
Procedure
To delete a free-form comment, proceed as follows:
1. Right-click on the free-form comment that you want to delete.
2. Select the "Delete" command in the shortcut menu.
See also
Basic information on using free comments in FBD (Page 1642)
Inserting free-form comments (Page 1642)
Editing free-form comments (Page 1643)
Requirement
FBD elements are available
See also
Copying FBD elements (Page 1645)
Cutting FBD elements (Page 1646)
Pasting an FBD element from the clipboard (Page 1646)
Replacing FBD elements (Page 1647)
Adding additional inputs and outputs to FBD elements (Page 1648)
Removing instruction inputs and outputs (Page 1649)
Enabling and disabling the EN/ENO mechanism (Page 1650)
Deleting FBD elements (Page 1651)
Requirement
An FBD element is available.
Procedure
To copy an FBD element, follow these steps:
1. Right-click the FBD element that you want to copy.
2. Select "Copy" in the shortcut menu.
Result
The FBD element will be copied and saved to the clipboard.
See also
Selecting FBD elements (Page 1644)
Cutting FBD elements (Page 1646)
Pasting an FBD element from the clipboard (Page 1646)
Replacing FBD elements (Page 1647)
Adding additional inputs and outputs to FBD elements (Page 1648)
Removing instruction inputs and outputs (Page 1649)
Enabling and disabling the EN/ENO mechanism (Page 1650)
Deleting FBD elements (Page 1651)
Requirement
An FBD element is available.
Cutting
To cut an FBD element, follow these steps:
1. Right-click the FBD element that you want to cut.
2. Select "Cut" in the shortcut menu.
Result
The FBD element will be cut and saved to the clipboard.
See also
Selecting FBD elements (Page 1644)
Copying FBD elements (Page 1645)
Pasting an FBD element from the clipboard (Page 1646)
Replacing FBD elements (Page 1647)
Adding additional inputs and outputs to FBD elements (Page 1648)
Removing instruction inputs and outputs (Page 1649)
Enabling and disabling the EN/ENO mechanism (Page 1650)
Deleting FBD elements (Page 1651)
Requirement
An FBD element is available.
Procedure
To paste an FBD element from the clipboard, follow these steps:
1. Copy an FBD element or cut an FBD element.
2. Right-click the point in the network where you want to paste the element.
3. Select "Paste" in the shortcut menu.
See also
Selecting FBD elements (Page 1644)
Copying FBD elements (Page 1645)
Cutting FBD elements (Page 1646)
Replacing FBD elements (Page 1647)
Adding additional inputs and outputs to FBD elements (Page 1648)
Removing instruction inputs and outputs (Page 1649)
Enabling and disabling the EN/ENO mechanism (Page 1650)
Deleting FBD elements (Page 1651)
Requirements
A network with at least one FBD element is present.
Procedure
To replace an FBD element with another FBD element, follow these steps:
1. Select the FBD element that you want to replace.
If elements compatible with the selected FBD element are available, a triangle will appear
in the upper right-hand corner of the element.
2. Position the cursor above the triangle of the FBD element.
A drop-down list is displayed.
3. From the drop-down list, select the FBD element that you want to use to replace the existing
FBD element.
See also
Selecting FBD elements (Page 1644)
Copying FBD elements (Page 1645)
Cutting FBD elements (Page 1646)
Pasting an FBD element from the clipboard (Page 1646)
Adding additional inputs and outputs to FBD elements (Page 1648)
Removing instruction inputs and outputs (Page 1649)
Introduction
You can expand several FBD elements with additional inputs that execute arithmetic or binary
operations. Such elements are, for example, the instructions "Add" (ADD), "Multiply" (MUL),
AND or OR. You can expand the "MOVE value" (MOVE) and "Demultiplex" (DEMUX)
instruction boxes by adding additional outputs.
The name of the new inputs and outputs is comprised of the type of inserted element and a
consecutive number. The name of a new input is may be "IN2"; the name of a new output may
be "OUT2".
Requirements
An FBD element is available that permits the insertion of additional inputs and outputs.
See also
Selecting FBD elements (Page 1644)
Copying FBD elements (Page 1645)
Introduction
Inputs and outputs which you have added to an instruction can be removed.
Requirement
An FBD element is available, which you have expanded with additional inputs or outputs.
Remove input
To remove an input, follow these steps:
1. Select the input that you want to remove.
2. Select the "Delete" command in the shortcut menu.
The input of the FBD element is removed.
Remove output
To remove an output, follow these steps:
1. Select the output that you want to remove.
2. Select the "Delete" command in the shortcut menu.
The output of the FBD element will be removed.
See also
Selecting FBD elements (Page 1644)
Copying FBD elements (Page 1645)
Cutting FBD elements (Page 1646)
Pasting an FBD element from the clipboard (Page 1646)
Replacing FBD elements (Page 1647)
Adding additional inputs and outputs to FBD elements (Page 1648)
See also
Selecting FBD elements (Page 1644)
Copying FBD elements (Page 1645)
Cutting FBD elements (Page 1646)
Pasting an FBD element from the clipboard (Page 1646)
Replacing FBD elements (Page 1647)
Requirement
An FBD element is available.
Procedure
To delete an FBD element, follow these steps:
1. Right-click the FBD element that you want to delete.
2. Select the "Delete" command in the shortcut menu.
See also
Selecting FBD elements (Page 1644)
Copying FBD elements (Page 1645)
Cutting FBD elements (Page 1646)
Pasting an FBD element from the clipboard (Page 1646)
Replacing FBD elements (Page 1647)
Adding additional inputs and outputs to FBD elements (Page 1648)
Removing instruction inputs and outputs (Page 1649)
Enabling and disabling the EN/ENO mechanism (Page 1650)
Inserting operands
The character strings "<???>", "<??.?>" and "..." are inserted as placeholders for the
parameters when a FBD element is inserted. The "<???>" and "<??.?>" strings displayed in
red indicate parameters that need to be connected. The "..." string displayed in black indicates
parameters that may be connected. "<??.?>" stands for Boolean placeholders.
Note
To display the available data types in a tooltip, move the cursor over the placeholder.
Requirement
An FBD element is available.
Procedure
To connect the parameters of an FBD element, follow these steps:
1. Click the placeholder of the parameter.
An input field is opened.
2. Enter the corresponding parameters, for example a PLC tag, a local tag or a constant.
Note
If you enter the absolute address of a parameter that has already been defined, this absolute
address will be changed to the symbolic name of the parameter as soon as the input is
confirmed. If you have not yet defined the parameter, a new tag with this absolute address
and the default name "Tag_1" will be entered in the PLC tag table. When you confirm your
input, the absolute address will be replaced with the symbolic name "Tag_1".
Result
If the syntax is error-free, the displayed parameter is black.
If there is an error in the syntax, the cursor stays in the input field and a corresponding error
message is displayed in the inspector window in the "Info > Syntax" register.
Introduction
Depending on the CPU used, you can use complex instructions in your program that are
included with the TIA Portal. These instructions can contain parameters that are declared as
hidden.
If an instruction contains hidden parameters, the instruction box has a small arrow on the lower
edge. You can recognize hidden parameters by their white font.
You can show and wire the hidden parameters at any time.
See also
Using libraries (Page 470)
Introduction
You can display the following information about the tags to be used in the Program editor:
Name of the tag
Address of the tag
Simple or hierarchical comments for tag documentation
The information is taken from the block interface for local tags and DB tags and from the PLC
tag table for tags that are valid CPU-wide.
You can display the tag information either for all the blocks or for individually opened blocks.
If you display the tag information for all the blocks, the tag information for all the blocks currently
opened and opened in future is shown.
You can hide the tag information at any time again. If you have hidden the tag information for
all blocks, you can display it again for individual blocks that are open.
When you select the display of tag information with hierarchical comments, the comments of
the higher structure levels are also displayed for structured tags. The comments are shown in
brackets after the tag comment; the comments of the individual levels are separated by a dot.
If there is no comment for a tag on a structure level, it is not displayed. This is indicated by two
successive dots.
Branches in FBD
Definition
You can use the Function Block Diagram (FBD) programming language to program parallel
branches. This is done using branches that are inserted between the boxes. You can insert
additional boxes within the branch and in this way build up complex function block diagrams.
The figure below shows an example of the use of branches:
!
6
6 /()7
6 5
5,*+7
6
See also
Rules for branches in FBD (Page 1655)
Inserting branches in FBD networks (Page 1655)
Deleting branches in FBD networks (Page 1656)
Rules
The following rules apply to the use of branches in FBD:
Branches are opened downward.
Branches can be inserted only between FBD elements.
To delete a branch, you must delete all FBD elements, including the branch itself.
If you delete the connection between two branches, the FBD elements of the interrupted
branch will be positioned freely in the network.
See also
Basic information on branches in FBD (Page 1654)
Inserting branches in FBD networks (Page 1655)
Deleting branches in FBD networks (Page 1656)
Requirement
A network is available.
Procedure
To insert a new branch in a network, follow these steps:
1. Open the "Instructions" task card.
2. Navigate to "General > Branch" in the "Basic instructions" palette.
3. Drag the element from the "Elements" pane to the a required location on a connection line
between two boxes.
See also
Rules for branches in FBD (Page 1655)
Basic information on branches in FBD (Page 1654)
Deleting branches in FBD networks (Page 1656)
Requirement
A branch is available.
Procedure
To delete a branch, follow these steps:
1. Select the connection line that links the branch to the main branch.
2. Select the "Delete" command in the shortcut menu.
Result
The branch is now deleted. Boxes connected to the deleted branch are placed freely within
the network.
See also
Rules for branches in FBD (Page 1655)
Basic information on branches in FBD (Page 1654)
Inserting branches in FBD networks (Page 1655)
6WDUW6ZLWFKB/HIW !
02725B21
6WDUW6ZLWFKB5LJKW 6
6WRS6ZLWFKB/HIW !
02725B21
6WRS6ZLWFKB5LJKW 5
Rules
Remember the following rules when using logic paths:
Connections are not permitted between logic paths.
Only one jump instruction is permissible per network. The positioning rules for jump
instructions remain valid.
See also
Inserting a logic path (Page 1658)
Deleting a logic operation path (Page 1658)
Requirement
A block is open.
A network is available.
Procedure
To insert a new logic path in a network, follow these steps:
1. Insert any instruction in a network in such a way that it has no connection to existing
instructions.
A new logic path is inserted.
2. Insert an assignment at the end of the new logic path.
3. Insert additional instructions in the new logic path.
See also
Basic information on logic paths in FBD (Page 1657)
Deleting a logic operation path (Page 1658)
Requirement
A logic path is available.
Procedure
To delete a logic path, proceed as follows:
1. Hold down the left mouse button and draw a frame around the logic path. At the same time,
make sure that you select all instructions of the logic path. Alternatively, you can hold down
the <Shift> key and select the first the last instruction of the logic path.
2. Right-click on one of the instructions in the logic path.
3. Select the "Delete" command in the shortcut menu.
See also
Basic information on logic paths in FBD (Page 1657)
Inserting a logic path (Page 1658)
Basics of SCL
Language elements
SCL also contains higher programming languages in addition to the typical elements of the
PLC, such as inputs, outputs, timers or memory bits.
Expressions
Value assignments
Operators
Program control
SCL provides convenient instructions for controlling the program allowing you, for example, to
create program branches, loops or jumps.
Application
SCL is therefore particularly suitable for the following areas of application:
Data management
Process optimization
Recipe management
Mathematical / statistical tasks
Expressions
Description
Expressions are calculated during the runtime of the program and return a value. An expression
consists of operands (such as constants, tags or function calls) and optionally out of operators
(such as *, /, + or -). Expressions can be linked together or nested within each other by
operators.
Evaluation order
The evaluation of the expression occurs in a specific order that is defined by the following
factors:
Priority of the operators involved
Left-to-right order
Brackets
Types of expressions
The following expression types are available depending on the operator:
Arithmetic expressions
Arithmetic expressions consist of either a numerical value or combine two values or
expressions with arithmetic operators.
Relational expressions
Relational expressions compare the values of two operands and yield a Boolean value.
The result is TRUE if the comparison is true, and FALSE if it is not met.
Logical expressions
Logical expressions combine two operands with logical operators (AND, OR, XOR) or
negating operands (NOT).
See also
Operators and operator precedence (Page 1665)
Arithmetic expressions (Page 1660)
Relational expressions (Page 1663)
Logical expressions (Page 1665)
Arithmetic expressions
Description
Arithmetic expressions consist of either a numerical value or combine two values or
expressions with arithmetic operators.
Arithmetic operators can process the data types that are allowed in the CPU in use. If two
operands are involved in the operation, the data type of the result is determined based on the
following criteria:
If both operands are integers with sign and have different lengths, the result receives the
data type of the longer integer (e. g. INT + DINT = DINT).
If both operands are integers without sign and have different lengths, the result receives
the data type of the longer integer (e. g. USINT + UDINT = UDINT).
If one operand is an integer with sign and the other integer is an operand without sign, the
result receives the next larger data type with sign that covers the integer without sign (e.
g. SINT + USINT = INT).
You can only execute an operation with such operands if the IEC check is not set.
If one operand is an integer and the other operand is a floating-point number, the result
receives the data type of the floating-point number (e. g. INT + REAL = REAL).
If both operands are floating-point numbers and have different lengths, the result receives
the data type of the longer floating-point number (e. g. REAL + LREAL = LREAL).
The data type of the result of an operation that involves operands of the data type groups
"Times" and "Date and time" can be found in the table in section "Data types of arithmetic
expressions".
You cannot use data types of the data type groups "Times" and "Date and time" when the
IEC check is set.
Example
The following example shows an arithmetic expression:
SCL
"MyTag1":= "MyTag2" * "MyTag3";
See also
Expressions (Page 1659)
Operators and operator precedence (Page 1665)
Relational expressions
Description
Relational expressions compare the values of two operands and yield a Boolean value. The
result is TRUE if the comparison is true, and FALSE if it is not met.
Relational operators can process the data types that are allowed in the CPU in use. The data
type of the result always is BOOL.
Note the following rules when forming relational expressions:
All tags are comparable within the following data type groups:
Integers/floating-point numbers
Binary numbers
String
With the following data types/data groups, only tags of the same type can be compared:
TIME, LTIME
Date and time
The comparison of strings is based on the ASCII character set. The length of the tags and
the numerical value of each ASCII character are used for the comparison.
S5TIME tags are not permitted as comparison operands. An explicit conversion from
S5TIME to TIME or LTIME is necessary.
Example
The following example shows a relational expression:
SCL
IF a > b THEN c:= a;
IF A > 20 AND B < 20 THEN C:= TRUE;
IF A<>(B AND C) THEN C:= FALSE;
Note
The comparison for STRING and DT are executed internally in the S7-300/400 by extended
instructions. The following operands are not permitted for these functions:
Parameter of a FC
In-out parameter of an FB of type STRUCT or ARRAY
See also
Expressions (Page 1659)
Operators and operator precedence (Page 1665)
Logical expressions
Description
Logical expressions combine two operands with logical operators AND OR XOR or negating
operands NOT.
Logical operators can process the data types that are allowed in the CPU in use. The result
of a logical expression is of BOOL data type, if both operands are of BOOL data type. If at
least one of both operands is a bit string, then the result is also a bit string and is determined
by the type of the highest operand. For example, when you link a BYTE type operand to a
WORD type operand, the result is type WORD.
To link a BOOL type operand with a bit string, you must first explicitly convert it to a bit string.
Example
The following example shows a logical expression:
SCL
IF "MyTag1" AND NOT "MyTag2" THEN c:=a;
MyTag:=ALPHA OR BETA;
See also
Expressions (Page 1659)
Operators and operator precedence (Page 1665)
The order of evaluation for expressions depends on the precedence of operators and brackets.
The following basic rules apply:
Arithmetic operators are evaluated before relational operators and relational operators are
evaluated before logical operators.
Operators with no precedence are evaluated according to their occurrence from left to right.
Operations in brackets are evaluated first.
The following table provides an overview of the operators and their precedence:
Value assignments
Definition
You can use a value assignment to assign the value of an expression to a tag. On the left side
of the assignment is the tag that takes the value of the expression on the right.
The name of a function can also be specified as an expression. The function is called by the
value assignment and returns its function value to the tag on the left.
The data type of value assignment is defined by the data type of the tag on the left. The data
type of the expression on the right must match this type.
For additional information on compatibility and conversion of data types, refer to "See also".
Examples
The following table shows examples for value assignments:
SCL
"MyTag1" := "MyTag2"; (* Assignment of a tag*)
"MyTag1" := "MyTag2" * "MyTag3"; (* Assignment of an expression*)
"MyTag" := "MyFC"(); (* Call for a function that assigns its
function value to the "MyTag" tag*)
#MyStruct.MyStructElement := "MyTag"; (* Assignment of a tag to a structure
element*)
#MyArray[2] := "MyTag"; (* Assignment of a tag to an ARRAY ele-
ment*)
"MyTag" := #MyArray[1,4]; (* Assignment of an ARRAY element to a
tag*)
#MyString[2] := #MyOtherString[5]; (* Assignment of a STRING element to
another STRING element*)
See also
Operators and operator precedence (Page 1665)
Overview
The following tables show the settings you can make for SCL:
Editor settings
See also
Changing the settings (Page 1669)
Procedure
To change the settings, follow these steps:
1. Select the "Settings" command in the "Options" menu.
The "Settings" window is displayed in the work area.
2. In the area navigation, select the "PLC programming" group.
3. Change the settings.
Result
The change will be loaded directly, there is no need to save it explicitly.
See also
Overview of the settings for SCL (Page 1668)
Function
The programming window is the work area, where you enter the SCL program.
The following figure shows the programming window of SCL:
Section Meaning
Sidebar You can set bookmarks and breakpoints in the sidebar.
Line numbers The line numbers are displayed to the left of the program
code.
Outline view The outline view highlights related code sections.
Code area You edit the SCL program in the code area.
Display of the absolute operands This table shows the assignment of symbolic operands
to absolute addresses.
See also
Customizing the programming window (Page 1671)
Formatting SCL code (Page 1672)
Expanding and collapsing sections of code (Page 1673)
Introduction
You can customize the appearance of the programming window and the program code in the
following way:
By setting the font, size and color
By setting the tab spacing
By displaying the line numbers
By showing or hiding the absolute operands
To hide or show the display of the absolute operands, follow these steps:
1. Click the "Absolute/symbolic operands" icon in the toolbar.
The display of the absolute operands appears.
2. To move the display, click the table and drag it to the desired position while holding down
the mouse button.
3. To change the width of the table, click on the right or left table border and drag it to the right
or left while holding down the mouse button.
See also
Overview of the programming window (Page 1670)
Formatting SCL code (Page 1672)
Expanding and collapsing sections of code (Page 1673)
Introduction
To make the program clearer, you can indent or outdent individual lines manually or format
code sections. Note the following information about formatting code sections:
The type of formatting is based on the general settings for indents, but at least the line or
the section is always indented. If you selected the setting "Smart", unnecessary spaces
within the SCL instruction are also removed.
Only syntactically correct code sections can be formatted.
If you place the insertion point in the first or last line of an instruction for program control,
for example in an IF instruction in the line with the "IF", the entire instruction is formatted.
If you select text, only the selected text is formatted.
Note
You can set the width of the indent in "Options > Settings".
See also
Overview of the programming window (Page 1670)
Customizing the programming window (Page 1671)
Expanding and collapsing sections of code (Page 1673)
Overview of the script and text editor settings (Page 304)
Introduction
SCL instructions can span several lines. Examples for this are program control instructions or
block calls.
Such instructions that belong together are identified as follows:
An outline view between the display line number and the program code marks the entire
code section.
When you select the opening keyword, the closing keyword is automatically highlighted.
To improve clarity, you can expand or collapse sections of code that belong together in the
outline display. The selected outline display is retained when you close the block or the project
so that, the next time you open the block, the sections of code are displayed in exactly the
same way as they were when you closed it.
Procedure
To expand or collapse the code section, follow these steps:
1. Click the minus sign in the outline view.
The code section closes.
2. Click the plus sign in the outline view.
The code section opens.
See also
Overview of the programming window (Page 1670)
Customizing the programming window (Page 1671)
Formatting SCL code (Page 1672)
Using bookmarks
Basics of bookmarks
Function
You can use bookmarks to mark program locations in extensive programs so that you can find
them quickly later if they need revising. Bookmarks are displayed in the sidebar of the
programming window. You can navigate between multiple bookmarks within a block using
menu commands.
Bookmarks are saved with the project and are therefore available for anyone who wants to
edit the block. However, they are not loaded to a device.
Bookmarks are not evaluated when blocks are compared.
See also
Setting bookmarks (Page 1674)
Navigating between bookmarks (Page 1675)
Deleting bookmarks (Page 1675)
Setting bookmarks
Requirement
The SCL block is open.
Procedure
To set a bookmark, follow these steps:
1. Right-click on the desired line in the sidebar.
2. Select the "Bookmarks > Set" command in the shortcut menu.
Or:
1. Click on the line in which you want to place the bookmark.
2. Click the "Set/delete bookmark" button in the toolbar.
Or:
1. Hold down the <Ctrl> key.
2. Click on the line in the sidebar in which you want to place the bookmark.
Result
A bookmark is placed in the program code.
See also
Basics of bookmarks (Page 1674)
Navigating between bookmarks (Page 1675)
Deleting bookmarks (Page 1675)
Requirement
Several bookmarks are set in a block.
Procedure
To navigate between bookmarks, follow these steps:
1. Set the insertion cursor in the program code.
2. In the "Edit" menu, select the "Go to > Next bookmark" or "Go to > Previous bookmark"
command.
Or:
1. Set the insertion cursor in the program code.
2. In the toolbar of the programming editor, click the "Go to next bookmark", "Go to previous
bookmark" button.
Or:
1. Click in the sidebar.
2. Select the "Bookmarks > Next" or "Bookmarks > Previous" command in the shortcut menu.
Result
The line with the bookmark is highlighted.
See also
Basics of bookmarks (Page 1674)
Setting bookmarks (Page 1674)
Deleting bookmarks (Page 1675)
Deleting bookmarks
You can delete individual bookmarks or all bookmarks from the block or the CPU.
See also
Basics of bookmarks (Page 1674)
Setting bookmarks (Page 1674)
Navigating between bookmarks (Page 1675)
Instructions in SCL
SCL recognizes the following types of instructions:
Value assignments
Value assignments are used to assign a tag a constant value, the result of an expression
or the value of another tag.
Instructions for program control
Instructions for program control are used to implement program branches, loops or jumps.
Rules
You need to observe the following rules when entering SCL instructions:
Instructions can span several lines.
Each instruction ends with a semicolon (;).
No distinction is made between upper and lower case.
Comments serve only for documentation of the program. They do not affect the program
execution.
Examples
The following examples shows the various types of instructions:
SCL
// Example of a value assignment
"MyTag":= 0;
// Example of a block call
"MyDB"."MyFB" (ParamInput:= 10);
// Example of a program control instruction
WHILE "Counter" < 10 DO
"MyTAG" := "MyTag" + 2;
END_WHILE;
Requirement
An SCL block is open.
Procedure
To enter SCL instructions, follow these steps:
1. Enter the syntax of the instruction using the keyboard.
You are supported by the auto-complete function when performing this task. It offers all the
instructions and operands that are allowed at the current location.
2. Select the required instruction or the desired operand from the auto-complete function.
If you select an instruction that requires specification of operands, placeholders for the
operands are inserted into the program. The placeholders for the operands are highlighted
in yellow. The first placeholder is selected.
Note
You can also drag-and-drop a defined operand from the PLC tag table or from the block
interface into the program. To replace an operand that has already been inserted, hover the
mouse pointer briefly over the operand to be replaced before releasing the mouse button. This
selects the operand and when you release the mouse button it is replaced by the new operand.
Result
The instruction is inserted.
The programming editor performs a syntax check. Incorrect entries are displayed in red and
italics. In addition, you also receive a detailed error message in the inspector window.
See also
Using autocompletion in textual programming languages (Page 1548)
Data type conversion for S7-1200: (Page 2091)
Expanding and reducing the parameter list (Page 1693)
Requirement
An SCL block is open.
Procedure
To insert SCL instructions into a program using the "Instructions" task card, follow these steps:
1. Open the "Instructions" task card.
2. To insert the instruction, select one of the following steps:
Navigate to the SCL instruction you want to insert and drag-and-drop it to the required
line in the program code. The insertion location is highlighted by a green rectangle.
Select the location in the program code where you want to insert the instruction and
then double-click on the instruction you want to insert.
The instruction is inserted in the program. The placeholders for the operands are highlighted
in yellow. The first placeholder is selected.
3. Replace this placeholder with an operand. You can also drag a tag from the interface or
the PLC tag table with drag-and-drop to the placeholder.
4. Use the <TAB> key to navigate to all other placeholders and replace them with operands.
Result
The instruction is inserted.
The programming editor performs a syntax check. Incorrect entries are displayed in red and
italics. In addition, you also receive a detailed error message in the inspector window.
See also
Using autocompletion in textual programming languages (Page 1548)
Data type conversion for S7-1200: (Page 2091)
Expanding and reducing the parameter list (Page 1693)
Introduction
The SCL instructions that you employ for block programming use specific data types to
calculate function values. Certain SCL instructions only support the use of a specific data type.
You cannot change the data type for these instructions. However, most of the SCL instructions
support the use of different data types. We differentiate between the following two types of
such instructions:
Instructions for which the data type of the function value is determined by the data type of
the input parameters. This is the case for most instructions.
Instructions with default data type. The instructions listed in the following table are of this
type.
You will have to change the default data type if this is incompatible with the data type of the
input parameter used. You can always change the data type based on the following syntax:
_<data type>
See also
Changing the data type of an SCL instruction (Page 1680)
Example for changing the data type of an SCL instruction (Page 1681)
Procedure
Proceed as follows to insert an SCL instruction and change its data type:
1. Insert the instruction at the required point in the program using drag-and-drop.
2. Specify the operands for the instruction.
The data type of the function value is specified based on the input parameters, or the default
data type of the instruction is used.
3. Append the "_<data type>" string to the instruction name.
"<data type>" represents the data type you need for the instruction.
See also
Basic information on the data types of SCL instructions (Page 1679)
Example for changing the data type of an SCL instruction (Page 1681)
Procedure
To change the data type of an IEC timer or IEC-counter instance data block, proceed as follows:
1. Open the block in which you call the IEC timer or IEC counter.
Depending on the instance type of the instance data block, there is a green-bordered box
before (multi-instance) or after (single instance) the name of the instance data block.
2. Click the green-bordered box.
A drop-down list box with the valid data types for the instance data block is opened.
3. Select the desired data type.
See also
Basic information on the data types of SCL instructions (Page 1679)
Changing the data type of an SCL instruction (Page 1680)
Introduction
Regardless of whether the operands are represented in absolute or symbolic form, you can
show and hide simple or hierarchical comments used to document global tags. This information
is taken from the PLC tag table.
You can display the tag information either for all the blocks or for individually opened blocks.
If you display the tag information for all the blocks, the tag information for all blocks currently
opened and opened in future is shown.
You can hide the tag information at any time again. If you have hidden the tag information for
all blocks, you can display it again for individual ones that you have opened.
If you select the display of tag information with hierarchical comments, the comments of the
higher structure levels of structured tags will also be displayed. The display is in brackets after
the comment of the tags; the comments of the individual levels are separated by a period. If
there is no comment at a structure level for a tag, it is omitted in the display and this is
recognizable because there are two periods.
Requirement
A block is open.
The multipane mode is set for the "Instructions" task card or the Favorites are also displayed
in the editor.
Procedure
To add SCL instructions to the Favorites, follow these steps:
1. Open the "Instructions" task card.
2. Maximize the "Basic instructions" pane.
3. Navigate in the "Basic instructions" pane to the instruction that you want to add to the
Favorites.
4. Drag-and-drop the instruction into the "Favorites" pane or into the Favorites area in the
program editor.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Overview of the program editor (Page 1529)
Inserting SCL instructions using Favorites (Page 1683)
Removing SCL instructions from the Favorites (Page 1684)
Requirement
A block is open.
Favorites are available.
Procedure
To insert an instruction into a program using Favorites, follow these steps:
1. Drag-and-drop the desired instruction from Favorites to the desired position.
Or:
1. Select the position in the program where you want to insert the instruction.
2. In the Favorites, click on the instruction you want to insert.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Overview of the program editor (Page 1529)
Adding SCL instructions to the Favorites (Page 1682)
Removing SCL instructions from the Favorites (Page 1684)
Requirement
A code block is open.
Procedure
To remove instructions from Favorites, follow these steps:
1. Right-click on the instruction you want to remove.
2. Select the "Remove instruction" command in the shortcut menu.
Note
To additionally display the Favorites in the program editor, click the "Display favorites in the
editor" button in the program editor toolbar.
See also
Overview of the program editor (Page 1529)
Adding SCL instructions to the Favorites (Page 1682)
Inserting SCL instructions using Favorites (Page 1683)
Syntax of a call
The following syntax is used to call a function block as a single or multi-instance:
Single instance:
If the function block originates from the project:
<DBName> (Parameter list)
If the function block originates from the "Instructions" task card:
<DB name>.<Instruction name> (Parameter list)
Multi-instance
<#Instance name> (Parameter list)
Parameter list
If you call another code block from a SCL block, you can supply the formal parameters of the
called block with actual parameters.
The specification of the parameters has the form of a value assignment. This value assignment
enables you to assign values (actual parameters) to the parameters you have defined in the
called block.
The formal parameters of the called code block are listed in brackets directly after the call.
Input and in-out parameters have the assignment identifier ":=", output parameters have the
assignment identifier "=>". A placeholder placed after the parameter shows the required data
type and the type of the parameter.
See also
Manually inserting block calls (Page 1689)
Inserting block calls with drag-and-drop (Page 1690)
Examples for calling a function block in SCL (Page 1687)
Calling functions
Syntax of a call
The following syntax is used to call a function:
<Function name> (Parameter list); //Standard call
Function value
Functions that provide a return value can be used in any expression in place of an operand.
For this reason, the return value is also known as the "function value" in SCL.
The call options of functions depend on whether the function returns a function value to the
calling block.
The function value is defined in the RET_VAL parameter. If the RET_VAL parameter is of the
VOID data type, then the function will not return a value to the calling block. If the RET_VAL
parameter has another data type, then the function returns a function value of this data type.
In SCL, all data types are permitted for the RET_VAL parameter except ANY, ARRAY,
STRUCT and VARIANT, as well as the parameter types TIMER and COUNTER.
Call options
There are two possibilities for calling functions in SCL:
Standard call for functions with and without a function value
With a standard call, the results of the function is made available as an output and in-out
parameter.
Call in an expression for functions with a function value
Functions that return a function value can be used in any expression in place of an operand,
for example, a value assignment.
The function calculates the function value, which has the same name as the function and
returns it to the calling block. There the value replaces the function call.
Following the call, the results of the function is made available as a function value or as an
output and in-out parameter.
Parameter list
If you call another code block from a SCL block, you need to supply the formal parameters of
the called block with actual parameters.
The specification of the parameters has the form of a value assignment. This value assignment
enables you to assign values (actual parameters) to the parameters you have defined in the
called block.
The formal parameters of the called code block are listed in brackets directly after the call.
Input and in-out parameters have the assignment identifier ":=", output parameters have the
assignment identifier "=>". A gray placeholder placed after the parameter shows the required
data type and the type of the parameter.
See also
Manually inserting block calls (Page 1689)
Inserting block calls with drag-and-drop (Page 1690)
Examples for calling functions in SCL (Page 1688)
SCL
// Call as a single instance
"MyDB" (MyInput:=10, MyInout:= "Tag1");
Result
After the call is executed, the value determined for the "MyInout" in/out parameter is available
in "Tag1" in the "MyDB" data block.
Calling as a multi-instance
The following example shows the call of an FB as a multi-instance:
SCL
// Call as a multi-instance
"MyFB" (MyInput:= 10, MyInout:= "Tag1");
Result
After the "MyFB" block is executed, the value determined for the "MyInout" in-out parameter
is made available in "Tag1" in the data block of the calling code block.
See also
Calling function blocks (Page 1684)
Manually inserting block calls (Page 1689)
Inserting block calls with drag-and-drop (Page 1690)
Standard call
The following example shows a standard function call:
SCL
// Standard function call
"MyFC" (MyInput := 10, MyInOut := "Tag1");
Result
After the "MyFC" block is executed, the value determined for the "MyInOut" in/out parameter
is available in "Tag1" in the calling block and needs to be further processed there.
SCL
(*Call in a value assignment, a function value was defined for "MyFC" *)
#MyOperand := "MyFC" (MyInput1 := 3, MyInput2 := 2, MyInput3 := 8.9,
MyInOut := "Tag1");
Result
The function value of "MyFC" is transferred to "#MyOperand".
SCL
(*Call in a mathematical expression, a function value was defined for
"MyFC" *)
#MyOperand := "Tag2" + "MyFC" (MyInput1 := 3, MyInput2 := 2, MyInput3 :=
8.9);
Result
The function value of "MyFC" will be added to "Tag2" and the result will be transferred to
"MyOperand".
See also
Calling functions (Page 1685)
Manually inserting block calls (Page 1689)
Inserting block calls with drag-and-drop (Page 1690)
5. Replace this placeholder with an actual parameter. You can also drag a tag from the
interface or the PLC tag table with drag-and-drop to the placeholder.
6. Use the <TAB> key to navigate to all other placeholders and replace them with actual
parameters.
Result
The block call is inserted.
If you specify an instance data block that does not exist when calling a function block, it is
created.
See also
Updating block calls (Page 1691)
Expanding and reducing the parameter list (Page 1693)
Using autocompletion in textual programming languages (Page 1548)
Requirement
The function to be called (FC) or the function block (FB) to be called is present.
Result
The block call is inserted.
If you specify an instance data block that does not exist when calling a function block, it is
created.
See also
Updating block calls (Page 1691)
Expanding and reducing the parameter list (Page 1693)
Using autocompletion in textual programming languages (Page 1548)
You have the following options for updating the block calls:
Explicit updating of all inconsistent block calls in the programming editor.
The inconsistent block calls within the open block are updated. The following actions are
carried out in the process:
New parameters are added. Please note, however, that the parameters are hidden for
function blocks (FBs) and the parameters are supplied via the corresponding instance
data block (DB). If required, you can show the parameters using the shortcut menu
command "Show all parameters".
Deleted parameters are not removed. If necessary, expand the parameter list to remove
deleted parameters manually.
Renamed parameters get the new parameter names.
Explicit updating of a block call in the programming editor.
The inconsistent call of this block is updated at all call locations. The following actions are
carried out in the process:
New parameters are added.
Deleted parameters are not removed. If necessary, expand the parameter list to remove
deleted parameters manually.
Renamed parameters get the new parameter names.
Implicit updating during compilation.
All block calls in the program as well as the used PLC data types will be updated. Make
sure that you manually remove deleted parameters before the compilation process and
supply all new formal parameters with actual parameters when you call functions.
Note
Note that the "Update block call" command is only available as long as you did not previously
update all block calls in the editor with the "Update inconsistent block calls" command.
See also
Manually inserting block calls (Page 1689)
Inserting block calls with drag-and-drop (Page 1690)
Expanding and reducing the parameter list (Page 1693)
See also
Entering SCL instructions manually (Page 1677)
Inserting SCL instructions using the "Instructions" task card (Page 1678)
Manually inserting block calls (Page 1689)
Inserting block calls with drag-and-drop (Page 1690)
Inserting comments
Example
The following code contains comment sections and line comments
(*************************************************************************************
A description of the instructions that follow can be placed here
**************************************************************************************)
IF "MyVal1" > 0 THEN //No division by 0
"MyReal" := "MyVal2" (* input value *) / "MyVal1" (* measured value *);
END_IF;
//Data type conversion
"MyInt" := REAL_TO_INT("MyReal");
Selecting instructions
You can select individual instructions or all instructions of a block.
Requirement
An SCL block is open.
Note
When you select the opening keyword of an instructing, the closing keyword is automatically
highlighted.
Copying an instruction
To copy an instruction, follow these steps:
1. Select the instruction you want to copy.
2. Select "Copy" in the shortcut menu.
Cutting an instruction
To cut an instruction, follow these steps:
1. Select the instruction you want to cut.
2. Select the "Cut" command in the shortcut menu.
Deleting instructions
Requirement
An SCL block is open.
Procedure
To delete an instruction, follow these steps:
1. Select the instruction you want to delete.
2. Select the "Delete" command in the shortcut menu.
Syntax errors
Below are some examples of syntax errors:
Missing separators or the use of too many separators
Incorrect keyword spelling
Incorrect jump label spelling/notation
Notation which does not match the set mnemonics (for example, "I2.3" instead of "E2.3")
The use of key words as operands
See also
Finding syntax errors in the program (Page 1697)
Procedure
To find syntax errors in the program, follow these steps:
1. Select the position in the program in which you wish to look for errors.
2. Click "Go to next error" in the toolbar.
The first error after the position you have selected will be marked.
You can use "Go to next error" and "Go to previous error" in the toolbar to find and correct all
errors in the block.
Or:
1. Open the error list in the inspector window with "Info > Syntax".
All syntax errors are listed in the table with a short description of the error.
2. If there are any errors, click on the blue question mark next to the error text to obtain
information on eliminating the problem.
3. Double-click the error you want to correct.
The corresponding error is highlighted.
See also
Basic information on syntax errors (Page 1697)
Rules
Observe the following rules if you want to change the programming language for a block:
All CPU series:
You can only change the programming language of entire blocks. The programming
language cannot be changed for individual networks.
You cannot switch blocks programmed in the programming languages SCL or GRAPH.
In GRAPH blocks, however, you can change between LAD and FBD as network
languages.
S7-300/400:
You can only change between the programming languages LAD, FBD and STL.
You can create networks within a block using another programming language and then
copy them into the desired block.
If the language of individual networks of the block cannot be changed, these networks
is displayed in their original language.
S7-1200/1500:
You can change between the programming languages LAD and FBD.
S7-1500:
You can create STL networks within the LAD and FBD blocks. However, you cannot
copy between STL and LAD/FBD.
Procedure
To change the programming language, follow these steps:
1. Right-click the block in the project tree.
2. Select the "Properties" command in the shortcut menu.
The dialog with the properties of the block opens.
3. Select the "General" entry in the area navigation.
4. Select the new programming language in the "Language" drop-down list.
5. Confirm your selection with "OK".
See also
Rules for changing the programming language (Page 1698)
Introduction
Program execution errors are programming or I/O access errors. You have a number of
different options for responding to program execution errors depending on the CPU used.
Note
Note the following information:
All memory access errors and I/O access errors must be captured either by global or local
error handling.
If the parameters of an instruction do not cause any memory access errors, you can query
the associated ENO.
See also
GET_ERROR: Get error locally (Page 2694)
GET_ERR_ID: Get error ID locally (Page 2697)
GET_ERROR: Get error locally (Page 2414)
GET_ERR_ID: Get error ID locally (Page 2417)
Querying and fixing errors in the program code (Page 228)
Introduction
Local error handling makes it possible to query the occurrence of errors within a block and
evaluate the associated error information. You can set local error handling for organization
blocks (OBs), function blocks (FBs), and functions (FCs). If local error handling is enabled, the
system reaction is ignored.
Local error handling applies only to blocks for which it has been set explicitly. The local error
handling setting is not assumed by a calling block, nor is it transferred to called blocks. For
higher-level blocks and lower-level blocks, the system settings still apply provided dedicated
error handling has not been programmed for these blocks.
The instructions differ in the amount of error information that is output with each one.
For additional information on the instructions, refer to "See also".
See also
GET_ERROR: Get error locally (Page 2694)
GET_ERR_ID: Get error ID locally (Page 2417)
GET_ERR_ID: Get error ID locally (Page 2697)
GET_ERROR: Get error locally (Page 2414)
See also
GET_ERROR: Get error locally (Page 2694)
GET_ERR_ID: Get error ID locally (Page 2417)
GET_ERR_ID: Get error ID locally (Page 2697)
GET_ERROR: Get error locally (Page 2414)
Introduction
Local error handling is enabled for a block if you insert one of the following instructions in a
network.
GET_ERROR: Get error locally
GET_ERR_ID: Get error ID locally
For additional information on the instructions, refer to "See also".
If local error handling is enabled for a block, the system reactions for this block are ignored.
Requirement
The block is open.
Die "Instructions" task card is open.
Procedure
To enable local error handling for a block, proceed as follows:
1. Navigate to the "Basic instructions" pane of the "Instructions" task card.
2. Open the "Program Control" folder.
3. Drag the instruction "Get error locally" (GET_ERROR) or "Get error ID locally"
(GET_ERR_ID) to the required network.
Result
Local error handling is enabled for the open block. The "Handle errors within block" check box
is selected in the Inspector window under "Properties > Attributes". This setting cannot be
edited in the Inspector window. Local error handling can be deactivated by deleting the inserted
instructions on local error handling.
See also
GET_ERROR: Get error locally (Page 2694)
GET_ERR_ID: Get error ID locally (Page 2417)
GET_ERR_ID: Get error ID locally (Page 2697)
GET_ERROR: Get error locally (Page 2414)
In contrast to the code block, the data block contains only tag declarations. It contains no
networks or instructions. The tag declarations define the structure of the data block.
Access modes
There are two different modes of accessing data values in data blocks:
Data blocks with optimized access (only S7-1200)
Data blocks with optimized access have no fixed defined structure. In the declaration, the
data elements are assigned only a symbolic name and no fixed address within the block.
You access the data values in these block via symbolic names.
The "Optimized block access" attribute is always enabled for ARRAY data blocks.
Data blocks with standard access (all CPU families)
Data blocks with standard access have a fixed structure. In the declaration, the data
elements are assigned both a symbolic name and a fixed address within the block. You
can access the data values in these blocks via symbolic names or the address.
ARRAY data blocks with standard access are not possible.
See also
Creating data blocks (Page 1508)
Global data blocks (DB) (Page 1416)
Instance data blocks (Page 1417)
Column Explanation
Symbol you can click to move or copy the tag. You can, for example, drag-
and-drop the tag into a program and use it there as operand.
Name Name of the tags.
Data type Data type of the tags.
Offset Relative address of the tags.
The column is only visible in data blocks with standard access.
Default value Default value of the tag in the interface of a higher-level code block or in a
PLC data type.
The values contained in the "Default value" column can only be changed in
the higher-level code block or PLC data type. The values are only displayed
in the data block.
Start value Value that the tag should assume at startup.
The default values defined in a code block are used as start values during the
creation of the data block. You can then replace these adopted values with
instance-specific start values.
Specification of an start value is optional. If you do not specify any value, the
tag assumes the default value at startup. If a default is not defined either, the
default value valid for the data type is used. For example, the value "FALSE"
is specified as standard for BOOL.
Monitor value Current data value in the CPU.
This column only appears if an online connection is available and you click
"Monitor".
Snapshot Shows values that were loaded from the device.
Retentivity Marks the tag as retentive. The values of retentive tags are retained even
after the power supply is switched off.
Visible in HMI Shows whether the tag is visible by default in the HMI selection list.
Accessible from HMI Shows whether HMI can access this tag during runtime.
Setting value Setting values are the values that will probably have to be fine tuned during
commissioning. After commissioning, the values of these tags can be trans
ferred to the offline program as start values and stored there.
Comment Comment to document the tags.
See also
Creating data blocks (Page 1508)
Basic information on start values (Page 1713)
Requirement
The "Program blocks" folder in the project tree is open.
Procedure
To create a data block, follow these steps:
1. Double-click the "Add new block" command.
The "Add new block" dialog box opens.
2. Click the "Data block (DB)" button.
3. Select the type of the data block. You have the following options available to you:
To create a global data block, select the list entry "Global DB".
To create an ARRAY data block, select the "ARRAY DB" entry in the list.
To create an instance data block, select the function block to which you want to assign
the instance data block from the list. The list contains only the function blocks that were
previously created for the CPU.
To create a data block based on a PLC data type, select the PLC data type from the
list. The list contains only the PLC data types that were previously created for the CPU.
To create a data block based on a system data type, select the system data type from
the list. The list contains only those system data types that have already been inserted
to program blocks in the CPU.
4. Enter a name for the data block.
5. Enter the properties of the new data block.
6. If you have selected an ARRAY DB as the data block type, enter the ARRAY data type and
the high limit for the ARRAY.
You can change the high limit for the ARRAY at any time in the property window of the
created block. The ARRAY data type cannot be changed subsequently.
7. To enter additional properties of the new data block, click "Additional information".
An area with further input fields is displayed.
8. Enter all the properties you require.
9. Activate the "Add new and open" check box if the block does not open as soon as it is
created.
10.Confirm your entry with "OK".
Result
The new data block is created. You can find the data block in the project tree in the "Program
blocks" folder.
See also
Instance data blocks (Page 1417)
Global data blocks (DB) (Page 1416)
Overview of block properties (Page 1518)
Introduction
Changes in the interface of a function block or a PLC data type can lead to the corresponding
data blocks becoming inconsistent. These inconsistencies are marked in red in the declaration
table and at the call point of the block. To remedy these inconsistencies, the data blocks must
be updated.
You have three options to update block calls:
Explicit updating in the declaration table for data blocks.
The data block is updated. Changes from the interface of the assigned function block and
changes to the used PLC data types are applied.
Explicit updating in the program editor.
The block calls in the open block will be updated. The associated instance data block is
also adjusted in the process.
Implicit updating during compilation.
All block calls in the program as well as the used PLC data types and the corresponding
instance data blocks are updated.
See also
Changing the properties of tags in instance data blocks (Page 1720)
Description
In order to enable the editing of PLC programs that have already been commissioned and that
are running without error on a system, CPUs of the S7-1500 series and most CPUs of the
S7-1200 V4 and higher series support the option of extending global data blocks during
runtime.
You can download the modified blocks without setting the CPU to STOP and without affecting
the values of already loaded tags.
This is a simple means of implementing program changes. This load process (download
without reinitialization) will not have a negative impact on the controlled process.
Principle of operation
Each data block is always assigned a default memory reserve. The memory reserve is not
used initially. Activate the memory reserve if you decide on loading interface changes after
having compiled and downloaded the block. All tags that you subsequently declare will be
saved to the memory reserve. A subsequent download has no impact on the values of tags
that have already been loaded.
If you decide to review your program at a later time while the plant is not in operation, you are
also provided an option of reworking the memory layout of individual or several blocks in a
single pass. With this action, you move all tags from the reserve area to the regular area. The
memory reserve is now cleared and made available for further interface extensions.
Requirements
This "Download without reinitialization" function is available if the following requirements are
met:
The project is in the "TIA Portal V12" format or a higher version.
You are working with a CPU that supports "Download without reinitialization".
The blocks were created in LAD, FBD, STL, or SCL.
The blocks were created by the user, i.e. they are not included with the blocks delivered in
your package.
These blocks are assigned the optimized access attribute.
Basic steps
Perform the following steps if you want to extend the data block and then load the block without
re-initialization.
1. All blocks have a default memory reserve of 100 bytes. You can adapt this memory reserve
to suit your requirements.
2. Activate the memory reserve.
3. Extend the block interface.
4. Compile the block.
5. Download the block to the CPU as usual.
Reference
For more information on the various steps, refer to chapter "Loading blocks (S7-1200/1500) ".
Requirement
A global data block is open.
Note
You cannot change the structure of instance data blocks and of data blocks based on a PLC
data type directly, since the structures of these blocks are defined by the respective function
block or the PLC data type.
The type of the data block is entered in the block properties.
Procedure
To declare a tag of the elementary data type, follow these steps:
1. Enter a tag name in the "Name" column.
2. In the "Data type" column, click the button for the data type selection.
A list of the permissible data types is opened.
3. Select the desired data type.
4. Optional: Change the properties of the tags that are displayed in the other columns.
5. Repeat steps 1 to 4 for all tags that are to be declared.
See also
Displaying and editing block properties (Page 1523)
Declaring tags of the ARRAY data type (Page 1711)
Declaring tags of STRUCT data type (Page 1712)
Editing tables (Page 347)
Requirement
A global data block is open.
Procedure
To declare a tag of the ARRAY data type, follow these steps:
1. Enter a tag name in the "Name" column.
2. Enter the "Array" data type in the "Data type" column. You will be supported by
autocompletion in this step.
The "Array" dialog opens.
3. In the "Data type" text box, specify the data type of the array elements.
4. In the "ARRAY limits" text box, specify the high and low limit for each dimension.
Example of a one-dimensional ARRAY:
[0..3]
Example of a three-dimensional ARRAY:
[0..3, 0..15, 0..33]
5. Confirm your entry.
6. Optional: Change the properties of the tags that are displayed in the other columns.
The tag is created but remains collapsed. To expand the ARRAY, click the triangle in front of
the tag. Not that you cannot expand very large ARRAYs for reasons of clarity.
See also
Array (Page 1941)
Requirement
A global data block is open.
Procedure
To declare a tag of the STRUCT data type, follow these steps:
1. Enter a tag name in the "Name" column.
2. Enter "Struct" in the "Data type" column. You will be supported by autocompletion during
input.
An empty, indented row is inserted after the new tag.
3. Insert the first structural element in the first empty row.
An additional empty row is inserted after the element.
4. Select a data type for the structure element.
5. Optional: Change the properties of the structural element that is displayed in the other
columns of the block interface.
6. Repeat the step 4 to 7 for all additional structure elements.
It is not necessary to end the structure explicitly. The structure ends with the last element
that is entered.
7. To insert a new tag after the structure, leave a blank row after the end of the structure and
then start the new tag in the second empty row.
Result
The tag of STRUCT data type is created.
Note
S7-1500: A maximum of 252 structures in one data block
A maximum of 252 structures is permitted in one data block. If you need additional structures,
you must restructure your program. You can, for example, create the structures in several
global data blocks.
See also
STRUCT (Page 1945)
Requirements
A global data block is open.
A PLC data type is declared in the current CPU.
Procedure
To declare a tag based on a PLC data type, follow these steps:
1. Enter a tag name in the "Name" column.
2. Enter the PLC data type in the "Data type" column. You will be supported by autocompletion
during input.
3. Optional: Change the properties of the tags that are displayed in the other columns of the
table.
Result
The tag is created.
See also
Layout of the block interface (Page 1551)
In this case you can define a default value for each tag in the higher-level element. These
default values are used as start values during the creation of the data block. You can then
replace these values with instance-specific start values in the data block.
Specification of an start value is optional. If you do not specify any value, the tag assumes the
default value at startup. If a default is not defined either, the default value valid for the data
type is used. For example, the value "FALSE" is specified as standard for BOOL.
See also
Define start values (Page 1714)
Structure of the declaration table for data blocks (Page 1705)
Declaring local tags and constants in the block interface (Page 1557)
Applying values from the online program as start values (Page 1733)
See also
Basic information on start values (Page 1713)
Applying values from the online program as start values (Page 1733)
Introduction
To apply the changed start values from the offline program to the online program, you must
load the changes. The following cases must be distinguished:
Loading changed start values of non-retentive tags
Loading changed start values of retentive tags
Loading changed start values of setting values
Requirement
The start values in the offline program were changed.
Procedure
To load changed start values of non-retentive tags, follow these steps:
1. Select the blocks to be loaded in the project tree.
2. Select the "Download to device > Software (only changes)" command from the shortcut
menu.
The blocks are compiled and loaded.
The start values of the newly defined tags are placed in the load memory of the CPU. The
program runs with the new start values at the next transition from STOP to RUN.
Information about loading changed setting values and general information about loading can
be found under "See also".
See also
Initializing setting values in the online program (Page 1732)
Setting retentivity
Retentive behavior
To prevent data loss in the event of power failure, you can mark the data as retentive. This
data is stored in a retentive memory area. The options for setting the retentivity depend on the
type of data block and the type of block access that is set.
See also
Setting retentivity in an instance data block (Page 1716)
Setting retentivity in a global data block (Page 1717)
Introduction
In an instance data block, the editability of the retentive behavior depends on the type of access
of the higher-level function block:
Function block with standard access
You can define the instance data both as retentive or non-retentive. Individual retentivity
settings are not possible for individual tags.
Function block with optimized access
In the instance data block, you can define the retentivity settings of the tags that are selected
in the block interface with "Set in IDB". With these tags also, you cannot individually set the
retentive behavior for each tag. The retentivity setting has an impact on all tags that are
selected in the block interface with "Set in IDB".
See also
Basics of block access (Page 1419)
Retentivity of tags in data blocks (Page 1716)
Introduction
In a global data block, the editability of the retentive behavior depends on the type of access:
Global data block with standard access
You can define the data both as retentive or non-retentive. Individual retentivity settings
are not possible for individual tags.
Global data block with optimized access
You can individually define the retentivity settings of the tags. For tags with structured data
types, retentivity settings are transferred for all tag elements.
See also
Basics of block access (Page 1419)
Retentivity of tags in data blocks (Page 1716)
Properties
The following table provides an overview of the properties of tags in data blocks:
See also
Changing the properties of tags in instance data blocks (Page 1720)
Changing the properties of tags in global data blocks (Page 1721)
See also
Updating data blocks (Page 1708)
Properties of the tags in data blocks (Page 1718)
Introduction
Two options are available for defining the tag properties:
The tag properties are applied from the PLC data type.
Properties that are applied from the PLC data type are shown grayed out in the columns
of the declaration table. The "Name" and "Data type" properties are always applied.
You define specific properties.
You can change some properties in the global data block. Changeable values are, for
example, "Comment" or "Visible in HMI". Properties that were changed are not grayed out
in the columns of the declaration table. The changes are retained, even if the PLC data
type changes and the global data block is subsequently updated.
3. In the required column, select each of the table cells whose value you want to change.
4. Select the "Set <property>" or "Reset <property>" command in the shortcut menu.
See also
Properties of the tags in data blocks (Page 1718)
Procedure
Proceed as follows to insert a row above the selected row:
1. Select the row in front of which you want to insert a new row.
2. Click the "Insert row" button on the toolbar of the table.
Result
A new row is inserted above the selected row.
See also
Editing tables (Page 347)
Procedure
Proceed as follows to insert a row below the selected row:
1. Select the row below which you want to insert a new row.
2. Click the "Add row" button on the table toolbar.
Result
A new empty row will be inserted below the selected row.
See also
Editing tables (Page 347)
Deleting tags
Requirements
A global data block is open.
Procedure
To delete a tag, follow these steps:
1. Select the row with the tag to be deleted. You can also select several rows by clicking on
them one after the other while holding down the <Ctrl> key or by pressing and holding down
<Shift> and clicking on the first and last row.
2. Select the "Delete" command in the shortcut menu.
Note
You cannot directly change the structure of instance data blocks and of global data blocks
based on a PLC data type, since the structures of these blocks are defined in the higher-level
object.
The type of the data block is entered in the block properties.
See also: Displaying and editing block properties (Page 1523)
See also
Editing tables (Page 347)
Requirement
The table is open.
Sufficient declaration rows are available.
Procedure
To automatically fill in successive cells, follow these steps:
1. Select the cells to be loaded.
2. Click the "Fill" symbol in the bottom right corner of the cell.
The mouse pointer is transformed into a crosshair.
3. Keep the mouse button pressed and drag the mouse pointer downwards over the cells that
you want to fill in automatically.
4. Release the mouse button.
The cells are filled in automatically.
5. If entries are already present in the cells that are to be automatically filled in, a dialog
appears. In this dialog you can indicate whether you want to overwrite the existing entries
or insert new rows for the new tags.
Procedure
To show or hide table columns, follow these steps:
1. Click a column header.
2. Select the "Show/Hide" command in the shortcut menu.
The selection of available columns is displayed.
3. To show a column, select the column's check box.
4. To hide a column, clear the column's check box.
5. To hide or show several columns, click "More" and activate or deactivate the check box of
the corresponding columns in the "Show/Hide" dialog.
Requirement
The data block and an external editor are opened.
Procedure
To export and re-import individual tags by drag-and-drop operation, follow these steps:
1. Select one or more tags.
2. Select "Copy" in the shortcut menu.
3. Switch to the external editor and paste the copied tags.
4. Edit the tags as required.
5. Copy the tags in the external editor.
6. Switch back to the declaration table.
7. Select "Paste" in the shortcut menu.
Overview of functions
The data block editor offers different options for monitoring and modifying tags. These functions
directly access the actual values of the tags in the online program. Actual values are the values
which the tags have at the current time during program execution in the CPU work memory.
The following table provides an overview of the functions for monitoring and modifying. Detailed
descriptions of the individual functions can be found in the following chapters.
Additional functions
You also have the option of specifically calibrating individual values during commissioning.
See also: Auto-Hotspot
Monitor tags
You can monitor the current values of the tags in the CPU directly in the declaration table.
Requirement
An online connection is available.
The data block has been loaded to the CPU.
The program execution is active (CPU in "RUN").
The data block is open.
Procedure
To monitor the tags, follow these steps:
1. Start monitoring by clicking the "Monitor all" button.
The additional "Monitor value" column is displayed in the table. This shows the current data
values.
See also: Structure of the declaration table for data blocks (Page 1705)
2. End the monitoring by clicking the "Monitor all" button again.
Modify tags
You can modify an individual tag in the data block to a specific value. The CPU then uses this
values as actual value in the online program.
Danger
Danger when changing tag values
Changing the tag values while the plant is operating can cause serious damage to property or
injury to persons if there are functional disturbances or program errors!
Make sure that no dangerous situations can arise before you modify the tags.
Requirement
An online connection to the CPU is available.
The data block whose tags you wish to modify is identical offline and online.
The data block is open.
Procedure
To modify an individual tag in the data block, follow these steps:
1. Start monitoring by clicking the "Monitor all" button.
The additional "Monitor value" column is displayed in the table. This shows the current data
values.
2. Select the tag to be modified.
3. Select "Modify operand" in the shortcut menu.
The "Modify operand" dialog opens.
4. Enter the required value in the "Control word" text box.
If there is a snapshot, the value is already entered as default.
5. Confirm your entry with "OK".
Result
The tag will have the specified value once when you execute the modify job. The job is executed
immediately and is not tied to the next cycle control point.
See also: Introduction to modifying tags (Page 1873)
A snapshot is also created automatically when you download a block or a program from the
device.
Caution
Creating the snapshot
The values in the snapshot may originate in several cycles.
Requirement
An online connection to the CPU is available.
The data blocks for which you want to create a snapshot are identical offline and online.
Procedure
To create a snapshot of an open data block, follow these steps:
1. Open the data block.
2. Click "Snapshot of the monitored values".
To create a snapshot of several selected data blocks, follow these steps:
1. Select the blocks in the project tree.
You can select the blocks individually or select devices, groups or folders in the project tree
which include the data blocks.
2. In the shortcut menu, select "Snapshot of the monitored values" or select the menu
command "Options > Snapshot of the monitored values".
Result
The latest monitored values will be applied in the "Snapshot" column.
An alarm is shown in the Inspector window after the operation is complete.
The time stamp of the snapshot is displayed above the declaration table.
Note
If you subsequently change the structure of the data block, the display of the current values
gets lost. The "Snapshot" column will then be empty.
Danger
Danger when changing tag values
Changing the tag values while the plant is operating can cause serious damage to property or
injury to persons if there are functional disturbances or program errors!
Make sure that the plant is in a safe state before you overwrite the actual values.
Make sure that the program does not read or write the affected data during transmission.
You may want to use the "Modify tag" function in the watch table or in the DB editor as an
alternative.
Requirement
You are using an S7-1200 V4.1 or higher or an S7-1500 V1.7 or higher.
An online connection to the CPU is available.
The data blocks whose actual values you wish to overwrite are identical offline and online.
A snapshot of the data block exists.
Procedure
To overwrite the actual values of a block with a snapshot, follow these steps:
1. Open the data block.
2. Click "Copy all values from the snapshot to the actual values of the CPU".
Result
The actual values in the online program are overwritten with the start values from the snapshot.
Introduction
During commissioning of a plant, data values have to be frequently adjusted in order to
optimally adapt the program to the general operating conditions on site. The declaration table
for data blocks offers some functions for this purpose.
To use the function, first define specific tags as "Setting values" in the program. Setting values
are the values that will probably have to be fine tuned during commissioning.
The following table provides an overview of the functions for tuning values during
commissioning. Detailed descriptions of the individual functions can be found in the following
chapters.
Additional functions
There are still some more general functions for monitoring and modifying the data block.
See also: Functions for monitoring and modifying tags in data blocks (Page 1725)
See also
Marking data as values that can be set (Page 1731)
Applying values from the online program as start values (Page 1733)
Rules
You can mark tags as "Setting value" in the following block types:
In function blocks (FB), but only in the "Static" section
in global data blocks (DB)
in PLC data types (UDT)
In the case of PLC data types (UDT), however, the setting is only effective, if the UDT is
used in the "Static" section of a function block or data block.
It is not possible to define setting values in the following block types:
In data blocks based on a PLC data type, and in instance data blocks. These inherit the
setting from the higher-level FB or UDT.
You cannot mark tags as a "Setting value" in ARRAY data blocks.
You also cannot mark tags as a "Setting value" at the call point of a multi-instance. You
have to make the setting in the interface of the function block that is called as multiple
instance.
You cannot change the "Setting value" marking in know-how-protected blocks. To do so,
you must first remove the know-how protection.
Requirement
A function block, a global data block or a PLC data type (UDT) is open.
Procedure
To mark a tag as "Setting value", follow these steps:
1. Select a tag from the "Static" section.
2. Select the check box in the "Setting value" column.
You cannot define the higher-level element of a structure or a PLC data type as "Setting
value". You have to make the setting for the lower-level elements individually.
In the case of ARRAYs, you can only mark the higher-level element as "Setting value".
The lower-level elements inherit the setting.
For ARRAYs of STUCT, you can only mark the elements below the first structure as
setting values. The elements of other structures inherit the setting.
Result
The tags are marked as setting values. During commissioning, these tags can be initialized
online. You do not need to set the CPU to "STOP" mode; it can remain in "RUN". In addition,
the current tag values can be transferred as start values to the offline program and saved there.
Danger
Danger when changing tag values
Changing the tag values while the plant is operating can cause serious damage to property or
injury to persons if there are functional disturbances or program errors!
Make sure that no dangerous situations can arise before you re-initialize the setting values.
Requirement
An online connection to the CPU exists.
The structure of the data block is identical offline and online.
One or more tags are marked as a "Setting value".
Procedure
To initialize all setting values of the data block, follow these steps:
1. Open a global data block or an instance data block.
2. Enter the desired values in the "Start value" column. The start values must correspond to
the indicated data type.
3. Click the "Initialize setting values" button.
Result
The setting values in the online program are initialized with the start values from the offline
program at the next cycle control point.
The maximum number of tags that can be initialized is dependent on the CPU. If too many
setting values are marked, an alarm informs you about this. In this case, you can insert the
tags in a watch table and initialize them using the "Modify" function in the watch table.
Alternatively, you can also load the entire data block. For more information on this, refer to
"See also".
See also
Loading changed values (Page 1715)
Requirement
An online connection to the CPU is available.
As least one data block has been loaded to the CPU.
Procedure
In order to apply all values or only the values of the tags marked as a "setting value" in a data
block, follow these steps:
1. Open the data block.
2. Start monitoring by clicking the "Monitor all" button.
The "Monitor value" column is displayed in the table. This shows the current data values.
3. On the toolbar, click "Snapshot of monitored values".
The latest monitored values will be applied in the "Snapshot" column.
4. Click one of the following buttons on the toolbar:
"Apply setting values from the snapshot as start values"
"Apply all values from the snapshot as start values"
The values from the "Snapshot" column are applied to the "Start value" column.
To apply the monitored values of multiple data blocks in the project tree, follow these steps:
1. Select the blocks in the project tree.
2. Select the "Snapshot of the monitored values" command in the shortcut menu.
The current monitored values of all selected blocks will be applied in the "Snapshot" column.
An alarm is shown in the Inspector window after the operation is complete.
3. Then select one of the following commands in the shortcut menu:
"Apply snapshot values as start values > All values"
"Apply snapshot values as start values > Only setpoints"
"Apply snapshot values as start values > Only retain values"
The values from the "Snapshot" column are applied to the "Start value" column.
Result
The new start values are stored in the offline program.
Note
Applying values of individual tags
You can also transfer the values of individual tags that were not marked as a setting value
beforehand from the "Snapshot" column to the "Start values" column. Use the "Copy" and
"Paste" commands from the shortcut menu to copy the values and insert them in the "Start
value" column. Note that only the values that are currently located in the visible area of the
table are copied.
See also
Basic information on start values (Page 1713)
Define start values (Page 1714)
Description
PLC data types are data structures that you define and that can be used multiple times within
the program. The structure of a PLC is made up of several components, each of which can
contain different data types. You define the type of components during the declaration of the
PLC data type.
You can create up to 65534 PLC data types for a CPU of the S7-1200 or S7-1500 series. Each
of these PLC data types can include up to 252 components.
See also
Creating PLC data types (Page 1736)
Column Explanation
Symbol you can click to move or copy the tag.
Column Explanation
Setting value Setting values are the values that will probably have to be fine tuned during com
missioning. After commissioning, the values of these tags can be transferred to
the offline program as start values and stored there.
Comment Comment to document the tags.
See also
Creating PLC data types (Page 1736)
Show and hide table columns (Page 1744)
Requirement
The "PLC data types" folder opens in the project tree.
Procedure
To create a PLC data type, proceed as follows:
1. In the "PLC data types" folder, click the "Add new data type" command.
A new declaration table for creating a PLC data type will be created and opened.
2. Select the PLC data type and select the "Rename" command in the shortcut menu.
3. Enter the name of the PLC data type.
Result
The new PLC data type is created. You can find the PLC data type in the project tree in the
"PLC data types" folder.
See also
Structure of the declaration table for PLC data types (Page 1735)
Basics of PLC data types (Page 1734)
Requirement
The PLC data type you want to delete is not open.
Procedure
To delete a PLC data type, follow these steps:
1. In the project tree, open the "PLC data types" folder.
2. Select the PLC data type to be deleted. You can also select several PLC data types by
clicking on them one after the other while holding down the <Ctrl> key or by pressing and
holding down <Shift> and clicking on the first and last data type.
3. Select the "Delete" command in the shortcut menu.
Note
If you delete a PLC data type, the blocks that use the data type will become inconsistent. These
inconsistencies are marked in red in the block used. To remedy these inconsistencies, the
data blocks have to be updated.
See also:
Updating the block interface (Page 1564)
Updating data blocks (Page 1708)
Procedure
To change the default number of a PLC data type, follow these steps:
1. Open the project library in the "Libraries" task card.
2. Drag the compilable PLC data type to the "Types" folder.
The "Add type" dialog opens.
3. Enter the properties of the new type.
4. Click "OK" to confirm.
5. Right-click the PLC data type in the project library and select the "Edit type" command from
the shortcut menu.
6. Click "OK" to confirm your selection of the instance.
The library view opens.
7. Close the library view.
The extension "in testing" is now added to the name of the PLC data type.
8. Right-click the PLC data type and select the "Properties" command from the shortcut menu.
Requirement
A PLC data type is open.
Procedure
To declare a tag, follow these steps:
1. Enter a tag name in the "Name" column.
2. Enter the required data type in the "Data type" column. You will be supported by
autocompletion during input.
3. Optional: Change the properties of the tags that are displayed in the other columns.
4. Repeat steps 1 to 3 for all tags that are to be declared.
See also
Editing tables (Page 347)
Requirement
A PLC data type is open.
Procedure
To declare a tag of the ARRAY data type, follow these steps:
1. Enter a tag name in the "Name" column.
2. Enter the "Array" data type in the "Data type" column. You will be supported by
autocompletion in this step.
The "Array" dialog opens.
3. In the "Data type" text box, specify the data type of the array elements.
4. In the "ARRAY limits" text box, specify the high and low limit for each dimension.
Example of a one-dimensional ARRAY:
[0..3]
Example of a three-dimensional ARRAY:
[0..3, 0..15, 0..33]
5. Confirm your entry.
6. Optional: Change the properties of the tags that are displayed in the other columns.
Note
You cannot define specific default values for ARRAY elements. You can, however, assign
them start values at the usage point in the data block.
See also
Array (Page 1941)
Structure of the declaration table for PLC data types (Page 1735)
Requirements
A PLC data type is open.
Procedure
To declare a tag of the STRUCT data type, follow these steps:
1. Enter a tag name in the "Name" column.
2. Enter "Struct" in the "Data type" column. You will be supported by autocompletion during
input.
An empty, indented row is inserted after the new tag.
3. Insert the first structural element in the first empty row.
An additional empty row is inserted after the element.
4. Select a data type for the structure element.
5. Optional: Change the properties of the structural element that is displayed in the other
columns.
6. Repeat steps 3 to 5 for all additional structure elements.
It is not necessary to end the structure explicitly. The structure ends with the last element
that is entered.
7. To insert a new tag after the structure, leave a blank row after the end of the structure and
then start the new tag in the second empty row.
Result
The tag of STRUCT data type is created.
See also
STRUCT (Page 1945)
Structure of the declaration table for PLC data types (Page 1735)
Requirements
A global data block is open.
A PLC data type is declared in the current CPU.
Procedure
To declare a tag based on a different PLC data type, follow these steps:
1. Enter a tag name in the "Name" column.
2. Enter the PLC data type in the "Data type" column. You will be supported by autocompletion
during input.
Result
The tag is created.
Note
You define the default values of tags within a PLC data type when the PLC data type is created.
You cannot change these values at the point of use of the PLC data type.
See also
Basics of PLC data types (Page 1734)
Structure of the declaration table for PLC data types (Page 1735)
Properties
The following table gives an overview of tag properties in PLC data types:
See also
Changing the properties of tags in PLC data types (Page 1741)
Basics of PLC data types (Page 1734)
Structure of the declaration table for PLC data types (Page 1735)
See also
Updating the block interface (Page 1564)
Updating data blocks (Page 1708)
Procedure
Proceed as follows to insert a row above the selected row:
1. Select the row in front of which you want to insert a new row.
2. Click the "Insert row" button on the toolbar of the table.
Result
A new row is inserted above the selected row.
Procedure
Proceed as follows to insert a row below the selected row:
1. Select the row below which you want to insert a new row.
2. Click the "Add row" button on the table toolbar.
Result
A new empty row will be inserted below the selected row.
Deleting tags
Procedure
Follow the steps below to delete elements:
1. Select the row with the element to be deleted. You can also select several rows by clicking
on them one after the other while holding down the <Ctrl> key or by pressing and holding
down <Shift> and clicking on the first and last row.
2. Select the "Delete" command in the shortcut menu.
See also
Updating the block interface (Page 1564)
Updating data blocks (Page 1708)
Requirement
The table is open.
Sufficient declaration rows are available.
Procedure
To automatically fill in successive cells, follow these steps:
1. Select the cells to be loaded.
2. Click the "Fill" symbol in the bottom right corner of the cell.
The mouse pointer is transformed into a crosshair.
3. Keep the mouse button pressed and drag the mouse pointer downwards over the cells that
you want to fill in automatically.
4. Release the mouse button.
The cells are filled in automatically.
5. If entries are already present in the cells that are to be automatically filled in, a dialog
appears. In this dialog you can indicate whether you want to overwrite the existing entries
or insert new rows for the new tags.
Procedure
To show or hide table columns, follow these steps:
1. Click a column header.
2. Select the "Show/Hide" command in the shortcut menu.
The selection of available columns is displayed.
3. To show a column, select the column's check box.
4. To hide a column, clear the column's check box.
5. To hide or show several columns, click "More" and activate or deactivate the check box of
the corresponding columns in the "Show/Hide" dialog.
Function
The textual programming languages STL and SCL allow you to enter the program code in any
ASCII editor and save it as an external source file. This enables you to perform a range of
tasks, for example:
Declaring tags
Specify block properties
Programming blocks
You can import these source files to your project and use them to generate blocks. You can
generate a number of different blocks from one source file. Observe the following special
features when generating blocks from a source file:
A block that exists under the same name in the project will be overwritten.
If a block was programmed with its absolute block number instead of a symbolic name in
the source file and this number is already assigned by a block in the project, the new
generated block is initially assigned the next free symbolic name.
If you have not explicitly defined the access mode for a block in the external source file,
the block access mode is set depending on the CPU series used:
Blocks generated for a CPU of the S7-1200/1500 series are assigned "optimized"
access mode by default.
Blocks generated for a CPU of the S7-300/400 product range are assigned "standard"
access mode by default.
Organization blocks are the exception in this case, as they are always assigned the
"standard" access mode by default, regardless of the CPU series. You have the option of
changing the block access mode manually.
It is possible that not all comments from the source file will be applied in the block.
If you use absolute addressing in the external source file, a symbolic tag is created for each
absolute address during the generation of the block. The names of these tags are made
up of "Tag_" and a time stamp. This may result in relatively long tag names, which you can
change manually if required.
If you are using instructions in a different version in the external source file than in the target
device, this may result in compilation errors. Correct the respective instructions in this case
and start the compilation process once again. You can also select a different version for
the target device.
You also have the option of saving existing blocks as external source files.
See also
Rules for programming external source files (Page 1745)
Saving blocks as external source files (Page 1746)
Inserting external source files (Page 1748)
Opening and editing external source files (Page 1748)
Generating blocks from external source files (Page 1749)
Syntax rules
The syntax of the instructions in external source files is very similar to that in the creation of
user programs in the program editor with STL or SCL. Note, however, the following additional
syntax rules:
Block call
When calling a block, transfer the parameters in the defined order in the ASCII editor. If
you do not, the comment assignments for these lines may not match.
Enter the parameters in brackets. The individual parameters are separated by a comma.
Upper or lower case
The program editor generally disregards upper or lower case. Jump labels are an exception
to this. Character string entries are also case-sensitive ("STRING" data type). Keywords
are displayed in upper case. For compilation purposes, however, case is disregarded; you
can therefore specify keywords in upper or lower case or a mixture of the two.
Semicolon
Mark the end of every instruction and every tag declaration with a semicolon. You can enter
several instructions per line.
Forward slashes
Begin every comment with two forward slashes (//) and end the comment with the <Enter>
key.
Use of String constants
To avoid compilation errors when using String constants, enter the text in the language of
the target project. You can explicitly use the data type WSTRING for CPUs of the
S7-1200/1500 series by using the prefix "WString#":
Operand := WString#'<String constant>';
See also
Basics of using external source files (Page 1744)
Saving blocks as external source files (Page 1746)
Inserting external source files (Page 1748)
Opening and editing external source files (Page 1748)
Generating blocks from external source files (Page 1749)
Result
The block has been saved as an external source file. You can include this source file in a
project in the TIA Portal and use it to generate other blocks. However, please note that you
can use STL source files only in S7-300/400/1500 CPUs.
See also
Basics of using external source files (Page 1744)
Rules for programming external source files (Page 1745)
Inserting external source files (Page 1748)
Opening and editing external source files (Page 1748)
Generating blocks from external source files (Page 1749)
Requirement
An external source file is available and complies with the syntax and structure rules.
The "External source files" folder is open in the project tree.
Procedure
Follow these steps to insert an external source file:
1. Double-click on the "Add new external file" command.
The "Open" dialog box is opened.
2. Navigate to and select existing external source files.
3. Confirm your selection with "Open".
Result
The new source file will be added to the "External source files" folder.
See also
Basics of using external source files (Page 1744)
Rules for programming external source files (Page 1745)
Saving blocks as external source files (Page 1746)
Opening and editing external source files (Page 1748)
Generating blocks from external source files (Page 1749)
Linking files with the file name extensions "stl" and "scl" file types to an editor
Proceed as follows to link files with the file name extensions "stl" and "scl" to an editor:
1. Open Windows Explorer.
2. Right-click on an STL file.
3. Select "Properties" in the shortcut menu.
The "Properties" dialog box opens.
4. Click "Change" in the "File type" area on the "General" tab.
The "Open with" dialog box opens.
5. Select the text editor you want to link to the "stl" file type.
6. Confirm your selection with "OK".
7. Close the "Properties" dialog with "OK".
8. Repeat steps 2 to 7 with an SCL file.
See also
Basics of using external source files (Page 1744)
Rules for programming external source files (Page 1745)
Saving blocks as external source files (Page 1746)
Inserting external source files (Page 1748)
Generating blocks from external source files (Page 1749)
Requirement
The "External source files" folder is open in the project tree.
An external source file is available.
Procedure
To generate blocks from an external source file, follow these steps:
1. Open the external source file from which you wish to generate blocks.
2. Select the "Generate blocks from source" command in the "Edit" menu.
3. A prompt will appear telling you any existing blocks will be overwritten.
4. Confirm the safety prompt with "Yes".
Result
The external source file blocks will be generated and inserted in the "Program blocks" folder
in the project tree. In the event of errors, information about the errors which have occurred will
be displayed in the inspector window. This information, however, relates to the external source
file and not to the block generated.
See also
Basics of using external source files (Page 1744)
Rules for programming external source files (Page 1745)
Saving blocks as external source files (Page 1746)
Inserting external source files (Page 1748)
Opening and editing external source files (Page 1748)
Function
You can compare the following objects of a PLC program in order to detect any differences:
Code blocks with other code blocks
Data blocks with other data blocks
PLC tags of a PLC tag table with the PLC tags of another PLC tag table
PLC data types with other PLC data types
compared will be opened side-by-side, each in its own program editor instance. Any differences
will be highlighted.
The table below gives an overview of the types and levels of comparison you can apply for
each object:
Note
Please note the following:
You cannot perform a detailed comparison for know-how protected blocks.
If the detail comparison detects differences only with respect to the data types of local tags,
with offline being an interrupt data type (C_ALARM C_ALARM_S C_ALARM_8
C_ALARM_8P C_ALARM_T C_AR_SEND C_NOTIFY C_NOTIFY_8P) and online a
DWORD, this difference is not marked as such.
You cannot run a detailed comparison for types and master copies from libraries.
See also
Basics of project data comparison (Page 402)
Comparison of code blocks (Page 1752)
Comparison of data blocks (Page 1753)
Introduction
The blocks to be compared in a code block comparison are assigned for comparison on the
basis of the following criteria:
Online/offline comparison: Addresses, e.g. FB100
Offline/offline comparison: Symbolic names of the blocks
The comparison involves an evaluation of the block time stamps. The results are displayed as
an overview in the comparison editor. You can then use actions to define what is to be done
about the differences. You can also start detailed comparisons for the individual blocks. The
versions of a block compared are opened beside each other and the differences are highlighted.
For the comparison of code blocks, both the block interfaces and the individual networks are
compared. Any differing tag names are also determined. All comments and other block
attributes are excluded from an online/offline comparison.
If the block interface changes, the time stamp of the code block interface will also change. This
change means a change in the time stamp of the program code. The first step in comparing
block interfaces is therefore a comparison of the program code time stamps. If these time
stamps are the same, it is assumed that the interfaces are the same. If the time stamps of the
interfaces differ, the next step is to compare the data types of the interfaces, section by section.
Multiple instances and PLC data types are included in the comparison. If the data types in the
sections are the same, the start values of the tags are compared. All differences are displayed.
When networks are compared, first inserted or deleted networks are detected. Then the other
networks are compared. Instructions are the same if the operator and operand are the same.
The first difference in each instruction is displayed. However, several differences per network
can be displayed.
See also
Introduction to comparing PLC programs (Page 1750)
Comparison of data blocks (Page 1753)
Comparing PLC tags and PLC data types (Page 1753)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Introduction
The blocks to be compared in a data block comparison are assigned for comparison on the
basis of the following criteria:
Online/offline comparison: Addresses, e.g. DB100
Offline/offline comparison: Symbolic names of the blocks
The first step in data block comparison is comparing the time stamps of the data block. If these
time stamps are the same, it is assumed that the data structures are the same. If the time
stamps differ, the structures are then compared until the first difference is found. If the data
structures in the sections are the same, the initial values of the tags are then compared. All
differences are displayed. Any differing tag names are also determined. Comments and PLC
data type structures used in the data block are not included in the comparison.
See also
Introduction to comparing PLC programs (Page 1750)
Comparison of code blocks (Page 1752)
Comparing PLC tags and PLC data types (Page 1753)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Introduction
The device PLC tag tables and the device PLC data types will also be shown in the comparison
editor if you carry out an offline/offline comparison. The PLC tag tables and the PLC data
types will be matched by name and you will receive the following information:
Status: A symbol shows whether the PLC tags/PLC data types are identical or differ.
Missing PLC tag tables / PLC data types: You can see at a glance whether the PLC tag
tables / PLC data types are available in both devices.
You obtain the following information with an online/offline comparison of CPUs of the
S7-1200/1500 series:
PLC tags: A symbol shows whether the PLC tags are identical or differ. Because PLC tag
tables are not downloaded to the device during loading, they cannot be displayed during
an online/offline comparison.
PLC data types: You receive the status symbol for each PLC data type. You can see at a
glance whether the PLC data types are available in both devices.
See also
Introduction to comparing PLC programs (Page 1750)
Comparison of code blocks (Page 1752)
Comparison of data blocks (Page 1753)
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
3. Drag-and-drop an additional device to the drop area of the right pane. The device to be
compared can originate from the same project, a reference project or the library.
4. Open the "Program blocks" folder.
You can identify the status of the objects based on the symbols in the status and action
area. You can define certain actions depending on the status of the objects. When you
select an object, the object's properties and the corresponding object of the assigned device
are clearly shown in the properties comparison.
You can drag any other device to the drop area at any time to perform further comparisons.
See also
Introduction to comparing PLC programs (Page 1750)
Using the compare editor (Page 405)
Comparing PLC tags (Page 1778)
Comparing PLC data types (Page 1780)
Note
Please note the following:
For blocks that are created in the programming language SCL, the detail comparison is not
available for S7-1200 series CPUs with a version older than 2.0.
S7-1500: It is possible that another user can carry out a loading process on the CPU through
joint parallel working on a CPU. If the currently compared block is changed or deleted by
this loading process, the detailed comparison is terminated and a message is displayed.
In this case, re-start the detailed comparison, if required.
Result
One instance of the program editor will be opened for each version of the block compared and
the two instances are displayed side by side. Any differences will be highlighted.
See also
Carrying out offline/offline comparisons (Page 404)
Carrying out an online/offline comparison (Page 403)
Using the compare editor (Page 405)
Visualization of the comparison result for LAD/FBD (Page 1759)
Visualization of the comparison result for STL (Page 1763)
Visualization of the comparison result for SCL (Page 1766)
Navigating in the detailed comparison (Page 1775)
Changing blocks during the detailed comparison (Page 1776)
Updating comparison results (Page 1778)
Note
S7-1500: It is possible that another user can carry out a loading process on the CPU through
joint parallel working on a CPU. If the currently compared block is changed or deleted by this
loading process, the detailed comparison is terminated and a message is displayed. In this
case, re-start the detailed comparison, if required.
Procedure
To start a detailed comparison, follow these steps:
1. First, perform an online/offline or an offline/offline comparison between the two devices.
The compare editor opens.
2. In the compare editor, select the block for which you want to perform a detailed comparison.
Note
The manual comparison is also available for an offline/offline comparison. It lets you select
any block in the comparison editor for the comparison.
8. To compare the complete sequencers once again, click "Comparison mode" in the toolbar.
Each time you click "Comparison mode" you are changing the comparison mode. You can
also open the drop-down list with the arrow and select the required mode from the list.
See also
Carrying out offline/offline comparisons (Page 404)
Carrying out an online/offline comparison (Page 403)
Using the compare editor (Page 405)
Visualization of the comparison result for GRAPH (Page 1769)
Navigating in the detailed comparison (Page 1775)
Changing blocks during the detailed comparison (Page 1776)
Updating comparison results (Page 1778)
Introduction
The detailed comparison allows you to identify the exact places where versions of a block
differ. The following color coding allows you to find these places as quickly as possible:
The lines where there are differences are highlighted in gray.
Differing operands and instructions are highlighted in green.
If the number of networks differs, pseudo-networks are added to allow the display of
identical networks to be synchronized. These pseudo-networks are highlighted in gray and
contain the text "No corresponding network found" in the title bar of the network. Pseudo-
networks cannot be edited.
For the sake of clarity, not all the differences are highlighted but rather the first difference of
an operation in each case. For example, if all the inputs in an instruction with multiple inputs
are different in the offline and online versions of the block, only the first input is highlighted as
a difference. You can resolve this difference and update the comparison list. The next input
will then be highlighted as a difference.
The number of differences highlighted within a network therefore depends on the number of
instructions.
Note
Display of the symbolic names of the online version of the block is only possible for S7-1200
and S7-1500.
Reference block
The reference block is displayed in the left window. In an online/offline comparison, the
reference block is the offline version of the block.
Compared block
The compared block is displayed in the right window. In an online/offline comparison, the
compared block is the online version of the block.
See also
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Start a detailed comparison for LAD/FBD/STL/SCL blocks (Page 1756)
Navigating in the detailed comparison (Page 1775)
Introduction
The detailed comparison allows you to identify the exact places where versions of a block
differ. The following color coding allows you to find these places as quickly as possible:
The lines where there are differences are highlighted in gray.
Differing operands and instructions are highlighted in green.
If the number of networks differs, pseudo-networks are added to allow the display of
identical networks to be synchronized. These pseudo-networks are highlighted in gray and
contain the text "No corresponding network found" in the title bar of the network. Pseudo-
networks cannot be edited.
Note
The display of the symbolic names of the online version of the block is only possible for S7-1500.
Reference block
The reference block is displayed in the left window. In an online/offline comparison, the
reference block is the offline version of the block.
Compared block
The compared block is displayed in the right window. In an online/offline comparison, the
compared block is the online version of the block.
See also
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Start a detailed comparison for LAD/FBD/STL/SCL blocks (Page 1756)
Navigating in the detailed comparison (Page 1775)
Introduction
The detailed comparison allows you to identify the exact places where versions of a block
differ. The following color coding allows you to find these places as quickly as possible:
The lines where there are differences are highlighted in gray.
Differing operands and instructions are highlighted in green.
Note
The online/offline detailed comparison is not available for the CPU families S7-300/400 and
for S7-1200 with a version less than 2.0.
Note
The display of the symbolic name of the online version of the block is only possible for S7-1200
and S7-1500.
Reference block
The reference block is displayed in the left window. In an online/offline comparison, the
reference block is the offline version of the block.
Compared block
The compared block is displayed in the right window. In an online/offline comparison, the
compared block is the online version of the block.
See also
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Start a detailed comparison for LAD/FBD/STL/SCL blocks (Page 1756)
Navigating in the detailed comparison (Page 1775)
Changing blocks during the detailed comparison (Page 1776)
Updating comparison results (Page 1778)
Introduction
The detailed comparison allows you to identify the exact places where versions of a block
differ. When you start a detailed comparison for a GRAPH block, navigation is opened first.
Use the dividers to toggle between the navigation and the currently set view. You can select
other views with the toolbar of the detailed comparison.
The result of the comparison is indicated by the comparison symbols.
See also: Overview of the comparison editor (Page 405)
Note
If there are structural differences between the blocks, the comparison results are only displayed
up to the first structural difference in the sequence view.
The following figure shows an example for the single step view with an online/offline detailed
comparison for the GRAPH programming language:
Note
The result of the comparison refers to the complete network Differences within the networks
are not identified.
The following figure shows an example for the view of permanent instructions with an online/
offline detailed comparison for the GRAPH programming language:
Note
The result of the comparison refers to the complete network Differences within the networks
are not identified.
The following figure shows an example for the alarm view with an online/offline detailed
comparison for the GRAPH programming language:
Toolbars
With the toolbar of the detailed comparison, you can access the following functions:
General functions
Change to permanent pre-instructions
Change to sequence view
Change to single step view
Change to permanent post-instructions
Change to alarm view
Open all networks
Close all networks
Comparison-specific functions
Position on first difference
Position on previous difference
Position on next difference
Position on last difference
Synchronize scrolling between editors
Update comparison results
The navigation has its own toolbar with the following functions:
Zoom in or zoom out of elements within the navigation
Synchronize navigation
Reference block
The reference block is displayed in the left window. In an online/offline comparison, the
reference block is the offline version of the block.
Compared block
The compared block is displayed in the right window. In an online/offline comparison, the
compared block is the online version of the block.
Dividers
You can click the dividers to toggle quickly between the navigation and the current view.
See also
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Start a detailed comparison for LAD/FBD/STL/SCL blocks (Page 1756)
Start detailed comparison for GRAPH blocks (Page 1757)
Navigating in the detailed comparison (Page 1775)
Changing blocks during the detailed comparison (Page 1776)
Updating comparison results (Page 1778)
Requirement
You have run a detailed comparison.
Switching off/on the synchronization of the vertical scrolling between the editors
The scrolling for both editors is synchronized to ensure that the corresponding networks are
visible parallel to each other during vertical scrolling. You can switch this mode off and on. To
do this, follow these steps:
1. To switch off synchronized scrolling, click the "Synchronize scrolling between editors"
button in the toolbar.
2. To switch on synchronized scrolling again, click the "Synchronize scrolling between editors"
button one more time in the toolbar.
See also
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Start a detailed comparison for LAD/FBD/STL/SCL blocks (Page 1756)
Start detailed comparison for GRAPH blocks (Page 1757)
Visualization of the comparison result for LAD/FBD (Page 1759)
Visualization of the comparison result for STL (Page 1763)
Visualization of the comparison result for SCL (Page 1766)
Visualization of the comparison result for GRAPH (Page 1769)
Changing blocks during the detailed comparison (Page 1776)
Updating comparison results (Page 1778)
Note
You cannot change SCL blocks manually. However, you can apply changes from one block
to the other block. In this regard, note the following points:
You cannot apply any changes in an online block.
You can only apply changes in an offline block if this is not write-protected. This is the case,
for example, if the blocks of the detailed comparison come from different CPUs. It is then
also possible to apply the changes to the block in the right-hand area.
See also
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Start a detailed comparison for LAD/FBD/STL/SCL blocks (Page 1756)
Start detailed comparison for GRAPH blocks (Page 1757)
Visualization of the comparison result for LAD/FBD (Page 1759)
Visualization of the comparison result for STL (Page 1763)
Visualization of the comparison result for SCL (Page 1766)
Visualization of the comparison result for GRAPH (Page 1769)
Navigating in the detailed comparison (Page 1775)
Updating comparison results (Page 1778)
Requirement
You have run a detailed comparison.
Procedure
To update the comparison results, follow these steps:
1. Click "Update the comparison result" in the toolbar.
See also
Carrying out an online/offline comparison (Page 403)
Carrying out offline/offline comparisons (Page 404)
Using the compare editor (Page 405)
Start a detailed comparison for LAD/FBD/STL/SCL blocks (Page 1756)
Start detailed comparison for GRAPH blocks (Page 1757)
Visualization of the comparison result for LAD/FBD (Page 1759)
Visualization of the comparison result for STL (Page 1763)
Visualization of the comparison result for SCL (Page 1766)
Visualization of the comparison result for GRAPH (Page 1769)
Navigating in the detailed comparison (Page 1775)
Changing blocks during the detailed comparison (Page 1776)
See also
Introduction to comparing PLC programs (Page 1750)
Using the compare editor (Page 405)
Comparing PLC data types (Page 1780)
You can drag any other device to the drop area at any time to perform further comparisons.
See also
Introduction to comparing PLC programs (Page 1750)
Using the compare editor (Page 405)
Comparing PLC tags (Page 1778)
Introduction
A user program must first be compiled before the CPU can execute it. You need to recompile
your program each time you make a change.
The following procedures take place during compilation:
The user program is checked for syntax errors.
Unneeded instructions are removed from the user program.
All the block calls within the compiled blocks are checked. In case of changes to the
interface of called blocks, errors will be shown in the "Compilation" tab of the information
window. You have to correct these errors first.
The blocks must be numbered uniquely in the user program. If more than one block has
the same number, the blocks with number conflicts are renumbered automatically during
compilation. A block will not be renumbered in the following cases:
The block was selected either individually or as part of a multiselection for the
compilation.
The block is know-how protected.
The number assignment is set to "manual" in the properties of the block.
Number conflicts that cannot be resolved by automatic renumbering must be corrected
manually. Note the messages in the Inspector window for this. You can only correct know-
how-protected blocks manually if you know the password since the blocks must then be
recompiled.
Finally, the user program is compiled into a code that can be read by the CPU.
Compilation methods
You can start compilation in the following windows or editors:
Compiling blocks in the project tree
Serves to compile individual blocks or the simultaneous compilation of one or several blocks
in the "Program blocks" folder.
Compiling blocks in the program editor
This is intended for compilation of a single open block.
Compiling blocks in the call or dependency structure
Used to compile individual blocks.
See also: Call structure (Page 1818), Dependency structure (Page 1824)
Compilation options
If you are compiling blocks in project tree, you have further options:
Software (changes only)
All program changes of the selected blocks are compiled. If you have selected a block
folder, all program changes to the bocks contained in the folder are compiled.
Software (compile all blocks)
All blocks are compiled. This is recommended for the first compilation and after major
revisions.
Software (reset memory reserve)
All tags declared in the reserve area of the interface of selected blocks are moved to the
standard area of the interface. Memory reserve is now available for further interface
extensions.
Note
This option is only available for CPUs of the S7-1500 and S7-1200 V4 and higher series.
Consistency check
Changing the interfaces of blocks called or PLC data types used can result in inconsistencies
between calling blocks and called blocks or between the PLC data types and the global data
blocks which use these PLC data types.
To avoid such inconsistencies in the user program, the system performs an automatic
consistency check before each compilation process. The time stamps are compared and
compilation is then either carried out or canceled depending on the results of the comparison.
The calling block can only be compiled if the time stamps of the interfaces of the called
blocks are older than those of the calling block.
A global data block based on a PLC data type can only be compiled correctly if the time
stamp of the global data block is newer than the time stamp of the PLC data type used.
The instance data block can only be compiled correctly if the interface time stamps for the
interface of the instance data block are identical to those of the assigned function block.
If the compilation process is cancelled, an alarm is displayed in the inspector window. Update
the block calls in the relevant blocks and the PLC data types in the global data blocks and then
restart compilation. The consistency check also finds know-how protected blocks which cannot
be compiled. The corresponding messages will also be shown in the inspector window.
If you start loading immediately instead of first compiling, the blocks selected will be
automatically compiled and the block call and global data blocks implicitly updated. Please
note the following differences between the CPU families:
S7-1200/1500: All blocks affected are loaded to ensure no inconsistencies can arise.
S7-300/400: Only the block selected is loaded.
See also
Compiling blocks in the project tree (Page 1784)
Compiling blocks in the program editor (Page 1785)
Correcting compilation errors (Page 1786)
Block time stamps (Page 1520)
Updating block calls in LAD (Page 1596)
Updating block calls in FBD (Page 1638)
Compiling project data (Page 392)
Requirement
The project tree is open.
Result
The code for the blocks will be generated if the consistency check has been successful.
Instance data blocks generated by the system which are no longer needed will be deleted.
The message under "Info > Compilation" in the inspector window reports whether the
compilation was successful.
See also
Basic information on compiling blocks (Page 1782)
Compiling blocks in the program editor (Page 1785)
Correcting compilation errors (Page 1786)
Finding syntax errors in the program (Page 1697)
Note
Note that the block is recompiled even if you have not made any changes and the time stamp
of the block is modified.
Requirement
The block to be compiled is open.
Procedure
To compile a block in the program editor, follow these steps:
1. Right-click in the instruction window of the programming editor.
2. Select the "Compile" command in the shortcut menu.
Result
The code for the block is generated. Instance data blocks generated by the system which are
no longer needed will be deleted.
The message under "Info > Compilation" in the inspector window reports whether the
compilation was successful.
See also
Basic information on compiling blocks (Page 1782)
Compiling blocks in the project tree (Page 1784)
Correcting compilation errors (Page 1786)
Procedure
To correct errors following compilation, follow these steps:
1. Open the error list in the Inspector window with "Info > Compile".
2. If there is one, click on the blue question mark next to the error text for information on
remedying errors.
3. Double-click the error you want to correct.
The corresponding error is highlighted.
4. Correct the error.
5. Restart compilation.
See also
Basic information on compiling blocks (Page 1782)
Compiling blocks in the program editor (Page 1785)
Compiling blocks in the project tree (Page 1784)
Depending on the selected object (such as individual blocks in the programming editor, the
complete block folder or the connected CPU in the project navigation) and the command
respectively selected, you can load the following components:
Hardware and software (only changes)
Hardware configuration
Software (only changes)
Software (all)
During the loading operation, all information that is required for the reconstruction of the
program, including symbolic information such as the names and comments for code and data
blocks, is also loaded in the current project language. If you change the project language, you
must therefore re-load the program.
The symbolic information is not loaded to the work memory, but rather to the load memory.
After the data has been loaded from a device, the symbolic information is available again in
your program, which increases the readability of your program code. Please note, however,
that loading to and from a device is not a substitute for storing data in an offline project, as
watch tables or multi-language capability of projects cannot be reproduced by loading to and
from a device.
After loading from a device, you can only display all data from know-how-protected blocks by
entering the correct password.
Note
No valid hardware configuration available
If no valid hardware configuration was found on the CPU while loading the software, the existing
hardware is loaded as well during a "Download to device".
Please note that in this case hardware components are also loaded during the download, even
though you executed the command for loading software!
Note
To avoid inconsistencies between calling and called blocks, all blocks affected are compiled
and loaded after each global change, such as a change in the block interface.
Note
S7-1200 Version 1.0
If you download an element of your project to the CPU, for example a program block, a data
block or the hardware configuration, the CPU runs a cold restart the next time it changes to
RUN mode. Apart from deleting the inputs, initializing the outputs and deleting the non-retentive
memory, cold restart also deletes the retentive memory areas. All subsequent changes from
STOP to RUN are warm restarts in which the retentive memory is not deleted.
Note
S7-1500
The load memory of S7-1500 series CPUs is on the SIMATIC memory card. Therefore, a
SIMATIC memory card absolutely must be inserted in order to operate the CPU.
Note
S7-1200
Note the following when uploading to or downloading from a memory card:
If the CPU contains no previous program and you insert an empty memory card in the CPU
the program will be loaded from the PG/PC to the memory card and not to the CPU.
If you insert an empty memory card prior to the startup of the CPU, the program that is on
the CPU will be transferred automatically to the memory card. The program on the CPU
will then be deleted.
If you insert a memory card with a program in the CPU prior to the startup of the CPU and
the CPU already contains a program, the program on the memory card will be executed
and not the program on the CPU. The program on the CPU will be deleted.
You can use the "Force download to device" command to download blocks without
synchronization, if desired.
If it is necessary to change to the "STOP" operating mode, you cannot continue the download
process until you have stopped the CPU.
If the requirements are met, you can also download a modified program or program parts to
a CPU in "RUN" operating mode.
The quantity structures may be exceeded for very complex programs which prevents a
download in "RUN". In this case you must first create the prerequisites for a download in "RUN".
Tips:
Use a memory card with sufficient capacity.
Select a CPU with sufficient work memory.
If necessary, reduce the number of downloaded objects (blocks, constants, PLC tags, data
types).
If you cannot download all objects at once, proceed in several steps and download a smaller
number of objects in each step.
Note
Actual parameters are not overwritten by a download process in the "RUN" operating mode.
Changes to the actual parameters will not become effective until the next time you change the
operating mode from "STOP" to "RUN".
New/revised text lists (messages) RUN RUN STOP RUN (V1.1 and
higher)
Revised comments (new, revised, de - - RUN RUN
leted) with the exception of comments in
the HW configuration
Number of blocks downloaded at the same RUN (<17) RUN (<57) RUN (<21) RUN (all)
time
Download PLC program to the device and STOP (Reset) STOP (Reset) STOP (Reset) STOP (Reset)
reset
New OB RUN RUN STOP RUN
Modified OB: Code changes RUN RUN RUN RUN
OB with modified properties RUN RUN STOP RUN
(e.g., cycle time change)
Deleted OB RUN RUN STOP RUN
New FB/FC/DB/User Data Type (UDT) RUN RUN RUN RUN
Deleted FB/FC/DB/User Data Type (UDT) RUN RUN RUN RUN
Revised FB/FC: Code change RUN RUN RUN RUN
Revised FB/FC: Interface change* STOP STOP RUN RUN
Modified DB: Modified property ("Only STOP STOP RUN (Init) RUN (Init)
store in load memory" attribute changed)
Modified DB (memory reserve not ena RUN (Init) RUN (Init) RUN (Init) RUN (Init)
bled): Name/type of tags modified, tags
added or deleted **
Modified DB (memory reserve enabled): - - RUN RUN
New tag added**
Modified User Data Type (UDT) STOP STOP RUN (Init) RUN (Init)
Add new PLC tags (timer, counter, bit RUN RUN RUN RUN
memory)
Modified retentivity settings (timer, coun STOP STOP STOP STOP
ter, bit memory, DB area)
Motion Control technology objects: - - - STOP
Changes to MC Servo cycle clock, change
from free-running to cyclical (and vice ver
sa). Changes to the HW interface of the TO
* If the interface change results in structural changes at the instance DB, see "Modified DB...".
** For the effect of download of data block changes to the data block content, see section "Downloading data blocks to the
CPU"
S7-1200 S7-1200
V1.0 - 2.1 V2.2 - V3.0
Action/type of change Download possible in mode ...
Modified properties of HW components. STOP STOP
This includes changes to comments in the HW configuration.
Added HW components STOP STOP
Download new data blocks Actual values in the new data blocks are set to
start values.
Download structurally modified data blocks Actual values of added tags in the structurally
(memory reserve not enabled) modified data blocks are set to start values.
Download structurally modified data blocks The following actual values are retained:
(memory reserve enabled) Actual values of tags outside the memory
reserve
Actual values of tags that were not modified
within the memory reserve
Actual values of added tags within the memory
reserve are set to start values.
Download of simply modified data blocks (no Actual values are retained.
structural modification)
Additional information
Additional information on download of block extensions without re-initialization and download
of modified values for data blocks is available at "See also".
See also
Downloading blocks from program editor to device (Page 1794)
Downloading blocks from the project tree to the device (Page 1796)
Downloading project data to a device (Page 396)
Requirement
The block to be downloaded is open.
Procedure
To download a block from the program editor to the device, follow these steps:
1. Right-click in the instruction window of the programming editor.
2. Select the "Download to device" command in the shortcut menu.
If you have not already established an online connection, the "Extended download to
device" dialog opens. In this case, set all parameters required for the connection and
click "Load".
You can save your preferred connection parameters as default under "Options >
Settings > Online & Diagnostics". When you first load with new connection parameters,
a query is automatically displayed whether you want to store it as a default setting. Click
"Yes", if you want to save the current connection parameters as default.
You have the option of showing all compatible devices by selecting the corresponding
option and clicking the "Start search" command. You can also open the "Extended
download to device" dialog explicitly via the "Online" menu.
See also: Establishing and terminating an online connection
If you have already specified an online connection, then the project data is compiled if
necessary and the "Load preview" dialog opens. This dialog displays alarms and
proposes actions necessary for loading.
3. Check the alarms and, where necessary, enable the actions in the "Action" column.
As soon as downloading becomes possible, the "Load" button is enabled.
Note
Actions
Performing the proposed actions during ongoing plant operation can cause serious damage
to property or injury to persons if there are functional faults or program errors.
Make sure that no dangerous situations can arise before you start the actions.
Note
To avoid inconsistencies between calling and called blocks, download all affected blocks
each time you make global changes, such as changes in the block interface. Select the
"Consistent download" action.
4. Click "Load".
If there is a need for synchronization, the system automatically displays the
"Synchronization" dialog. This dialog displays messages and suggests actions that are
needed for the synchronization. You have the option of performing these actions or forcing
the download without synchronization by clicking "Force download to device". If you have
performed the suggested actions, you will be asked whether you want to continue with the
download. Click "Continue download" in order to download the block. The "Load results"
dialog then opens and shows you the status and the actions after the download operation.
5. If you want to start the modules again directly after downloading, select the "Start all" check
box.
6. To close the "Load results" dialog box, click "Finish".
Result
The code for the block will be downloaded to the device. If the changes affect additional blocks,
these will be compiled and also downloaded to the device. Blocks that only exist online in the
device are deleted. Existing CPU data blocks are retained, however. Inconsistencies between
the blocks in the user program are avoided by loading all blocks affected and deleting the
unneeded blocks in the device.
The messages under "Info > General" in the Inspector window show whether the downloading
process was successful.
See also
Downloading blocks from the project tree to the device (Page 1796)
Downloading project data to a device (Page 396)
Downloading blocks in the "RUN" operating mode to the device (Page 1790)
Downloading one or more blocks from the project tree to the device
To download one block or multiple blocks to the device from the project tree, follow these steps:
1. Open the "Program blocks" folder in project tree.
2. Select the blocks you want to download.
3. Select the "Download to device > Software (only changes)" command from the shortcut
menu.
If you have not already established an online connection, the "Extended download to
device" dialog opens. In this case, set all parameters required for the connection and
click "Load".
You can save your preferred connection parameters as default under "Options >
Settings > Online & Diagnostics". You will be prompted as such when you download
new connection parameters for the first time. Select "Yes", if you want to save the current
connection parameters as default.
You have the option of showing all compatible devices by selecting the corresponding
option and clicking the "Start search" command. You can also open the "Extended
download to device" dialog explicitly via the "Online" menu.
See also: Go online and Go offline
If you have already specified an online connection, then the project data is compiled if
necessary and the "Load preview" dialog opens. This dialog displays alarms and
proposes actions necessary for loading.
4. Check the alarms and, where necessary, enable the actions in the "Action" column.
Note
Performing the proposed actions during ongoing plant operation can cause serious damage
to property or injury to persons if there are functional faults or program errors.
Make sure that no dangerous situations can arise before you start the actions.
As soon as downloading becomes possible, the "Load" button is enabled.
5. Click "Load".
If there is a need for synchronization, the system automatically displays the
"Synchronization" dialog. This dialog displays messages and suggests actions that are
needed for the synchronization. You have the option of performing these actions or forcing
the download without synchronization by clicking "Force download to device". If you have
performed the suggested actions, you will be asked whether you want to continue with the
download. Click "Continue download" in order to download the block. The "Load results"
dialog then opens and shows you the status and the actions after the download operation.
6. If you want to start the modules again directly after downloading, select the "Start all" check
box.
7. To close the "Load results" dialog box, click "Finish".
5. Click "Load".
If there is a need for synchronization, the system automatically displays the
"Synchronization" dialog. This dialog displays messages and suggests actions that are
needed for the synchronization. You have the option of performing these actions or forcing
the download without synchronization by clicking "Force download to device". If you have
performed the suggested actions, you will be asked whether you want to continue with the
download. Click "Continue download" in order to download the block. The "Load results"
dialog then opens and shows you the status and the actions after the download operation.
6. If you want to start the modules again directly after downloading, select the "Start all" check
box.
7. To close the "Load results" dialog box, click "Finish".
Result
The code for the blocks is downloaded to the device. If the changes affect additional blocks,
these will be compiled and also downloaded to the device. Blocks that only exist online in the
device are deleted. Inconsistencies between the blocks in the user program are avoided by
loading all blocks affected and deleting the unneeded blocks in the device.
The messages under "Info > General" in the Inspector window show whether the downloading
process was successful.
See also
Downloading blocks from program editor to device (Page 1794)
Downloading project data to a device (Page 396)
Downloading blocks in the "RUN" operating mode to the device (Page 1790)
Note
Please note the following:
Please note that when you load individual blocks, no tags or other required blocks to which
you may refer are loaded together with the individual blocks. During the loading operation,
reference to tags and blocks are reassigned where possible based on the names. After the
loading operation, check whether these assignments are correct.
When uploading from a device to an empty project, any existing folder structures for blocks
and objects from libraries may not be downloaded.
S7-1500: When GRAPH function blocks are loaded from a device to your project, the step-
specific alarm texts for the interlock and supervision alarms are not loaded.
Requirement
The online and offline versions of a block to be loaded are different or the blocks only exists
online.
Result
The blocks will be uploaded from the device to the project. You can edit them as normal,
recompile them and download them to the device again.
Requirement
The memory card is marked as a program card.
The "Program blocks" folder of the memory card is open.
Procedure
To download blocks to a memory card, follow these steps:
1. Open the "Program blocks" folder of the device in the project tree.
2. Select the blocks you want to download to the memory card.
3. Drag the blocks in project tree to the "Program blocks" folder of the memory card. You can
also copy the blocks and add them to the memory card.
If necessary, the blocks are compiled. The "Load preview" dialog then opens. This dialog
displays alarms and proposes actions necessary for loading.
4. Check the alarms and, where necessary, enable the actions in the "Action" column.
5. As soon as downloading becomes possible, the "Load" button is enabled.
6. Click the "Load" button.
If there is a need for synchronization, the system automatically displays the
"Synchronization" dialog. This dialog displays messages and suggests actions that are
needed for the synchronization. You have the option of performing these actions or forcing
the download without synchronization by clicking "Force download to device". If you have
performed the suggested actions, you will be asked whether you want to continue with the
download. Click "Continue download" to download the block. The "Load results" dialog then
opens and shows you the status and the actions after the download operation.
7. Click "Finish".
Or:
1. In the project tree, select the blocks that you want to upload.
2. Select the "Card reader/USB memory > Write to memory card" command in the "Project"
menu.
The "Select memory card" dialog opens.
3. Select a memory card which is compatible with the CPU.
A button with a green check mark is activated at the bottom of the dialog.
4. Select the button with the green check mark.
If necessary, the project data are compiled. The "Load preview" dialog then opens. This
dialog displays alarms and proposes actions necessary for loading.
5. Check the alarms and, where necessary, enable the actions in the "Action" column.
As soon as downloading becomes possible, the "Load" button is enabled.
6. Click the "Load" button.
If there is a need for synchronization, the system automatically displays the
"Synchronization" dialog. This dialog displays messages and suggests actions that are
needed for the synchronization. You have the option of performing these actions or forcing
the download without synchronization by clicking "Force download to device". If you have
performed the suggested actions, you will be asked whether you want to continue with the
download. Click "Continue download" to download the block. The "Load results" dialog then
opens and shows you the status and the actions after the download operation.
7. Click "Finish".
Result
The blocks are downloaded to the memory card. If the changes affect additional blocks, these
will also be downloaded to the memory card. Blocks that exist only on the memory card are
deleted. Inconsistencies between the blocks in the user program are avoided by downloading
all affected blocks and the deleting of the non-required blocks on the memory card.
The messages under "Info > General" in the Inspector window show whether the downloading
process was successful.
See also
Uploading blocks from a memory card (Page 1801)
Accessing memory cards (Page 468)
Requirement
The memory card is displayed.
See also: Accessing memory cards (Page 468)
Procedure
To upload blocks from a memory card to your project, follow these steps:
1. In the project tree, drag the folder of the memory card to the folder of the device in the
project. You can also copy the memory card and insert it in the device.
The "Upload preview" dialog box opens. This dialog displays alarms and proposes actions
necessary for loading.
2. Check the alarms and, where necessary, enable the actions in the "Action" column.
The "Upload from device" button will be enabled as soon as uploading becomes possible.
3. Click on the "Upload from device" button.
See also
Downloading blocks to a memory card (Page 1799)
Introduction
You can use a password to protect one or more blocks of the OB, FB, FC type and global data
blocks from unauthorized access. Note the following particularities:
You can not manually protect instance data blocks; they depend on the know-how
protection of the assigned FB. This means that when you create an instance data block for
a know-how protected FB, the instance data block also receives this know-how protection.
This is independent of whether you explicitly create the instance data block or if it is created
by a block call.
The know-how protection acts as write protection in global blocks and in instance data
blocks.
You cannot provide ARRAY data blocks with know-how protection.
If a block is know-how protected, only the following data is readable without the correct
password:
Interface parameters Input, Output, InOut, Return, Static
Block title
Block comment
Block properties
Tags of global data blocks without specification of the location of use
The following actions can be performed with a know-how protected block:
Copying and deleting
Calling in a program
Online/offline comparison
Downloading
The code of the block, on the other hand, is protected from unauthorized reading and
modification. For S7-1200/1500 CPUs, you can also set up copy protection which binds
execution of the block to the CPU or the memory card with the defined serial number.
Note
Please note the following:
S7-1200 version 1.0 and S7-300/400 (only GRAPH and SCL blocks): If you download a
know-how-protected block to a device, no restore information is loaded along with it. This
means that you cannot open a know-how-protected block again even with the correct
password if you upload it from the device.
Only the non-protected data is compared in offline-online comparison of know-how
protected blocks.
You will no longer be able to access the block if you do not have the password.
If you add a know-how-protected block to a library, the master copy created will also be
know-how protected.
For S7-1500, you can select the "Block can be used as know-how protected library item"
check box in the block properties to obtain the information on whether or not the block can
be used as protected library item. For this purpose, the block cannot use any tags from the
operand areas Output (Q), Input (I), Bit memory (M), Timer function (T) or Count function
(C), and cannot access data blocks.
Cross references to used tags, bit memories, inputs and outputs in know-how protected
blocks are not displayed even after the correct password is entered..
If you change the number of a block, the loadable binary component of the block is out of
date. This means that the block must be recompiled before loading it to a device. For know-
how-protected blocks, this is only possible with the correct password. Keep this in mind
particularly if you want to copy a know-how-protected block to another device in which there
is already a block with the same number.
Always pass on a project that includes know-how-protected blocks as a project archive or
library archive. In this way, you ensure that the know-how protection cannot be bypassed.
If you wish to assign know-how protection to several blocks using multiple selection, no
instance data block can be included in the selection. Otherwise, it will not be possible to
set know-how protection.
You cannot change the know-how protection settings for an open, know-how protected
block.
See also
Setting up and removing block copy protection (Page 1804)
Setting up block know-how protection (Page 1805)
Opening know-how protected blocks (Page 1806)
Printing know-how protected blocks (Page 1807)
Removing block know-how protection (Page 1808)
Changing a password (Page 1808)
Creating compressed project archive (Page 387)
Archiving global libraries (Page 493)
Note
S7-1500 and S7-1200 V2.2 and higher: If you download a copy protected block to a device
that does not match the specified serial number, the entire download operation will be rejected.
This means that blocks without copy protection, too, will not be downloaded.
See also
Protecting blocks (Page 1802)
Setting up block know-how protection (Page 1805)
Opening know-how protected blocks (Page 1806)
Printing know-how protected blocks (Page 1807)
Removing block know-how protection (Page 1808)
Changing a password (Page 1808)
Procedure
To set up block know-how protection, follow these steps:
1. Select the blocks with no know-how protection which you want to protect.
2. Select the command "Know-how protection" in the "Edit" menu.
The "Know-how protection" dialog will open.
3. Click "Define".
The "Define password" dialog box opens.
4. Enter a password in the "New" field.
5. Enter the same password in the "Confirm" field.
6. Confirm your entries with "OK".
7. Close the "Know-how protection" dialog by clicking on "OK".
Result
The blocks selected will be know-how-protected. Know-how protected blocks are marked with
a lock in the project tree. The password entered is valid for all blocks selected.
See also
Protecting blocks (Page 1802)
Setting up and removing block copy protection (Page 1804)
Opening know-how protected blocks (Page 1806)
Printing know-how protected blocks (Page 1807)
Removing block know-how protection (Page 1808)
Changing a password (Page 1808)
Procedure
To open a know-how protected block, follow these steps:
1. Double-click on the block you wish to open.
The "Access protection" dialog will open.
2. Enter the password for the know-how protected block.
3. Confirm your entry with "OK".
Result
The know-how protected block will open provided you have entered the correct password.
However, the block will remain know-how protected. If you copy the block or add it to a library,
for example, the copies will also be know-how protected.
Once you have opened the block, you can edit the program code and the block interface of
the block for as long as the block or TIA Portal is open. The password must be entered again
the next time the block is opened. If you close the "Access protection" dialog with "Cancel",
the block will open but the block code will not be displayed and you will not be able to edit the
block.
See also
Protecting blocks (Page 1802)
Setting up and removing block copy protection (Page 1804)
Setting up block know-how protection (Page 1805)
Printing know-how protected blocks (Page 1807)
Removing block know-how protection (Page 1808)
Changing a password (Page 1808)
Procedure
To print a know-how protected block in full, follow these steps:
1. Open the know-how protected block you wish to print.
See also: Opening know-how protected blocks (Page 1806)
2. Select the "Print" command in the "Project" menu.
The "Print" dialog will open.
3. Select the printer in the "Name" field.
4. Click "Advanced" to modify the Windows printer settings.
5. Select the documentation information set in the "Document information" drop-down list that
you want to use for the frame layout.
6. Under "Print objects/area" select whether you want to print all objects or the complete area,
or only a selection.
7. Under "Properties" select the print scope.
Select "All" to print the complete block.
Choose "Visible" to print all the information within the block that is visible on the screen.
Select "Compact" to print a shortened form of the block.
8. Click "Preview" to generate a print preview in advance.
A print preview is created in the work area.
9. Click "Print" to start the printout.
See also
Printing project contents (Page 419)
Protecting blocks (Page 1802)
Setting up and removing block copy protection (Page 1804)
Setting up block know-how protection (Page 1805)
Removing block know-how protection (Page 1808)
Changing a password (Page 1808)
Procedure
To change the password, follow these steps:
1. Select the know-how protected blocks for which you want to change the password.
Note
You can only change the password for several blocks at once if all blocks selected have
the same password.
See also
Protecting blocks (Page 1802)
Setting up and removing block copy protection (Page 1804)
Setting up block know-how protection (Page 1805)
Opening know-how protected blocks (Page 1806)
Printing know-how protected blocks (Page 1807)
Removing block know-how protection (Page 1808)
Procedure
To remove block know-how protection, follow these steps:
1. Select the blocks for which you want to remove know-how protection.
Note
You can only remove know-how protection for several blocks at once if all blocks selected
have the same password.
Result
Know-how protection will be disabled for the blocks selected.
See also
Protecting blocks (Page 1802)
Setting up and removing block copy protection (Page 1804)
Setting up block know-how protection (Page 1805)
Opening know-how protected blocks (Page 1806)
Printing know-how protected blocks (Page 1807)
Changing a password (Page 1808)
Program information
The program information of a user program contains the view specified in the following table.
View Application
Assignment list (Page 1810) Provides an overview of the address bits for the I,
Q, and M memory areas already allocated within
the user program.
Also indicates if an address has been allocated by
access from an S7 program or if the address has
been assigned to a SIMATIC S7 module.
Call structure (Page 1818) Shows the call structure of the blocks within the
user program and provides an overview of the
blocks used and their relationships.
View Application
Dependency structure (Page 1824) Shows the list of blocks used in the user program.
A block is shown at the first level and blocks that
call or use this block are indented below it. In con
trast to the call structure, instance blocks are listed
separately.
Resources (Page 1830) Shows the hardware resources of the CPU for ob
jects (OB, FC, FB, DB, user-defined data types
and PLC tags), for CPU memory areas and for the
existing I/O modules.
Filters
You can filter the display within the assignment list. You can use predefined filters or create
your own.
See also
Symbols in the assignment list (Page 1812)
Layout of the assignment list (Page 1811)
See also
Introduction to the assignment list (Page 1810)
Symbol Meaning
Indicates the address assignment in the selected state.
Indicates the address assignment in the non-selected state.
Indicates that a pointer start address and a tag address access the
same address range and that they are selected.
Indicates that a pointer start address and a tag address access the
same address range and that they are not selected.
Indicates the pointer assignment in the selected state.
Indicates that the byte is in use with byte access and the corre
sponding tag is selected. The shortcut menu allows you to display
cross-reference information for the selected variables as well as the
PLC tag table.
Indicates that the byte is in use with byte access and the corre
sponding tag is not selected.
Indicates that the byte is in use with word access and the corre
sponding tag is selected. The shortcut menu allows you to display
cross-reference information for the selected variables as well as the
PLC tag table.
Symbol Meaning
Indicates that the byte is in use with word access and the corre
sponding tag is not selected.
Indicates that the byte is in use with double word access and the
corresponding tag is selected. The shortcut menu allows you to dis
play cross-reference information for the selected variables as well
as the PLC tag table.
Indicates that the byte is in use with double word access and the
corresponding tag is not selected.
Background color: gray Indicates that a byte is in use with byte, word or double word access
and that the address is also in use by the hardware. The gray back
ground color indicates overlapping memory access.
Background color: yellow Indicates that the address is not in use by the hardware.
Indicates that the memory area has been defined as system mem
ory.
Indicates that the memory area has been defined as clock memory.
See also
Layout of the assignment list (Page 1811)
Introduction to the assignment list (Page 1810)
Requirement
A project has been created with programmed blocks.
Procedure
Proceed as follows to display the assignment list:
1. Select the "Program blocks" folder or one or more of the blocks it contains.
2. Select the "Assignment list" command in the "Tools" menu.
Result
The assignment list for the selected program is displayed.
See also
Setting the view options for the assignment list (Page 1814)
Layout of the assignment list (Page 1811)
Introduction
The following view options are available for the assignment list:
Used addresses:
When this check box is activated, the addresses, I/Os and pointers used in the program
are displayed.
Free hardware addresses:
When this check box is activated, only the free hardware addresses are displayed.
Requirement
A project has been created with programmed blocks.
The assignment list is open.
Procedure
Proceed as follows to set the view options for the assignment list:
1. Click on the arrow of the symbol ("View options") in the task bar.
The view options for the assignment list are opened. Check marks are set in front of the
activated view options.
2. If you want to activate or deactivate a view option, click on the respective check box and
set or remove the check mark.
Result
The view options are set and the desired information is displayed in the assignment list.
Filter settings
You can define your own filter settings for the assignment list. The following options are
available for defining filters:
Display all addresses of the address areas specified.
Display of single, defined addresses from the selected address area, for example, "0" and
"200".
Display of complete areas from the selected address area, for example, "0 - 256".
The following table provides an overview of all available options:
Requirement
A project has been created with programmed blocks.
The assignment list is open.
Defining filter
Proceed as follows to define a filter for the assignment list:
1. Click on the symbol ("Filter") in the task bar.
The "Assignment List Filter" dialog opens.
2. Click on the symbol ("Create new filter") in the task bar.
A new filter is created with the name "Filter_1". The check boxes for all addresses (inputs,
outputs, memory bits, timers and counters) are activated by default for the filter.
3. If you want to change the name of the filter, click on the drop-down list in the task bar and
enter a new filter name.
4. Deactivate the check boxes of addresses that are not to be affected by the filter.
5. Enter one of the following options in the filter area of the activated address:
Show all addresses used = "*"
Show single, defined addresses, for example, IB 0" and IB 25 = "0.25". Individual
addresses and address areas are separated by commas or semicolons.
Show complete address areas, for example, IB 0 to IB 256 = "0-256". Complete address
areas should be connected by a hyphen.
6. Confirm your entries with "OK".
The newly defined filter is shown in the task bar of the assignment list under the specified
name.
Delete filter
Proceed as follows to delete a filter:
1. Click on the symbol ("Filter") in the task bar.
The filter dialog for the assignment list opens.
2. In the drop-down list of the task bar, select the filter you want to delete.
3. Click on the symbol ("Delete selected filter") in the task bar.
The selected filter is deleted.
See also
Filter options in the assignment list (Page 1815)
Displaying an assignment list (Page 1813)
Introduction to the assignment list (Page 1810)
Requirement
A project has been created with programmed blocks.
The assignment list is open.
Procedure
1. Click on the arrow on the drop-down list.
The available filter are displayed.
2. Select the desired filter.
Result
The assignment list is filtered according to the settings of the selected filter.
Note
The filter settings are saved when the project is closed.
Introduction
In the assignment list you can define the width of the retentive memory area for bit memories.
The content of tags which are addressed in retentive memory is retained after power off and
at the STOP to RUN transition after power on.
The display of retentive bit memories can be enabled and disabled in the assignment list. If
their display is enabled, retentive bit memories are identified by an icon in the "Address"
column.
Requirement
The assignment list is open.
Procedure
Proceed as follows to define the width of the retentive memory area for bit memories:
1. Click "Retain" in the toolbar.
The "Retain memory" dialog will open.
2. Starting at the count of 0, define the width of the retentive memory area by entering the last
byte of this area in the input field. Watch out for any addresses of tags already assigned to
the retentive area.
3. Load the block to the target system. Select the "Program blocks" folder in the Project tree
and select the "Download to device" submenu in the shortcut menu.
Result
The width of the retentive memory area is defined. If enabled in the assignment list, an icon
will indicate the retentive state of all tags in the "Address" column.
Introduction
In the assignment list you can enable and disable the display of retentive bit memories. The
retentive bit memories are identified by means of an icon in the "Address" column if the display
of retentivity is enabled.
Requirement
The assignment list is open.
Procedure
Proceed as follows to enable and disable the display of retentive bit memories:
1. Click "Display/hide retentivity" in the toolbar.
Result
The retentive tags are identified by means of an icon in the "Address" column of the bit memory
area if the display of retentivity is enabled. The icons in the "Address" column are hidden if the
display of retentivity is disabled.
Call structure
The call structure describes the call hierarchy of the block within an S7 program.
It provides an overview of:
The blocks used
Jumps to the places of use of the blocks
Relationships between blocks
Local data requirements of the blocks
Status of the blocks
View options
The following view options are available for the call structure:
Show conflicts only:
When this check box is activated, only the conflicts within the call structure are displayed.
Group multiple calls together:
When this check box is activated, several block calls are grouped together. The number of
block calls is displayed in the "Call frequency" column. The links to the various call locations
are offered in a drop-down list in the "Details" column.
Note
Please note that any existing local data can only be displayed or updated after compiling a
block.
See also
Symbols in the call structure (Page 1820)
Symbol Meaning
Indicates an organization block (OB).
Indicates that the block is not called directly or indirectly from an OB.
Symbol Meaning
Indicates that the block is normally called recursively.
Column Content/meaning
Call structure Shows an overview of the blocks called
If the viewing option "Group multiple calls together" is ena
bled, several block calls are grouped together and the "Num
ber of calls" column is displayed.
Call type (!) Shows the type of call, for example recursive block call.
Address Shows the absolute address of the block. With a function
block, the absolute address of the corresponding instance
data block is also shown.
Call frequency Indicates the number of multiple calls of blocks.
Details Shows the network or interface of the calling block. All infor
mation are offered as a link in this column. With this link, you
can jump to the location of the block call in the program editor.
If the viewing option "Group multiple calls together" option is
enabled, the calls are grouped together and are available as
links in a drop-down list.
Local data (in path) Indicates the local data requirement of the full path.
Blocks with optimized access have higher local data require
ments because the information for the symbolic addressing
is stored with them.
Please note that any existing local data can only be displayed
or updated after compiling a block.
Local data (for blocks) Show the local data requirements of the block.
Blocks with optimized access have higher local data require
ments because the information for the symbolic addressing
is stored with them.
Please note that any existing local data can only be displayed
or updated after compiling a block.
See also
Symbols in the call structure (Page 1820)
Introducing the consistency check in the call structure (Page 1823)
Requirement
A project has been created with blocks.
Procedure
Proceed as follows to display the call structure:
1. Select the "Program blocks" folder or one or more of the blocks it contains.
2. Select the "Call structure" command in the "Tools" menu.
Result
The call structure for the selected program is displayed.
Note
Please note that any existing local data can only be displayed or updated after compiling a
block.
See also
Setting the view options for the call structure (Page 1822)
Introduction
The following view options are available for the call structure:
Show conflicts only:
Only the blocks causing conflicts within the call structure are displayed if this check box is
activated.
The following blocks cause conflicts:
Blocks executing any calls with older or newer code time stamps.
Blocks calling a block with modified interface.
Blocks using a tag with modified address and/or data type.
Block called neither directly, nor indirectly by an OB.
Blocks calling a block which no longer exists.
Group multiple calls together:
When this viewing option is enabled, several block calls and data block accesses are
grouped together. The number of block calls is displayed in the "Call frequency" column.
The links to the various call locations are offered in a drop-down list in the "Details" column.
Requirement
A project has been created with programmed blocks.
The call structure is open.
Procedure
Proceed as follows to set the view options for the call structure:
1. Click on the arrow of the symbol ("View options") in the task bar.
The view options for the call structure opens. Check marks are set in front of the activated
view options.
2. If you want to activate or deactivate a view option, click on the respective check box and
set or remove the check mark.
Result
The view options are set and the required information is displayed in the call structure.
Consistency check
Changing the time stamp of a block during or after the program is generated can lead to time
stamp conflicts, which in turn cause inconsistencies among the blocks that are calling and
being called.
See also
Symbols in the call structure (Page 1820)
Requirement
A project has been created with programmed blocks.
The call structure is open.
Procedure
Proceed as follows to check the block consistency:
1. Click on the symbol ("Consistency check") in the task bar.
The block consistency is checked. Blocks found to be inconsistent are marked accordingly
by a symbol.
2. If a block is inconsistent, click on the arrow in front of the block title in the call structure.
The inconsistent blocks are displayed. The exact problem locations are listed as links in
the "Details" column.
3. Click on the respective link in the "Details" column to jump to the location in the block
requiring correction.
4. Check and correct the inconsistencies in the blocks.
5. Recompile the blocks by selecting the required blocks and clicking on the command
"Compile" in the shortcut menu.
6. Download the corrected blocks to the target system by clicking the command "Download
to device" in the shortcut menu.
Result
The block consistency is checked. The inconsistencies in the blocks are corrected. The
corrected blocks are loaded to the target system.
See also
Symbols in the call structure (Page 1820)
Introduction
The dependency structure shows the dependencies each block has to other blocks in the
program.
View options
The following view options are available for the dependency structure:
Show conflicts only:
When this check box is activated, only the conflicts within the dependency structure are
displayed.
Group multiple calls together:
When this check box is activated, several block calls are grouped together. The number of
block calls is shown numerically in the "Dependency structure" column. The links to the
various call locations are offered in a drop-down list in the "Details" column.
Column Content/meaning
Dependency It indicates the dependencies between each block and the
other blocks in the program.
Call type (!) Shows the type of call, for example recursive block call.
Address Shows the absolute address of the block.
Call frequency Indicates the number of multiple calls of blocks.
Details Shows the network or interface of the called block. All infor
mation are offered as a link in this column. With this link, you
can jump to the location of the block call in the program editor.
If the viewing option "Group multiple calls together" option is
enabled, the calls are grouped together and are available as
links in a drop-down list.
See also
Symbols in the dependency structure (Page 1826)
Symbol Meaning
Indicates an organization block (OB).
Symbol Meaning
Indicates that an object has know-how protection.
Requirement
A project has been created with programmed blocks.
Procedure
Proceed as follows to display the dependency structure:
1. Select the block folder or one or more of the blocks contained therein.
2. Select the "Dependency structure" command in the "Tools" menu.
Result
The dependency structure for the selected program is displayed.
See also
Setting the view options for the dependency structure (Page 1828)
Introduction
The following view options are available for the dependency structure:
Show conflicts only:
When this check box is activated, only the conflicts within the dependency structure are
displayed.
The following blocks cause conflicts:
Blocks executing any calls with older or newer code time stamps.
Blocks called by a block with modified interface.
Blocks using a tag with modified address and/or data type.
Block called neither directly, nor indirectly by an OB.
Group multiple calls together:
When this check box is activated, several block calls are grouped together. The number of
block calls is shown in the relevant column. The links to the various call locations are offered
in a drop-down list in the "Details" column.
Requirement
A project has been created with programmed blocks.
The dependency structure is open.
Procedure
Proceed as follows to set the view options for the dependency structure:
1. Click on the arrow of the symbol ("View options") in the task bar.
The view options for the dependency structure are opened. Check marks are set in front
of the activated view options.
2. If you want to activate or deactivate a view option, click on the respective check box and
set or remove the check mark.
Result
The view options are set and the required information is displayed in the dependency structure.
Consistency check
Changing the time stamp of a block during or after the program is generated can lead to time
stamp conflicts, which in turn cause inconsistencies among the blocks that are calling and
being called.
See also
Layout of the dependency structure (Page 1826)
Symbols in the dependency structure (Page 1826)
Requirement
A project has been created with programmed blocks.
The dependency structure is open.
Procedure
Proceed as follows to check the block consistency:
1. Click on the symbol ("Consistency check") in the task bar.
The block consistency is checked. Blocks found to be inconsistent are marked accordingly
by a symbol.
2. If a block is inconsistent, click on the arrow in front of the block title in the dependency
structure.
The inconsistent blocks are displayed. The exact problem locations are listed as links in
the "Details" column.
3. Check and correct the inconsistencies in the blocks.
4. Recompile the blocks by selecting the required blocks and clicking on the command
"Compile" in the shortcut menu.
5. Download the corrected blocks to the target system by clicking the command "Download
to device" in the shortcut menu.
Result
The block consistency is checked. The inconsistencies in the blocks are corrected. The
corrected blocks are loaded to the target system.
See also
Symbols in the dependency structure (Page 1826)
Introduction
The "Resources" tab indicates the hardware resources of the configured CPU for:
the used programming objects,
the assignment of the different memory areas within the CPU and
the assigned inputs and outputs of the existing input and output modules.
Note
Retentive memory data
All bit memories and data blocks specified as retentive will be integrated in the calculation of
the retentive data.
See also
Layout of the "Resources" tab (Page 1832)
Displaying resources (Page 1833)
Selecting the maximum load memory available (Page 1834)
Column Content/meaning
Objects The "Details" area provides an overview of the programming
objects available in the CPU, including their memory assign
ments.
Load memory Displays the maximum load memory resources of the CPU
as a percentage and as absolute value.
The values displayed under "Total" provide information on
the maximum memory available in the load memory.
The values displayed under "Used" provide information on
the memory actually used in the load memory.
If a value is displayed in red, the available memory capacity
has been exceeded.
Work memory Displays the maximum work memory resources of the CPU
or as a percentage and as absolute value.
code and data work memory The work memory depends on the CPU and is divided into
"Code work memory" and "Data work memory" for a CPU
from the S7-400 or S7-1500 series, for example.
The values displayed under "Total" provide information on
the maximum memory available in the work memory.
The values displayed under "Used" provide information on
the memory space actually used in the work memory.
If a value is displayed in red, the available memory capacity
has been exceeded.
Retentive memory Displays the maximum resources for retentive memory in the
CPU as a percentage and as absolute value.
The values displayed under "Total" provide information on
the maximum memory available in the retentive memory.
The values displayed under "Used" provide information on
the memory actually used in the retentive memory.
If a value is displayed in red, the available memory capacity
has been exceeded.
Column Content/meaning
I/O Displays the I/Os which are available on the CPU, including
their module-specific availability in the next columns.
The values displayed at "Configured" provide information
about the maximum number of I/O available.
The values displayed under "Used" provide information on
the actually used inputs and outputs.
DI / DQ / AI / AQ Displays the number of configured and used inputs/outputs:
DI = Digital inputs
DQ = Digital outputs
AI = Analog inputs
AQ = Analog outputs
The values displayed at "Configured" provide information
about the maximum number of I/O available.
The values displayed under "Used" provide information on
the actually used inputs and outputs.
See also
Displaying resources (Page 1833)
Selecting the maximum load memory available (Page 1834)
Introducing resources (Page 1830)
Requirement
A project with programmed blocks has been created.
Procedure
Proceed as follows to display the resources of the respective CPU memory areas:
1. Select the block folder below the relevant CPU, or one or several of the blocks contained
therein.
2. Select the "Resources" command in the "Tools" menu.
Result
The memory resources of the assigned CPU are displayed.
Requirement
A project with programmed blocks has been created.
Procedure
Proceed as follows to display the available maximum of load memory resources:
1. Select the block folder below the relevant CPU, or one or several of the blocks contained
therein.
2. Select the "Resources" command in the "Tools" menu.
3. In the dialog that is displayed, open the drop-down list in the "Total" field of the "Load
memory" column by clicking the icon.
4. Select a corresponding value for the CPU used by clicking it in the drop-down list box.
Result
The "Total" field displays the selected maximum memory resources.
Note
Display of maximum memory resources
If a value is displayed in red for the maximum memory resources, the available memory
capacity has been exceeded.
In this case, adapt the memory capacity as described above.
Introduction
The cross-reference list provides an overview of the use of operands and tags within the user
program.
Uses of cross-references
The cross-reference list offers you the following advantages:
When creating and changing a program, you retain an overview of the operands, tags and
block calls you have used.
From the cross-references, you can jump directly to the point of use of operands and tags.
During a program test or when troubleshooting, you are informed of the following:
Which operand is processed by which command in which block.
Which tag is used in which picture.
Which block is called by which other block.
Cross-reference information for subordinate and higher-level structures.
As part of the project documentation, the cross-references provide a comprehensive
overview of all operands, memory areas, blocks, tags and pictures used.
See also
Structure of the cross-reference list (Page 1835)
Displaying the cross-reference list (Page 1836)
Displaying cross-references in the Inspector window (Page 1838)
Column Content/meaning
Object Name of the object that uses the lower-level objects or that is being
used by the lower-level objects.
Number Number of uses
Point of use Each point of use, for example, network
Column Content/meaning
Property Special properties of referenced objects, for example, the tag names
in multi-instance declarations.
as Shows additional information about the object, e.g., that an instance
DB is used as template or as multiple instance.
Access Type of access, whether access to the operand is read access (R) and/
or write access (W).
Address Address of the operand
Type Information on the type and language used to create the object
Path Path of object in project tree
Depending on the installed products, additional columns or different columns are displayed for
the cross-references.
See also
General information about cross references (Page 1834)
Displaying the cross-reference list (Page 1836)
Requirements
You have created a project.
Introduction
There are several ways of displaying cross-references depending on whether you are in the
Portal view or in the Project view and which object you have selected in the project tree.
In the Portal view, you can only display cross-references for the entire CPU; in the Project
view, you can, for example, display cross-references for the following objects:
"PLC tags" folder
"PLC data types" folder
"Program blocks" folder
"Tags and connections" folder
Individual tags
Individual PLC data types
Individual blocks
Technological objects
Watch tables
Displaying cross-references
Proceed as follows to display cross-references:
1. Select the required action in the Portal view, for example "PLC programming" and the "Show
cross-references" command or select one of the objects listed above in the Project view
and select the "Cross-references" command in the "Tools" menu.
The cross-reference list is displayed.
2. Click the "Used by" button to display where the objects shown in the cross-reference list
are used.
3. Click the "Uses" button to view the users of the objects displayed in the cross-reference list.
4. You can perform the following actions using the buttons in the toolbar:
Update cross-reference list
Making settings for the cross-reference list
Collapse entries
Expand entries
5. You can sort the entries in the "Object" and "Address" columns in ascending or descending
order by clicking on the relevant column title.
6. To go to the point of use of the object, click on the displayed link.
See also
General information about cross references (Page 1834)
Structure of the cross-reference list (Page 1835)
Introduction
The Inspector window displays cross-reference information about an object you have selected
in the "Info > Cross-references" tab. This tab displays the instances where a selected object
is being used and the other objects using it.
The Inspector window also includes blocks which are only available online in the cross-
references.
You can use the "Show overlapping access..." shortcut menu command to also have
overlapping access displayed for specific objects.
Note
Displaying "Overlapping accesses"
Please note that you can only have overlapping accesses displayed online and solely for
structures such as for structured variables or structured elements in data blocks.
Structure
The Inspector window displays the cross-reference information in tabular format. Each column
contains specific and detailed information on the selected object and its application. The table
below shows the additional information listed in the "Info > Cross-reference" tab:
Column Meaning
Object Name of the object that uses the lower-level ob
jects or that is being used by the lower-level ob
jects.
Number Number of uses
Point of use Each location of use, for example, network
Property Special properties of referenced objects, for ex
ample, the tag name in multi-instance declarations
as Shows additional information about the object,
e.g., that an instance DB is used as template or as
multiple instance.
Access Access mode
Shows whether the operand is accessed by a read
(R) and/or write (W) operation.
Address Address of the operand
Monitor value This column will only be displayed when the pro
gram editor is open.
Type Information about the type and language used to
create the object
Path Path of object in project tree
Depending on the installed products, additional columns or different columns are displayed for
the cross-references.
Functions
You have the option of testing the running of your user program on the device. You can then
monitor signal states and values of tags and can assign values to tags to simulate certain
situations in the running of the program.
Requirement
There must be an executable program loaded on the device.
Test options
The following test options are available:
Testing with program status
The program status allows you to monitor the running of the program. You can display the
values of operands and the results of logic operations (RLO) allowing you to recognize and
fix logical errors in your program.
Testing in single step mode (S7-300/400 only)
You can test blocks you created in STL or SCL in the single step mode. You do this by
setting breakpoints in the program code at which program execution stops. You can then
continue to run the program one step at a time. Within a CPU, you can test either with
program status or in single step mode. You cannot, however, use both test options at the
same time within a CPU.
Testing with the watch table
With the watch table, you can monitor and modify the current values of individual tags in
the user program or on a CPU. You can assign values to individual tags for testing and run
the program in a variety of different situations. You can also assign fixed values to the I/O
outputs of a CPU in STOP mode, for example to check the wiring.
Testing with the force table
With the force table, you can monitor and force the current values of individual tags in the
user program or on a CPU. When you force, you overwrite individual tags with specified
values. This allows you to test your user program and run through various situations.
When forcing, make sure that you keep to the necessary safety measures for forcing
(Page 1899)!
See also
Introduction to testing with program status (Page 1840)
Introduction to testing with the watch table (Page 1854)
Introduction for testing with the force table (Page 1881)
Note
With older CPUs from the S7-300/400 CPU family, you will need to change the operating
response using the hardware configuration and then download the hardware configuration to
the device. You have the option to set the "Process operation" or "Test operation" operating
response.
Note
To avoid a possible STOP in the CPU , ensure that no programmed loops are displayed in the
active monitoring window during "Testing with program status". Alternatively you can also
increase the maximum permissible cycle time of the CPU.
Warning
Testing with program status
A test with the "Program status" function can cause serious damage to property or injury to
persons if there are functional disturbances or program errors.
Make sure that no dangerous situations can arise before you conduct a test with the "Program
status" function.
Function
You can define the call environment for blocks and for breakpoints. With this, you specify the
conditions for recording the program status of a block or for stopping program execution at a
breakpoint.
Specification of the call environment for blocks
You can alternatively activate one of the following options to specify the call environment:
No condition defined
If no other option was selected this option is the default.
Instance data block
The program status of a function block will then only be recorded when you call the function
block with the selected instance data block.
Call path
The program status of a block will then only be recorded when you call the block with a
specific block or from a specific path.
Manually adapted call path
You can enter the desired call environment manually in this field. The "Transfer to "Adjusted
manually"" button is used to transfer the content selected under "Call environment", which
you can edit further if required.
The program status of a block will then only be recorded when you call the block with a
specific block or from a specific path.
Specification of the call environment for breakpoints
You can also specify a separate condition for each breakpoint.
If you do not specify the call environment, the program status of a block call is selected at
random and recorded within the call structure and program execution is always interrupted at
the relevant breakpoint. You should therefore always specify the call environment if you want
to display the program status for a specific call.
See also
Setting the call environment of the block (Page 1842)
Requirement
The block is open.
Result
The selected call environment is displayed in the "Testing" task card within the "Call
environment" pane. The program status is now carried out in accordance with the set call
environment.
Result
The selected call environment is displayed in the "Testing" task card within the "Call
environment" pane. The program status is now carried out in accordance with the set call
environment.
See also
Basics of the call environment (Page 1841)
Introduction to testing with program status (Page 1840)
Note
Note the following:
The resources for testing with program status are limited. If there are not enough resources
for the current test, earlier tests will be terminated.
It is possible that another user can carry out a loading process on the selected CPU through
joint parallel working on a CPU. It is therefore possible in the following cases that you can
either not start the test with program status or that a running test is terminated:
Through the loading process the block for which you want to start or already have carried
out the test with program status is loaded.
You use an instance data block as the call environment for the test with program status
and the block changes structurally through the loading process, e.g. by renumbering.
You use a call path as the test condition for the test with program status and a block
within the call path changes through the loading process.
If a running test is terminated, a corresponding message is displayed in the Inspector
window.
Requirement
Code block: The code of the offline block is identical with the code of the online block. In
this case the "Code" time stamps of the blocks are identical.
Data block: The structure of the offline block is identical with the structure of the online
block. In this case the "Interface" time stamps of the blocks are identical.
Result
If you enable the display of the program status, an online connection is established and the
program status is displayed. When you turn off the display of the program status, you can
terminate the online connection at the same time.
The call path of the block is shown under the block interface. If necessary, you can change
the call environment in the "Call environment" section at the right-hand edge at "Test" and
"Options". In the case of CPUs of the S7-1200/1500 series the "Call hierarchy" is displayed
additionally on the right-hand edge. You can open the calling block by clicking the link.
Procedure
To edit blocks while the test with program status is still running, follow these steps:
1. Edit the block as necessary.
The test with program status is interrupted and the block is switched offline assuming it
exists offline.
2. If the block does not exist offline, load it to the project from the device.
3. Compile the block.
See also: Auto-Hotspot
4. Download the block to the device.
See also: Auto-Hotspot
Result
The block now contains your modifications both online and offline. The online connection is re-
established and testing with program status continues.
Procedure
To modify tags during testing with the program status, proceed as follows:
1. Right-click on the tag you want to modify.
2. Select one of the following commands in the shortcut menu:
"Modify > Modify to 1"
"Modify > Modify to 0"
"Modify > Modify operand"
3. If you select "Modify operand", the "Modify operand" dialog opens. Enter the value you
require in the "Modify value" box and confirm with "OK".
Introduction
The display formats for tags are generally displayed in "integer" form. In the program status,
you have the option of switching the current display format by means of the shortcut menu.
The possible display formats for a tag are offered in a list. This is useful, for example, when
you need a hexadecimal display in order to search for a hexadecimal error code.
Procedure
To switch the display format, follow these steps:
1. Open the desired block in the programming editor.
2. Switch on the program status by clicking "Monitoring on/off" in the toolbar.
If you have not already established an online connection, the "Go online" dialog opens. In
this dialog, you can establish an online connection.
3. Select the tags for which you want to start the program status.
4. Select "Modify > Monitor selection" in the shortcut menu to start monitoring this tag.
5. Select the desired tag at the corresponding block output and then select the desired display
format in the shortcut menu, for example, "Modify > Display format > Hexadecimal".
Result
The display format for the selected tag is shown in hexadecimal form.
Note
Switching the display format in the program status
Please note that it is not possible to switch the display format for unconnected outputs, as no
monitoring value is output in this case.
Representation Status
Green solid Satisfied
Blue dashed Not satisfied
Gray solid Unknown or not executed
Black Not interconnected
Parameter in a frame with a saturation of 100 % Value is current
Parameter in a frame with a saturation of 50 % Value originates from an earlier cycle. The point in
the program was not executed in the current cycle.
Representation Status
Green solid Satisfied
Blue dashed Not satisfied
Gray solid Unknown or not executed
Black Not interconnected
Parameter in a frame with a saturation of 100 % Value is current
Parameter in a frame with a saturation of 50 % Value originates from an earlier cycle. The point in
the program was not executed in the current cycle.
The values of the operands are displayed above the relevant operand name in a gray box.
Note
Program status display for outputs which are not interconnected
Please note that a monitor value cannot be displayed for outputs which are not interconnected.
The tables to be displayed in the program status always contain the following information:
RLO
The "RLO" column shows the result of logic operation for each line of program. You can
recognize the value of the RLO based on the background color of the table cell. Here, green
means an RLO of 1 and lilac an RLO of 0.
Value
The current value of the operand is shown in the "Value" column.
Extra
The "Extra" column shows additional information depending on the particular operation, for
example, relevant status bits for mathematical instructions, time or count values for timers
and counters or memory addresses for indirect addressing.
The following figure shows an example of the program status display of a CPU S7-300 under
STL:
The following figure shows an example of the program status display for SCL:
In the first column, you can see the name of the tag for which the current value is being
displayed. If the line includes the "IF", "WHILE" or "REPEAT" instruction, the result of the
instruction is displayed in the line as "True" or "False". If the line contains more than one tag,
the value of the first tag is displayed. In both cases, all tags of these lines are displayed with
their values in a separate list as soon as you select a line. If you place the cursor in a tag in
the program code, this is shown in bold face in the list. You can also display the other tags of
a line explicitly by clicking the arrow right located in front of lines containing more than one tag.
If the code of the line is not executed, the tag name is displayed in the values table in gray
text.
The current values of the tags are displayed in the last column. If no values can be displayed
for a tag, the line has a yellow background and three question marks are shown. In this case,
select the "Create extended status information" check box in the properties of the block and
download the block to the device again. All values are then displayed.
The following figures show examples of the display for the program status in the sequence
view:
Step 2 contains a supervision error. The transition for switching to step 3 is fulfilled.
Step 2 contains an interlock error. The transition for switching to step 3 is fulfilled.
The figure below shows an example of the display for the program status in the single step
view of a S7-300:
The step does not contain an interlock error. The subsequent transition is not satisfied.
Overview
The following functions are available in the watch table:
Monitoring tags
This allows the current values of the individual tags of a user program or a CPU to be
displayed on the programming device or PC.
Monitoring tags
You can use this function to assign fixed values to the individual tags of a user program or
CPU. Modifying is also possible with Test with program status .
"Enable peripheral outputs" and "Modify now"
These two functions enable you to assign fixed values to individual peripheral outputs of a
CPU in the STOP mode. You can also use them to check your wiring.
Possible applications
The advantage of the watch table is that a variety of test environments can be stored. This
enables you to reproduce tests during commissioning or for service and maintenance
purposes.
See also
Creating and editing watch tables (Page 1858)
Layout of the watch table (Page 1855)
Basic mode and expanded mode in the watch table (Page 1856)
Icons in the watch table (Page 1857)
Introduction
A watch table contains the tags you defined for the entire CPU. A "Watch and force tables"
folder is automatically generated for each CPU created in the project. You create a new watch
table in this folder by selecting the "Add new Watch table" command.
See also
Icons in the watch table (Page 1857)
Difference between basic mode and expanded mode in the watch table
Depending on the mode specified, the watch table displays different columns and column
headings that can be used to perform different actions.
You will find a detailed list of the columns in Layout of the watch table (Page 1855).
Notice
Danger of a time-out while monitoring peripheral inputs and controlling peripheral outputs
Note that the monitoring of peripheral inputs and the controlling of peripheral outputs in the
watch table can result in a time-out.
The CPU assumes the "STOP" mode.
See also
Setting the monitoring and modify mode (Page 1869)
Icon Meaning
Identifies a table inside the project tree as a watch table.
Modifies the addresses of all selected tags immediately and once. This
command is executed once and as quickly as possible without reference
to a defined trigger point in the user program.
Modifies the addresses of all selected tags with reference to a defined trig
ger point in the user program.
Disables the command output disable of the peripheral outputs. You can
then modify the peripheral outputs when the CPU is in STOP mode.
Displays all columns of expanded mode. If you click this icon again, the
columns of expanded mode will be hidden.
Displays all modify columns. If you click this icon again, the modify columns
will be hidden.
Starts monitoring of the visible tags in the active watch table. The default
setting for the monitoring mode in basic mode is "permanent". In expanded
mode, you can set defined trigger points for the monitoring of tags.
Starts monitoring of the visible tags in the active watch table. This command
is executed immediately and the tags are monitored once.
Displays the check box for the selection of tags to be modified.
Indicates that the value of the selected tag has been modified to "1".
Indicates that the value of the selected tag has been modified to "0".
Indicates that the substitute value is being used. Substitute values are val
ues that are output to the process in case of signal output module faults or
are used instead of a process value in the user program in case of signal
input module faults. The substitute values can be assigned by the user (e.g.,
retain old value).
Indicates that the address is blocked because it is already being modified.
Icon Meaning
Indicates that an associated I/O address is being fully or partly forced.
Indicates that the address is selected but at the moment e.g. has not yet
been modified.
See also
Layout of the watch table (Page 1855)
Introduction
The watch table allows you to monitor and modify tags in the user program. Once you have
created a watch table, you can save it, duplicate it, and print it and use it again and again to
monitor and modify tags.
Requirement
A project is open.
Procedure
To create a watch table, follow these steps:
1. Click "Project view" in the status bar.
The project view is displayed.
2. In the project tree, double-click the CPU for which you want to create a watch table.
3. Double-click the "Watch and force tables" folder and then the "Add new watch table"
command.
A new watch table is added.
4. In the "Name" column or in the "Address" column, enter the name or the absolute address
for the tags that you want to monitor or modify.
5. You can select a display format from the drop-down list in the "Display format" column if
you want to change this default setting.
6. Now decide whether you want to monitor or modify the entered tags and, if applicable, enter
the desired values for modifying.
Requirement
A watch table has been created.
Procedure
To open a watch table, follow these steps:
1. Open the "Watch and force tables" folder below the desired CPU.
2. Double-click on the required watch table in the folder.
Result
The selected watch table opens.
Requirement
A watch table has been created.
Procedure
To copy a watch table, follow these steps:
1. Right-click the watch table that you want to copy.
2. In the context menu, select "Copy".
3. In the project tree, open the folder structure for the CPU in which you want to paste the
copied watch table.
4. Right-click on the "Watch and force tables" folder.
5. In the context menu, select "Paste".
6. Alternatively, you can select the entire contents of the watch table and Drag & Drop it onto
another watch table.
Result
A copy of the selected watch table is placed in the "Watch and force tables" folder of the
relevant CPU.
Prerequisite
A watch table has been created.
Procedure
To save a watch table, follow these steps:
1. In the project tree select the watch table you want to save.
2. If you wish to change the preset name of the table, select the "Rename" command in the
context menu and enter a new name for the table.
3. In the "Project" menu, select "Save". Note that this save operation will save the entire project.
Result
The contents of the watch table and the project are saved.
Note
You can reuse saved watch tables to monitor and modify tags when retesting your program.
Recommended procedure
Select the tags whose values you want to monitor or modify, and enter them in the watch
table.
When entering tags into the watch table, please note that these tags must be previously
defined in the PLC tag table.
When entering tags, work from the outside to the inside. This means that you start by
entering the tags for the inputs in the watch table. Then, you enter the tags that are affected
by the inputs or that affect the outputs. Finally, you enter the tags for the outputs.
Select the display format you require from the drop-down list in the "Display format" column,
if you do not want to use the default setting.
Now decide whether you want to monitor or modify the entered tags. Enter the desired
values for modifying as well as a comment in the corresponding columns of the watch table.
Syntax check
When you enter the tags in the watch table, the syntax of each cell is checked when you exit
the cell. Incorrect entries are marked in red.
Note
When you place the mouse pointer in a cell marked in red, brief information is displayed with
additional notes on the error.
See also
Permitted operands for the watch table (Page 1861)
Permissible modify values for the watch table (Page 1862)
Note
Please observe the following notes to work with the watch table.
You cannot enter "DB0..." because it is used by the system!
Peripheral outputs can be modified but not monitored.
Peripheral inputs can be monitored but not modified.
Notice
Danger of a time-out while monitoring peripheral inputs and controlling peripheral outputs
Note that the monitoring of peripheral inputs and the controlling of peripheral outputs in the
watch table can result in a time-out.
The CPU assumes the "STOP" mode.
See also
Basic information on entering tags in the watch table (Page 1860)
Overview of the valid data types (Page 1908)
Counter
Note
Modifying a counter influences only the value, not the status. Counter C1 can be changed
to the value "0", but the result of the logic operation for A C1 is not changed.
Example
The following table shows the 32-bit data types permitted for all CPU families in the watch
table and their possible display formats:
For the S7-1200 CPU family, all 32-bit data types are permitted (see table above), as well as
the 64-bit data type LREAL with the following possible display formats:
For the S7-1500 CPU family, in addition to 32-bit data types, the 64-bit data types listed in the
table are also permitted with the following possible display formats:
For more information, refer to the description of the valid data types (Page 1908).
Note
Rounding of floating-point numbers
In the watch table, floating-point numbers are stored as binary numbers in IEEE format.
Because not every floating point number (real, longreal) that can be displayed on the user
interface can be mapped to the IEEE format, there is a possibility that floating-point numbers
will be rounded. If a rounded floating-point number in the watch table is copied and, in turn,
inserted in another input field, the rounding may cause a slight difference.
Note
Only symbolic addressing is possible
In the watch table, LongDataTypes such as LWORD or LREAL can only be addressed
symbolically.
Procedure
To select the display format of the tags, follow these steps:
1. Enter the desired address in the watch table.
2. Click the desired cell in the "Display format" column, and open the drop-down list.
The permissible display formats are shown in the drop-down list.
3. Select the desired display format from the drop-down list.
Note
If the selected display format cannot be applied, then the last selected display format will
be displayed automatically.
See also
Overview of the valid data types (Page 1908)
3. Enter the required comment in the comment line. The entered comment is shown in green.
4. To show all comments you entered, double-click "Project texts" in the project tree under
"Languages & Resources".
5. If you are working in multi-lingual projects and want your comment to be translated into
other languages, you can set the project languages required in addition to the editing
language in the project tree under "Languages & Resources > Project languages".
Introduction
The watch table allows you to monitor the tags of the configured input and output modules in
the CPU, depending on the monitoring and modify mode (Page 1869) selected. To monitor
tags, an online connection to the CPU must exist.
Notice
Danger of a time-out while monitoring peripheral inputs
Note that the monitoring of peripheral inputs can result in a time-out.
The CPU assumes the "STOP" mode.
Introduction
By selecting the monitoring and modify mode, you specify the trigger point and the duration of
the tag monitoring in the watch table and the force table.
3URFHVVLPDJHLQSXW
7ULJJHUSRLQW$WVWDUWRIVFDQF\FOH
2%
7ULJJHUSRLQW$WWUDQVLWLRQIURP
581WR6723
7ULJJHUSRLQW$WHQGRIVFDQF\FOH
3URFHVVLPDJHRXWSXW
Monitoring tags
When tags are being modified, the following applies to the trigger points:
If you have specified the modify mode as "once only", you will receive an alarm if the
selected tags cannot be modified.
In "permanent" modify mode, you do not receive an alarm.
Introduction
The "Monitor all" command allows you to start monitoring the visible tags in the active watch
table. The default setting for the monitoring mode in basic mode of the watch table is
"permanent". In expanded mode, you can specify defined trigger points for the monitoring of
tags. In this case, the tags are monitored with reference to the specified trigger points.
Notice
Danger of a time-out while monitoring peripheral inputs
Note that the monitoring of peripheral inputs can result in a time-out.
The CPU assumes the "STOP" mode.
Requirements
A watch table has been created.
An online connection to the CPU exists.
Procedure
To execute the "Monitor all" command, follow these steps:
1. Enter the tags to be monitored and the corresponding addresses in the watch table.
2. Switch to expanded mode by clicking
the icon "Show/hide advanced setting columns" in the toolbar.
3. If you want to change the default monitoring mode for a tag, click the appropriate cell in the
"Monitor with trigger" column and select the desired monitoring mode from the drop-down
list.
4. Click the "Monitor all" icon in the toolbar.
Result
The tags of the active watch table are monitored using the monitoring mode selected.
See also
Icons in the watch table (Page 1857)
Entering tags in the watch table (Page 1860)
Basic mode and expanded mode in the watch table (Page 1856)
Introduction
The "Monitor now" command starts the monitoring of tags immediately without reference to
defined trigger points. The tag values are read out once only and displayed in the watch table.
Notice
Danger of a time-out while monitoring peripheral inputs
Note that the monitoring of peripheral inputs can result in a time-out.
The CPU assumes the "STOP" mode.
Requirements
A watch table has been created.
An online connection to the CPU exists.
Procedure
To execute the "Monitor now" command, follow these steps:
1. Enter the tags to be monitored and the corresponding addresses in the watch table.
2. Click the "Monitor now" icon in the toolbar.
Result
The tags of the active watch table are monitored immediately and once only.
See also
Icons in the watch table (Page 1857)
Entering tags in the watch table (Page 1860)
Basic mode and expanded mode in the watch table (Page 1856)
Introduction
The watch table allows you to modify the tags of the configured input and output modules in
the CPU, depending on the monitoring and modify mode (Page 1869) selected.
Danger
Danger when modifying:
Serious personal injury and material damage can result from changes in the tags or addresses
during plant operation in the event of malfunctions or program errors!
Make sure that dangerous conditions cannot occur before you execute the "Modify" function.
Notice
Danger of a time-out while controlling peripheral outputs
Note that the controlling of peripheral outputs in the watch table can result in a time-out.
The CPU assumes the "STOP" mode.
Notice
Danger due to modifying an identical operand in parallel with different modify values in more
than one watch table
When working with more than one watch table, avoid modifying identical operands
permanently multiple times with different modify values.
If an identical operand is modified permanently with different modify values at the same time
in different watch tables, all watch tables will display the last modified value, because the modify
value assigned last will be used in this case.
Introduction
You can assign one-time values to tags independent of the monitoring and modify mode and
modify them. The modify command is executed as fast as possible, similar to a "Trigger now"
command, without reference to a defined position in the user program.
Danger
Danger when modifying:
Serious personal injury and material damage can result from changes in the tags or addresses
during plant operation in the event of malfunctions or program errors!
Make sure that dangerous conditions cannot occur before you execute the "Modify" function.
Notice
Danger of a time-out while controlling peripheral outputs
Note that the controlling of peripheral outputs in the watch table can result in a time-out.
The CPU assumes the "STOP" mode.
Requirements
A watch table has been created.
An online connection to the CPU exists.
Procedure
To modify tags to "0", follow these steps:
1. Enter the desired address in the watch table.
2. Select the "Online > Modify > Modify to 0" command in order to modify the selected address
with the specified value.
Result
The selected address is modified to "0".
Note
When modifying, note the following:
Modifying can not be undone!
Introduction
You can assign one-time values to tags independent of the monitoring and modify mode and
modify them. The modify command is executed as fast as possible, similar to a "Trigger now"
command, without reference to a defined position in the user program.
Danger
Danger when modifying:
Serious personal injury and material damage can result from changes in the tags or addresses
during plant operation in the event of malfunctions or program errors!
Make sure that dangerous conditions cannot occur before you execute the "Modify" function.
Notice
Danger of a time-out while controlling peripheral outputs
Note that the controlling of peripheral outputs in the watch table can result in a time-out.
The CPU assumes the "STOP" mode.
Requirements
A watch table has been created.
An online connection to the CPU exists.
Procedure
To modify tags to "1", follow these steps:
1. Enter the desired address in the watch table.
2. Select the "Online > Modify > Modify to 1" command in order to modify the selected address
with the specified value.
Result
The selected address is modified to "1".
Note
When modifying, note the following:
Modifying can not be undone!
Introduction
You can assign one-time values to tags independent of the monitoring and modify mode and
modify them immediately. The modify command is executed as fast as possible, similar to a
"Trigger now" command, without reference to a defined position in the user program.
Danger
Danger when modifying:
Serious personal injury and material damage can result from changes in the tags or addresses
during plant operation in the event of malfunctions or program errors!
Make sure that dangerous conditions cannot occur before you execute the "Modify" function.
Notice
Danger of a time-out while controlling peripheral outputs
Note that the controlling of peripheral outputs in the watch table can result in a time-out.
The CPU assumes the "STOP" mode.
Requirements
A watch table has been created.
An online connection to the CPU exists.
Procedure
To modify tags immediately, follow these steps:
1. Enter the desired addresses and modify values in the watch table.
2. Select the addresses to be modified by selecting the check boxes for modifying in the
column after the "Modify value".
A yellow triangle appears behind the selected check box, indicating that the address is now
selected for modifying but has not yet been modified.
3. Select the "Online > Modify > Modify once and now" command in order to immediately
modify the selected address once only with the specified value.
Result
The selected addresses are modified immediately and once only.
Note
When modifying, note the following:
Modifying can not be undone!
Introduction
You can assign values to addresses dependent on the defined monitoring and modify mode
and modify them. The modify command is executed as specified in the monitoring and modify
mode, with reference to the defined trigger position in the user program.
Danger
Danger when modifying:
Serious personal injury and material damage can result from changes in the tags or addresses
during plant operation in the event of malfunctions or program errors!
Make sure that dangerous conditions cannot occur before you execute the "Modify" function.
Notice
Danger of a time-out while controlling peripheral outputs
Note that the controlling of peripheral outputs in the watch table can result in a time-out.
The CPU assumes the "STOP" mode.
Requirements
A watch table has been created.
An online connection to the CPU exists.
The watch table has to be in expanded mode.
Procedure
To modify tags "with trigger", follow these steps:
1. Enter the desired addresses and modify values in the watch table.
2. Select the addresses to be modified by selecting the check boxes for modifying in the
column after the "Modify value".
A yellow triangle appears behind the selected check box, indicating that the address is now
selected for modifying but has not yet been modified.
3. Switch to expanded mode using the icon "Show/hide advanced settings columns" in the
toolbar or the "Online > Expanded mode" command.
The "Monitor with trigger" and "Modify with trigger" columns are displayed.
4. In the "Modify with trigger" column, select the desired modify mode from the drop-down list
box. The following options are available:
Permanent
Permanently, at start of scan cycle
Once only, at start of scan cycle
Permanently, at end of scan cycle
Once only, at end of scan cycle
Permanently, at transition to STOP
Once only, at transition to STOP
5. Start modifying using the "Online > Modify > Modify with trigger" command.
6. Confirm the prompt with "Yes" if you want to start modifying with trigger.
Result
The selected tags are modified using the selected monitoring and modify mode. The yellow
triangle is no longer displayed.
Note
When modifying, note the following:
Modifying can not be undone!
Introduction
The "Enable peripheral outputs" function deactivates the command output disable of the
peripheral outputs. You can then modify the peripheral outputs when the CPU is in STOP
mode. This function is available in the watch table in "Expanded mode" only.
Danger
Danger when enabling the peripheral outputs:
Attention, the enabling of the peripheral outputs can cause serious personal injury and material
damage!
Make certain that dangerous conditions cannot occur before you execute the "Enable
peripheral outputs" function.
Prerequisites
A watch table has been created.
An online connection to the CPU exists.
The CPU is in STOP mode before you can enable the peripheral outputs.
The watch table has to be in expanded mode.
The option Force (Page 1898) of tags must not be enabled.
Note
"Enable peripheral outputs" function
This function is possible only in STOP mode. The function is exited by an operating state
change of the CPU and by the termination of the online connection.
While the function is enabled, forcing is not possible.
Procedure
To enable the peripheral outputs in STOP mode, follow these steps:
1. Enter the desired addresses and modify values in the watch table.
2. Select the addresses to be modified by selecting the check boxes for modifying in the
column after the "Modify value".
A yellow triangle appears behind the selected check box, indicating that the address is now
selected for modifying but has not yet been modified.
3. Switch to expanded mode using the icon "Show/hide advanced settings columns" in the
toolbar or the "Online > Expanded mode" command.
The "Monitor with trigger" and "Modify with trigger" columns are displayed.
4. Change the relevant CPU to STOP using the operator panel.
5. Right-click to open the shortcut menu and select "Enable peripheral outputs".
6. Confirm the prompt with "Yes" if you want to unlock the command output disable for the
peripheral outputs.
7. Modify the peripheral outputs using the "Online > Modify > Modify now" command.
Result
The peripheral outputs are modified with the selected modify values. The yellow triangle is no
longer displayed.
Overview
You can use the force table to assign permanent values to individual tags
of the user program. This action is referred to as "forcing".
The following functions are available in the force table:
Monitoring tags
This allows the current values of the individual tags of a user program or a CPU to be
displayed on the programming device or PC. Tags can be monitored with or without a trigger
condition.
Forcing tags
This function lets you assign a fixed value to individual I/O tags of the user program.
Example
Independent of the CPU used, only I/O can be forced, such as: "Tag_1":P or "QW0:P" or
"IW0:P". Note that "Tag_1":P must not be the symbolic name of a bit memory.
Possible applications
One advantage of the force table is that you can simulate different test environments and
overwrite tags in the CPU with a permanent value. This enables you to intervene in the ongoing
process for regulating purposes.
See also
Layout of the force table (Page 1883)
Basic mode and expanded mode in the force table (Page 1884)
Icons in the force table (Page 1885)
Open and edit force table (Page 1886)
Danger
Prevent personal injury and material damage!
Note that an incorrect action when executing the "Force" function can:
Harm persons or pose a health hazard.
Cause damage to machinery or the entire plant.
Caution
Prevent personal injury and material damage!
Before you start the "Force" function, you should ensure that no one else is currently
executing this function on the same CPU.
Forcing can only be stopped by clicking the "Stop forcing" icon or using the "Online > Force
> Stop forcing" command. Closing the active force table does not stop the forcing!
Forcing can not be undone!
Review the differences between " modifying tags" (Page 1873) and "forcing tags"
(Page 1898).
If a CPU does not support the "Force" function, the relevant icons cannot be selected.
If the function "Enable peripheral outputs" is active on your CPU, then forcing is not possible
on this CPU. If desired, deactivate this function in the watch table.
Introduction
In the force table, enter the CPU-wide tags that you have defined and selected and which are
to be forced in the allocated CPU. Only peripheral inputs and peripheral outputs can be forced.
For each CPU created in the project, a force table will automatically be created in the "Watch
and force tables" folder. Only one force table can be allocated to a CPU. This force table
displays all the addresses forced in the allocated CPU.
See also
Icons in the force table (Page 1885)
Basic mode and expanded mode in the force table (Page 1884)
Difference between basic mode and expanded mode in the force table
In expanded mode the "Monitor with trigger" column is also displayed in the force table.
You will find a detailed list of the columns under Layout of the force table (Page 1883).
Icon Meaning
Identifies a table inside the project tree as a force table.
Identification column
Displays all columns of expanded mode. If you click this icon again, the col
umns of the expanded mode will be hidden.
Updates all operands and values currently being forced on the CPU in the
open force table.
Starts forcing for all addresses of the selected tags. If forcing is already run
ning, the previous action is replaced without interruption.
Stops forcing of addresses in the force table.
Starts monitoring of the visible tags in the force table. The default setting for
monitoring in basic mode is "permanent". In expanded mode an additional
column is shown and you can set certain trigger points for monitoring tags.
Starts monitoring of the visible tags in the force table. This command is exe
cuted immediately and the tags are monitored once.
Displays the check box for the selection of tags to be forced.
Indicates that the address is selected but has not been forced yet.
Icon Meaning
Indicates that the selected tag was monitored for the value "1".
Indicates that the selected tag was monitored for the value "0".
Indicates that a substitute value is being used. Substitute values are values
that are output to the process in case of signal output module faults or are
used instead of a process value in the user program in case of signal input
module faults. The substitute values can be assigned by the user (e.g., retain
old value).
See also
Layout of the force table (Page 1883)
Introduction
You cannot create a new force table; one force table already exists for each CPU. It is
permanently allocated to this CPU and cannot be copied or duplicated.
Requirements
A project with an allocated CPU has to be open.
Requirements
A project with an allocated CPU must be created.
Procedure
Proceed as follows to open a force table:
1. Open the "Watch and force tables" folder below the desired CPU.
2. Double-click the "Force table" in this folder.
Result
The selected force table opens.
Requirements
A project with an allocated CPU has been created.
Procedure
Proceed as follows to save a force table:
1. Enter the desired changes in the force table.
2. Select the "Save" command in the "Project" menu or click the "Save project" icon in the
toolbar. Note that this save operation will save the entire project.
Result
The contents of the force table and the associated project are saved.
Note
You cannot rename a force table.
Recommended procedure
Select the tags whose values you want to monitor or force, and enter them in the force table.
When entering tags in the force table, please note that these tags must be previously defined
in the PLC tag table.
Now you have to decide whether you want to monitor or force the entered tags. Enter the
required force value and a comment in the appropriate columns of the force table.
Note that only peripheral inputs and peripheral outputs can be forced and review the Safety
precautions when forcing tags (Page 1899).
Syntax check
When you enter tags in the force table, the syntax of each cell will be checked when you exit
the cell. Incorrect entries are marked in red.
Note
When you place the mouse pointer in a cell marked in red, brief information is displayed with
additional notes on the error.
The following table shows the operands that are permitted for monitoring in the force table:
Note
You cannot enter "DB0..." because it is used by the system!
Example
The following table shows the 32-bit data types permitted for all CPU families in the force table
and their possible display formats:
For the S7-1200 CPU family, all 32-bit data types are permitted (see table above), as well as
the 64-bit data type LREAL with the following possible display formats:
For the S7-1500 CPU family, in addition to 32-bit data types, the 64-bit data types listed in the
table are also permitted with the following possible display formats:
For more information, refer to the description of the valid data types (Page 1908).
Note
Rounding of floating-point numbers
In the force table, floating-point numbers are stored as binary numbers in IEEE format.
Because not every floating point number (real, longreal) that can be displayed on the user
interface can be mapped to the IEEE format, there is a possibility that floating-point numbers
will be rounded. If a rounded floating-point number in the force table is copied and, in turn,
inserted in another input field, the rounding may cause a slight difference.
Note
Only symbolic addressing is possible
In the force table, LongDataTypes such as LWORD or LREAL can only be addressed
symbolically.
Procedure
To select the display format of the tags, follow these steps:
1. Enter the desired address in the force table.
2. Click the desired cell in the "Display format" column, and open the drop-down list.
The permitted display formats are shown in the drop-down list.
3. Select the desired display format from the drop-down list.
Note
If the selected display format cannot be applied, then the last selected display format will
be displayed automatically.
3. Enter the required comment in the comment line. The entered comment is shown in green.
4. To show all comments you entered, double-click "Project texts" in the project tree under
"Languages & Resources".
5. If you are working in multi-lingual projects and want your comment to be translated into
other languages, you can set the project languages required in addition to the editing
language in the project tree under "Languages & Resources > Project languages".
Introduction
Use the force table to monitor the tags of the configured input and output modules in the CPU,
dependent on the monitoring mode (Page 1895) you have selected. An online connection to
the CPU must exist to monitor tags.
Monitor now
This command starts the monitoring of the visible tags in the active force table immediately
and once only.
Introduction
By selecting the monitoring mode, you specify the trigger point and the duration of tag
monitoring in the force table.
3URFHVVLPDJHLQSXW
7ULJJHUSRLQW$WVWDUWRIVFDQF\FOH
2%
7ULJJHUSRLQW$WWUDQVLWLRQIURP
581WR6723
7ULJJHUSRLQW$WHQGRIVFDQF\FOH
3URFHVVLPDJHRXWSXW
Introduction
Use the "Monitor all" command to start monitoring the visible tags in the active force table. In
basic mode of the force table, the default setting for the monitoring mode is "permanent". In
expanded mode, you can specify defined trigger points for the monitoring of tags. In this case,
the tags are monitored with reference to the specified trigger points.
Requirements
An online connection to the CPU exists.
Procedure
To execute the "Monitor all" command, follow these steps:
1. Enter the tags to be monitored and the corresponding addresses in the force table.
2. Switch to expanded mode by clicking
the icon "Show/hide advanced setting columns" in the toolbar.
3. If you want to change the default monitoring mode for a tag, click the appropriate cell in the
"Monitor with trigger" column and select the desired monitoring mode from the drop-down
list.
4. Click the "Monitor all" icon in the toolbar.
Result
The tags of the active force table will be monitored using the set monitoring mode.
Introduction
The "Monitor now" command starts the monitoring of tags immediately without reference to
defined trigger points. The tag values are read out only once and displayed in the force table.
Requirements
An online connection to the CPU exists.
Procedure
To execute the "Monitor now" command, follow these steps:
1. Enter the tags to be monitored and the corresponding addresses in the force table.
2. Click the "Monitor now" icon in the toolbar.
Result
The tags of the active force table are monitored immediately and once only.
Introduction
You can use the force table to assign permanent values to individual tags of the user program.
This action is referred to as forcing. Only peripheral inputs and peripheral outputs can be forced.
To use the forcing function, you must have an online connection to the CPU and the utilized
CPU must support this functionality.
If you open a force table in the "Watch and force tables" folder below a CPU on which a force
job is already running, you will first be prompted to update the display of the forced operand.
Forcing or stopping forcing in the open force table is only possible following this command.
Possible applications
By permanently assigning defined values to tags, you can specify defined default settings for
your user program and, thus, test the programmed functions. Forcing is possible in basic mode
and in expanded mode (Page 1884).
Danger
Prevent personal injury and material damage!
Remember that an incorrect action when executing the "Force" function can:
Harm persons or pose a health hazard.
Cause damage to machinery or the entire plant.
Force all
This command starts the forcing of enabled addresses in the active force table or replaces
an existing force job without interruption.
Stop forcing
This command stops the forcing of all addresses in the active force table.
Danger
Prevent personal injury and material damage!
Note that an incorrect action when executing the "Force" function can:
Harm persons or pose a health hazard.
Cause damage to machinery or the entire plant.
Caution
Prevent personal injury and material damage!
Before you start the "Force" function, you should ensure that no one else is currently
executing this function on the same CPU.
Forcing can only be stopped by clicking the "Stop forcing" icon or using the "Online > Force
> Stop forcing" command. Closing the active force table does not stop the forcing!
Forcing can not be undone!
Review the differences between " modifying tags" (Page 1873) and "forcing tags"
(Page 1898).
If a CPU does not support the "Force" function, the relevant icons cannot be selected.
If the function "Enable peripheral outputs" is active on your CPU, then forcing is not possible
on this CPU. If desired, deactivate this function in the watch table.
Introduction
If a force job is already running on a CPU, after opening the force table, you first need to make
sure that the operands and values currently being forced on the CPU are displayed in the force
table.
The command "Online" > "Force" > "Update forced operands" updates all operands and values
currently being forced on the CPU in the open force table.
"Force" or "Stop forcing" in the open force table is only possible following this command.
Danger
Prevent personal injury and material damage!
Remember that an incorrect action when executing the "Force" function can:
Harm persons or pose a health hazard.
Cause damage to machinery or the entire plant.
Requirement
An online connection to the CPU is possible.
A force job is currently running on the CPU being used.
Procedure
To update the forced operands and values, follow these steps:
1. Open a force table.
2. Establish an online connection to the CPU.
3. Confirm the "Update forced operands" dialog that follows with "Yes".
Result
All forced operands in the open force table are updated with the relevant values. A red "F" is
displayed in the first column indicating which operands are being forced.
This enables the "Force all" and "Stop forcing" buttons and you can select these functions.
Note
When forcing, note the following:
Forcing cannot be undone!
Terminating the online connection does not stop the forcing function!
To stop forcing, the forced address must be visible in the active force table.
Introduction
You can use the force function to assign permanent values to individual tags of a user program.
Danger
Prevent personal injury and material damage!
Note that an incorrect action when executing the "Force" function can:
Pose a risk to the life or health of persons.
Cause damage to machinery or the entire plant.
Requirements
An online connection to the CPU exists.
The utilized CPU supports the force function.
The "Enable peripheral outputs" function is not enabled on the CPU on which the tags are
to be forced. If desired, deactivate this function in the watch table.
Procedure
To force tags to "0", follow these steps:
1. Open the force table.
2. Enter the desired address in the force table.
3. Select the "Online > Force> Force to 0" command in order to force the selected address
with the specified value.
4. Confirm the next dialog with "Yes".
Result
The selected address is forced to "0". The yellow triangle is no longer displayed. A red "F" is
displayed in the first column, for example, indicating that the tag is being forced.
Stop forcing
To stop forcing, follow these steps:
1. Open the force table.
2. Select the "Online > Force > Stop forcing" command.
3. Confirm the next dialog with "Yes".
Result
Forcing of the selected values is stopped. The red "F" in the first column is no longer displayed.
The yellow triangle reappears behind the check box again to indicate that the address is
selected for forcing but is not being forced at the moment.
Note
When forcing, note the following:
Forcing cannot be undone!
Terminating the online connection does not stop the forcing!
To stop forcing, the forced address must be visible in the active force table.
Introduction
You can use the force function to assign permanent values to individual tags of a user program.
Danger
Prevent personal injury and material damage!
Note that an incorrect action when executing the "Force" function can:
Endanger the life or health of personnel
Cause damage to machinery or the entire plant.
Requirements
An online connection to the CPU exists.
The utilized CPU supports the force function.
The "Enable peripheral outputs" function is not enabled on the CPU on which the tags are
to be forced. If desired, deactivate this function in the watch table.
Procedure
To force tags to "1", follow these steps:
1. Open the force table.
2. Enter the desired address in the force table.
3. Select the "Online > Force> Force to 1" command in order to force the selected address
with the specified value.
4. Confirm the next dialog with "Yes".
Result
The selected address is forced to "1". The yellow triangle is no longer displayed. A red "F" is
displayed in the first column, for example, indicating that the tag is being forced.
Stop forcing
To stop forcing, follow these steps:
1. Open the force table.
2. Select the "Online > Force > Stop forcing" command.
3. Confirm the next dialog with "Yes".
Result
Forcing of the selected values is stopped. The red "F" in the first column is no longer displayed.
The yellow triangle reappears behind the check box again to indicate that the address is
selected for forcing but is not being forced at the moment.
Note
When forcing, note the following:
Forcing cannot be undone!
Terminating the online connection does not stop the forcing!
To stop forcing, the forced address must be visible in the active force table.
Introduction
You can use the force function to assign permanent values to individual tags of a user program.
If forcing is already active, this forcing operation is replaced without interruption by the "Online
> Force > Force all" command. Any forced addresses that are not selected will no longer be
forced.
Danger
Prevent personal injury and material damage!
Note that an incorrect action when executing the "Force" function can:
Pose a risk to the life or health of persons.
Cause damage to machinery or the entire plant.
Requirements
An online connection to the CPU exists.
The utilized CPU supports the force function.
The "Enable peripheral outputs" function is not enabled on the CPU on which the tags are
to be forced. If desired, deactivate this function in the watch table.
Procedure
To force tags with the "Online > Force > Force all" command, follow these steps:
1. Open the force table.
2. Enter the desired addresses and force values in the force table.
3. Select the addresses to be forced by selecting the check boxes for forcing in the column
after the "Force value".
A yellow triangle appears behind the selected check box, indicating that the address is
selected for forcing but is not being forced at the moment.
4. Select the "Online > Force> Force all" command in order to force the selected addresses
with the specified values.
5. Confirm the next dialog with "Yes".
Result
The selected addresses are forced to the specified values. The yellow triangle is no longer
displayed. A red "F" is displayed in the first column, for example, indicating that the tag is being
forced.
Stop forcing
To stop forcing, follow these steps:
1. Open the force table.
2. Select the "Online > Force > Stop forcing" command.
3. Confirm the next dialog with "Yes".
Result
Forcing of the selected addresses is stopped. The red "F" in the first column is no longer
displayed. The yellow triangle reappears behind the check box again to indicate that the
address is selected for forcing but is not being forced at the moment.
Note
When forcing, note the following:
Forcing cannot be undone!
Terminating the online connection does not stop the forcing!
To stop forcing, the forced address must be visible in the active force table.
Introduction
Note the following before you stop forcing tags:
Stopping forcing cannot be undone!
Terminating the online connection does not stop the forcing!
To stop forcing, the forced address must be visible in the active force table.
Danger
Prevent personal injury and material damage!
Note that an incorrect action when stopping the "Force" function can:
Pose a risk to the life or health of persons.
Cause damage to machinery or the entire plant.
Requirements
Tags are forced in a force table.
An online connection to the CPU exists.
Procedure
Proceed as follows to stop forcing all tags :
1. Open the force table.
2. Select the "Online > Force > Stop forcing" command in order to stop forcing the displayed
addresses.
3. Confirm the "Stop forcing" dialog with "Yes".
Result
The forcing of all tags is stopped. The red "F" in the first column is no longer displayed. The
yellow triangle reappears behind the check box again to indicate that the address is flagged
for forcing but is not being forced at the moment.
Introduction
Note the following before you stop forcing tags:
Stopping forcing cannot be undone!
Terminating the online connection does not stop the forcing!
To stop forcing, the forced address must be visible in the active force table.
Danger
Prevent personal injury and material damage!
Note that an incorrect action when stopping the "Force" function can:
Pose a risk to the life or health of persons.
Cause damage to machinery or the entire plant.
Requirements
Tags are forced in a force table.
An online connection to the CPU exists.
Procedure
Proceed as follows to stop forcing individual tags :
1. Open the force table.
2. Deactivate the check boxes for the addresses that are no longer to be forced.
3. Reselect the "Online > Force" command.
Result
Forcing of the disabled addresses will be stopped. The red "F" in the first column is no longer
displayed. The yellow triangle reappears behind the check box again to indicate that the
address is flagged for forcing but is not being forced at the moment.
Note
Depending on the CPU version, the actually valid data types can deviate slightly from the table.
Description
An operand of data type BOOL represents a bit value and contains one of the following values:
TRUE
FALSE
Note
Applies to CPUs of the S7-1500 series
For a block with the block property "Optimized block access", the bit has a length of 1 byte.
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
BYTE (byte)
Description
An operand of data type BYTE is a bit string of 8 bits.
The following table shows the properties of data type BYTE:
Note
The BYTE data type cannot be compared for more than or less than. It can only be supplied
with the same decimal data that can be processed by the SINT and USINT data types.
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
WORD
Description
An operand of data type WORD is a bit string of 16 bits.
The following table shows the properties of data type WORD:
Note
The WORD data type cannot be compared for more than or less than. It can only be supplied
with the same decimal data that can be processed by the INT and UINT data types.
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
DWORD
Description
An operand of data type DWORD is a bit string of 32 bits.
The following table shows the properties of data type DWORD:
Note
The DWORD data type cannot be compared for more than or less than. It can only be supplied
with the same decimal data that can be processed by the DINT and UDINT data types.
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
LWORD
Description
An operand of data type LWORD is a bit string of 64 bits.
Note
The LWORD data type cannot be compared for more than or less than. It can only be supplied
with the same decimal data that can be processed by the LINT and ULINT data types.
See also
Overview of the valid data types (Page 1908)
Implicit conversion (Page 1961)
Explicit conversion (Page 2010)
Overview of data type conversion (Page 1959)
Data type conversion for S7-1200: (Page 2091)
11.5.3 Integers
Description
An operand of data type SINT (Short INT) has a length of 8 bits and consists of two
components: a sign and a numerical value in the two's complement. The signal states of bits
0 to 6 represent the number value. The signal state of bit 7 represents the sign. The sign may
assume "0" for the positive, or "1" for the negative signal state.
An operand of data type SINT occupies one BYTE in the memory.
The following table shows the properties of data type SINT:
Example
The following figure shows the integer +44 as a binary number:
%LW
6LJQ
'HFLPDOYDOXHV
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
An operand of data type USINT (Unsigned Short INT) has a length of 8 bits and contains
unsigned numerical values:
An operand of data type USINT occupies one BYTE in the memory.
The following table shows the properties of data type USINT:
Example
The following figure shows the integer 78 as a binary number:
%LW
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
An operand of data type INT has a length of 16 bits and consists of two components: a sign
and a numerical value in the two's complement. The signal states of bits 0 to 14 represent the
number value. The signal state of bit 15 represents the sign. The sign may assume "0" for the
positive, or "1" for the negative signal state.
An operand of data type INT occupies two BYTE in the memory.
Example
The following figure shows the integer +3785 as a binary number:
%LW
6LJQ
'HFLPDOYDOXHV
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
An operand of data type UINT (Unsigned INT) has a length of 16 bits and contains unsigned
numerical values.
An operand of data type UINT occupies two BYTE in the memory.
The following table shows the properties of data type UINT:
Example
The following figure shows the integer 65295 as a binary number:
%LW
'HFLPDOYDOXHV
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
An operand of data type DINT (Double INT) has a length of 32 bits and consists of two
components: a sign and a numerical value in the two's complement. The signal states of bits
0 to 30 represent the number value. The signal state of bit 31 represents the sign. The sign
may assume "0" for the positive, or "1" for the negative signal state.
An operand of data type DINT occupies four BYTE in the memory.
The following table shows the properties of data type DINT:
Example
The following figure shows the integer +125790 as a binary number:
%LW
6LJQ
'HFLPDOYDOXHV
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
An operand of data type UDINT (Unsigned Double INT) has a length of 32 bits and contains
unsigned numerical values.
An operand of data type UDINT occupies four BYTE in the memory.
The following table shows the properties of data type UDINT:
Example
The following figure shows the integer 4042322160 as a binary number:
%LW
'HFLPDOYDOXHV
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
An operand of data type LINT (Long INT) has a length of 64 bits and consists of two
components: a sign and a numerical value in the two's complement. The signal states of bits
0 to 62 represent the number value. The signal state of bit 63 represents the sign. The sign
may assume "0" for the positive, or "1" for the negative signal state.
An operand of data type LINT occupies eight BYTE in the memory.
The following table shows the properties of data type LINT:
Example
The following figure shows the integer +154325790816159 as a binary number:
%LW
%LW
6LJQ
'HFLPDOYDOXHV
See also
Overview of the valid data types (Page 1908)
Overview of data type conversion (Page 1959)
Implicit conversion (Page 1961)
Explicit conversion (Page 2010)
Data type conversion for S7-1200: (Page 2091)
Description
An operand of data type ULINT (Unsigned Long INT) has a length of 64 bits and contains
unsigned numerical values.
An operand of data type ULINT occupies eight BYTE in the memory.
Example
The following figure shows the integer 154325790816159 as a binary number:
%LW
%LW
'H]LPDOZHUWH
See also
Overview of the valid data types (Page 1908)
Overview of data type conversion (Page 1959)
Implicit conversion (Page 1961)
Explicit conversion (Page 2010)
Data type conversion for S7-1200: (Page 2091)
11.5.4.1 REAL
Description
Operands of the data type REAL have a length of 32 bits and are used to represent floating-
point numbers. An operand of the REAL data type consists of the following three components:
Sign: The sign is determined by the signal state of bit 31. The bit 31 assume the value "0"
(positive) or "1" (negative).
8-bit exponents to basis 2: The exponent is increased by a constant (base, +127), so that
it has a value range of 0 to 255.
23-bit mantissa: Only the fraction part of the mantissa is shown. The integer part of the
mantissa is always 1 with normalized floating-point numbers and is not stored.
The REAL data type is processed with a precision of 6 digits.
The following figure shows the structure of the REAL data type:
%LW
6 H P
Note
With floating-point numbers, only the precision defined by the IEEE754 standard is stored.
Additionally specified decimals are rounded off according to IEEE754.
The number of decimal places may decrease for frequently nested arithmetic calculations.
If more decimal places are specified than can be stored by the data type, the number is rounded
to the value corresponding to the precision allowed by this value range.
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Calculating with floating-point numbers (REAL and LREAL) in SCL (Page 290)
11.5.4.2 LREAL
Description
Operands of the data type LREAL have a length of 64 bits and are used to represent floating-
point numbers. An operand of the LREAL data type consists of the following three components:
Sign: The sign is determined by the signal state of bit 63. The bit 63 assumes the value "0"
(positive) or "1" (negative).
11-bit exponents to base 2: The exponent is increased by a constant (base, +1023), so that
it has a value range of 0 to 2047.
52-bit mantissa: Only the fraction part of the mantissa is shown. The integer part of the
mantissa is always 1 with normalized floating-point numbers and is not stored.
The LREAL data type is processed with a precision of 15 digits.
The following figure shows the structure of the LREAL data type:
%LW
9 H P
Note
With floating-point numbers, only the precision defined by the IEEE754 standard is stored.
Additionally specified decimals are rounded off according to IEEE754.
The number of decimal places may decrease for frequently nested arithmetic calculations.
If more decimal places are specified than can be stored by the data type, the number is rounded
to the corresponding value of the precision allowed by this value range .
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Calculating with floating-point numbers (REAL and LREAL) in SCL (Page 290)
Description
We distinguish between four number ranges for data types REAL and LREAL:
normalized numbers stored with full accuracy
denormalized numbers not stored with full accuracy
Infinite numbers: +Inf/-Inf (infinity)
Invalid numbers: NaN (Not a Number)
Note
Floating-point numbers are stored as specified by the IEEE754 standard. Results of conversion
or arithmetic functions with a denormalized, infinite or NaN (Not a Number) floating point
depend on the CPU.
If you are not working with normalized floating-point numbers in mathematical functions, the
result will show significant differences depending on the series of the CPU which you are using.
A CPU cannot calculate with denormalized floating-point numbers, with the exception of older
CPU versions of the S7-300 and S7-400 series. The bit pattern of a denormalized number is
interpreted as a zero. If the result of calculation falls into this range, it is continued with zero;
the status bits OV and OS are set (number range undershoot).
Even though the values of invalid floating-point numbers can only be displayed with limited
accuracy for mathematical functions, numbers with an exponent of -39 (e.g. 2.4408e-039) can
be monitored in the TIA Portal and therefore do not necessarily represent a faulty result. This
means that floating-point values may be located outside the range of valid numerical values.
Note
The following applies to CPUs of the series S7-1200 V1, V2 and V3:
The comparison operation "Equal" uses the bit pattern of the invalid floating-point number. If
two "NaN numbers" with the same bit pattern are compared, the output of the "Equal"
comparison operation returns the result TRUE.
Note
The following applies to CPUs of the S7-1200 V4 and S7-1500 series:
If two invalid numbers (NaN) are compared with each other, the result is always FALSE,
regardless of the bit pattern of the invalid number or the relation (>, >, ...).
Note
Comparison of denormalized floating-point numbers
For the comparison operation "Equal" with two denormalized floating-point numbers, the output
for CPUs of the S7-300/400 series is set to the signal state "0" and for CPUs of the
S7-1200/1500 series to the signal state "1".
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Calculating with floating-point numbers (REAL and LREAL) in SCL (Page 290)
11.5.5 Timers
Format
Data type S5TIME stores the duration in BCD format. The duration is the product from a time
in the range 0 to 999 and a time basis. The time basis indicates the interval at which a timer
decrements the time value by one unit until it reaches "0". The resolution of the times can be
controlled via the time basis.
The following table shows the range of values for data type S5TIME:
The following table shows the time base coding for S5TIME:
Always observe range limits and the resolution of time values when using data type S5TIME
with timers. The table below specifies the range associated with each resolution:
Resolution Range
0.01 s 10 ms to 9 s 990 ms
0.1 s 100 ms to 1 min 39 s 900 ms
1s 1 s to 16 min 39 s
10 s 10 s to 2 h 46 min 30 s
Example
The following figure shows the content of the time operand for a time value of 127 and a time
base of 1 s:
%LW
[ [
7LPHEDVLV 7LPHYDOXHLQ%&'IRUPDW
VHFRQG WR
,UUHOHYDQW7KHVHELWDUHGLVUHJDUGHGZKHQWKHWLPHULVVWDUWHG
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
The contents of an operand of the data type TIME is interpreted as milliseconds. The
representation contains information for days (d), hours (h), minutes (m), seconds (s) and
milliseconds (ms).
The following table shows the properties of data type TIME:
It is not necessary to specify all time units. T#5h10s is a valid entry, for example. If only one
unit is specified, the absolute value of days, hours, and minutes must not exceed the high or
low limits. When more than one time unit is specified, the value must not exceed 24 days, 23
hours, 59 minutes, 59 seconds or 999 milliseconds.
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
The contents of an operand of data type LTIME is interpreted as nanoseconds. The
representation contains information for days (d), hours (h), minutes (m), seconds (s) and
milliseconds (ms), microseconds (us) and nanoseconds (ns).
The following table shows the properties of data type LTIME:
It is not necessary to specify all time units. LT#5h10s is therefore a valid entry, for example. If
only one unit is specified, the absolute value of days, hours, and minutes must not exceed the
high or low limits. When more than one time unit is specified, the value must not exceed 106751
days, 23 hours, 59 minutes, 59 seconds, 999 milliseconds, 999 microseconds or 999
nanoseconds.
See also
Overview of the valid data types (Page 1908)
Overview of data type conversion (Page 1959)
Implicit conversion (Page 1961)
Explicit conversion (Page 2010)
Data type conversion for S7-1200: (Page 2091)
11.5.6.1 DATE
Format
The DATE data type saves the date as an unsigned integer. The representation contains the
year, the month, and the day.
The contents of an operand of DATE data type correspond in hexadecimal format to the
number of days since 01-01-1990 (16#0000).
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Format
Data type TOD (TIME_OF_DAY) occupies a double word and stores the number of
milliseconds since the beginning of the day (0:00 h) as unsigned integer.
The following table shows the properties of data type TOD:
You always need to specify the hours, minutes and seconds. The specification of milliseconds
is optional.
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Format
Data type LTOD (LTIME_OF_DAY) occupies two double words and stores the number of
nanoseconds since the beginning of the day (0:00 h) as unsigned integer.
You always need to specify the hours, minutes and seconds. The specification of nanoseconds
is optional.
See also
Overview of the valid data types (Page 1908)
Overview of data type conversion (Page 1959)
Implicit conversion (Page 1961)
Explicit conversion (Page 2010)
Data type conversion for S7-1200: (Page 2091)
Format
The DT (DATE_AND_TIME) data type saves the information on date and time of day in BCD
format.
The following table shows the properties of data type DT:
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Format
Data type LDT (DATE_AND_LTIME) stores the date and time-of-day information in
nanoseconds since 01/01/1970 0:0.
See also
Overview of the valid data types (Page 1908)
Overview of data type conversion (Page 1959)
Implicit conversion (Page 1961)
Explicit conversion (Page 2010)
Data type conversion for S7-1200: (Page 2091)
11.5.6.6 DTL
Description
An operand of data type DTL has a length of 12 bytes and stores date and time information in
a predefined structure.
The following table shows the properties of data type DTL:
The structure of data type DTL consists of several components each of which can contain a
different data type and range of values. The data type of a specified value must match the data
type of the corresponding components.
The following table shows the structure components of data type DTL and their properties:
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
Description
An operand of data type CHAR has a length of 8 bits and occupies one BYTE in the memory.
The CHAR data type stores a single character in ASCII format. You can find information on
the encoding of special characters under "See also > STRING".
The following table shows the value range of the CHAR data type:
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
STRING (Page 1937)
Description
An operand of data type WCHAR (Wide Characters) has a length of 16 bits and occupies two
BYTE in the memory.
The WCHAR data type saves a single character of an expanded character set which is stored
in Unicode format. However, only a subset of the entire Unicode range is covered. When a
control character is entered, it is represented with a dollar sign.
The following table shows the value range of the WCHAR data type:
See also
Overview of the valid data types (Page 1908)
11.5.7.3 STRING
Description
An operand of the STRING data type saves several characters in a character string that can
consist of up to 254 characters. In a character string, all characters of the ASCII code are
permitted. The characters are specified in single quotation marks.
The following table shows the properties of a STRING tag:
A character string can also contain special characters. The escape character $ is used to
identify control characters, dollar signs and single quotation marks.
The table below shows examples for the notation of special characters:
The maximum length of the character string can be specified during the declaration of an
operand using square brackets after the keyword STRING (for example, STRING[4]). If the
specification of the maximum length is omitted, the standard length of 254 characters is set
for the respective operand.
If the actual length of a specified character string is shorter than the declared maximum length,
the characters are written to the character string left-justified and the remaining character
spaces remain undefined. Only occupied character spaces are considered in the value
processing.
Note
For S7-300/400 CPUs, please note: If a temporary tag of the STRING data type was defined,
you must describe the BYTE "Max. length of string" with the defined length before you use the
tags in the user program.
Example
The example below shows the byte sequence if the STRING[4] data type is specified with
output value 'AB':
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
11.5.7.4 WSTRING
Description
An operand of data type WSTRING (Wide String) stores several Unicode characters of data
type WCHAR in one character string. If you do not specify a length, the character string has
a preset length of 254 characters. In a character string, all characters of the Unicode format
are permitted. This means you can also use Chinese characters in a character string.
When declaring an operand of data type WSTRING you can define its length using square
brackets (for example WSTRING[10]). If you do not specify a length, the length of the
WSTRING is set to 254 characters by default. You can declare a length of up to 16382
characters (WSTRING[16382]).
Note
Use in the watch table
If you wish to monitor or control a tag with data type WSTRING in the watch table, it cannot
contain more than 254 characters.
The specification of the characters occurs in single quotes and always with the qualifier
WSTRING#.
The table below shows the properties of a WSTRING tag:
A character string can also contain special characters. The escape character $ is used to
identify control characters, dollar signs and single quotation marks.
The table below shows examples for the notation of special characters:
The maximum length of the character string can be specified during the declaration of an
operand using square brackets after the keyword WSTRING (for example, WSTRING[4]). If
the specification of the maximum length is omitted, the standard length of 254 characters is
set for the respective operand.
If the actual length of a specified character string is shorter than the declared maximum length,
the characters are written to the character string left-justified and the remaining character
spaces remain undefined. Only occupied character spaces are considered in the value
processing.
Note
Conversion of WSTRING tags
Implicit conversion of the WSTRING data type is not possible. Explicit conversion from the
WSTRING data type to STRING is generally possible. However, normally only the conversion
of characters in the code range from 0 - 127 will work in all Windows code pages. For all
characters outside this range, the code page character and the Unicode character must be in
exactly the same position for the conversion to work without errors.
Example
The example below shows the byte sequence if the WSTRING[4] data type is specified with
output value 'AB':
See also
Overview of the valid data types (Page 1908)
11.5.8 Array
Description
The Array data type represents a data structure that consists of a fixed number of components
of the same data type. All data types except Array are permitted.
A tag with the Array data type always starts at a WORD limit.
The array components are addressed by means of an index. In the array declaration, the index
limits are defined in square brackets after the keyword Array. The low limit must be smaller
than or equal to the high limit. An array may contain up to six dimensions, the limits of which
can be specified separated by a comma.
The following table shows the property of the Array data type:
Example
The following example shows how operands of data type Array can be declared:
See also
Overview of the valid data types (Page 1908)
Description
The Array data type represents a data structure that consists of a fixed number of components
of the same data type. All data types except Array are permitted.
The array components are addressed by means of an index. In the array declaration, the index
limits are defined in square brackets after the keyword Array. The low limit must be smaller
than or equal to the high limit. An array may contain up to six dimensions, the limits of which
can be specified separated by a comma.
Note
Depending on the CPU, the storage capacity of a data block is limited and the number of
components of the Array is therefore also limited. However, you may initialize the addressing
of the array components at any position within index limits.
The following table shows the property of the Array data type:
Note
The length of the array depends on whether the block was created with the "Standard" or "with
optimized access" block property.
Note
Applies to CPUs of the S7-1500 series
For a block with the block property "Optimized block access", a bit requires 1 byte of memory.
This is also true when you use an ARRAY of <data type>. An ARRAY [0..1] of BOOL, for
example, thus requires 2 bytes in an optimized block.
Example
The following example shows how operands of data type Array can be declared:
Due to various technical/internal constraints, the actual usable memory area may be
approximately 70 - 100 bytes less. The memory area may be further restricted due to a default
setting, for example, by the "Load without reinitialization" block property.
See also
Overview of the valid data types (Page 1908)
Declaration
The following table shows the declaration of a one-dimensional Array tag:
The following figure shows the structure of the declared array tag:
2SB7HPS>@
2SB7HPS $55$<>@ 2SB7HPS>@
,17(*(5 2SB7HPS>@
Declaration
The following table shows the declaration of a two-dimensional Array tag:
The following figure shows the structure of the declared array tag:
,QWHJHU
,QWHJHU
,QWHJHU
2SHUDWLQJB7HPS $55$<>@
,17(*(5 ,QWHJHU
,QWHJHU
,QWHJHU
The index of the first array component is in this case [1,1,1,1,1,1] and the index of the last
component is [3,2,3,4,3,4]. Intermediate values are accessed by entering the corresponding
value for each dimension.
11.5.9 Structures
11.5.9.1 STRUCT
Description
Data type STRUCT represents a data structure that consists of a fixed number of components
of various data types. Components of STRUCT or ARRAY data type can also be nested in a
structure. The nesting depth is hereby limited to eight levels. Structures can be used to group
data according to the process control system and to transfer parameters as one data unit.
You can create up to 65534 structures for a CPU of the S7-1200 or S7-1500 series. Each of
these structures can include up to 252 components. In addition, you can create up to 65534
function blocks, 65535 functions and 65535 organization blocks with up to 252 components
each.
A component of the ARRAY data type always starts at a WORD limit.
The following table shows the properties of data type STRUCT:
Example
The following figure shows an example of the structure of a STRUCT variable:
6758&7
,17 ,QWHJHU
%<7( %\WH
&KDUDFWHU
&+$5
5($/ )ORDWLQJSRLQW
%22/ QXPEHU
%RROHDQYDOXH
See also
Overview of the valid data types (Page 1908)
11.5.10 Pointer
11.5.10.1 POINTER
Description
A parameter of the type POINTER is a pointer that can point to a specific tag. It occupies 6
bytes (48 bits) in memory and may contain the following tag information:
DB number, or 0 if the data is not stored in a DB
Memory area in the CPU
Tag address
The following figure shows the structure of parameter type POINTER:
3RLQWHUIRUPDW
%LW %LW
%\WH '%QXPEHURU %\WH
%\WH E E E E E E E E E E E E E [ [ [ %\WH
E %\WHDGGUHVVRIWKHWDJ [ %LWDGGUHVVRI
WKHWDJ
Types of pointer
Depending on the information, you can use parameter type POINTER to declare the following
four types of pointer:
Area-internal pointer:
An area-internal pointer contains information on the address of a tag.
Cross-area pointer:
A cross-area pointer contains information on the memory area and the address of a tag.
DB pointer:
You can use a DB pointer to point to a data block tag. A DB pointer also contains a data
block number in addition to the memory area and the address of a tag.
Zero pointer:
Use the zero pointer to indicate a missing value. A missing value may indicate that no value
exists, or that the value is not yet known. A zero value represents the absence of a value,
but is also a value.
The following table shows the formats for the declaration of various pointer types:
You can enter a parameter of the type POINTER without prefix (P#). The entry is then
automatically converted to the POINTER format.
Note
If you use the prefix P#, you can only point to memory areas with "standard" access mode.
Memory areas
The following table shows the hexadecimal codes of the memory areas for parameter type
POINTER:
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
11.5.10.2 ANY
Description
An ANY type parameter points to the start of a data area and specifies its length. An ANY
pointer occupies 10 bytes of memory and may contain the following information:
Data type:
Data type of the elements of the data area
Repetition factor:
Number of elements of the data area
DB number:
Data block that contains the declaration of data area elements.
Memory area:
Memory area of the CPU that stores the data area elements.
Start address of the data in the format "byte.bit":
Data area start identified by the ANY pointer.
Zero pointer:
Use the zero pointer to indicate a missing value. A missing value may indicate that no value
exists, or that the value is not yet known. A zero value represents the absence of a value,
but is also a value.
In the programming languages SCL and STL, memory of any kind can be transferred upon a
block call if an ANY pointer has been programmed at a block parameter.
The ANY pointer cannot, however, store any information on the structure of the memory. For
example, the ANY pointer does not save the information that it points to a tag of the PLC data
type. The ANY pointer sees this as an ARRAY of BYTE.
Parameters of the ANY data type can be passed to system function blocks (SFBs) or system
functions (SFCs).
Note
Memory area
For an S7-1500 CPU, the ANY pointer can also only point to memory areas with "Standard"
access mode.
%LW %LW
%\WH %\WH
KIRU6 'DWDW\SH
%\WH %\WH
5HSHWLWLRQIDFWRU
%\WH '%QXPEHURU %\WH
%\WH E E E E E E E E E E E E E [ [ [ %\WH
E %\WHDGGUHVVRIWKHWDJ [ %LWDGGUHVVRI
WKHWDJ
An ANY pointer cannot identify structures. It can only be assigned to local tags.
The following table shows the formats for the declaration of an ANY pointer:
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
11.5.10.3 VARIANT
Description
A parameter of the VARIANT type is a pointer that can point to tags of different data types
other than an instance. The VARIANT pointer can be an object of an elementary data type,
such as INT or REAL. It can also be a STRING, DTL, ARRAY of STRUCT, UDT, or ARRAY
of UDT. The VARIANT pointer can recognize structures and point to individual structure
components. An operand of data type VARIANT occupies no space in the instance data block
or work memory. However, it will occupy memory space on the CPU.
A tag of the VARIANT type is not an object but rather a reference to another object. Individual
elements of the VARIANT type can only be declared on formal parameters within the block
interface of a function in the VAR_IN, VAR_IN_OUT and VAR_TEMP sections. For this reason,
it cannot be declared in a data block or in the static section of the block interface of a function
block, for example, because its size is unknown. The size of the referenced objects can change.
You can use VARIANT to generate generic function blocks or functions. When a block is called,
you can connect the parameters of the block to tags of any data type. When a block is called,
the type information of the tag is transferred in addition to a pointer to the tag. The code of the
block can then be executed according to its type in line with the tag transferred during runtime.
If, for example, a block parameter of a function has the VARIANT data type, then a tag of the
integer data type can be transferred at one point in the program, and a tag of the PLC data
type can be transferred at another point in the program. With the help of the VARIANT
instructions, the function is then in a position to react to the situation without errors.
Note
You can only point to a complete data block if it was originally derived from a user-defined data
type (UDT).
Note
If you use the prefix P#, you can only point to memory areas with "standard" access mode.
Example
The following example shows how VARIANT works using the "MOVE: Move value" instruction
of STL:
STL Explanation
CALL MOVE // The "Move value" instruction is called.
VARIANT // Data type of the instruction
IN := "Data_TIA_Portal".StructVariable.FirstCompo- // The contents of the "FirstComponent" operand
nent are moved from the "Data_TIA_Portal" DB.
OUT := "MotorDB".StructResult.TagResult // And transferred to the "TagResult" operand from
the "MotorDB" DB.
See also
Overview of the valid data types (Page 1908)
Data type conversion for S7-1200: (Page 2091)
VARIANT instructions (Page 263)
Description
The parameter types are data types for formal parameters that are transferred to called blocks.
A parameter type can also be a PLC data type.
The following table shows the available parameter data types and their purpose: