Professional Documents
Culture Documents
Generating GSDML Files For SINAMICS Drives V2 1 en
Generating GSDML Files For SINAMICS Drives V2 1 en
Generating GSDML Files For SINAMICS Drives V2 1 en
SINAMICS
Script to generate GSDML files
Caution:
The functions and solutions described in this article are limited primarily to the
implementation of the automation task. Please also note that in case of networking
your plant area with other parts of the plant, the company network or the Internet,
appropriate protective measures within the framework of industrial security must be
adopted. For more information, see the entry ID 50203404.
http://support.automation.siemens.com/WW/view/en/50203404
Siemens AG 2014-2016 All rights reserved
Copyright
Integration in a project 2
Application 3
Contact person 4
Generating GSDML files for
SINAMICS History 5
Installation and description
Siemens AG 2014-2016 All rights reserved
Copyright
Note The application examples are non-binding and do not claim to be complete in
terms of configuration and equipment, or to take account of any other
contingencies. These application examples do not represent specific customer
solutions – but are only intended to provide support when it comes to typical
applications. You are responsible for the proper operation of the described
products. These application examples do not exempt users from their due
diligence obligation with regard to application, installation, operation and
maintenance. By using these application examples, you agree that Siemens
cannot be made liable for possible damage beyond the liability clause described.
We reserve the right to make changes to these application examples at any time
and without prior notice. If there are any differences between the suggestions
made in these application examples and other Siemens publications, such as
catalogs, the contents of the other document(s) take priority.
We do not provide a warranty for any of the information contained in this document.
We accept no liability for any damage or loss caused by the examples, information,
programs, planning data, or performance data described in this application
example, irrespective of the legal basis for claims arising from such damage or
Siemens AG 2014-2016 All rights reserved
loss, unless liability is mandatory. For example, according to the product liability
law, in cases of malfeasance, gross negligence, due to endangerment of life, body
or health, due to assumption of a guarantee for the properties of a product, due to
malicious concealment of a defect or due to violation of basic contractual
obligations. However, claims for indemnification based on breach of contract shall
be limited to liability for damages to the contract-specific, foreseeable damages,
provided there is no mandatory liability for intent, acts of gross negligence, harm to
the life, body and health of human beings. Any change to the burden of proof to
your disadvantage is not covered hereby.
Copyright
Table of contents
Warranty and liability ............................................................................................... 4
1 Motivation ....................................................................................................... 6
1.1 Boundary conditions .......................................................................... 6
1.2 Context.............................................................................................. 7
2 Integration in a project ................................................................................... 8
2.1 Inserting a script folder....................................................................... 9
2.2 Importing the script .......................................................................... 10
3 Application.................................................................................................... 12
3.1 General ........................................................................................... 12
User interface language ................................................................... 12
Log file 12
3.2 Executing the script ......................................................................... 13
Select a device ................................................................................ 14
Directory for generated GSDML files ................................................ 15
Original SINAMICS GSDML file ....................................................... 16
GSDML file name ............................................................................ 17
Free telegram configuration with BICO............................................. 18
Graphics file .................................................................................... 19
Siemens AG 2014-2016 All rights reserved
Summary ......................................................................................... 20
Script history.................................................................................... 20
3.3 Using the GSDML file in the TIA Portal ............................................ 21
3.3.1 Installation in the TIA Portal ............................................................. 22
3.3.2 Instantiating the device in the TIA Portal project ............................... 25
Updating a GSDML file .................................................................... 26
3.4 Special application cases................................................................. 27
Removing installed GSDML files from the TIA Portal ........................ 27
Working in parallel on a project ........................................................ 27
Accessing an older, backed-up project version................................. 27
Upgrading a project to a higher STARTER version ........................... 27
Copyright
1 Motivation
At the present time, SINAMICS S120, S150, G130 and G150 devices are not
integrated in Startdrive. As a consequence, drives based on these devices are
currently configured in STARTER.
TIA Portal applications, which use these SINAMICS devices, must use GSD
configurations for these devices.
Configuring in parallel in the TIA Portal and in STARTER is possible under the
following general conditions:
Telegrams are configured manually and separately in the TIA Portal and in
STARTER.
Telegram configurations are not synchronized with one another.
Changes to the configuration must be updated on both sides.
As a consequence, configuring costs increase and also the possibility of making
mistakes.
The scripts presented here generate GSDML files for specific drive configurations.
The script runs in the context of STARTER. The user installs the generated
GSDML files in the TIA Portal, and there they are directly available in the hardware
Siemens AG 2014-2016 All rights reserved
catalog.
The above-mentioned points can be significantly improved with this approach:
Telegrams are only configured in STARTER.
Configuring telegrams in the TIA Portal is synchronized with configuring
telegrams in STARTER.
Changes to the configuration only have to be updated in STARTER.
Configuring a drive must comply with the following conditions in order that the
script can create a GSDML file:
It involves a SINAMICS S120, S150, G130 or G150 device.
The device has firmware version V4.3 or higher.
Cyclic communication is configured via PROFINET; optionally on board or with
the Communication Board Extension (CBE).
Cyclic communication is realized via the logical IF1 interface.
1.2 Context
The script has been implemented and tested using STARTER V4.4 SP1 HF1 and
the TIA Portal V13 SP1 including update 6.
Both development environments can be installed on the same computer – or on
different computers. In the second case, the generated GSDML files must be
copied by the user to the computer where the TIA Portal is installed.
The script has been developed under the assumption that it can also run in higher
versions of the development environments mentioned above and will also generate
error-free GSDML files. Of course, this cannot be guaranteed. If you are already
using higher versions of these development environments, please check whether
an updated version of the script is available.
Lower versions of the development environments mentioned above have not been
tested, and the functionality is not explicitly guaranteed.
Further, without being able to absolutely guarantee the functionality, the script can
be run within the context of SIMOTION SCOUT. It is potentially possible to install
the generated GSDML files in SIMATIC STEP7 Classic as well as in the
appropriate environments provided by third-party suppliers.
Further, Microsoft Internet Explorer 8 or higher as well as Microsoft XML Core
Siemens AG 2014-2016 All rights reserved
Services V6.0 are used. As standard, both are installed with Windows 7.
The script interface was tested with Internet Explorer 11.
2 Integration in a project
Irrespective of the deployed development environment (STARTER or
SIMOTION SCOUT), the procedure for integrating the script to generate GSDML
files in a project does not change.
Only the screenshots shown here can differ in detail for the concrete constellation,
with regard to
Type of the deployed development environment
Version of the deployed development environment
Language setting of the operating system, respectively the user-interface
language set for the development environment.
The screenshots shown here were created with Windows 7 Ultimate 64 bit English
and STARTER V4.4 with an English user interface.
Siemens AG 2014-2016 All rights reserved
Copyright
In the following dialog, select the directory with the script by clicking the Browse…
button.
Now click the Open button to accept the file selection (shown in the upper text
field).
The import has now been completed. The script is contained in the script folder that
has been created and can be executed immediately.
Note The script has no reference to the context (position of the script folder); there is
always an absolute reference to a specific project. As a consequence, the script
can be saved in any script folder.
We recommend that the script is saved in the script folder at the project level.
3 Application
3.1 General
The screenshots shown here were created with Windows 7 Ultimate 64 bit English,
Internet Explorer 11, TIA Portal V13 including update 4 and STARTER V4.4 with
an English user interface.
Log file
The script documents its actions in the details display. This is done in the same
language as the above-mentioned user interface language.
The output can also be written in the details display in a log file. The log file exists
in the project directory and has *.log as file extension.
Siemens AG 2014-2016 All rights reserved
If the log file does not yet exist, it will be created implicitly by the script. An existing
log file will never be overwritten; new entries are written as new text lines at the
end of the log file.
Note Because the log file is contained in the project directory, it will also be archived
automatically.
Select a device
The subsequent dialog is displayed to select the SINAMICS devices.
In the dialog that is displayed, select the SINAMICS device for which a GSDML file
is to be generated. A separate GSDML file is generated for each selected device.
No device is selected by default. You can change the selection using the mouse or
with the Shift and Ctrl keys.
Copyright
Note If possible, terminate the script using the Cancel button rather than using the
Executing script dialog. The latter does not close the script dialog.
Note The setting made here is permanently saved in the project path (also see
Section "Script history" at the end of the chapter as well as Chapter 3.4, Section
"Removing the script history").
Copyright
Fig. 3-5: Selecting the original GSDML file (here: SINAMICS S120)
Siemens AG 2014-2016 All rights reserved
Note Depending on the specific operating environment, the open file dialog can have a
different appearance as well as various properties.
Copyright
Note You can find the original GSDML files for SINAMICS e.g. in the firmware in the
SIEMENS\SINAMICS\DATA\CFG\PNGSD.zip file.
Copy the unzipped GSDML files and the graphic file into the directory that you
have selected.
Note The setting made here is permanently saved in the project path (also see
Section "Script history" at the end of the chapter as well as Chapter 3.4, Section
"Removing the script history").
The project name and the device name, taken from the STARTER project, are
preset in the text fields Vendor and Device Family. The names are used for the
GSDML file names, as well as for the visible names in the TIA Portal hardware
catalog.
The write-protected text field Proposed GSDML File Name shows the GSDML file
name to be generated based on the entries of the other two text fields and the
actual system time.
Note The allocation of names for GSDML files is clearly defined; the range of
characters that can be used is quite restrictive.
The script automatically replaces the hyphens generally used in project and
device names by underscore characters.
The script rejects other entries with invalid characters with an appropriate note.
Note The name components (manufacturer and device name) are permanently saved
in the project path (also see Section "Script history" at the end of the chapter as
well as Chapter 3.4, Section "Removing the script history").
This is the reason that when changing project names or device names in the
STARTER project, the previous name components still remain available.
If a GSDML file was already generated for the device, then the name
NOTICE
components (manufacturer and device family) should no longer be
changed.
Otherwise, when importing the GSDML file, the device will be identified as
a new device and not as a more recent version of an existing device.
The device is skipped without generating a GSDML file by pressing the Skip
button. The script is exited if it involves a single device or the last device.
Click the Cancel button to exit the script without performing any further action.
Note If possible, terminate the script using the Cancel button rather than using the
Executing script dialog. The latter does not close the script dialog.
Copyright
Click the Yes button to generate a free telegram with isochronous capability.
Graphics file
If there is an associated graphic file for the device, then this is also copied into the
directory of the generated GSDML file.
Siemens AG 2014-2016 All rights reserved
Copyright
Summary
In the final dialog a summary is displayed.
Script history
The script saves the necessary information in an XML file in the project directory.
This involves the following:
Copyright
A GSDML file is generated for the device using the script. The GSDML file name
was derived from the project and the device names, and is:
Copyright
GSDML-V2.31-#MyProject-S120_CU320_2_PN_1-20140822-105319.xml
Start the TIA Portal and change to the project view. A generated GSDML file is
installed using the menu command Options Install general station description
file (GSD). It is irrelevant as to whether a project has already been opened.
In the Install general station description file dialog, navigate in the directory, in
which the generated GSDML file is saved. Select the checkbox in front of the file
and press the Install button.
The GSDML file is now installed. The progress is displayed in a dialog. Generally, it
takes a few seconds to install a GSDML file.
The information is transferred into the hardware catalog by pressing the Close
button.
If several versions of the GSDML file have been installed, then the required version
can be selected using the Version drop-down list.
The device installed in the TIA Portal using the GSDML file can be instantiated just
like any other device.
Contrary to a standard GSDML file of a SINAMICS S120, for this device, the slots
and their sub slots are already assigned corresponding to the telegram
configuration in the STARTER project.
When assigning to an IO system, the IO addresses are automatically preassigned.
In this case, the device must be reinstantiated with the required revision.
Copyright
Renaming a project
The project name is used as manufacturer name for the generated GSDML files,
as part of the GSDML file name. Further, the project name is entered within the
GSDML file; this is used to assign the project name within the tree-type structure of
the hardware catalog.
If the project name is changed, and if this change were to be transferred into the
names of newly generated GSDML files, then this would mean multiple entries in
the tree-type view of the TIA Portal hardware catalog.
The script uses the project ID to identify the project. This means that in spite of the
changed name, the script can uniquely identify the project.
After changing the project name, when the script is executed, users have the
option of deciding as to whether the previous project name (updated GSDML files
are recognized as updates of previous GSDML files) is used, or the new project
name (updated GSDML files are recognized as separate GSDML files, the
previous GSDML files still remain visible in parallel).
Renaming a device
For the generated GSDML files, the device name is used as a component of the
file name. Further, the device name is entered within the GSDML file; this is used
to assign the device name within the tree-type structure of the HW catalog within
Siemens AG 2014-2016 All rights reserved
(updated GSDML file is recognized as separate GSDML files, the previous GSDML
files still remain visible in parallel).
Duplicating a project #1
If the project is duplicated using the STARTER menu command Project Save
and create copy… and if the option With reorganization (slow) is deactivated, then
the script history is also duplicated. The project ID remains in the duplicated project
(there are now two projects with the same ID). This means, that in spite of the
changed name, the script can uniquely identify the project.
As a consequence, the "Rename project in STARTER" application case applies.
Duplicating a project #2
If the project is duplicated using the STARTER menu command Project Save
and create copy… and if the option With reorganization (slow) is activated, then the
script history is not transferred into the new project.
As a consequence, the "Remove the script history" application case applies.
Duplicating a device
If a device is duplicated within the project, then the duplicated device is allocated a
new name and a new ID.
As a consequence, the script does not know the duplicated device. From the
perspective of the script, a GSDML file is being generated for the first time. If the
Siemens AG 2014-2016 All rights reserved
device name is not specifically changed, then for the TIA Portal, this involves a
device description that is still unknown.
Copyright
4 Contact person
Siemens AG
Industry Sector
I DT MC PMA APC
Frauenauracher Strasse 80
D - 91056 Erlangen, Germany
E-mail: tech.team.motioncontrol@siemens.com
Siemens AG 2014-2016 All rights reserved
Copyright
5 History
Table 5-1
Version Date Change
V1.0 2014-05-26 First Edition
V2.0 2014-08-22 Support of SINAMICS S150, G130, G150
V2.1 2016-02-29 Free telegrams in isochronous mode
Siemens AG 2014-2016 All rights reserved
Copyright