Edit parameters in

several drives
Add-In V17:
Using Startdrive Openness
interface to enter parameters
for drive groups

Siemens
TIA Portal / Startdrive / TIA Portal Openness Industry
Online
https://support.industry.siemens.com/cs/ww/en/view/109777633 Support
 Legal information

Legal information
Use of application examples
Application examples illustrate the solution of automation tasks through an interaction of several
components in the form of text, graphics and/or software modules. The application examples are
a free service by Siemens AG and/or a subsidiary of Siemens AG (“Siemens”). They are non-
binding and make no claim to completeness or functionality regarding configuration and
equipment. The application examples merely offer help with typical tasks; they do not constitute
customer-specific solutions. You yourself are responsible for the proper and safe operation of the
products in accordance with applicable regulations and must also check the function of the
respective application example and customize it for your system.
Siemens grants you the non-exclusive, non-sublicensable and non-transferable right to have the
application examples used by technically trained personnel. Any change to the application
examples is your responsibility. Sharing the application examples with third parties or copying the
application examples or excerpts thereof is permitted only in combination with your own products.
The application examples are not required to undergo the customary tests and quality inspections
of a chargeable product; they may have functional and performance defects as well as errors. It is
your responsibility to use them in such a manner that any malfunctions that may occur do not
result in property damage or injury to persons.

Disclaimer of liability
Siemens shall not assume any liability, for any legal reason whatsoever, including, without
limitation, liability for the usability, availability, completeness and freedom from defects of the
application examples as well as for related information, configuration and performance data and
any damage caused thereby. This shall not apply in cases of mandatory liability, for example
under the German Product Liability Act, or in cases of intent, gross negligence, or culpable loss of
life, bodily injury or damage to health, non-compliance with a guarantee, fraudulent
non-disclosure of a defect, or culpable breach of material contractual obligations. Claims for
damages arising from a breach of material contractual obligations shall however be limited to the
 Siemens AG 2021 All rights reserved

foreseeable damage typical of the type of agreement, unless liability arises from intent or gross
negligence or is based on loss of life, bodily injury or damage to health. The foregoing provisions
do not imply any change in the burden of proof to your detriment. You shall indemnify Siemens
against existing or future claims of third parties in this connection except where Siemens is
mandatorily liable.
By using the application examples you acknowledge that Siemens cannot be held liable for any
damage beyond the liability provisions described.

Other information
Siemens reserves the right to make changes to the application examples at any time without
notice. In case of discrepancies between the suggestions in the application examples and other
Siemens publications such as catalogs, the content of the other documentation shall have
precedence.
The Siemens terms of use (https://support.industry.siemens.com) shall also apply.

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

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 2
 Table of Contents

Table of Contents
Legal information ......................................................................................................... 2
1 Overview ............................................................................................................. 5
1.1 Introduction ........................................................................................... 5
1.2 Overview of the Application Example ................................................... 6
1.3 Components used ................................................................................ 6
2 Purpose............................................................................................................... 7
2.1 Problem description.............................................................................. 7
2.2 Requirements ....................................................................................... 7
2.3 Objectives ............................................................................................. 7
3 Requirements ..................................................................................................... 8
3.1 Required practical knowledge .............................................................. 8
3.2 System requirements ........................................................................... 8
4 Parameter Lists .................................................................................................. 9
4.1 Direct Access Lists ............................................................................... 9
4.2 DFI Lists (SINAMICS G only) ............................................................. 10
 Siemens AG 2021 All rights reserved

4.3 Acyclic Lists ........................................................................................ 11

4.4 List Files ............................................................................................. 12
5 Installation ........................................................................................................ 13
5.1 Installing the Add-In............................................................................ 13
5.2 Activating the Add-In .......................................................................... 14
5.3 Launching the Add-In ......................................................................... 16
6 Structure of the Interface ................................................................................ 17
6.1 File Menu ............................................................................................ 18
6.2 Add-In Settings ................................................................................... 19
6.3 Device Area ........................................................................................ 21
6.4 Parameter List Area ........................................................................... 23
6.5 Parameter Range ............................................................................... 25
6.6 Reading Parameter Values ................................................................ 27
6.7 Writing Parameters ............................................................................. 28
6.8 Configuring the Motor & Encoder ....................................................... 29
6.9 Parameter Comparison ...................................................................... 30
6.10 Message Area .................................................................................... 31
7 Acyclic Lists ..................................................................................................... 32
7.1 Jobs .................................................................................................... 32
7.2 Creating a List of Jobs........................................................................ 33
7.3 Date Type Parameter ......................................................................... 34
7.4 Generating Blocks .............................................................................. 35

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 3
 Table of Contents

7.5 Settings............................................................................................... 37
7.6 Diagnostics ......................................................................................... 37
7.7 Error Codes ........................................................................................ 39
7.7.1 LAcycCom_ReadDriveParams – Diagnostics Messages .................. 39
7.7.2 LAcycCom_WriteDriveParams – Diagnostics Messages .................. 40
7.7.3 FB_AcycJobs – Error Codes .............................................................. 41
8 Appendix .......................................................................................................... 42
8.1 Service and support ........................................................................... 42
8.2 Industry Mall ....................................................................................... 43
8.3 Application support ............................................................................. 43
8.4 Links and literature ............................................................................. 43
8.5 Change documentation ...................................................................... 43
 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 4
 1 Overview

1 Overview
1.1 Introduction
By using the TIA Portal Openness interface, your own .NET applications can
integrate the TIA Portal in your development environment. Working from one
application, the programmer can perform TIA Portal functions, which entails
benefits such as:
 Increased efficiency, thanks to faster execution of the task
 Accuracy, thanks to the automation of consistent processes
 Short commissioning times, thanks to program-supported creation of
configurations
 Competitiveness, thanks to targeted use of resources

The following actions are possible with Openness:

 Open and close TIA Portal with or without user interface
 Open, save and close projects
 Compile hardware and software
 Export and import blocks
 Siemens AG 2021 All rights reserved

Note More information on TIA Portal Openness can be found at the following link:
https://support.industry.siemens.com/cs/search?search=openness

Using the Openness Startdrive interface, a user can access drive devices and
thereby read and write parameter values.

ATTENTION Improper use of the interfaces can result in data loss and production halt.

TIA add-ins offer a convenient way of expanding the functionality of the TIA Portal
via TIA Portal Openness. No additional external applications are required to run
TIA add-ins, because add-ins are started directly in the TIA Portal.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 5
 1 Overview

1.2 Overview of the Application Example

The aim of this Application Example is to facilitate the commissioning of similar
drives by copying an existing configuration from one drive object to other drive
objects. Parameter values can be written offline or online.

1.3 Components used

This Application Example was created using these software components:
Table 1-1: Software components
Components

TIA Portal V17

TIA Portal Openness V17
Microsoft Visual Studio 2019

Online functions were created and tested using the following hardware:
Table 1-2: Hardware components
Components
SINAMICS G120 demo kit
 Siemens AG 2021 All rights reserved

SINAMICS S120 demo kit

SINAMICS G110 demo kit
SINAMICS S210 demo kit

This Application Example consists of the following components:

Table 1-3
Components File name
TIA Portal Add-In 109777633_EditParametersInSeveralDrivesAddIn_V17.zip
Visual Studio 109777633_EditParametersInSeveralDrivesAddIn_V17_SOURCE-CODE.zip
project
Manual 109777633_EditParametersInSeveralDrivesAddIn_DOC_V17_en.pdf

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 6
 2 Purpose

2 Purpose
2.1 Problem description
In applications such as logistics systems or in the automobile industry, oftentimes
more than 100 drives are controlled by one PLC. In materials handling applications,
for instance, drive settings are often standardized for various conveyor elements. In
such cases, the configurations are the same, or they differ only with respect to
parameters that are not performance-related.
When commissioning such a system it is repeatedly the case that settings
parameters have to be adjusted in order to achieve the desired drive
characteristics. These changes then have to be carried out for a great number of
drives (10 to 50). Although these are simple changes, they take considerable time.
To support the commissioning technician, the intention is to create a tool which can
be used to automate such changes.

2.2 Requirements
The application will use the Openness interface in order to access TIA Portal. The
tool should be implemented as a TIA Portal add-in. The following functionality
should be provided to the user:
 Siemens AG 2021 All rights reserved

 Display the drives in the project

 Support for drives from the S120, S210, G120 and G110 series
 Read and write drive parameters offline and online
 Compare parameter values of multiple drives offline and online
 Support for hardware parameters (DFI: Drive Function Interface)

2.3 Objectives
By using the TIA Portal add-in EditParametersInSeveralDrives, the following
should be achieved:
 Reduce commissioning time
 Change parameters even without knowledge of TIA Portal
 Prevent errors with the help of automatic processing

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 7
 3 Requirements

3 Requirements
3.1 Required practical knowledge
To work with the tool you will need:
 Working knowledge of TIA Portal
 Working knowledge of SINAMICS drives

In order to extend or customize the tool, you will also need:

 Knowledge of Visual Studio.
 C# programming and NET Framework skills
 Knowledge of the TIA Portal Openness interface

3.2 System requirements

The following requirements must be met in order to run the tool on a computer:
 TIA Portal V17 installation
 SINAMICS Startdrive V17 installation

 Siemens AG 2021 All rights reserved

TIA Portal Openness V17 installation

 Windows user is a member of the local group Siemens TIA Openness

Note Refer to chapter 4 of the the Openness documentation (see \3\) for how to add a
user to the user group Siemens TIA Openness.

If the application will be modified or extended, you will also need:

 Microsoft Visual Studio 2019

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 8
 4 Parameter Lists

4 Parameter Lists
Parameters whose values are to be read, written, or compared are managed by the
add-in of a parameter list.
A parameter list is created within the add-in and saved as an XML file. Multiple
parameter lists for different purposes can be simultaneously handled by the add-in.
The add-in continues to support different types of parameter lists.

4.1 Direct Access Lists

Direct access lists allow direct access to parameters of a drive. This is only
possible for drives that are supported by Startdrive. Parameter values can be read
or written from the project (offline) or directly from the device (online).
It should be noted that it is not possible to access all parameters with direct access
lists. Access to drive parameters with the TIA Portal Openness interface is
controlled via a whitelist concept. Only parameters that are entered in the system
whitelists can be accessed. The whitelists are predefined and differ depending on
the actuator type and firmware version.

Note The current whitelists can be found via the following link.
support.industry.siemens.com/cs/ww/en/view/109763491
The whitelist section of this entry is only visible to Siemens internally. If
 Siemens AG 2021 All rights reserved

necessary, contact your Siemens representative to obtain whitelists.

The add-in can be used to create a direct access list with all accessible parameters
(whitelist).

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 9
 4 Parameter Lists

4.2 DFI Lists (SINAMICS G only)

With DFI lists (Drive Function Interface), motor and encoder parameters can be
read and written. Here, too, only Startdrives can be managed, and both offline and
online access is supported. The DFI parameters of a drive depend on the
underlying hardware (e.g., asynchronous motor or synchronous motor). If the motor
type is changed, the relevant parameters also change. A DFI list can usually
consist of three parameter groups:
 Required motor parameters
These are absolutely needed when writing. If one of these parameters is
missing, an error occurs.
 Optional motor parameters
These parameters are ignored when writing if not present and no error occurs.
 Required encoder parameters
These are the parameters that are required when an encoder needs to be
parameterized.

The add-in supports the creation of DFI lists and gives hints for missing
parameters.
 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 10
 4 Parameter Lists

4.3 Acyclic Lists

A separately available version of the add-in supports acyclic lists.
Acyclic lists can be used when parameters must be accessed which are not
supported by the other list types or if the drive unit is not supported by Startdrive. In
the latter case, the drive unit is available as GSD/GSDML in the TIA Portal project.
With an acyclic list, the write and read requests from a PLC can be executed by
using DPV1 services. The Add-In creates all required PLC blocks from an acyclic
list and adds them to the PLC program in the TIA Portal project.
The processing of an acyclic list is done later at PLC runtime, independent of the
use of the add-in. This means that the add-in gives no response about the success
or failure of processing an acyclic list.

Note To use acyclic lists, the drive unit must be configured in the TIA project and
networked with a SIMATIC PLC.
 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 11
 4 Parameter Lists

4.4 List Files

The parameter lists are XML files. The following code section shows the basic
structure of a direct access list with two parameters.

<?xml version="1.0" encoding="utf-8"?>

<JobList Type="DirectAccess" Description="">
<Jobs>
<SinParameterJob Type="ReadWrite" Description="">
<Parameters>
<Parameter Number="r206[0]"
Active="True"
Description="Rated power unit power, Rated value"
Value="0,12"
Unit="kW"
Min=""
Max="" />
<Parameter Number="p2000"
Active="True"
Description="Reference speed reference frequency"
 Siemens AG 2021 All rights reserved

Value="3000"
Unit="rpm"
Min=""
Max="" />
</Parameters>
</SinParameterJob>
</Jobs>
</JobList>

Attention If you have already worked with older versions of the add-in and have created
parameter lists in the old format, you can convert them with the Import button.
Alternatively, the parameter lists created in the old format can be copied to the
list folder. These are automatically converted when the add-in is started.
Please note that the lists are overwritten with the current format and are no
longer available in the old format.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 12
 5 Installation

5 Installation
5.1 Installing the Add-In
In order for the TIA Portal to recognize the add-in, it must be copied to the AddIns
folder in the installation directory of the TIA Portal.

Figure 5-1 AddIns Folder

 Siemens AG 2021 All rights reserved

It is recommended to run the supplied batch file run_as_admin_to_install.bat to

install the add-in. This also copies the sample lists and the library for acyclic
communication to the appropriate folders.
Alternatively, the add-in and the supplied sample lists and library can be copied
manually. The storage location of the sample lists and the library may need to be
adjusted in the add-in settings.
The TIA Portal must be closed before the installation is started.

Attention The batch file must be executed as Administrator in order to copy files into the
installation folder of the TIA Portal.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 13
 5 Installation

5.2 Activating the Add-In

As soon as the add-in has been copied to the AddIns folder, it is available in the
TIA Portal in the Add-Ins task card. Before the add-in can be used, it must be
activated.

Figure 5-2 Activating the add-in

 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 14
 5 Installation

To activate the add-in, the permissions must be applied.

Figure 5-3 Applying add-in permissions

 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 15
 5 Installation

5.3 Launching the Add-In

Right-click the following objects in the project directory of an open TIA project to
launch the add-in:
 Compile
All drive units in the project are loaded. The add-in can also be started if the
project does not contain any drive units.
 Group
All drive units in the group are loaded. The add-in can also be started if the
group does not contain any drive units.
 Device
The selected device is loaded. The add-in can only be started if a drive unit is
selected.

Note Several groups or drive units can be selected by pressing the Ctrl key.

The following figure shows the selection of two drive units and the corresponding
context menu for starting the add-in.
 Siemens AG 2021 All rights reserved

Figure 5-4: Launching the Add-In

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 16
 6 Structure of the Interface

6 Structure of the Interface

The interface of the EditParametersInSeveralDrives add-in is divided into several
sections (see Figure 6-1):
1. The drive units and groups are displayed in the device area.
2. Existing lists are displayed in the parameter list area and can be edited there.
3. In the parameter area, the parameters of the selected parameter list are
displayed and can be edited there.
4. In the parameter search area, you can search for parameters in the selected
drive and add them to a list or read the values of the active parameter list from
the selected drive. The Offline (read from TIA project) and Online (read from
drive unit) buttons are available for this purpose.
The Compare devices Offline and Compare devices Online buttons can be
used to compare parameter values.
5. The Change Parameters Offline and Change Parameters Online buttons in
the lower parameter list area are used to write the values from the active
parameter list to the selected drive objects.
The Set Motor & Encoder button can be used to write motor type and encoder
data.
6. Information, warnings, and errors of the add-in are displayed in the message
area.
7. Parameter lists can be saved via the File menu. Here you can also access the
settings of the add-in.
 Siemens AG 2021 All rights reserved

The About menu displays the version and disclaimer dialog.

Figure 6-1 Areas of the interface

1 3 2

5
6

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 17
 6 Structure of the Interface

6.1 File Menu

The TIA Portal project and all parameter lists can be saved via the File menu. A list
of the last opened TIA Portal projects is also displayed here. The Settings menu
item takes you to the add-in settings.

Figure 6-2 File menu

 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 18
 6 Structure of the Interface

6.2 Add-In Settings

The add-in settings are configured in this dialog.

General settings
The following settings can be changed:
 Storage location of all parameter lists. The add-in loads all lists in this directory.
New lists, as well as lists imported by the user, are stored there. This change is
not adopted until the next start.
 Automatic saving of the TIA project.
 Automatic saving of parameter lists.
 Confirmation before deleting parameter lists or list entries (parameters or jobs).
 Deleting lists from the file system, too, or not displaying them in the add-in
only. A list that has not been deleted from the file system is displayed again the
next time the add-in is started.
 Display and number of TIA projects shown in the "last opened" list.
 Reset all settings to default values.
 Delete the list of the last opened TIA projects.

Figure 6-3 General settings

 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 19
 6 Structure of the Interface

Parameter Lists
The following settings can be adjusted for parameter lists:
 Allow only whitelist parameters to be added to direct access lists.
 Confirm that RAM is saved to ROM when writing parameters online.
 Automatic saving from RAM to ROM.
 Restoring the online state of the drive after online operations or remaining
online.
 Automatic scrolling when reading and comparing parameters.
 Selection of the standard view when comparing drives. Either with parameter
columns and drive rows (useful when comparing many drives and few
parameters) or drive columns and parameter rows (useful when comparing
many parameters and few drives).

Figure 6-4 Parameter lists settings

 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 20
 6 Structure of the Interface

6.3 Device Area

After starting the add-in, the drives are displayed in the device area in the
navigation view. If the drives are divided into groups, the groups are also displayed.
Only groups containing SINAMICS drives are displayed.

Figure 6-5 Device area with drives divided into groups

The checkboxes in front of the drives and groups can be used to select them. All
 Siemens AG 2021 All rights reserved

selected drives are taken into account for mass operations (write parameters offline
or online, write motor & encoder data and compare parameters).
The Show all and Show selected buttons display either all or only the selected
drives in the navigation view.

Note Only drives of the same SINAMICS type can be selected at the same time.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 21
 6 Structure of the Interface

Create parameter list from whitelist

Via the context menu of a drive, the Create whitelist command can be used to
create a parameter list with all enabled parameters. You can select whether the list
should contain all parameters, only p-parameters, or only r-parameters.

Figure 6-6 Device area with context menu

Note It should be noted that this operation is time consuming.

 Siemens AG 2021 All rights reserved

DFI lists
Via the context menu of a drive, a list with all DFI parameters can be created with
the Create DFI list command.

Note This command is only available for SINAMICS G drives.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 22
 6 Structure of the Interface

6.4 Parameter List Area

The existing parameter lists are displayed in the parameter list area. By default, the
parameter lists are stored in the path
"C:\Users\<UserName>\AppData\Roaming\Siemens\EditParametersInSeveral
DrivesAddIn\Parameter Lists".
This folder is created when the add-in is run for the first time, if it does not exist. If
the add-in is installed with the supplied batch file, the folder is already created
during the installation.
The list types are distinguished by different icon colors:
 Green: Direct access lists
 Red: DFI lists
 Yellow: Acyclic lists

Figure 6-7 Parameter list area with context menu

 Siemens AG 2021 All rights reserved

The context menu of a parameter list can be used to rename, delete, duplicate, or
save it.
When renaming, the file name of the parameter list is also changed automatically.
Using Paste, parameters previously copied from the parameter area to the
clipboard are added to the selected parameter list.
Visible columns can be used to set the columns displayed in the parameter list
area.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 23
 6 Structure of the Interface

Create parameter lists

The Add New button can be used to create a new list. The new lists are stored in
the standard list directory.

Figure 6-8 Create new parameter list

 Siemens AG 2021 All rights reserved

When creating the list, the name must be specified, along with an optional
description. The file path is displayed in the lower part of the dialog. If a file with the
same name exists, the name is reset by appending a number.
The name and description of a parameter list can be changed later in the add-in.

Note Parameter lists can also be created manually with a text editor. Care must be
taken to ensure that the XML structure is correct.

Save parameter lists

The Save button saves changes to the selected list. In the settings (see Section
6.2), there is an option to automatically save parameter lists when the add-in is
closed.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 24
 6 Structure of the Interface

Import parameter lists

The parameter lists in the default path are automatically loaded when the add-in is
started. Alternatively, parameter lists can be imported via the Import button (see
Figure 6-7).
Different formats are supported during import:
 The internal add-in format (*.xml).
 The add-in format of older versions (*.xml).
 The format of a custom list (*.csv) exported from Startdrive.
 The format of a custom list (*.xml) exported from Starter.
With BiCo connections, the values are first imported in the format x####[#].#.
After writing, the correct parameter is determined.

6.5 Parameter Range

The parameters contained in the currently selected parameter list are displayed in
the parameter area. In the header of the parameter area, the name of the current
parameter list and the number of parameters it contains are displayed.

Figure 6-9 Parameter area with context menu

 Siemens AG 2021 All rights reserved

By clicking on the individual cells, the values can be edited.

Several parameters can be selected and copied or deleted via the context menu.
The parameters can be rearranged by moving them via drag & drop.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 25
 6 Structure of the Interface

Add parameters
Adding new parameters can be done either manually by editing the XML file, via
the context menu, or by using the search function. Alternatively, parameters can be
copied and added from another parameter list.

Search parameters
The search function can be used to search for parameters in the selected drive. If
the parameter is found, its description and value are displayed; otherwise an error
message is displayed.
The search function supports the input of a complete parameter name or,
alternatively, only the input of the parameter number. When searching for a
parameter with an index, enter the parameter number and the index, separated by
a comma. The zero index does not have to be entered. When searching for a
parameter bit, specify the parameter number and the bit number separated by a
period.
The following table shows some examples.

Table 6-1 Parameter search examples

Input Result
1. Parameter name
 Siemens AG 2021 All rights reserved

2. Parameter number

3. Parameter name
with index

4. Parameter number
with index

5. Parameter name
with bit number

6. Parameter number
with bit number

7. Parameter name
with index and bit
number

8. Parameter number
with index and bit
number

9. Parameter cannot
be found

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 26
 6 Structure of the Interface

Add only whitelist parameters

This setting (see Section 6.2) is only relevant for direct access lists.
If the setting is active, only whitelisted parameters are added to a direct access list.
For this purpose, a drive must be selected during the parameter search. If the
parameter is found, its description is displayed. In the following, the found
parameter is appended to the end of the direct access list with the Enter key.
If the parameter does not exist or is not present in the whitelist of the selected
drive, a message is displayed.
If the setting is not activated, any parameter can be added, even without selecting
a drive. Only the syntax is checked for correctness.

6.6 Reading Parameter Values

The checkbox in the Active column in the parameter area defines which
parameters are to be read. Via the context menu in the parameter area (see Figure
6-9), all parameters in the block can be activated or deactivated.
The Update list from selected drive buttons in the search area are used to read
the values of the activated parameters from the selected drive either Offline or
Online. The same operation can be started via the context menu of a drive.

Figure 6-10 Activate and read parameters

 Siemens AG 2021 All rights reserved

To read all parameters independently of the Active checkbox, the context menu of
the drive offers the option Update list from selected drive  Offline All or
Online All. The context menu in the parameter area (see Figure 6-9) also offers
this option.
The colors of the icons show which parameters were read successfully. The colors
are reset via the context menu in the parameter area (see Figure 6-9) with the
Reset coloring option.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 27
 6 Structure of the Interface

6.7 Writing Parameters

The checkbox in the Active column in the parameter area (see Figure 6-10)
defines which parameters will be written. Via the context menu in the parameter
area (see Figure 6-9), all parameters in the block can be activated or deactivated.
Parameters are written using the buttons at the bottom of the parameter list area.

Figure 6-11 Write parameter buttons

Write parameters offline

The Change Parameters Offline button writes the values of the activated
parameters to the selected devices in the TIA Portal project. The parameterization
must be transferred manually to the device for it to become effective.

Write parameters online

 Siemens AG 2021 All rights reserved

The Change Parameters Online button writes the values of the activated
parameters to the selected devices. This establishes a connection to the devices.
The connection settings of the TIA Portal project are used. For this purpose, a
connection to the devices must already have been configured and established
once in the TIA Portal.
It is recommended to use the central setting of the online access path (see the TIA
Portal main menu "Extras / Settings / Online & Diagnostics / Preset connection
path for online access").
Before the data is written, you will be asked whether the changes should be saved
in a power-failure-proof manner (RAM to ROM).

It should be noted that writing parameters online can lead to dangerous

situations.

CAUTION

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 28
 6 Structure of the Interface

6.8 Configuring the Motor & Encoder

The Set Motor & Encoder (see Figure 6-11) button can be used to change the
motor type and encoder data for the selected SINAMICS G drives. The settings
made in the dialog are written to the selected devices in the TIA Portal project. The
parameterization must be transferred manually to the device for it to become
effective.

Figure 6-12 Dialog for motor and encoder configuration

 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 29
 6 Structure of the Interface

6.9 Parameter Comparison

There are buttons for parameter comparison on the right side of the search area.
The Compare drives Offline button compares the parameter values of the
selected drives. The Compare drives Online button compares the offline and
online values of the selected drives. For this purpose, a drive must be selected.

Figure 6-13 Compare parameter buttons

The results of a comparison are displayed in a separate window. Several

comparisons can be carried out in succession, the results of which are opened in
separate windows.
The results of a comparison are represented by the following colors:
 Green – All values of a parameter are equal.
 Red – At least one value of a parameter is unequal.

Figure 6-14 Results of a parameter comparison

 Siemens AG 2021 All rights reserved

The Switch View button changes the view so that the columns are converted to
rows and the rows are converted to columns. The results can be saved to a CSV
file using the Save button.

Figure 6-15 Switching rows and columns

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 30
 6 Structure of the Interface

6.10 Message Area

Messages are displayed in the lower area of the application. These are divided into
three categories: Info, warning, and error. The output can be filtered with the
corresponding icons for info, warning, and error.
The messages can be saved as a file using the Export button. During export, the
filters are active (i.e., only the displayed messages are exported).

Figure 6-16 Message area

 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 31
 7 Acyclic Lists

7 Acyclic Lists
Acyclic lists can be used when parameters must be accessed which are not
supported by the other list types or if the drive unit is not supported by Startdrive. In
the latter case, the drive unit is available as GSD/GSDML in the TIA Portal project.
With an acyclic list, the write and read requests from a PLC can be executed by
using DPV1 services. The Add-In creates all required PLC blocks from an acyclic
list and adds them to the PLC program in the TIA Portal project. All necessary
blocks are included in the library. The basis for this is the standard library
LAcycCom. The add-in stores the contents of the acyclic list in a data block.
The processing of an acyclic list is done later at PLC runtime, independent of the
use of the add-in. This means that the add-in gives no response about the success
or failure of processing an acyclic list.

Note Acyclic lists are only supported by a separately available version of the add-in.
To do this, contact the address given in Section8.3

Note To use acyclic lists, the drive unit must be configured in the TIA project and
networked with a SIMATIC PLC.
 Siemens AG 2021 All rights reserved

Note The LAcycCom library is available via the following link:

support.industry.siemens.com/cs/ww/en/view/109479553

7.1 Jobs
Acyclic lists support the following job types (jobs):
 Read Job
List of parameters to be read. Up to 39 parameters can be read per job.
 Write Job
List of parameters to be written. Up to 19 parameters can be written per job.
 Check Job
List of parameters that must be checked for the given value before the PLC
continues with the next job. Up to 39 parameters can be checked per job. A
maximum waiting time can be entered. If this is exceeded without the specified
parameters reaching the expected values, an error is generated.
 Pause job
It will specify a time to pause between jobs.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 32
 7 Acyclic Lists

7.2 Creating a List of Jobs

To create an acyclic list, choose Add New. In the dialog, enter a name for the list
and select the type Acyclic. Optionally, you can enter a description. Click OK, to
create the list.

Figure 7-1 Create new acyclic list

 Siemens AG 2021 All rights reserved

To create jobs, right-click the Jobs area and select Add New and then select the
desired job. You can also use the keyboard shortcuts to add jobs. However, before
doing so, click in the job area to be able to input keyboard commands there.

Figure 7-2 Adding jobs

After you have added a job, you can add parameters. The next figure shows a list
for the quick commissioning of a G120X.
The parameters are added in the parameter area of the job via right-click >> Add
New or using Ctrl+Shift+N.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 33
 7 Acyclic Lists

Figure 7-3 Sample list

 Siemens AG 2021 All rights reserved

7.3 Date Type Parameter

When writing parameters, it is very important to distinguish between integer and
real values. The real values must be written in floating point form (i.e., 1360.0 and
not 1360). The integer values must not contain a comma. If this rule is not
observed, the values will be coded incorrectly. The data type of a parameter can be
looked up in the TIA Portal help.
In the case of a BiCo connection with 1 or 100%, enter r1.

Figure 7-4 Data type parameter

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 34
 7 Acyclic Lists

7.4 Generating Blocks

To generate the blocks that are needed to write the parameters, you must select
the desired drives with the checkboxes and then click the GENERATE BLOCKS
button.

Figure 7-5 Generating blocks

 Siemens AG 2021 All rights reserved

When generating, the supplied library is opened and all blocks contained there are
copied into the TIA Portal project. The blocks are stored in the AcycJobsGroup
group. A total of three groups are created.

Figure 7-6 Groups

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 35
 7 Acyclic Lists

In addition to the general blocks, two data blocks are created for each selected
axis:
 DbAcycInst_xxx is an instance DB of FB_AcycJobs and is used to call the
block.
 DbAcycCtrl_xxx represents the acyclic list and contains the jobs and the tags
that are connected to the inputs and outputs of the FB. This DB also contains
the values when reading parameters.

Figure 7-7 Control DB

 Siemens AG 2021 All rights reserved

In addition to the data blocks, a Cyclic OB (OB_AcycJobs_xxx) is created. In this

OB, the LAcycCom Resource Manager is called, as well as the FB_AcycJobs for
each axis. The following figure shows the OB for an example with one axis.

Figure 7-8 OB_AcycJobs_xxx

As shown in the figure, the instance DB is used for the call. The inputs and outputs
are connected to the Control DB. After loading, writing and reading can be started
by setting Execute in the Control DB.

Data loss
Please note that the groups are deleted each time they are generated.
CAUTION
Therefore, do not store your own code in these groups.

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 36
 7 Acyclic Lists

7.5 Settings
Via File >> Settings >> Acyclic Lists, you can set the following:
 Storage location of the supplied library.
 Activate auto numbering of blocks or assign start numbers.
 Do not generate an error if the HW_ID cannot be determined.

Figure 7-9
 Siemens AG 2021 All rights reserved

7.6 Diagnostics
When an error occurs, the output error is set and the error number is displayed in
status. In the static area of the instance DB, you can find the index of the current
job in the tag CurrentJobIndx.
If an error occurs when reading or writing a parameter, the error number is
displayed in the current job in the Control DB under errorValue for the affected
parameter (JobValue).

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 37
 7 Acyclic Lists

Figure 7-10 Control DB error number.

The FB errors are displayed in the status output. Errors from the write and read
blocks of the LAcycCom library are also copied to the status output. Based on the
type of the current job and the error number, you can find the error in the error
 Siemens AG 2021 All rights reserved

code tables in the Appendix.

 Read or Check Job:
LAcycCom_ReadDriveParams diagnostics messages
 Write Job:
LAcycCom_WriteDriveParams diagnostics messages

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 38
 7 Acyclic Lists

7.7 Error Codes

7.7.1 LAcycCom_ReadDriveParams – Diagnostics Messages

Status Meaning Comment

16#0000 STATUS_EXECUTION_FINISHED Execution finished without errors
16#7000 STATUS_NO_CALL No call of FB
16#7001 STATUS_ALLOCATE FB is currently allocating a request element
16#7002 STATUS_GET_RESOURCE FB is waiting until it has "speaking rights"
16#7003 STATUS_BUSY FB is currently in processing
16#7004 STATUS_RELEASE FB is releasing the allocated element
16#7100 WARN_EXECUTE Execute input set during silent operation
mode
16#7101 WARN_EXECUTE_SET_DURING_PR Execute input set during processing
OCESSING
16#8001 ERR_NO_OF_PARAMETERS Invalid count of parameters
16#8002 ERR_INVALID_PRIORITY_CLASS FB is not called in OB1
16#8004 ERR_JOB_REJECTED Request rejected
16#8005 ERR_RESOURCE_RELEASED Request is already released
16#8006 ERR_AMBIGUOUS_FB_CALL Execute input set during processing
(possible inconsistent data at output)
16#8200 ERR_INVALID_DATA_TYPE Invalid PLC data type at the input “dataset”
 Siemens AG 2021 All rights reserved

16#8201 ERR_INVALID_BUF_INDEX Buffer index is invalid

16#8600 ERR_COMMAND_TIMEOUT The assigned buffer element is no longer
available for the request
16#8601 ERR_RDREC_TEMP_COUNTER Counter for temporary errors reached the
maximum during RDREC command
16#8602 ERR_WRREC_TEMP_COUNTER Counter for temporary errors reached the
maximum during WRREC command
16#8603 ERR_WRREC Error occurred during WRREC command
16#8604 ERR_RDREC Error occurred during RDREC command
16#8605 ERR_REFERENCE_NO Reference number of the request does not
match the response reference number
16#8606 ERR_RESPONSE_ID Invalid response from the drive object
16#8607 ERR_PARAMETER_NO The number of parameters received does
not match the requested number of
parameters
16#8608 ERR_DRIVE_OBJECT_NO The drive object does not match the
responded drive object
16#8609 ERR_ALLOCATION_TIME The allocation time exceeded the
configured value
16#8610 ERR_MOVE_BLK_VARIANT Error occurred during
MOVE_BLK_VARIANT command
16#8611 ERR_UNDEFINED_STATE Error due to an undefined state
16#8612 ERR_UNDEFINED_SUBSTATE Error due to an undefined substate
16#8619 ERR_PARAMETER Error in at least one parameter (see:
errorValue in dataset)

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 39
 7 Acyclic Lists

7.7.2 LAcycCom_WriteDriveParams – Diagnostics Messages

Status Meaning Comment

16#0000 STATUS_EXECUTION_FINISHED Execution finished without errors
16#7000 STATUS_NO_CALL No call of FB
16#7001 STATUS_ALLOCATE FB is currently allocating a request element
16#7002 STATUS_GET_RESOURCE FB is waiting until it has "speaking rights"
16#7003 STATUS_BUSY FB is currently in processing
16#7004 STATUS_RELEASE FB is releasing the allocated element
16#7100 WARN_EXECUTE Execute input set during silent operation
mode
16#7101 WARN_EXECUTE_SET_DURING_PR Execute input set during processing
OCESSING
16#8001 ERR_NO_OF_PARAMETERS Invalid count of parameters
16#8004 ERR_REQUEST_REJECTED Request rejected
16#8005 ERR_RESOURCE_RELEASED Request is already released
16#8006 ERR_AMBIGUOUS_FB_CALL Execute input set during processing
(possible inconsistent data at output)
16#8200 ERR_INVALID_DATA_TYPE Invalid PLC data type at the input “dataset”
16#8201 ERR_INVALID_BUF_INDEX Buffer index is invalid
16#8600 ERR_COMMAND_TIMEOUT The assigned buffer element is no longer
available for the request
 Siemens AG 2021 All rights reserved

16#8601 ERR_RDREC_TEMP_COUNTER Counter for temporary errors reached the

maximum during RDREC command
16#8602 ERR_WRREC_TEMP_COUNTER Counter for temporary errors reached the
maximum during WRREC command
16#8603 ERR_WRREC Error occurred during WRREC command
16#8604 ERR_RDREC Error occurred during RDREC command
16#8605 ERR_REFERENCE_NO Reference number of the request does not
match the response reference number
16#8606 ERR_RESPONSE_ID Invalid response from the drive object
16#8607 ERR_PARAMETER_NO The number of parameters received does
not match the requested number of
parameters
16#8608 ERR_DRIVE_OBJECT_NO The drive object does not match the
responded DO
16#8609 ERR_ALLOCATION_TIME The allocation time exceeded the
configured value
16#8610 ERR_MOVE_BLK_VARIANT Error occurred during
MOVE_BLK_VARIANT command
16#8611 ERR_UNDEFINED_STATE Error due to an undefined state
16#8612 ERR_UNDEFINED_SUBSTATE Error due to an undefined substate
16#8619 ERR_PARAMETER Error in at least one parameter (see:
errorValue in dataset)

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 40
 7 Acyclic Lists

7.7.3 FB_AcycJobs – Error Codes

Status Meaning Comment

16#9000 ERR_NEXT_JOB MOVE_BLK_VARIANT error while copying
next job
16#9001 ERR_UNKNOWN_JOB Unknown job type
16#9002 ERR_READ_COPY MOVE_BLK_VARIANT error while copying
read values
16#9003 ERR_WRITE_COPY MOVE_BLK_VARIANT error while copying
write values
16#9004 ERR_CHECK_TIMEOUT Timeout error in check job. Time elapsed
without reaching the expected values
16#9005 ERR_CHECK_COPY MOVE_BLK_VARIANT error while copying
check values
 Siemens AG 2021 All rights reserved

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 41
 8 Appendix

8 Appendix
8.1 Service and support
Industry Online Support
Do you have any questions or need assistance?
Siemens Industry Online Support offers round the clock access to our entire
service and support know-how and portfolio.
The Industry Online Support is the central address for information about our
products, solutions and services.
Product information, manuals, downloads, FAQs, application examples and videos
– all information is accessible with just a few mouse clicks:
support.industry.siemens.com

Technical Support
The Technical Support of Siemens Industry provides you fast and competent
support regarding all technical queries with numerous tailor-made offers
– ranging from basic support to individual support contracts.
Please send queries to Technical Support via Web form:
siemens.com/SupportRequest
 Siemens AG 2021 All rights reserved

SITRAIN – Digital Industry Academy

We support you with our globally available training courses for industry with
practical experience, innovative learning methods and a concept that’s tailored to
the customer’s specific needs.
For more information on our offered trainings and courses, as well as their
locations and dates, refer to our web page:
siemens.com/sitrain

Service offer
Our range of services includes the following:
 Plant data services
 Spare parts services
 Repair services
 On-site and maintenance services
 Retrofitting and modernization services
 Service programs and contracts
You can find detailed information on our range of services in the service catalog
web page:
support.industry.siemens.com/cs/sc

Industry Online Support app

You will receive optimum support wherever you are with the "Siemens Industry
Online Support" APP. The app is available for iOS and Android:
support.industry.siemens.com/cs/ww/en/sc/2067

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 42
 8 Appendix

8.2 Industry Mall

The Siemens Industry Mall is the platform on which the entire siemens Industry
product portfolio is accessible. From the selection of products to the order and the
delivery tracking, the Industry Mall enables the complete purchasing processing –
directly and independently of time and location:
mall.industry.siemens.com

8.3 Application support

Siemens AG
Digital Industries
RC-DE DI FA PMA APC3 2
Am Kabellager 9
51063 Köln, Deutschland
 Siemens AG 2021 All rights reserved

mailto:[email protected]

8.4 Links and literature

Table 8-1
No. Topic
\1\ Siemens Industry Online Support
https://support.industry.siemens.com
\2\ Link to this entry page of this application example
https://support.industry.siemens.com/cs/ww/en/view/109777633
\3\ TIA Portal Openness manual
https://support.industry.siemens.com/cs/ww/en/view/109773802
\4\ Information on TIA Portal Openness Add-Ins
https://support.industry.siemens.com/cs/ww/en/view/109773999

8.5 Change documentation

Table 8-2
Version Date Modifications
V1.0 01/2020 First version
V17 10/2021 Updated for TIA Portal V17

Edit Parametes In Several Drives

Entry ID: 109777633, V17, 10/2021 43