ST_Programming
ST_Programming
1
______________
Introduction
2
SIMOTION ______________
Getting Started with ST
3
SIMOTION ST Structured Text ______________
ST Fundamentals
Integration of ST in
5
Programming and Operating Manual ______________
SIMOTION
A
______________
Appendix
08/2008
Safety Guidelines
Safety Guidelines
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
with a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken.
CAUTION
without a safety alert symbol, indicates that property damage can result if proper precautions are not taken.
NOTICE
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.
Scope
This document is part of the SIMOTION Programming documentation package.
This document is valid for product version V4.1 Service Pack 2 of SIMOTION SCOUT (the
engineering system of the SIMOTION product family) in conjunction with:
● a SIMOTION device with the following versions of the SIMOTION kernel:
– V4.1 SP2
– V4.1 SP1
– V4.0
– V3.2
– V3.1
– V3.0
● The relevant version of the following SIMOTION Technology Packages, depending on the
kernel
– Cam
– Path (kernel V4.1 and higher)
– Cam_ext (kernel V3.2 and higher)
– TControl
– Gear, Position and Basic MC (only for kernel V3.0).
This document describes the syntax and implementation of the SIMOTION ST Structured
Text programming language for this version of SIMOTION SCOUT. It also includes
information on the following topics:
● ST Editor and Compiler with program example
● Data storage and data management on SIMOTION devices
● Options for diagnosis and troubleshooting
The scope of the SIMOTION ST programming language may contain new syntax elements
compared to earlier versions. These have only been tested using the current version of the
SIMOTION kernel and are released only for this kernel version or higher versions.
SIMOTION Documentation
An overview of the SIMOTION documentation can be found in a separate list of references.
This documentation is included as electronic documentation with the supplied SIMOTION
SCOUT.
The SIMOTION documentation consists of 9 documentation packages containing
approximately 80 SIMOTION documents and documents on related systems (e.g.
SINAMICS).
The following documentation packages are available for SIMOTION V4.1 SP2:
● SIMOTION Engineering System
● SIMOTION System and Function Descriptions
● SIMOTION Diagnostics
● SIMOTION Programming
● SIMOTION Programming - References
● SIMOTION C
● SIMOTION P350
● SIMOTION D4xx
● SIMOTION Supplementary Documentation
Technical support
If you have any technical questions, please contact our hotline:
Europe / Africa
Phone +49 180 5050 222 (subject to charge)
Fax +49 180 5050 223
Internet http://www.siemens.com/automation/support-request
Americas
Phone +1 423 262 2522
Fax +1 423 262 2200
E-mail mailto:techsupport.sea@siemens.com
Asia / Pacific
Phone +86 1064 719 990
Fax +86 1064 747 474
E-mail mailto:adsupport.asia@siemens.com
Note
Country-specific telephone numbers for technical support are provided under the following
Internet address:
http://www.siemens.com/automation/service&support
Calls are subject to charge, e.g. 0.14 €/min. on the German landline network. Tariffs of other
phone companies may differ.
Additional support
We also offer introductory courses to help you familiarize yourself with SIMOTION.
Please contact your regional training center or our main training center at D-90027
Nuremberg, phone +49 (911) 895 3202.
Information about training courses on offer can be found at:
www.sitrain.com
The execution of user programs can be time-driven if you want them to run synchronously
with the system clock or a defined time cycle. They can be interrupt-driven if they are to start
and run once in response to a particular event. Alternatively, they can run sequentially or
cyclically at the round robin execution level.
&RPSLOHU
3URJUDP6WDWXV
(GLWRU
'HWDLOYLHZ
0HQXEDU
7RROEDUV
:RUNLQJDUHD
3URMHFWQDYLJDWRU
6\PEROEURZVHU
This window allows you to perform specific tasks either independently (by programming) or
using wizards (by configuring).
● Detailed view
The detail view displays additional information about the elements selected in the project
navigator, e.g. all global variables for a program or the Compile/Test Output window.
Configuring hardware
Within the project, the hardware used must be made known to the system, including:
● SIMOTION device
● Centralized I/O (with I/O addresses)
● Distributed I/O (with I/O addresses)
A SIMOTION device must be configured before you can insert and edit ST source files.
Proceed as follows
1. Open the appropriate SIMOTION device in the project navigator.
2. Select the PROGRAMS folder.
3. Select the menu Insert > Program > ST source file.
4. Enter the name of the ST source file.
Names for program source files must satisfy the rules for identifiers: They are made up of
letters (A … Z, a … z), digits (0 … 9) or single underscores (_) in any order, whereby the
first character must be a letter or underscore. No distinction is made between upper and
lower case letters.
The permissible length of the name depends on the SIMOTION Kernel version:
– As of Version V4.1 of the SIMOTION Kernel: maximum 128 characters.
– Up to Version V4.0 of the SIMOTION Kernel: maximum 8 characters.
Names must be unique within the SIMOTION device.
Protected or reserved identifiers (Page 75) are not allowed.
Existing program sources (e.g. ST source files, MCC units) are displayed.
5. If necessary, select further tabs to make local settings (only valid for this ST source file):
– Compiler tab: Local settings of the compiler (Page 46) for code generation and
message display.
– Additional settings tab: Definitions for preprocessor (Page 51)
6. Select the Open editor automatically checkbox.
7. Confirm with OK.
NOTICE
With versions of the SIMOTION Kernel up to V4.0, a violation of the permissible length of
the program source file name may not be detected until a consistency check or a download
of the program source file is performed!
Proceed as follows
1. Open the subtree of the appropriate SIMOTION device in the project navigator.
2. Open the PROGRAMS folder.
3. Select the desired ST source file.
4. Select the Edit > Open object menu command.
5. Only for ST source files with know-how protection:
If the user with the login assigned to the ST source file has not yet logged on:
– Enter the corresponding password for the displayed login.
You can now open additional ST source files to which the same login is assigned without
having to re-enter the password.
Note
You can also double-click the required ST source file to open it.
Proceed as follows
1. Under the SIMOTION device, open the PROGRAMS folder.
2. Select the desired ST source file.
3. Select the Edit > Object Properties menu command.
4. If necessary, select further tabs to make local settings (only valid for this ST source file):
– General tab: General details for the ST source, e.g. timestamp of the last change and
the storage location of the project (see figure).
– Compiler tab: Local settings of the compiler (Page 46) for code generation and
message display.
– Additional settings tab: Definitions for the preprocessor (Page 51) and display the
compiler options (Page 49) as specified for the current settings of the compiler.
– Compilation tab: Display of the compiler options (Page 49) for the last compilation of
the ST source.
– Object address tab: Set the internal object address of the ST source. The object
addresses of the other program sources are displayed.
NOTICE
With versions of the SIMOTION Kernel up to V4.0, a violation of the permissible length of
the program source file name may not be detected until a consistency check or a download
of the program source file is performed!
See also
Shortcuts (Page 27)
2.3.4.2 Drag&drop
Drag&drop
A drag-and-drop operation (dragging while keeping the left mouse button pressed) enables
you to:
● Move selected text areas within an ST source file or to another opened ST source file.
● Copy names of variables from the symbol browser to the ST source file.
● Copy names (e.g. of technology objects, functions or function blocks) from the project
navigator to the ST source file.
● Copy system functions from the command library to the ST source file.
To copy names of variables from the symbol browser to the ST source file:
1. Select the entire line of the desired variable in the symbol browser. To do this, click the
line number at the start of the line.
2. Press the left mouse button and drag the line number to the desired position in the ST
source file.
The name of the selected variable is inserted in the ST source file.
To copy the name of an element (e.g. a technology object, a function or a function block)
from the project navigator to the ST source file:
1. Select the Project tab in the project navigator.
2. Select the element in the project navigator.
3. Press the left mouse button and drag the element to the desired position in the ST source
file.
The name of the selected element is inserted in the ST source file.
To copy a system function from the command library to the ST source file:
1. Select the Command Library tab in the project navigator.
2. Select the system function in the command library.
3. Press the left mouse button and drag the system function to the desired position in the ST
source file.
The system function is inserted in the ST source file with its parameters.
2.3.4.3 Shortcuts
The ST editor also provides keyboard shortcuts. Commands can currently also be called via
the Edit and ST editor menus:
Shortcuts Description
DEL Delete the selected area (Menu Edit > Delete)
F2 Jump to the next bookmark
Arrow key Move the cursor
SHIFT+F2 Jump to the previous bookmark
SHIFT+Arrow key Select line of text
CTRL+A Select all text (Menu Edit > Select All)
CTRL+B Save and compile ST source file (menu ST source > Accept and compile)
CTRL+C Copy the selected area to the clipboard
(Menu Edit > Copy)
CTRL+D Duplicate Row
CTRL+F Find text in ST source file (Menu Edit > Find)
CTRL+H Replace text in ST source file (Menu Edit > Replace)
CTRL+L Copy line
CTRL+V Paste clipboard contents (Menu Edit > Paste)
CTRL+X Cut the selected area (Menu Edit > Cut)
CTRL+Y Redo the last action (Menu Edit > Redo)
CTRL+Z Undo the last action (Menu Edit > Undo)
CTRL+space Automatic completion
CTRL+F2 Set or delete bookmarks
CTRL+F4 Close ST source (Menu ST source > Close)
CTRL+F7 Activation and deactivation of the Program Status function (menu ST source >
Program Status on/off)
CTRL+SHIFT+F2 Delete all bookmarks in the ST source code
CTRL+SHIFT+F3 Arrange windows, tile horizontally
CTRL+SHIFT+F5 Arrange windows, tile vertically
CTRL+SHIFT+F8 Format selected area
CTRL+SHIFT+F9 Move cursor to the start of the current or higher-level block
CTRL+SHIFT+F10 Move cursor to the end of the current block
CTRL+SHIFT+F11 Move cursor to the start of the higher-level block, 1st level
CTRL+SHIFT+F12 Move cursor to the start of the higher-level block, 2nd level
CTRL+ALT+B Display bracket pairs in the current ST source file
CTRL+ALT+C Folding: Hide all blocks of the current ST source file
CTRL+ALT+D Folding: Display all blocks of the current ST source file
CTRL+ALT+F Folding: Display or hide folding information in the current ST source file
CTRL+ALT+I Display indentation level in the current ST source file
CTRL+ALT+L Display or hide line numbers in the current ST source file.
CTRL+ALT+R Folding: Display all subordinate blocks
Shortcuts Description
CTRL+ALT+T Folding: Display/hide block
CTRL+ALT+V Folding: Hide all subordinate blocks
CTRL+ALT+W Display or hide spaces and tabs in the current ST source file
CTRL+ADD (numeric keypad) Increase font size in the current ST source file
CTRL+MINUS Decrease font size in the current ST source file
(numeric keypad)
CTRL+DIV (numeric keypad) Change font size in the current ST source file to 100%
ALT+SHIFT+Arrow key Select text by column
ALT+SHIFT+L Change selected text to upper case
ALT+SHIFT+U Change selected text to lower case
Proceed as follows:
1. Select the menu Tools > Settings.
2. Select the ST editor / Scripting tab.
3. Enter the settings.
4. Click OK or Accept to confirm.
Parameter Description
Display line numbering If active, the line numbers are displayed.
See: Other ST editor tools (Page 42).
Replace tabs with blanks You select here how text indentation is performed (for the
automatic indentation or by pressing the Tab key):
• If active: By adding the appropriate number of space
characters ($20).
• If inactive: By adding the tab character ($09).
See: Indentations and tabs (Page 30).
Tab width Number of characters skipped by a tab.
See: Indentations and tabs (Page 30).
Parameter Description
Tooltip display for function parameters When active, the parameters are displayed as tooltips for
the functions.
Automatic indent/outdent If active, for the text input, source file sections and blocks
are indented automatically by the set tab width.
See: Indentations and tabs (Page 30).
Folding active If active, the column with the folding information is displayed
at the left-hand side next to the edit area.
You can then hide blocks in an ST source file so that only
the first line of the block remains visible.
See: Fold (show and hide blocks) (Page 32)
Display indentation level If active, you can optically highlight the indent and outdent
for blocks using vertical help lines (in accordance with the
set tab size).
See: Indentations and tabs (Page 30).
Display bracket pairs If active, the associated bracket of the pair that belongs to
the bracket where the cursor is located will be found and
optically highlighted.
See: Other ST editor tools (Page 42).
Font Font for the display of the text in the ST editor. All non-
proportionally spaced fonts installed on the PC are available
for selection.
Font size Font size (in pt) for the display of the text in the ST editor.
See: Change the font size in the ST editor (Page 36).
Status format Format in which the variable values are displayed for the
program status (for ST editor only).
See: Properties of the program status (Page 265).
Note
This setting affects only the behavior during the text input. It does not have any effect on
existing text in the ST sources.
Format selection
You can use this function to force the blocks (see above) in an existing text to be indented by
the tab size in accordance with their hierarchy. The number of the leading spaces or tabs will
be changed:
● As specified by the current tab size of the ST source file.
● As specified by the current setting for the type of the indent (with tabs or spaces).
Follow these steps:
1. Select the text area in the ST editor that you want to format (see Select text (Page 37)).
2. Press the CTRL+SHIFT+F8 key combination.
NOTICE
Leading tabs or spaces will be replaced in a line only when the formatting changes their
number.
Proceed as follows:
How to show or hide the column with the fold information (at the left-hand side of the editing
area):
● For the active ST source:
– Press the CTRL+ALT+F key combination.
● For all open ST sources:
– Activate or deactivate the Folding active checkbox in the settings of the ST
editor (Page 29).
How to hide a block:
● Click on the minus character in the column with the fold information.
Only the first line of the block remains visible. All subsequent lines of the block (including
lower-level blocks) will be hidden.
How to show a block:
● Click on the plus character in the column with the fold information.
All subsequent lines of the block will be shown. Lower-level blocks will be displayed in the
state they had when they were hidden.
Note
After opening an ST source in the editor, all lines of the ST source are visible. All blocks are
shown.
Proceed as follows
How to specify whether spaces and tabs are displayed in the active ST source file:
1. Set the cursor in the opened ST source.
2. Press the CTRL+ALT+W key combination.
This setting is not saved when the ST source is closed.
Proceed as follows
You can change the font size:
● For the current ST source
● For ST source files to be opened subsequently
How to change the font size for the current ST source (alternative):
● Press the CTRL key while moving the mouse wheel
● Press concurrently the CTRL key and one of the following keys on the numeric block:
– ADD (+) to increase,
– MINUS (-) to reduce,
– DIV for 100%.
NOTICE
Bookmarks are not saved when the ST source is closed.
Jump to bookmark
How to jump to the next bookmark within the ST source:
● Press the F2 key.
How to jump to the previous bookmark within the ST source:
● Press the SHIFT+F2 key combination.
Proceed as follows
How to automatically complete an identifier:
1. Write the first characters of the identifier (e.g. the letters of a word).
2. Press the Ctrl+space key combination.
The selection possibilities are displayed in a window.
3. Select the required identifier.
Note
If only a single identifier is offered for selection, the selection window will not be opened and
the identifier completed immediately.
Functional description
The following identifiers that begin with the specified character will be offered:
● Keywords of the Structured Text language
● Identifiers from the command library
● For technology objects including their system variables and configuration data
● Identifiers of the own ST source:
– Program organization units (POU)
– Data types
– Variables and constants
– Structure elements
● Identifiers from imported program sources
Note
Identifiers from the own ST source and from imported program sources will be displayed
correctly only when the corresponding program source has been compiled.
The display is made context-sensitive, only those types of identifiers that are appropriate at
the associated location of the ST source will be offered:
• Within a declaration block, only data types and keywords
• Within a program organization unit (POU), no data types
• For a structure (e.g. var_struct.xx), only structure components
Symbol Meaning
Program status
Click this icon to start the program status test mode. During the program execution,
you can monitor the values of the variables marked in the ST source.
The following prerequisites are necessary:
1. The program must be compiled with the appropriate compiler option.
2. The project and the program must be loaded into the target system.
3. An online connection to the target system must have been established.
Reclick this icon to end the program status.
See: Using the program status (Page 266).
Stop monitoring of the program variables
Click this icon in the program status test mode to stop the monitoring of the program
variables.
See Using the program status (Page 266).
Continue monitoring of the program variables
Click this icon in the program status test mode to continue the monitoring of the
program variables.
See: Using the program status (Page 266).
Refresh
Click this icon in the program status test mode to force the updating of the displayed
values. The monitoring of the program variables must have been activated.
See: Using the program status (Page 266).
Insert ST source file
Click this icon to create a new ST source file. The icon is active only when the
PROGRAMS folder where the ST source file is to be saved is selected in the project
navigator.
See: Insert ST source file (Page 21).
Accept and compile
Click this icon to transfer the current ST source file to the project and compile into
executable code.
See: Starting the compiler (Page 44).
Requirement
The ST source file has been opened with the ST editor.
Proceed as follows
1. Click in the window with the ST editor. The dynamic ST source file menu appears.
2. Select the ST source file > Accept and compile menu command.
Note
The ST source file menu is dynamic. It only appears if the window of the ST editor is active.
The compiler checks the syntax of the ST source file. The "Compile/check output" tab of the
detail view displays the successful compilation of the source text or compiler errors. The
error details include: The name of the ST source file, the number of the line in which the
error occurred, the error number and the error description.
Proceed as follows
1. Select the menu Tools > Settings.
2. Select the Compiler tab.
3. Define the settings according to the following table.
4. Confirm with OK.
Parameter
Parameter Description
Warning classes1 Active: In addition to the error messages, the compiler outputs warning messages of the
selected classes.
Inactive: The compiler suppresses the warning messages of the respective class.
See also For meanings of the warning classes (Page 49).
Selective linking1 Active (standard): Unused code is removed from the executable program.
Inactive: Unused code is retained in the executable program.
Use preprocessor1 Active: Preprocessor is used (see Control preprocessor (Page 243)).
Inactive (standard): Preprocessor is not used.
Parameter Description
Enable program status1 Active: Additional program code is generated to enable monitoring of program variables
(including local variables).
Inactive (standard): Program status not possible.
See Properties of the program status (Page 265).
Permit language extensions1 Active: Language elements are permitted that do not comply with IEC 61131-3.
Inactive (standard): Only language elements that comply with IEC 61131-3 are permitted.
Only create program Active: The local variables of a program are only stored once in the user memory of the
instance data once1 unit. The setting is required when a further program is to be called within a program.
Inactive (standard): The local variables of a program are stored according to the task
assignment in the user memory of the respective task.
See Memory ranges of the variable types (Page 194).
Display all messages with Here, you can control the scope of the error log that will be displayed in the workbench's
Save and compile all2 detail view when you call the Save and compile all command in SIMOTION SCOUT.
Active: A detailed log is created that is similar to that for single compilation of an ST source
file.
Inactive: A compressed error log is created.
1 Local setting also possible, see Local settings of the compiler (Page 46).
2User-specific settings. Valid for all SIMOTION projects that the user processes.
NOTICE
You may have to recompile the project for the settings to take effect.
Proceed as follows
1. Open the Properties window for the ST source file, see Changing the properties of an ST
source (Page 23):
Select the ST source file in the project navigator and select the Edit > Object properties
menu command.
2. Select the Compiler tab.
3. Define the settings according to the following table.
4. Confirm with OK.
Parameter
Table 2-6 Parameters for the local compiler settings for the ST source file
Parameter Description
Ignore global settings Affects:
• Warning classes
• Selective linking
• Use preprocessor
• Enable program status
• Permit language extensions
• Only create program instance data once
Active: Only the selected local settings apply. The global settings are ignored.
Inactive: The respective global setting can be adopted. The corresponding checkbox is
grayed out.
Suppress warnings In addition to error messages, the compiler can output warnings. You can set the scope of
the output warning messages:
Active: The compiler outputs the warning messages according to the selection in the global
settings of the warning classes. The checkboxes of the warning classes can no longer be
selected.
Inactive: The compiler outputs the warning messages according to the following selection of
the warning classes.
Warning classes1 Only for Suppress warnings = inactive.
Active: The compiler outputs warning messages of the selected class.
Inactive: The compiler suppresses warning messages of the respective class.
Grey background: The displayed global setting is adopted (only for Ignore global settings =
inactive).
See also For meanings of the warning classes (Page 49).
Parameter Description
Selective linking1 Active: Unused code is removed from the executable program.
Inactive: Unused code is retained in the executable program.
Grey background: The displayed global setting is adopted (only for Ignore global settings =
inactive).
Use preprocessor1 Active: Preprocessor is used.
Inactive: Preprocessor is not used.
Grey background: The displayed global setting is adopted (only for Ignore global settings =
inactive).
See Controlling the preprocessor (Page 243).
Enable program status1 Active: Additional program code is generated to enable monitoring of program variables
(including local variables).
Inactive: Program status not possible.
Grey background: The displayed global setting is adopted (only for Ignore global settings =
inactive).
See Properties of the program status (Page 265).
Permit language extensions1 Active: Language elements are permitted that do not comply with IEC 61131-3.
Inactive: Only language elements are permitted that comply with IEC 61131-3.
Grey background: The displayed global setting is adopted (only for Ignore global settings =
inactive).
Only create program Active: The local variables of a program are only stored once in the user memory of the
instance data once1 unit. The setting is required when a further program is to be called within a program.
Inactive: The local variables of a program are stored according to the task assignment in
the user memory of the respective task.
Grey background: The displayed global setting is adopted (only for Ignore global settings =
inactive).
See Memory ranges of the variable types (Page 194).
Enable OPC-XML Active: Symbol information for the unit variables of the ST source is available in the
SIMOTION device (required for the _exportUnitDataSet and _importUnitDataSet functions,
see the SIMOTION Basic Functions Function Manual.
Inactive: Icon information is not created,
1 Global setting also possible, see Global settings of the compiler (Page 45).
Requirement
The Properties window of the program source (Page 23) is open.
Proceed as follows
To display the current compiler options using the global or local settings of the
compiler (Page 44):
● Select the Additional settings tab.
The current compiler options for the program source are displayed. They are valid for a
future compilation.
To display the compiler options used for the last compilation of the program source:
● Select the Compiler tab.
The following are displayed for the last compilation of the program source:
– The version of the used compiler.
– The used compiler options.
Note
The compiler options can also be specified when the compiler is called from the command
line, e.g. using scripting.
Note
If you export in XML format, the ST source files are exported in an encrypted form. When
importing the encoded XML files, the know-how protection, including login and password,
remains in place.
See also
Know-how protection for libraries (Page 229)
Syntax Meaning
Identifier=text The specified identifier is defined and replaced in the ST source file by
’Identifier=text’ the specified text.
"Identifier=text" Permissible characters: See table footnote.
If the expression contains blanks (e.g. in the text), the syntax
"Identifier=text" must be used.
Identifier The specified identifier is defined and replaced in the ST source file by
blank text.
Permissible characters: See table footnote.
Multiple preprocessor definitions are separated by commas: Definition_1, Definition_2, …
Permissible characters:
• For identifier: In accordance with the rules for identifiers: Series of letters (A … Z, a … z), digits
(0 … 9) or single underscores (_) in any order, whereby the first character must be a letter or
underscore. No distinction is made between upper and lower case letters.
• For text: Sequence of any characters other than \ (backslash), ’ (single quote) and ” (double
quote). The keywords USES, USELIB and USEPACKAGE are not permitted.
Note
Preprocessor definitions made within an ST source file with pragmas, overwrite the
definitions in the Properties dialog box.
Note the information for preprocessor statement (Page 244)!
Note
Know-how-protected ST source files can also be exported in XML format. The ST source
files are exported encrypted. When importing the encoded XML files, the know-how
protection, including login and password, remains in place.
Note
Note that if the XML data to be imported were exported from an ST source file that was
know-how protected, the know-how protection, including login and password, remains in
place while importing the encoded XML files.
Note
If you use an external editor, the dynamic ST source file menu and its entries are not
available. The corresponding toolbar is also inactive.
It must be possible to start compilation of the ST source file from the external editor.
Status Program continues with the ST editor.
CAUTION
Close all windows of the external editor before you close a project or exit SIMOTION
SCOUT. Failure to do so could result in loss of data!
Function Meaning/Note
Close Select this command to close the active ST source file. In the event of changes, you can
decide whether you want to transfer the changed source file to the project.
Characteristics Select this command to display the properties of the active ST source file. Several tabs
are provided to make local settings for this source.
See: Changing the properties of an ST source file (Page 23).
Accept and compile Choose this command to transfer the current ST source file to the project and compile into
executable code.
See: Starting the compiler (Page 44).
Use preprocessor As an option, the preprocessor scans an ST source file before compiling and can, for
example, replace character strings in the file, which will then be taken into account during
the compilation. You can specifically execute the preprocessor statements with this menu
command.
Export Select this command to export the active ST source file as text file (ASCII).
See: Exporting an ST source file as a text file (ASCII) (Page 53).
Program status On/Off Program status On/Off monitors the current status of the active ST source file. During the
status, the program variable values can be monitored during a program run. The ST editor
is divided into two windows. The right pane displays the current values of the program
variables selected in the ST source file (left pane).
The project and the program must be available in the target system and an ONLINE
connection to the target system must be active.
Function Meaning/Note
Close Close closes the active ST source file.
Cut Select Cut to remove the selected object and save it to the clipboard.
Copy Select Copy to copy the selected object. It is stored in the clipboard.
Inserting Select Paste to insert the contents of the clipboard at the current cursor position.
Deleting Use Delete to delete the current St source file. All data from the ST source file is
permanently deleted.
Rename Use Rename to rename the current ST source file. Please note that with name changes, it
is not possible to change the referencing to this name and that the new name must
comply with the ST conventions
Save variables You can save retain, unit and global variables with this menu command. You can save
these variables from the RAM/ROM memory of the target device and store them on a data
medium as XML file. When these variables are restored, they can be written from the data
medium to the RAM/ROM memory of the target device.
Restore variables You can restore retain, unit and global variables from the previously exported variables
with this menu command. When these variables are restored, they can be written from the
data medium to the RAM/ROM memory of the target device.
Expert
Import object Import object imports the data of an ST source file from another project which was
previously created with a selective XML export.
Save project and export object Use Save project and export object to export selected data of the ST source file in XML
format. This data export can then be reimported into other projects.
Accept and compile Use Accept and compile to save and compile the selected ST source file.
Run preprocessor As an option, the preprocessor scans an ST source file before compiling and can, for
example, replace character strings in the file, which will then be taken into account during
the compilation. You can specifically execute the preprocessor statements with this menu
command.
Program status On/Off Program status On/Off monitors the current status of the active ST source file. During the
status, the program variable values can be monitored during a program run. The ST editor
is divided into two windows. The right pane displays the current values of the program
variables selected in the ST source file (left pane).
The project and the program must be available in the target system and an ONLINE
connection to the target system must be active.
Export Export exports the active ST source file as a file in ST format, e.g. to import the program
to other projects.
Know-how Protection
Set Use Set know-how protection to set know-how protection for ST sources files. The
protected sources can only be opened and modified with the specified log-on and
password.
Deleting Delete know-how protection releases the protected ST source files so that they can be
opened and read without entering a password.
Reference data
Function Meaning/Note
Create Select Create reference data to create the reference data of the selected ST source file.
The reference data contains information about the designators used, with details of their
declaration, application, function calls and the nesting of these.
Display
Cross references Display cross references displays the cross reference list of the selected ST source file in
the detail view. The reference data must be created before the cross references can be
displayed.
Program structure Select Display program structure to display the program structure of the selected ST
source file in the detail view. Before the program structure can be displayed, the reference
data must first be created.
Print Use Print to print the selected ST source file.
Print preview Select Print preview to preview the page to be printed.
Characteristics Use Properties to display the properties of the active ST source file. This window displays
the name, change date and the storage location.
Function
The Flash program sets a bit in an output byte of your target system and rotates it within this
byte. This causes each bit of the output byte to be set and reset in succession. After the last
bit of the byte, the first bit is to be set again. You can observe the result of the program at the
outputs of your target system.
2.4.1 Requirements
To create the sample program, you need
● A SIMOTION project and
● A SIMOTION device (e.g. SIMOTION C240) within the project whose output is configured
at address 62.
Proceed as follows
If a project does not yet exist, proceed as follows:
1. Select Project in the menu bar.
2. Select New or Open.
3. Specify a name for a new project, and click OK to confirm.
For details, see the online help.
Proceed as follows
1. In the project navigator, open the tree for your SIMOTION device (programs are assigned
to the SIMOTION device on which they are to run).
2. Select the PROGRAMS folder and choose Insert > Program > ST source file.
3. Enter a name for the ST source file consisting of up to 128 characters (see figure), e.g.
ST_1, and click OK to confirm the entries.
The ST editor appears in the working area. The ST source file ST_1 is inserted in the
navigator.
4. Enter the source text from Source text of the sample program (Page 64), preferably with
indented lines. To do this, press the TAB key.
The features of the ST editor are described in Working with the ST editor (Page 25); the
structure of an ST source file is described in detail in Structure of the ST source
file (Page 86) and in Source file sections (Page 169).
5. Use comments as often as possible. Enter your comment after the // characters if the
comment fits on one line of text. If the comment extends across several lines, insert it
between character pairs (* and *).
6. Save the complete project with Project > Save.
IMPLEMENTATION
PROGRAM Flash
IF counterVar >= 500 THEN // in every 500th pass
%QB62 := outputVar; // set output byte
outputVar := ROL (in := outputVar, n := 1);
(* // rotate bit in byte
one digit to the left*)
counterVar := 0; // reset counter
END_IF;
counterVar := counterVar + 1; // increment counter
END_PROGRAM
END_IMPLEMENTATION
The figure shows an example of compiling the ST source file ST_1 (see Source text of the
sample program (Page 64), in which the following change has been made: The semicolon is
missing in the statement "counterVar := counterVar + 1" at the end of line 18.
The compiler does not detect the error until Line19, because it continues with the compilation
after the missing semicolon.
Once the missing semicolon is added, the ST source file is compiled without errors.
A detailed list of all compiler error messages can be found in Compiler error messages and
their correction (Page 350).
Note
For more detailed information, refer to the SIMOTION SCOUT Configuring Manual and
SIMOTION SCOUT online help.
5XOHQDPH
6HTXHQFH
%ORFN
%ORFN
The syntax diagram in the previous figure is read from left to right. The following rule
structures must be observed:
● Sequence: Sequence of blocks
● Option: Statement(s) that can be skipped
● Iteration: Repetition of one or more statements
● Alternative: Branch
%ORFNV
%DVLFHOHPHQWUHTXLULQJQRIXUWKHU &RPSRVLWHHOHPHQWWKDWLVGHVFULEHG
H[SODQDWLRQ E\IXUWKHUV\QWD[GLDJUDPV
7KHVHDUHSULQWDEOHFKDUDFWHUVDQGVSHFLDO
FKDUDFWHUVUHVHUYHGZRUGVDQGSUHGHILQHG
LGHQWLILHUV
7KHVSHFLILFDWLRQVLQWKHVHEORFNVVKRXOG
EHDFFHSWHGZLWKRXWPRGLILFDWLRQV
Formatted and unformatted rules must be observed when entering source text, i.e. when
converting the blocks or elements of a syntax diagram into source text (see Help for the
language description (Page 291)).
See also
Formal Language Description (Page 291)
See also
Formal Language Description (Page 291)
3.2.2 Identifiers in ST
Identifiers are names in ST. These names can be defined by the system, such as language
commands. However, the names can also be user-defined, for example, for a constant,
variable or function.
,GHQWLILHU IRUPDWWHG
/HWWHU /HWWHU
B
/HWWHU 'LJLW
B 8QGHUVFRUH
'LJLW /HWWHU$=D]
8QGHUVFRUH 'LJLW
When assigning a name, it is best to choose a unique, meaningful name that contributes to
the clarity of the program.
The syntax diagram in the figure says that the first character of an identifier must be a letter
or underscore. An underscore must be followed by a letter or number, i.e. more than one
underscore in succession is not allowed. This can be followed by any number or sequence of
underscores, letters or numbers. The only exception here again is that two underscores may
not appear together.
Note
If possible, avoid defining identifiers that begin with _ (underscore), struct, enum or
command.
While these are valid identifiers, their use can cause errors later when you download
(additional) technology packages. Command words, parameters or data types in the
basic system and in technology packages begin with these characters.
A
ABS ANYTYPE_TO_LITTLEBYTEARRAY
ACOS ARRAY
AND AS
ANYOBJECT ASIN
ANYOBJECT_TO_OBJECT AT
ANYTYPE_TO_BIGBYTEARRAY ATAN
B
BIGBYTEARRAY_TO_ANYTYPE BY
BOOL BYTE
BOOL_TO_BYTE BYTE_TO_BOOL
BOOL_TO_DWORD BYTE_TO_DINT
BOOL_TO_WORD BYTE_TO_DWORD
BOOL_VALUE_TO_DINT BYTE_TO_INT
BOOL_VALUE_TO_INT BYTE_TO_SINT
BOOL_VALUE_TO_LREAL BYTE_TO_UDINT
BOOL_VALUE_TO_REAL BYTE_TO_UINT
BOOL_VALUE_TO_SINT BYTE_TO_USINT
BOOL_VALUE_TO_UDINT BYTE_TO_WORD
BOOL_VALUE_TO_UINT BYTE_VALUE_TO_LREAL
BOOL_VALUE_TO_USINT BYTE_VALUE_TO_REAL
C
CASE CTD_UDINT
CONCAT CTU
CONCAT_DATE_TOD CTU_DINT
CONSTANT CTU_UDINT
COS CTUD
CTD CTUD_DINT
CTD_DINT CTUD_UDINT
D
DATE DO
DATE_AND_TIME DT
DATE_AND_TIME_TO_DATE DT_TO_DATE
DATE_AND_TIME_TO_TIME_OF_DAY DT_TO_TOD
DELETE DWORD
DINT DWORD_TO_BOOL
DINT_TO_BYTE DWORD_TO_BYTE
DINT_TO_DWORD DWORD_TO_DINT
DINT_TO_INT DWORD_TO_INT
DINT_TO_LREAL DWORD_TO_REAL
DINT_TO_REAL DWORD_TO_SINT
DINT_TO_SINT DWORD_TO_UDINT
DINT_TO_STRING DWORD_TO_UINT
DINT_TO_UDINT DWORD_TO_USINT
DINT_TO_UINT DWORD_TO_WORD
DINT_TO_USINT DWORD_VALUE_TO_LREAL
DINT_TO_WORD DWORD_VALUE_TO_REAL
DINT_VALUE_TO_BOOL
E
ELSE END_REPEAT
ELSIF END_STRUCT
END_CASE END_TYPE
END_EXPRESSION END_VAR
END_FOR END_WAITFORCONDITION
END_FUNCTION END_WHILE
END_FUNCTION_BLOCK ENUM_TO_DINT
END_IF EXIT
END_IMPLEMENTATION EXP
END_INTERFACE EXPD
END_LABEL EXPRESSION
END_PROGRAM EXPT
F
F_TRIG FOR
FALSE FUNCTION
FIND FUNCTION_BLOCK
G
GOTO
I
IF INT_TO_SINT
IMPLEMENTATION INT_TO_TIME
INSERT INT_TO_UDINT
INT INT_TO_UINT
INT_TO_BYTE INT_TO_USINT
INT_TO_DINT INT_TO_WORD
INT_TO_DWORD INT_VALUE_TO_BOOL
INT_TO_LREAL INTERFACE
INT_TO_REAL
L
LABEL LREAL_TO_REAL
LEFT LREAL_TO_SINT
LEN LREAL_TO_STRING
LIMIT LREAL_TO_UDINT
LITTLEBYTEARRAY_TO_ANYTYPE LREAL_TO_UINT
LN LREAL_TO_USINT
LOG LREAL_VALUE_TO_BOOL
LREAL LREAL_VALUE_TO_BYTE
LREAL_TO_DINT LREAL_VALUE_TO_DWORD
LREAL_TO_INT LREAL_VALUE_TO_WORD
G
MAX MOD
MID MUX
MIN
N
NOT
O
OF OR
P
PROGRAM
R
R_TRIG REAL_VALUE_TO_BYTE
REAL REAL_VALUE_TO_DWORD
REAL_TO_DINT REAL_VALUE_TO_WORD
REAL_TO_DWORD REPEAT
REAL_TO_INT REPLACE
REAL_TO_LREAL RETAIN
REAL_TO_SINT RETURN
REAL_TO_STRING RIGHT
REAL_TO_TIME ROL
REAL_TO_UDINT ROR
REAL_TO_UINT RS
REAL_TO_USINT RTC
REAL_VALUE_TO_BOOL
S
SEL SINT_TO_WORD
SHL SINT_VALUE_TO_BOOL
SHR SQRT
SIN SR
SINT STRING
SINT_TO_BYTE STRING_TO_DINT
SINT_TO_DINT STRING_TO_LREAL
SINT_TO_DWORD STRING_TO_REAL
SINT_TO_INT STRING_TO_UDINT
SINT_TO_LREAL STRUCT
SINT_TO_REAL StructAlarmId
SINT_TO_UDINT STRUCTALARMID_TO_DINT
SINT_TO_UINT StructTaskId
SINT_TO_USINT
T
TAN TOD
THEN TOF
TIME TON
TIME_OF_DAY TP
TIME_TO_INT TRUE
TIME_TO_REAL TRUNC
TO TYPE
U
UDINT UINT_TO_UDINT
UDINT_TO_BYTE UINT_TO_USINT
UDINT_TO_DINT UINT_TO_WORD
UDINT_TO_DWORD UINT_VALUE_TO_BOOL
UDINT_TO_INT UNIT
UDINT_TO_LREAL UNTIL
UDINT_TO_REAL USELIB
UDINT_TO_SINT USEPACKAGE
UDINT_TO_STRING USES
UDINT_TO_UINT USINT
UDINT_TO_USINT USINT_TO_BYTE
UDINT_TO_WORD USINT_TO_DINT
UDINT_VALUE_TO_BOOL USINT_TO_DWORD
UINT USINT_TO_INT
UINT_TO_BYTE USINT_TO_LREAL
UINT_TO_DINT USINT_TO_REAL
UINT_TO_DWORD USINT_TO_SINT
UINT_TO_INT USINT_TO_UDINT
UINT_TO_LREAL USINT_TO_UINT
UINT_TO_REAL USINT_TO_WORD
UINT_TO_SINT USINT_VALUE_TO_BOOL
V
VAR VAR_OUTPUT
VAR_GLOBAL VAR_TEMP
VAR_IN_OUT VOID
VAR_INPUT
W
WAITFORCONDITION WORD_TO_INT
WHILE WORD_TO_SINT
WITH WORD_TO_UDINT
WORD WORD_TO_UINT
WORD_TO_BOOL WORD_TO_USINT
WORD_TO_BYTE WORD_VALUE_TO_LREAL
WORD_TO_DINT WORD_VALUE_TO_REAL
WORD_TO_DWORD
X
XOR
A
ACTION ADD_TIME
ADD ADD_TOD_TIME
ADD_DT_TIME
B
BCD_TO_BYTE BCD_TO_LWORD
BCD_TO_DINT BCD_TO_SINT
BCD_TO_DWORD BCD_TO_WORD
BCD_TO_INT BYTE_TO_BCD
C
CONFIGURATION CTU_ULINT
CTD_LINT CTUD_LINT
CTD_ULINT CTUD_ULINT
CTU_LINT
D
DINT_TO_BCD DIVTIME
DIV DWORD_TO_BCD
E
EN END_STEP
END_ACTION END_TRANSITION
END_CONFIGURATION ENO
END_RESOURCE EQ
F
F_EDGE FROM
G
GE GT
I
INITIAL_STEP INT_TO_BCD
L
LE LWORD
LINT LWORD_TO_BCD
PM
G
MUL MULTIME
N
MS
R
R_EDGE RESOURCE
S
SEMA SUB_DT_DT
SINT_TO_BCD SUB_DT_TIME
STEP SUB_TIME
SUB SUB_TOD_TIME
SUB_DATE_DATE SUB_TOD_TOD
T
TRANSITION
U
ULINT
V
VAR_ACCESS VAR_EXTERNAL
VAR_ALIAS VAR_OBJECT
W
WORD_TO_BCD
3.2.4.1 Integers
An integer contains neither a decimal point nor an exponent. An integer is thus a sequence
of numeric digits that can be preceded with a sign.
The following are valid integers:
0 1 +1 -1
743 -5280 60_000 -32_211_321
In ST, you can represent integers in different number systems. This is achieved by inserting
a keyword prefix for the number system.
The following are used:
● 2# for the binary system
● 8# for the octal system
● 16# for the hexadecimal system.
Valid representations of the decimal number 15 are:
1. A numeric digit must be present before the decimal point and after the
decimal point.
1,000.0 Commas are not permitted.
1.333.333 Two points are not permitted.
3.2.4.3 Exponents
An exponent can be included to define the position of the decimal point. If no decimal point
appears, it is assumed that it is on the right side of the digit. The exponent itself must be
either a positive or negative integer. Base 10 is expressed by the letter E.
The magnitude 3 x 108 can be represented in ST by the following correct floating-point
numbers:
3.E+8 A numeric digit must be present before the decimal point and after the decimal
point.
8e2.3 The exponent must be an integer.
.333e-3 A numeric digit must be present before the decimal point and after the decimal
point.
30 E8 Blanks are not permitted.
a := 1; // is equivalent a := TRUE
b := FALSE; // is equivalent to b := 0
Note
Floating-point numbers can only be assigned to data types REAL and LREAL.
Examples:
67VRXUFHILOH
67VRXUFHILOH
6RXUFHILOHVHFWLRQ
VAR CONSTANT
'HFODUDWLRQ PI : REAL := 3.1415;
VHFWLRQ END _ VAR
6RXUFHILOH VAR _ INPUT
VHFWLRQV r1 : REAL;
END _ VAR
You do not have to program every function yourself. You can also make use of SIMOTION
system components. These are preprogrammed sections such as system functions or the
functions of the technology objects (TO functions).
Note
An extensively annotated template for example unit is also available in the online Help. You
can use it as a template for a new ST source file.
Call the ST editor Help and click the relevant link. Copy the text to the open window of the
ST editor and modify the template according to your requirements.
Template for example unit contains a copy of this template.
3.3.1 Statements
The statement section of a program organization unit (POU – program, function, function
block) consists of repeated single statements. It follows the declaration section of a POU and
ends with the end of the POU. There are no explicit keywords for the start and end.
There are three basic types of statements in ST:
● Value assignments
Assignment of an expression to a variable, see Variable declaration (Page 105)
● Control statements
Repetition or branching of statements, see Control statements (Page 130)
● Subroutine execution
Functions (FC) and function blocks (FB), see Functions, Function Blocks, and
Programs (Page 147)
// Control statement
IF a = b THEN
FOR c := 1 TO 10 DO
b := b + c;
END_FOR;
END_IF;
// Function call
retVal := Test1(10.0);
...
3.3.2 Comments
Comments are used for documentation purposes and to help the user understand the source
file section. After compilation, they have no meaning for the program execution.
There are two types of comments:
● Line comment
● Block comment
The line comment is preceded by //. The compiler will process the text which follows until the
end of the line as a comment.
You can enter a block comment over several lines if it is preceded by (* and ends with *).
Please note the following when inserting comments:
● You can use the complete extended ASCII character set in comments.
● The character pairs (* and *) are ignored within the line comment.
● Nesting of block comments is not allowed. However, you can nest line comments in block
comments.
● Comments can be inserted at any position, but not in rules that have to be maintained,
such as in names of identifiers. For more information about these rules, refer to
Language description resources (Page 291).
See also
Elementary data types (Page 90)
Description of the technology object data types (Page 101)
System data types (Page 104)
Table 3-7 Bit widths and value ranges of the elementary data types
NOTICE
During variable export to other systems, the value ranges of the corresponding data types
in the target system must be taken into account.
6WULQJGDWDW\SH XQIRUPDWWHG
675,1*
> &RQVWDQWH[SUHVVLRQ @
&KDUDFWHUVWULQJOHQJWK
,17GDWDW\SHYDOXH
'HIDXOW
Table 3-8 Symbolic constants for the value range limits of elementary data types
Note
You cannot use general data types as type identifiers in variable or type declarations.
The general data type is retained when a user-defined data type (UDT) is derived directly
from an elementary data type (only possible with the SIMOTION ST programming language).
Table 3-11 Symbolic constants for invalid values of elementary system data types
See also
Syntax of user-defined data types (type declaration) (Page 95)
Derivation of elementary or derived data types (Page 96)
Derived data type ARRAY (Page 97)
Derived data type - Enumerator (Page 99)
Derived data type STRUCT (structure) (Page 100)
8VHUGHILQHGGDWDW\SHVಥ8'7 XQIRUPDWWHG
7<3( ,GHQWLILHU
8'7LGHQWLILHU
'DWDW\SH
$55$<
GDWDW\SH ,QLWLDOL]DWLRQ (1'B7<3(
VSHFLILFDWLRQ
(QXPHUDWRU
GDWDW\SH
VSHFLILFDWLRQ
6758&7
GDWDW\SH
VSHFLILFDWLRQ
3. Optional initialization:
You can specify an initialization value for the data type. If you subsequently declare a
variable of this data type, the initialization value is assigned to the variable.
Exception: With the STRUCT data type specification, each individual component is
initialized within the data type specification.
See also Initialization of variables or data types (Page 107).
The complete UDT declaration is terminated with the keyword END_TYPE. You can create
any number of data types within the TYPE/END_TYPE construct. You can use the defined
data types to declare variables or parameters.
UDTs can be nested in any way as long as the syntax in the figure is observed. For example,
you can use previously defined UDTs or nested structures as a data type specification. Type
declarations can only be used sequentially and not in nested structures.
Note
You can learn how to declare variables and parameters in Overview of all variable
declarations (Page 106), and how to assign values with UDT in Syntax for value
assignment (Page 113).
Below is a description of individual data type specifications for UDTs and examples
demonstrating their use.
$55$<GDWDW\SHVSHFLILFDWLRQ XQIRUPDWWHG
,QGH[VSHFLILFDWLRQ
',17GDWDW\SH ',17GDWDW\SH
2) 'DWDW\SH
Note
If array limits are violated during runtime, a processing error occurs in the program (see
SIMOTION Basic Functions Function Manual).
You declare the data type of the array components with the data type specification. All of the
options described in this chapter can be used as data types, for example, even user-defined
data types (UDT).
There are several different ARRAY types:
● The one-dimensional ARRAY type is a list of data elements arranged in ascending order.
● The two-dimensional ARRAY type is a table of data consisting of lines and columns. The
first dimension refers to the line number, the second to the column number.
● The higher-dimensional ARRAY type is an expansion of the two-dimensional ARRAY
type that includes additional dimensions.
Two-dimensional arrays are comparable to a table with lines and columns. You can create
two- or multi-dimensional arrays by means of a multi-level type declaration, see example:
VAR
m: matrix1; // Variable m of data type two-dim. Field
n: matrix2; // Variable m of data type two-dim. Field
END_VAR
(QXPHUDWRUGDWDW\SHVSHFLILFDWLRQ XQIRUPDWWHG
(QXPHUDWRUHOHPHQW
,GHQWLILHU
Once you have declared the identifier data type, you can define variables in the enumerator
data type. In the statement section, you can assign only elements from the list of defined
identifiers (enumerator elements) to these variables.
You can also specify the data type directly: Place the enumerator data type identifier and the
"#" sign in front of the enumerator element (see Table Examples of enumerator data types).
You can obtain the first and last value of an enumeration data type with enum_type#MIN and
enum_type#MAX respectively, whereby enum_type is the enumeration data type identifier.
You can obtain the numeric value of an enumeration element with the ENUM_TO_DINT
conversion function.
VAR
myC11, myC12, myC13 : C1;
END_VAR
myC11 := GREEN;
myC1l := C1#GREEN;
myC12 := C1#MIN; // RED
myC13 := C1#MAX; // BLUE
Note
You will also find enumerator data types as system data types.
Enumerator data types can be components of a structure, meaning that they can be found at
any lower level in the user-defined data structure.
6758&7GDWDW\SHVSHFLILFDWLRQ XQIRUPDWWHG
&RPSRQHQWV
6758&7 GHFODUDWLRQ (1'B6758&7
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B6758&7NH\ZRUGZLWKDVHPLFRORQ
&RPSRQHQWGHFODUDWLRQ XQIRUPDWWHG
,GHQWLILHURIWKH
FRPSRQHQW
$55$<
GDWDW\SH
VSHFLILFDWLRQ
Note
The following data specifications cannot be used directly within a component declaration:
• STRUCT data type specifications
• Enumerator data type specifications
Solution: Declare a UDT (user-defined data type) beforehand with the above-mentioned
specifications and use this in the component declaration.
This allows you to nest STRUCT data types.
You will also find STRUCT data types as system data types.
This example shows how a UDT is defined and how this data type is used within a variable
declaration.
VAR
myS1 : S1;
END_VAR
myS1.var1 := -4;
myS1.var4 := T#2d_2h_20m_33s_2ms;
Table 3-18 Symbolic constants for invalid values of technology object data types
See also
Inheritance of the properties for axes (Page 103)
Examples of the use of technology object data types (Page 103)
Table 3-19 Example of the use of a data type for technology objects
VAR
myAxis : posAxis; // Declaration variable for axis
myPos : LREAL; // Variable for position of axis
retVal: DINT; // Variable for return value of the
// TO function
END_VAR
myAxis := Axis1; // The name Axis1 was defined when the axis
// was configured in the project navigator.
// Axis is positioned.
retVal := _pos(axis := myAxis,
position := 100,
commandId:= _getCommandId() );
The second example does not use a variable with TO data type.
// Axis is positioned.
retVal := _pos(axis := Axis1
position := 100,
commandId:= _getCommandId() );
You will find details for configuration of technology objects in the SIMOTION Motion Control
function descriptions.
9DULDEOHGHFODUDWLRQ XQIRUPDWWHG
VAR
// Declaration of a variable ...
var1 : REAL;
// ... or if there are several variables of the same type:
var2, var3, var4 : INT;
// Declaration of a one-dimensional array:
a1 : ARRAY[1..100] OF REAL;
// Declaration of a character string (string):
str1 : STRING[40];
END_VAR
● Assign the elementary data types (or data types derived from elementary data types) a
constant expression in accordance with Figure Syntax: constant expression.
● Assign a field initialization list to a field (ARRAY) according to Figure Syntax: Field
initialization list.
● Assign a structure initialization list to the individual components of a structure (STRUCT)
in accordance with Figure Syntax: Structure initialization list.
● Assign an enumerator element to an enumerator data type.
,QLWLDOL]DWLRQ XQIRUPDWWHG
&RQVWDQWH[SUHVVLRQ
,QLWLDOL]DWLRQRIHOHPHQWDU\GDWDW\SHV
> $UUD\LQLWLDOL]DWLRQOLVW @
,QLWLDOL]DWLRQRIDUUD\V
6WUXFWXUHLQLWLDOL]DWLRQOLVW
,QLWLDOL]DWLRQRILQGLYLGXDOFRPSRQHQWVZLWKLQVWUXFWXUHV
The initialization value assigned to a variable is calculated from the constant expression at
the time of the compilation. See the figure for the syntax. For information about the syntax of
the constant expression, see Figure Syntax: Constant expression.
Note that a variable list (a1, a2, a3, .. : INT := .. ) can be initialized with a common value. In
this case, you do not have to initialize the variables individually (a1 : INT := .. ; a2 : INT := .. ;
etc.).
&RQVWDQWH[SUHVVLRQ XQIRUPDWWHG
&RQVWDQW
%DVLFORJLF
RSHUDWRU
%DVLFDULWKPHWLF
RSHUDWRU
&RQVWDQWH[SUHVVLRQ
8QDU\PLQXV
127
1HJDWLRQ
'DWDW\SHFRQYHUVLRQIXQFWLRQ
&RQVWDQW
H[SUHVVLRQ
52/
525
6+/
&RQVWDQW &RQVWDQW
6+5 H[SUHVVLRQ H[SUHVVLRQ
$UUD\LQLWLDOL]DWLRQOLVW XQIRUPDWWHG
&RQVWDQWH[SUHVVLRQ
&RQVWDQWH[SUHVVLRQ
'HFLPDOGLJLWVWULQJ
5HSHDWIDFWRU $UUD\LQLWLDOL]DWLRQOLVW
6WUXFWXUHLQLWLDOL]DWLRQOLVW XQIRUPDWWHG
,GHQWLILHU ,QLWLDOL]DWLRQ
'HVLJQDWLRQRIWKH
FRPSRQHQW
Variables of a technology object (TO) data type are initialized by the compiler with TO#NIL.
The effect of tasks on variable initialization is described in the SIMOTION Basic Functions
Function Manual.
3.5.4 Constants
Constants are data with a fixed value that you cannot change during program runtime.
Constants are declared in the same way as variables:
● In the declaration section of a POU for local constants (see Figure Syntax: Constant
block in a POU and Syntax: Constant declaration).
● In the interface or implementation section of the ST source file for unit constants (see
FigureSyntax: Unit constants in the interface or implementation section and Syntax:
Constant declaration). You can import unit constants declared in the interface section into
other ST source files (see Variable model (Page 184)).
The source file section also determines the range of the constant declaration.
&RQVWDQWEORFN XQIRUPDWWHG
8QLWFRQVWDQWVJOREDOFRQVWDQWEORFN XQIRUPDWWHG
&RQVWDQWGHFODUDWLRQ XQIRUPDWWHG
,GHQWLILHURIWKH
FRQVWDQWV $55$<
GDWDW\SH
VSHFLILFDWLRQ
The value assigned to a constant is calculated from the constant expression at the time of
compilation. For information about the syntax of the constant expression, see Figure Syntax:
Constant expression.
Note
In arithmetic and logic expressions, the result is always calculated in the largest number
format of the expression and converted to the data type of the result. Implicit conversion is
not always possible in value assignments. For more information on this error source and its
solution, see SIMOTION Basic Functions Function Manual.
See also
Notes on avoiding errors and on efficient programming (Page 251)
9DOXHDVVLJQPHQW XQIRUPDWWHG
9DULDEOHRIWKH
HOHPHQWDU\GDWDW\SH
9DULDEOHRIWKH
HQXPHUDWRUGDWDW\SH
$UUD\YDULDEOH
6WUXFWXUHGYDULDEOH
$EVROXWH3,DFFHVV ([SUHVVLRQ
2XWSXWVRQO\
([WHUQDOWDJ
$FFHVVWR)%LQSXWSDUDPHWHUV !
'LUHFWELWDFFHVV !
!2QO\IRUDFWLYDWHG3HUPLWODQJXDJHH[WHQVLRQVFRPSLOHURSWLRQ
The following contains explanations and examples for the left side of the value assignment:
● Value assignments with variables of an elementary data type (Page 114) ,
● Value assignments with variables of the derived enumerator data type (Page 117)
● Value assignments with variables of the derived ARRAY data type (Page 118)
● Value assignments with variables of the derived STRUCT data type (Page 118)
● Value assignments with absolute PI access (to addresses of the process image), see:
Absolute access to the fixed process image of the BackgroundTask (absolute PI
access) (Page 221).
How the right side of a value assignment, i.e. an expression, is formed, is described in
Expressions (Page 119).
elemVar := 3*3;
elemVar := elemVar1;
See also
Value assignments with variables of a bit data type (Page 116)
3.6.1.3 Value assignments with variables of the STRING elementary data type
string20 := 'ABCDEFG';
string20 := string30;
byteVar := string20[5];
string20[10] := byteVar;
Editing strings
Various system functions are available for the editing of strings, such as the joining of
strings, replacement and extraction of characters, see SIMOTION Basic Functions Function
Manual.
'LUHFWELWDFFHVV IRUPDWWHG
2QO\IRUDFWLYDWHG3HUPLWODQJXDJHH[WHQVLRQVFRPSLOHURSWLRQ
6LPSOHYDULDEOH
$UUD\YDULDEOH
6WUXFWXUHGYDULDEOH
([WHUQDOWDJ &RQVWDQW
'DWDW\SH$1<B,17
$FFHVVWR)%RXWSXWSDUDPHWHUV
$FFHVVWR)%LQSXWSDUDPHWHUV
3HUPLWWHGGDWDW\SHV
HDFK%<7(:25'':25'
NOTICE
The access to bits of an I/O variable or system variable can be interrupted by other tasks.
There is therefore no guarantee of consistency.
Logic operators
Variables of the bit data types can be combined with logic operators, see Logic expressions
and bit-serial expressions (Page 127).
3.6.1.5 Value assignments with variables of the derived enumerator data type
Each expression and each variable of the derived enumerator data type (see also: Derived
data type - Enumerator (Page 99)) can be assigned another variable of the same type.
type1 := BLUE;
3.6.1.6 Value assignments with variables of the derived ARRAY data type
An array consists of several dimensions and array elements, all of the same type (see also:
Derived data type ARRAY (Page 97)).
There are various ways to assign arrays to variables. You can assign complete arrays,
individual elements, or parts of arrays:
● A complete array can be assigned to another array if both the data types of the
components and the array limits (the smallest and largest possible array indices) are the
same. Valid assignments are:
array_1 := array_2;
● An individual array element is addressed by the array name followed by the index value
in square brackets. An index must be an arithmetic expression of the data type SINT,
USINT, INT, UINT or DINT.
● A value assignment for a valid subarray can be obtained by omitting a pair of square
brackets for each dimension of the array, starting at the right. This addresses a partial
area of the array whose number of dimensions is equal to the number of remaining
indices (see example below).
Consequently, you can reference rows and individual components within a matrix but not
closed columns (closed in the sense of from...to). Valid assignments are:
matrix1[i] := matrix2[k];
array1 := matrix2 [k];
3.6.1.7 Value assignments with variables of the derived STRUCT data type
Variables of a user-defined data type that contain STRUCT data type specifications are
called structured variables (see also Derived data type STRUCT (structure) (Page 100)).
They can either represent a complete structure or a component of this structure.
Valid parameters for a structure variable are:
There are two ways to assign structures to variables. You can reference complete structures
or structure components:
● A complete structure can only be assigned to another structure if the data type and the
name of both structure components match.
A valid assignment is:
struct1 := struct2;
struct1.elem1 := Var1;
struct1.elem1 := 20;
struct1.elem1 := struct2.elem1;
struct1.array1 := struct2.array1;
struct1.array1[10] := 100;
Note
You also use structured variables in the FBInstanceName.OutputParameter format, e.g.
myCircle.circumference to access the output variables of a function block, i.e. the result of
the function block. For more information about function blocks, see explanations in Defining
functions (Page 148) and Defining function blocks (Page 149).
A further application of structured variables is to access TO variables and the variables of
the basic system.
3.6.2 Expressions
An expression represents a value that is calculated when the program is compiled or
executed. It consists of operands (e.g. constants, variables or function values) and operators
(e.g. *, /, +, -).
The data types of the operands and the operators involved determine the expression type.
ST uses the following types of expression:
● Arithmetic expressions
● Relational expressions
● Logic expressions
● Bit-serial expressions
Note
Expressions containing only the following elements can be used for variable initialization
and index specification in ARRAY declarations (for initialization expressions – see Figure
Syntax: Constant expression in Initialization of variables or data types (Page 107)):
• Constants
• Basic arithmetic operations
• Logic and relational operations
• Bit string standard functions
3.6.3 Operands
Definition
Operands are objects which can be used to formulate expressions. Operands can be
represented by the syntax diagram:
2SHUDQG XQIRUPDWWHG
9DULDEOHRIWKHHOHPHQWDU\GDWDW\SH
9DULDEOHRIWKHHQXPHUDWRUGDWDW\SH
$UUD\YDULDEOH
6WUXFWXUHGYDULDEOH
$EVROXWH3,DFFHVV
,QSXWVDQGRXWSXWV
&RQVWDQW
)&FDOO
$FFHVVWR)%RXWSXWSDUDPHWHUV
([WHUQDOWDJ
$FFHVVWR)%LQSXWSDUDPHWHUV !
'LUHFWELWDFFHVV !
!2QO\IRUDFWLYDWHG3HUPLWODQJXDJHH[WHQVLRQVFRPSLOHURSWLRQ
$ULWKPHWLFRSHUDWRU XQIRUPDWWHG
%DVLFDULWKPHWLFRSHUDWRU
%DVLFDULWKPHWLFRSHUDWRU XQIRUPDWWHG
02'
Note
Further operations are possible with standard numeric functions, see Standard numeric
functions in the SIMOTION Basic Functions Function Manual.
It is recommended to enclose negative numbers in parentheses, even in cases where it is
not absolutely necessary, in order to enhance legibility.
The arithmetic operators are processed in accordance with their rank (Page 129).
Note
If the limits of the value range are exceeded in operations with variables of the general
ANY_REAL data type, the result contains the equivalent bit pattern according to IEEE 754.
In order to establish whether the value range was exceeded in the operation, you can verify
the result using the function _finite (see SIMOTION Basic Functions Function Manual).
Expression Value
i + j 8
i - j 14
i * j -33
i MOD j -2
i / j -3
Some expressions with these variables and their values are shown in the example.
Expression Value
t1 + t2 T#3D_3H_3M_3S_3MS
dt1 + t1 DT#2004-01-12-12:12:12.111
t1 - t2 T#48D_16H_1M_46S_295MS
t1 * 2 T#2D_2H_2M_2S_2MS
t1 / 2 T#12H_30M_30S_500MS
DATE_AND_TIME_TO_TIME_OF_DAY(dt1) TOD#11:11:11.110
DATE_AND_TIME_TO_DATE(dt1) D#2004-01-11
Definition
A relational expression is an expression of the BOOL data type formed with relational
operators (see figure).
5HODWLRQDORSHUDWRU XQIRUPDWWHG
! ! !
Relational operators compare the values of two operands (see table) and return a Boolean
value as result.
1st Operand Operator 2nd Operand -> Boolean value
Operator Meaning
> 1. operand is greater than the 2nd operand
< 1. operand is less than the 2nd operand
>= 1. operand is greater than or equal to the 2nd operand
<= 1. operand is less than or equal to the 2nd operand
= 1. operand is equal to the 2nd operand
<> 1. operand is not equal to the 2nd operand
The result of the relational expression is:
● 1 (TRUE), when the comparison is satisfied
● 0 (FALSE), when the comparison is not satisfied.
The following table shows permissible combinations of the data types for the two operands
and relational operators.
Table 3-31 Relational expressions: Permissible combinations of the data types and relational
operators
NOTICE
Relational operators have a higher priority than logic operators in an expression (see
Priority of operators (Page 129)). Therefore the operands of a relational expression must be
placed in brackets if they themselves are logic expressions or bit-serial expressions.
Note that errors can occur when comparing REAL or LREAL variables (also the
corresponding system variables, e.g. axis position).
Definition
With the logic operators AND, &, XOR, and OR, it is possible to combine operands and
expressions of the general data type ANY_BIT (BOOL, BYTE, WORD, or DWORD).
With the logic operator NOT it is possible to negate operands and expressions of data type
ANY_BIT.
The table provides information about the available operators:
Examples
Expression Value
2#01010101 AND 2#11110000 2#01010000
2#01010101 OR 2#11110000 2#11110101
2#01010101 XOR 2#11110000 2#10100101
NOT 2#01010101 2#10101010
Lowest
3.7.1 IF statement
The IF statement is a conditional statement. It specifies one or more options and selects one
(or none) of its statement sections for execution.
The specified logic expressions are evaluated when the conditional statement is executed. If
the value of an expression is TRUE, the condition is fulfilled, if the value is FALSE, it is not
fulfilled.
,)VWDWHPHQW XQIRUPDWWHG
&RQGLWLRQRIGDWDW\SH%22/
&RQGLWLRQRIGDWDW\SH%22/
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B,)NH\ZRUGZLWKDVHPLFRORQ
3. If none of the Boolean expressions in the ELSIF branches is TRUE, the sequence of
statements after the ELSE is executed (or, if there is no ELSE branch, no further
statements are executed).
The program is subsequently resumed after the END_IF.
Any number of ELSIF statements may be programmed.
Note that there may not be any ELSIF branches and/or ELSE branch. This is interpreted in
the same way as if the branches existed with no statements.
Note
An advantage of using one or more ELSIF branches rather than a sequence of IF statements
is that the logic expressions following a valid expression are no longer evaluated. This helps
to reduce the processing time required for the program and to prevent execution of
unwanted program routines.
&$6(VWDWHPHQW XQIRUPDWWHG
9DULDEOH
(QXPHUDWRUGDWDW\SH
'DWDW\SH$1<B,17
9DOXHOLVW 6WDWHPHQWVHFWLRQ
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B&$6(NH\ZRUGZLWKDVHPLFRORQ
9DOXHOLVW XQIRUPDWWHG
&RQVWDQW
9DOXH
&RQVWDQW &RQVWDQW
9DOXH 9DOXH
9DOXH 9DOXH
Note
A value should only occur once in the value lists of a CASE statement.
In the event of multiple occurrence of a value, the compiler will issue an alarm, and only
the section of the statement corresponding to the value list in which the value occurred
first is executed.
Note
You use the FOR statement when the number of loop passes is known at the programming
stage. If the number of passes is not known, the WHILE or REPEAT statement is more
suitable (see WHILE statement (Page 136) and REPEAT statement (Page 137)).
)25VWDWHPHQW XQIRUPDWWHG
9DULDEOHLGHQWLILHU
)25 ([SUHVVLRQ
6WDUWYDOXH
6LPSOHYDULDEOHGDWDW\SH
6,1786,17,178,17',17
(QGYDOXH ,QFUHPHQW
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B)25NH\ZRUGZLWKDVHPLFRORQ
3. If the FOR loop is not executed due to Step 2, the count variable retains the current
value.
Note
You use the WHILE statement when the number of loop passes is not known at the
programming stage. If the number of passes is known, the FOR statement is more suitable
(see FOR statement (Page 134)).
:+,/(VWDWHPHQW XQIRUPDWWHG
&RQGLWLRQRIGDWDW\SH%22/
6WDWHPHQWVHFWLRQ (1'B:+,/(
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B:+,/(NH\ZRUGZLWKDVHPLFRORQ
The statement section after DO is repeated until the iteration condition has the value TRUE.
The WHILE statement is processed according to the following rules:
1. The iteration condition is evaluated each time before the statement section is executed.
2. If the value is TRUE, the statement section is executed.
3. If the value is FALSE, the WHILE statement is terminated (this can occur the first time the
condition is evaluated) and the program is resumed after END_WHILE.
Note
You use the REPEAT statement when the number of loop passes is not known at the
programming stage. If the number of passes is known, the FOR statement is more suitable
(see FOR statement (Page 134)).
5(3($7VWDWHPHQW XQIRUPDWWHG
([SUHVVLRQ (1'B5(3($7
&RQGLWLRQRIGDWDW\SH%22/
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B5(3($7NH\ZRUGZLWKDVHPLFRORQ
The condition is checked after the statement section is executed. That means the statement
section is executed at least once, even if the termination condition is true at the start.
The REPEAT statement is processed according to the following rules:
1. The iteration condition is evaluated each time after the statement section is executed.
2. If the value is FALSE, the statement section is executed again.
3. If the value is TRUE, execution of the REPEAT statement is terminated and program
execution is resumed after END_REPEAT.
:$,7)25&21',7,21VWDWHPHQW XQIRUPDWWHG
:$,7)25&21',7,21
([SUHVVLRQLGHQWLILHU )&SDUDPHWHU
&RQGLWLRQ 7KHFDOORIDQH[SUHVVLRQZLWKSDUDPHWHUVLV
1DPHRIDFRQVWUXFWGHFODUHGZLWK SHUPLWWHGRQO\DVRI9HUVLRQ9RIWKH
(;35(66,21 6,027,21NHUQHO
(GJHHYDOXDWLRQ
:,7+ ([SUHVVLRQ '2
%22/GDWDW\SH
758(5LVLQJHGJHRIWKHFRQGLWLRQLVHYDOXDWHG
)$/6(&RQGLWLRQLVHYDOXDWHGVWDWLFDOO\ GHIDXOWVHWWLQJ
6WDWHPHQWVHFWLRQ (1'B:$,7)25&21',7,21
'RQRWIRUJHWWRWHUPLQDWHWKH
(1'B:$,7)25&21',7,21NH\ZRUGZLWKDVHPLFRORQ
Expression identifier is a construct declared with EXPRESSION; its value defines (together
with WITH edge evaluation, if necessary) whether the condition is considered as been
satisfied.
The WITH edge evaluation sequence is optional. Edge evaluation is an expression of data
type BOOL; it determines how the value of expression identifier is interpreted:
● Edge evaluation = TRUE: The rising edge of expression identifier is interpreted; i.e. the
condition is satisfied when the value of expression identifierchanges from FALSE to
TRUE.
● Edge evaluation = FALSE: The static value of expression identifier is interpreted; i.e. the
condition is satisfied when the value of expression identifier is TRUE.
If WITH edge evaluation is not specified, the default setting is FALSE, i.e. the static value of
expression identifier is evaluated.
The statement section must contain at least one statement (empty statements also possible).
*272VWDWHPHQW
*272 -XPSODEHO
-XPSODEHOGHILQHGLQDVWDWHPHQWDQGRSWLRQDOO\
LQWKHMXPSODEHOGHFODUDWLRQ /$%(/
Note
You should only use the GOTO statement in special circumstances (for example, for
troubleshooting). It should not be used at all according to the rules for structured
programming.
Jumps are only permitted within a POU.
The following jumps are illegal:
• Jumps to subordinate control structures (WHILE, FOR, etc.)
• Jumps from a WAITFORCONDITION structure
• Jumps within CASE statements
Jump labels can only be declared in the POU in which they are used. If jump labels are
declared, only the declared jump labels may be used.
Table 3-45 Type conversion of numeric data types and bit data types
For information on conversion functions for date and time data types: Please refer to the
SIMOTION Basic Functions Function Manual.
,QWHJHUV
XQVLJQHG 86,17 8,17 8',17
,QWHJHUV
VLJQHG 6,17 ,17 ',17
5($/ /5($/
)ORDWLQJSRLQW
5($/ /5($/
QXPEHUV
Figure 3-33 Implicit type conversion chains (one or more levels from left to right or one level from top
to bottom)
Note
In arithmetic expressions, the result is always calculated in the largest number format
contained in the expression.
A value can only be assigned to the expression if:
• The calculated expression and the variable to be assigned are of the same data type.
• The data type of the calculated expression can be implicitly converted to the data type of
the variable to be assigned.
For more information on this error source and its solution: Please refer to the SIMOTION
Basic Functions Function Manual.
Note
If applicable, specify the data type explicitly for numbers (e.g. UINT#127, if the number 127
is to be of data type UINT instead of USINT).
NOTICE
The type conversion may cause errors when the program is running, which will trigger the
error response set in the task configuration (see SIMOTION Basic Functions Function
Manual).
Special attention is required when converting DWORD to REAL. The bit string from
DWORD is taken unchecked as the REAL value. You must make sure that the bit string in
DWORD corresponds to the bit pattern of a normalized floating-point number in accordance
with IEEE. To do this, you can use the _finite and _isNaN functions.
Otherwise, an error is triggered (see above) as soon as the REAL value is first used for an
arithmetic operation (for example, in the program or when monitoring in the symbol
browser).
Note
The following applies if the value range limits are exceeded during conversion from LREAL
to REAL:
• Underflow (absolute value of LREAL number is smaller than the smallest positive REAL
number):
Result is 0.0.
• Overflow (absolute value of LREAL number is larger than the largest positive REAL
number):
The error response specified during task configuration is triggered.
)XQFWLRQ XQIRUPDWWHG
)XQFWLRQLGHQWLILHU 92,'
)81&7,21 ,GHQWLILHU
'DWDW\SH
6WDWHPHQW
)&GHFODUDWLRQVHFWLRQ VHFWLRQ (1'B)81&7,21
1RWHIRUIXQFWLRQVZLWKGDWDW\SH QRW92,'
7KHUHWXUQYDOXHRIWKHIXQFWLRQLGHQWLILHUPXVWEHDVVLJQHGLQWKHVWDWHPHQWVHFWLRQ
The FUNCTION keyword is followed by an identifier as the FC name and the data type of the
return value. Enter VOID as data type if the FC has no return value.
Then enter (see example in Source file with comments (Page 162)):
● The optional declaration section
● The statement section
● The END_FUNCTION keyword
)XQFWLRQEORFN XQIRUPDWWHG
)XQFWLRQEORFNLGHQWLILHU
)81&7,21B%/2&. ,GHQWLILHU
Data Syntax FB FC
Constant VAR CONSTANT X X
Declaration list
END_VAR
Input parameters VAR_INPUT X X
Declaration list
END_VAR
Data Syntax FB FC
In/out parameter VAR_IN_OUT X X
Declaration list
END_VAR
Output parameters VAR_OUTPUT X –
Declaration list
END_VAR
Local variable VAR X X
(for FC and FB) Declaration list (static) (temporary)
END_VAR
Local variable VAR_TEMP X -
(for FB) Declaration list (temporary)
END_VAR
Declaration list: The list of identifiers of the type to be declared
Parameters are local data and are formal parameters of a function block or function. When
the FB or FC is called, the formal parameters are substituted by the actual parameters, thus
providing a means of exchanging information between the called and calling source file
sections.
● Formal input parameters receive the actual input values (data flow inwards).
● Formal output parameters (only for FB) are used to transfer output values (data flow
outwards).
● Formal in/out parameters act as input and output parameters.
The following figures show the syntax for the parameter declaration of an FB or an FC.
)%SDUDPHWHUEORFN XQIRUPDWWHG
9$5B,1387 )RUPDOSDUDPHWHU
)RULQSXWSDUDPHWHU
9DULDEOHGHFODUDWLRQ
9$5B287387 (1'B9$5
)RURXWSXWSDUDPHWHU
9DULDEOHGHFODUDWLRQ
9$5B,1B287
)RULQRXWSDUDPHWHU ,QVWDQFHGHFODUDWLRQ
,QLWLDOL]DWLRQQRWSRVVLEOH
7KH9$5B,13879$5B287387DQG9$5B,1B287NH\ZRUGVPD\EHXVHGMXVWRQFHLQWKH
GHFODUDWLRQVHFWLRQ
9$5B,1387 9DULDEOHGHFODUDWLRQ
)RULQSXWSDUDPHWHU
(1'B9$5
9DULDEOHGHFODUDWLRQ
9$5B,1B287
)RULQRXWSDUDPHWHU ,QVWDQFHGHFODUDWLRQ
,QLWLDOL]DWLRQQRWSRVVLEOH
7KH9$5B,1387DQG9$5B,1B287NH\ZRUGVPD\EHXVHGMXVWRQFHLQWKHGHFODUDWLRQVHFWLRQ
You can use the declared parameters the same as other variables within the FB or FC, with
the following exception: You cannot assign values to input parameters.
From outside of an FB or an FC, you can access:
● The input and output parameters of an FB by means of structured variables (see User-
defined data types (Page 94)).
The access to the input parameter is possible only when the "Permit language
extensions" compiler option has been activated (see Global compiler
settings (Page 45) or Local compiler settings (Page 46) ).
Data access to the output parameter is possible as standard.
● The return value of an FC by using the function in an expression and assigning this, for
example, to a variable (the specification of the function name calls the function and
simultaneously returns a result).
Note
For tips on the efficient use of parameters, please refer to Runtime-optimized Programming
in the SIMOTION Basic Functions Function Manual.
Parameter/variable Use
Input parameters With the call of an FC or an FB, assign the current values to the input
parameters. These values are used for data processing within the FC or
the FB, for example, for calculations, but cannot be modified themselves.
Only for activated "Permit language extensions" compiler option (see
Global compiler settings (Page 45) or Local compiler settings (Page 46)):
The input parameters of an FB can be read and written using structured
variables, also outside the FB (e.g. in the calling source file section).
In/out parameter You assign a variable to an in/out parameter for the call of the FB or FC.
The FC or the FB accesses this variable directly and can change it
immediately. Type conversions are not supported.
The variable assigned to an in/out parameter must be able to be directly
read and written. Therefore, system variables (of the SIMOTION device or
a technology object), I/O variables or process image accesses cannot be
assigned to an in/out parameter.
Output parameters You assign a variable to an in/out parameter for the call of an FB using
(for FB only) the => operator. The value of the output parameter (result) is transferred
to the variables when the FB is closed. The output parameters of an FB
can also be read using structured variables, also outside the FB (e.g. in
the calling source file section).
An FC has no formal output parameters, because the function name
receives the return value. The function name itself is, in a sense, the
output parameter.
Local variables Local variables are variables that are declared and used only within the
block.
All local variables (VAR ... END_VAR) are temporary in an FC, i.e. they
lose their value when the FC is terminated. The next time the FC is called,
they are reinitialized.
A differentiation between static and temporary local variables is made in
the FB:
• Static variables (VAR ... END_VAR) retain their value when the FB is
closed.
• Temporary variables (VAR_TEMP ... END_VAR) lose their value when
the FB is closed. The next time the FB is called, they are reinitialized.
The value of the local variable cannot be queried directly by the calling
block. This is only possible using an output parameter.
3DUDPHWHUWUDQVIHU
/LVWRISDUDPHWHUV
Input and in/out parameters are normally specified as a value assignment. In this way, you
assign values (actual parameters) to the parameters you have defined in the declaration
section of the called block (formal parameters).
The assignment of output parameters is made using the => operator. In this way, you assign
a variable (actual parameter) to the output parameters you have defined in the declaration
section of the called block (formal parameters).
,QSXWDVVLJQPHQW XQIRUPDWWHG
)RUPDOSDUDPHWHU $FWXDOSDUDPHWHU
,GHQWLILHU ([SUHVVLRQ
,GHQWLILHURIWKH
LQSXWSDUDPHWHU
You transfer the data (actual parameters) to the formal input parameters of an FB or FC by
means of input assignments. You can specify the actual parameters in the form of
expressions. You can use the formal input parameters in statements within the FB or FC, but
you cannot modify their values.
A short form of parameter transfer is supported, but should not be applied in conjunction with
user-defined FBs. This short form is required only for some FCs, see SIMOTION Basic
Functions Function Manual.
,QRXWDVVLJQPHQW XQIRUPDWWHG
)RUPDOSDUDPHWHU $FWXDOSDUDPHWHU
,GHQWLILHU 9DULDEOHLGHQWLILHU
'HVLJQDWLRQRIWKH 6LPSOHYDULDEOH
LQRXWSDUDPHWHU
You transfer the data (actual parameters) to the formal in/out parameters of an FB or an FC
using in/out assignments. You can only assign a variable of the same type to the formal
in/out parameter, data type conversions are not possible.
You can use and change the formal in/out parameters in statements within the FC or the FB.
The FC or the FB accesses the variable of the actual parameter directly and can change it
immediately.
Also refer to the examples in Calling functions (Page 156) and Calling function blocks
(instance calls) (Page 157).
When using the STRING data type in in/out assignments, the declared length of the actual
parameter must be greater than or equal to the length of the formal in/out parameter (see
following example).
Table 4-3 Example of the use of the STRING data type in in/out assignments
FUNCTION_BLOCK REF_STRING
VAR_IN_OUT
io : STRING[80];
END_VAR
; // Statements
END_FUNCTION_BLOCK
FUNCTION_BLOCK test
VAR
my_fb : REF_STRING;
str1 : STRING[100];
str2 : STRING[50];
END_VAR
my_fb(io := str1); // Permitted call
my_fb(io := str2); // Not permitted call,
// compiler error message
END_FUNCTION_BLOCK
The variable assigned to an in/out parameter must be able to be directly read and written.
Therefore, system variables (of the SIMOTION device or a technology object), I/O variables
or process image accesses cannot be assigned to an in/out parameter.
Please note the different parameter access times!
2XWSXWDVVLJQPHQW XQIRUPDWWHG
)RUPDOSDUDPHWHU $FWXDOSDUDPHWHU
,GHQWLILHU ! 9DULDEOHLGHQWLILHU
,GHQWLILHURIWKH 6LPSOHYDULDEOH
LQRXWSDUDPHWHU
You use an output assignment to assign the formal output parameters of an FB to the
variables (actual parameter) that accept the value of the formal output parameter when the
FB is closed.
You can use and change the formal output parameters in statements within the FB.
Also refer to the examples in Calling function blocks (instance calls) (Page 157).
Output assignments are optional for the parameter transfer. You can read and write an FB's
output parameter at any time, even outside the FB. For further details, see: Accessing the
FB's output parameter outside the FB (Page 159).
Note
Using in/out parameters instead of input parameters is only faster if a large volume of
data is to be passed to the function block.
If unit variables are used predominantly instead of parameters, the resulting program
structure will be complex and confusing: object orientation, data encapsulation, multiple
use of variable names (encapsulation of validity ranges), etc., are no longer possible.
y:=sin(x);
y := sin(in := x);
y := sqrt (1 - cos(x) * cos(x));
Note
In the function itself, the result (return value) is assigned to the function name (except for
data type VOID).
,QVWDQFHGHFODUDWLRQ XQIRUPDWWHG
)XQFWLRQEORFN
,GHQWLILHU
LGHQWLILHU
,QVWDQFHLGHQWLILHU
)%$55$<
VSHFLILFDWLRQ
)XQFWLRQEORFNVPXVWDOUHDG\H[LVW
,QLWLDOL]DWLRQQRWSRVVLEOH
Note
Pay attention to the different initialization times for different variable types.
You call a function block instance in the statement section of a POU (for information about
syntax, see Figure). FB parameters are input and in-out assignments separated by commas.
)%FDOO XQIRUPDWWHG
,GHQWLILHU
,QVWDQFHQDPH
,QVWDQFHQDPH ,QGH[
',17GDWDW\SH
)%SDUDPHWHU
The example in the following table is applicable, assuming that the supply and motor function
blocks have already been defined:
● FB Supply:
Input parameters in1, in2; in/out parameter inout; output parameter out
● FB motor:
In/out parameters inout1, inout2; output parameters out1, out2
Table 4-4 Example of instance declaration, FB call, and access to output parameters
VAR
Supply1, Supply2: Supply;
Motor1 : Motor;
END_VAR
Supply1 (in1 := var11, in2 := expr12, inout := var13, out => var14) ;
Supply2 (in1 := var21, in2 := expr22, inout := var23, out => var24) ;
Motor1 (inout1 := var31, inout2 := var32, out1 => var33, out2 => var34);
// ...
var15 := PowerSupply1.out;
var25 := PowerSupply2.out;
var35 := Motor1.out1;
var36 := Motor1.out2;
var41 := Motor1.out1 * Motor1.out2 * (Supply1.out + Supply2.out);
See also
User-defined data types (Page 94)
NOTICE
To be able to use this option, the "Permit language extensions" compiler option (see Global
compiler settings (Page 45) and Local compiler settings (Page 46)) must have been
activated.
The instance name of the FB itself must not be used in a value assignment!
Table 4-7 Example of the differences between FB and FC for the previous example
4.3 Programs
Programs are a series of statements placed between the PROGRAM and END_PROGRAM
keywords.
3URJUDP XQIRUPDWWHG
3URJUDPLGHQWLILHU
352*5$0 ,GHQWLILHU
Programs are declared in the Implementation section (Page 171) of an ST source file and
are comparable with the FB. Static local variables (VAR...END_VAR) or temporary local
variables (VAR_TEMP...END_VAR) can be created, for example. However, they do not have
any formal parameters and so cannot be called with arguments. Examples for programs are
contained in the Source file with comments (Page 162) and Source text of the sample
program (Page 64) sections.
NOTICE
The activated "Create program instance data only once" compiler option causes:
• The static variables of the programs (program instance data) are stored in a different
Memory area (Page 194). This also changes the Initialization behavior (Page 204).
• All called programs with the same name use the same program instance data.
PROGRAM main_prog
; // ...
my_prog();
; // ...
END_PROGRAM
This can be used to perform most of the programming of the assignment of the programs to
the tasks. In the execution system, only each associated calling program needs to be
assigned to the tasks.
4.4 Expressions
The expression is a special case of a function declaration:
● The data type of the return value is defined as BOOL and is not specified explicitly.
It is used in conjunction with the WAITFORCONDITION statement (Page 139).
An expression can only be declared in the implementation section of the ST source file.
([SUHVVLRQ XQIRUPDWWHG
([SUHVVLRQLGHQWLILHU
(;35(66,21 ,GHQWLILHU
([SUHVVLRQGHFODUDWLRQ 6WDWHPHQW
VHFWLRQ VHFWLRQ (1'B(;35(66,21
1RWHWKDWDQH[SUHVVLRQRIWKH%22/GDWDW\SHPXVWEHDVVLJQHGWRWKHH[SUHVVLRQ
LGHQWLILHULQWKHVWDWHPHQWVHFWLRQ
Note
The statement section of the expression cannot contain any function calls or loops.
Example
The following example assumes that the feeder program is running in a MotionTask. The
option Activation after StartupTask is selected for this MotionTask. The assignment of
programs to tasks is performed in SIMOTION SCOUT (see SIMOTION Motion Control Basic
Functions function description).
Table 4-9 Example of the use of an EXPRESSION and the WAITFORCONDITION statement
INTERFACE
USEPACKAGE cam;
PROGRAM feeder; // in MotionTask_1
END_INTERFACE
IMPLEMENTATION
// Condition for WAITFORCONDITION statement
EXPRESSION automaticExpr
automaticExpr := IOfeedCam; // Digital input
END_EXPRESSION
PROGRAM feeder
VAR
retVal : DINT ;
END_VAR ;
retVal := _enableAxis (axis := realAxis,
enableMode := ALL,
servoCommandToActualMode := INACTIVE,
nextCommand := WHEN_COMMAND_DONE,
commandId := _getCommandId() );
Note
A template with all possible source file sections is available in the online help.
Syntax INTERFACE
// Interface statements (optional)
END_INTERFACE
An individual identifier of the section cannot be specified.
Optionally, interface statements exist in the following order between reserved words INTERFACE
and END_INTERFACE.
1. Specification of utilized technology package. Syntax:
USEPACKAGE tp-name [AS namespace];
For more details, refer to the SIMOTION Basic Functions Function Manual.
2. Specification of utilized libraries.
Syntax:
USELIB library-name-list [AS namespace];
For more information, see "Using data types, functions and function blocks from
libraries (Page 230)".
3. Reference to other units in order to use their exported components.
Syntax:
USES unit_name-list;
For more information, see "USES statement in an importing unit (Page 181)".
4. Declarations and specifications for the export
– Data type definitions (Page 176):
User-defined data types (UDT) that are valid in the entire ST source file and that are to be
exported
– Variable declarations (Page 177):
Unit variables and unit constants valid in the entire ST source file and exported.
Permissible keywords: See table in "Variable declaration (Page 177)".
– Information regarding program organization units (POU) to be exported.
Syntax:
FUNCTION fc_name;
FUNCTION_BLOCK fb_name;
PROGRAM program_name;
All technology packages, libraries, imported units, data type declarations, variable declarations
and program organization units listed in the interface section will be exported. For more
information on export, see "Interface section of an exporting unit (Page 179)".
Sequence The interface section is the first section of an ST source file1.
The order of the interface statements 1 to 4 is fixed.
Within number 4, any order is permitted. The individual declaration blocks for data type definitions
and variable definitions can appear more than once.
Attention: Identifiers must be declared before they are used.
Frequency Once per ST source file
Mandatory section yes
1 Optionally, the unit statement can precede the interface section (see "Identifier of the unit (Page 179)".
Syntax IMPLEMENTATION
// Implementation statements (optional)
END_IMPLEMENTATION
An individual identifier of the section cannot be specified.
Optionally, implementation statements (main part of the ST source file) exist in the following order
between the reserved words IMPLEMENTATION and END_IMPLEMENTATION:
1. Reference to other units in order to use their exported components. Syntax:
USES unit_name-list;
For more information, see "USES statement in an importing unit (Page 181)".
2. Declarations
– Data type definitions (Page 176):
User-defined data types (UDT) that are valid in the entire ST source file
– Variable declarations (Page 177):
Unit variables and constants that are valid in the entire ST source file
Permissible keywords: See table in "Variable declaration (Page 177)".
3. Program organization units (POUs) (Page 171)
Sequence Always follows the interface section.
The order of the implementation statements indicated above is mandatory; within number 2 and 3,
any order is permitted:
Attention: Identifiers must be declared before they are used.
Frequency Once per ST source file
Mandatory section yes
Note
Called POUs always precede the calling POUs so that they are recognized by the latter.
5.1.1.6 Programs
Programs are classified as program organization units (POUs). They are called on the target
system according to their task assignment (see Configuring the execution system in the
SIMOTION Basic Functions Function Manual) and can call FCs and FBs.
Programs have the following syntax:
5.1.1.7 Expressions
Expressions are a special case of a function declaration with the specified data type BOOL
of the return value. The expression within the EXPRESSION <expression identifier> ...
END_EXPRESSION reserved words assigned to the function name is evaluated.
You can use the WAITFORCONDITION construct to wait directly for a programmable event
or condition in a MotionTask. The statement suspends the task that called it until the
condition (expression) is true.
Structure // Statements
Sequence The statement section has no explicit keywords at the start or end. It begins after the declaration
section and ends with the keyword of the respective POU.
Frequency Once per POU
Mandatory section no
For more information on statements, see
● Value assignments and expressions (Page 112)
● Control statements (Page 130)
● Calling functions and function blocks (Page 153)
Syntax TYPE
name : data_type_specification;
// ...
END_TYPE
name represents the name of the individual data type that you use for the Variable declarations.
data_type_specification stands for any data type or a structure. Any number of individual data
types can appear between TYPE and END_TYPE.
Sequence You can define UDTs as follows:
• In the Interface section:
The UDTs are recognized within the ST source file and will be exported
They can be used in the interface and implementation section for declaration of unit variables
and in all POUs for declaration of local variables.
In addition, they can be used in all units which import this ST source file (in SIMOTION ST
with the USES statement).
• In the Implementation section:
The UDTs are recognized within the ST source file
They can be used in the implementation section for declaration of unit variables and in all
POUs for declaration of local variables.
• In the Declaration section of a POU (FC, FB, program, expression)
The UDTs are only recognized locally within the POU
They can only be used within the POU for declaration of local variables.
UDTs must be defined before they are used in a variable declaration.
Frequency The TYPE / END_VAR declaration block may appear more than once in a source file section; any
number of UDTs are possible within a declaration block.
Mandatory section no
For more information about the UDT, see User-defined data types (Page 94).
Syntax variable_type
name_list : data_type;
// ...
END_VAR
variable_type represents the keyword of the variable type being declared. The permitted
keywords depend on the source file section.
• In the Interface section or Implementation section of an ST source file:
VAR_GLOBAL: Non-retentive unit variable
VAR_GLOBAL CONSTANT: Unit constant
VAR_GLOBAL RETAIN: Retentive unit variable
• In the Declaration section of a function:
VAR: Local variable
VAR CONSTANT: Local constant
VAR_INPUT: Input parameter
VAR_IN_OUT: In/out parameter
• In the Declaration section of a function block:
VAR: Local variable
VAR CONSTANT: Local constant
VAR_TEMP: Temporary variable
VAR_INPUT: Input parameter
VAR_OUTPUT: Output parameter
VAR_IN_OUT: In/out parameter
• In the Declaration section of a program:
VAR: Local variable
VAR CONSTANT: Local constant
VAR_TEMP: Temporary variable
• In the Declaration section of an expression:
VAR: Local variable
VAR CONSTANT: Local constant
VAR_INPUT: Input parameter (as of Version 4.1 of the SIMOTION kernel)
VAR_IN_OUT: In/out parameter (as of Version 4.1 of the SIMOTION kernel)
name_list is the list of identifiers of the data_type data type to be declared.
UNIT name;
name corresponds to the name of the ST source file defined in SIMOTION SCOUT, see Add
ST source (Page 21) or Change the properties of an ST source file (Page 23).
The unit statement is ignored if the name specified there differs from the name of the ST
source file.
Note
The following further specifications are possible in the interface section, they are listed
before the exported data types, variables and POU:
1. Specification of utilized technology packages (USEPACKAGE …).
2. Specification of utilized libraries (USELIB …).
3. Reference to other units in order to use their exported units (USES …).
These imported technology packages, libraries and units are also exported. For inheritance,
see "USES statement in an importing unit (Page 181)".
You must adhere to the order presented for the specifications in the interface section of a
unit (ST source file), see "Interface section (Page 170)". Otherwise, error-free compilation of
the ST source file will not be possible.
The programs of an ST source file must be listed in the interface section so that they can be
assigned to a task in the execution system (see Configuring the execution system in the
SIMOTION Basic Functions Function Manual). The compiler outputs a warning message if
programs cannot be exported in the interface section of an ST source file.
Functions and function blocks that are only used in the ST source file should not be listed in
the interface section.
INTERFACE
// ... USES statement also possible here
TYPE // Declaration of data types to be exported
color : (RED, GREEN, BLUE);
END_TYPE
VAR_GLOBAL
cycle : INT := 1; // Declaration of the
// unit variables to be exported
END_VAR
FUNCTION myFC; // Export statement of an FC
FUNCTION_BLOCK myFB; // Export statement of an FB
PROGRAM myProgram_A; // Export statement of a program
// (to interface with the execution system)
END_INTERFACE
IMPLEMENTATION
Function myFC : LREAL // Function written out
; // ... (Statements)
END_FUNCTION
USES unit_name-list
unit_name-list is a list of units separated by commas from which the modules are to be
imported.
Example:
This enables you to access the following elements specified or declared in the interface
section of the imported unit (e.g. ST source file, MCC source):
● User-defined data types (UDT)
● Unit variables and unit constants
● Programs, functions and function blocks
● Imported technology packages, libraries and units
You can use the imported elements as if they existed in the current unit.
Note
The keyword USES can only occur once in the interface section or in the implementation
section of a unit. When multiple units are to be imported, enter them as a list separated by
commas after the keyword USES.
The USES statement can appear in either the interface section or the implementation section
of a unit. This has far-reaching implications:
Table 5-12 Implications regarding placement of USES statement in interface section or in implementation section
Note
You will find tips for use of unit variables in the SIMOTION Basic Functions Function Manual.
IMPLEMENTATION
USES myUnit_A; // Specification of unit to be imported
VAR_GLOBAL
myInstance : myFB; // Declaration of an instance
// of the imported FB
mycolor : color; // Declaration of a variable
// of the imported data type
END_VAR
PROGRAM myProgram_B
System variables
● In the SIMOTION Basic Functions Function Manual you can find information on how to
access system variables and configuration data.
● This documentation contains information on:
– Access to I/O addresses with I/O variables (see Direct access and process image of
cyclic tasks (Page 214))
– Process image access (see ),
– Creation and use of global device variables (see Use of global device
variables (Page 193)),
– Use of unit variables and local variables (static and temporary variables).
Note
Please note that downloading the ST source file to the target system and running
tasks affect variable initialization and thus the contents of the variables, see Time of
the variable initialization (Page 200).
See also
Access to fixed process image of the BackgroundTask (Page 220)
8QLW9DULDEOHV*OREDO9DULDEOH%ORFN 8QIRUPDWWHG
9DULDEOHGHFODUDWLRQ
,QVWDQFH
GHFODUDWLRQ
This declaration block may appear more than once within an interface or implementation
section. You specify the variable name and data type for the variable declaration (see
Overview of all variable declarations (Page 106) and Initialization of variables or data
types (Page 107)).
For the scope of the declaration and the HMI export, see Unit variables (Page 186).
Note
For initialization of the non-retentive unit variables:
• See Initialization of non-retentive global variables (Page 202).
• The behavior during downloading can be set (Options > Settings menu command, Project
Download tab, Initialize all non-retentive device-global variables and program data
checkbox)
• The type of version ID and therefore the initialization behavior on downloading depends
on the SIMOTION Kernel version. For details, see Version ID of global variables and their
initialization during download (Page 207).
5HWHQWLYHYDULDEOHEORFN XQIRUPDWWHG
This declaration block may appear more than once within an interface or implementation
section. You specify the variable name and data type for the variable declaration (see
Overview of all variable declarations (Page 106) and Initialization of variables or data
types (Page 107)).
For the scope of the declaration and the HMI export, see Unit variables (Page 186).
Note
Note
Local variables cannot be accessed outside the source file section in which they were
declared.
The following table provides an overview of the declaration of static and temporary variables.
It shows the source file sections in which these variables can be declared and the keywords
that can be used to declare them.
Table 5-16 Keywords for declaring static and temporary variables depending on source file section.
Note
Please note that downloading the ST source file to the target system and running tasks
affect variable initialization and thus the contents of the variables, see Time of the variable
initialization (Page 200).
6WDWLFYDULDEOHEORFN XQIRUPDWWHG
9DULDEOHGHFODUDWLRQ
,QVWDQFH
GHFODUDWLRQ
You can do the following in the static variable block, according to the syntax in the figure:
● Declare variables (name and data type), optionally with initialization.
● Declare symbolic accesses to the process image of the BackgroundTask.
● Declare instances of the function blocks.
7HPSRUDU\YDULDEOHEORFNLQ)%DQGSURJUDP XQIRUPDWWHG
In functions and expressions, you declare temporary variables in the FC temporary variable
block (see following figure):
7HPSRUDU\YDULDEOHEORFNLQ)& XQIRUPDWWHG
9DULDEOHGHFODUDWLRQ
9$5 (1'B9$5
Note
If you have declared unit variables or local variables of the same name (e.g. var-name),
specify the global device variable with _device.var-name.
An alternative to global device variables is the declaration of unit variables in a separate unit,
which is imported into other units. This has the following advantages:
1. Variable structures can be used.
2. The initialization of the variables during the STOP-RUN transition is possible (via
Program in StartupTask).
3. For newly created global unit variables, a download in RUN is also possible.
Please refer to the SIMOTION Basic Functions Function Manual.
Table 5-18 Memory ranges assigned to different variable types and their initialization
Table 5-19 Example of memory ranges of the variable types, as of Kernel V3.1 (Part 1)
INTERFACE
// The statements in the interface section specify,
// what source content is exported.
FUNCTION FC1;
FUNCTION_BLOCK FB1;
PROGRAM p1;
IMPLEMENTATION
// The implementation section contains the executable code sections
// in different program organization units (POU)
// A POU can be a program, FC, or FB.
// Unit variables of the implementation section can only be used
// within the source file.
VAR_GLOBAL // Non-retentive unit variables are located
// in the unit user memory
u1_glob : INT;
END_VAR
VAR_GLOBAL CONSTANT // Unit constants are located
// in the unit user memory
END_VAR
VAR_GLOBAL RETAIN // Retentive unit variables are located
// in the retentive (power-fail-safe) memory
END_VAR
//----------------------------------------------------------------------
Table 5-20 Example of memory ranges of the variable types, as of Kernel V3.1 (Part 2)
// Continuation
//----------------------------------------------------------------------
FUNCTION_BLOCK FB1 // Declaration of an instance
// instance determines where its data are located:
// - as VAR_GLOBAL in a unit:
// in the unit user memory
// - as VAR in a program:
// in the user memory of the task (default)
// - As VAR in a function block:
// in the user memory of the unit or task,
// depending on the instance declaration of the higher-level FB
// When the instance is called, a pointer to the instance data
// is placed on the stack of the calling task
Table 5-21 Example of memory ranges of the variable types, as of Kernel V3.1 (Part 3)
// Continuation
//----------------------------------------------------------------------
FUNCTION FC1 : INT // The function data is on the
// stack of the calling task; they are initialized each time
// the function is called.
// The return value is on the stack of the calling task
PROGRAM p1
VAR // By default, variables are located in the
// in the user memory of the task
p_var : INT;
p_varFB : FB1;
END_VAR
5.2.3.2 Memory requirement of the variables on the local data stack (Kernel V3.1 and higher)
The variables stored on the local data stack of a task are listed in Memory ranges of the
variable types (Page 194). You set the stack size for each task in the task configuration.
Note the following for memory requirements in the local stack:
● Temporary local variables require their own size on the stack.
● Global variables and static local variables do not require any resources on the stack.
If you are using them as input parameters for a function, however, they require their own
data size on the stack.
● Even if a function is called more than once in a task, it only uses the stack's resources
once.
● Variables of type BOOL require one byte on the stack.
Note
The above details are also true for the use of libraries that have been compiled with
reference to the SIMOTION device and the associated version of the SIMOTION kernel (as
of Version V3.1).
NOTICE
If the library is not device-dependent (i.e. compiled without reference to a SIMOTION
device or SIMOTION Kernel version): These libraries are compiled compatible to the
permitted versions of the SIMOTION kernel.
Consequently, the variables of program organization units (POU) called from these libraries
occupy the local data stack as for versions of the SIMOTION kernel up to V3.0. See
Memory requirement of the variables on the local data stack (up to Kernel
V3.0) (Page 199).
You can obtain information about the memory requirements of a POU in the local data stack
using the Program Structure (Page 239) function.
5.2.3.3 Memory requirement of variables on local data stack (Kernel V3.0 and below)
The variables stored on the local data stack of a task are listed in Memory ranges of the
variable types (Page 194). You set the stack size for each task in the task configuration.
Note the following for memory requirements in the local stack:
● Static local variables in programs require double their size on the stack.
● Static local variables in FBs require several times their size on the stack, depending on
the calling depth.
● Temporary local variables (in programs, FBs, and FCs) require their own size on the
stack.
● Global variables do not occupy any stack memory space.
If you are using them as input parameters for a function or function block, however, they
will occupy their usual space on the stack.
● Even if a function is called more than once in a task, it only uses the stack's resources
once.
● Variables of type BOOL require one byte on the stack.
NOTICE
When a function block instance is called, all instance data is copied to the local data stack,
even if the instance is declared as a VAR_GLOBAL instance.
If the library is not device-dependent (i.e. compiled without reference to a SIMOTION
device or SIMOTION Kernel version): These libraries are compiled compatible to the
permitted versions of the SIMOTION kernel. Consequently, the variables of program
organization units (POU) called from these libraries occupy the local data stack as
described in this section.
The memory requirement on the local data stack is significantly larger than for versions of
the SIMOTION kernel as of V3.1, see Memory requirement of the variables on the local
data stack (as of Kernel V3.1) (Page 199). Take this into consideration for setting the stack
size for the task configuration!
You can obtain information about the memory requirements of a POU in the local data stack
using the Program Structure (Page 239) function.
Note
You can upload values of unit variables or global device variables from the SIMOTION
device into SIMOTION SCOUT and save them in XML format.
1. Save the required data segments of the unit variables or global device variables as a data
set with the function _saveUnitDataSet.
2. Use the Save variables function in SIMOTION SCOUT.
You can use the Restore variables function to download these data sets and variables back
to the SIMOTION device.
For more information, refer to the SIMOTION SCOUT Configuration Manual.
This makes it possible, for example, to obtain this data, even if it is initialized by a project
download or if it becomes unusable (e.g. due to a version change of SIMOTION SCOUT).
Note
You can obtain information about the memory requirements of a POU in the local data stack
using the Program Structure (Page 239) function.
The initialization of the variables thus depends on the execution behavior of the task to
which the program is assigned (see SIMOTION Basic Functions Function Manual):
– Sequential tasks (MotionTasks, UserInterruptTasks, SystemInterruptTasks,
StartupTask, ShutdownTask): The static variables are initialized every time the task is
started.
– Cyclic tasks (BackgroundTask, SynchronousTasks, TimerInterruptTasks): The static
variables are initialized only during transition to RUN mode.
● For the activated "Create program instance data only once" compiler option:
This setting is necessary, for example, if a program is to be called within a program.
The static variables are stored only once in the user memory of the task.
– They are thus initialized together with the non-retentive unit variables, see Initialization
of non-retentive global variables (Page 202).
– Only as of Version V4.1 of the SIMOTION Kernel:
In addition, they can be initialized during transition to RUN mode. To do this, the
following attribute must be specified in the associated declaration block within a
pragma (only SIMOTION ST programming language):
{ BlockInit_OnDeviceRun := ALWAYS; }.
Note
You can obtain information about the memory requirements of a POU in the local data
stack using the Program Structure (Page 239) function.
Table 5-26 Version ID of global variables and their initialization during download
Data segment As of Version V3.2 of the SIMOTION kernel Up to Version V3.1 of the
SIMOTION kernel
Global device variables
Retentive global • Separate version ID for each data segment of the global • Common version ID for all data
device variables device variables. segments of the global device
• The version identification of the data segment changes variables.
Non-retentive
global device for: • This version ID changes when
variables – Add or remove a variable within the data segment the variable declaration is
changed in a data segment.
– Change of the identifier or the data type of a variable
within the data segment • During downloading2, the rule
is: Initialization of all data
• This version ID does not change on: segments if the version ID
– Changes in the other data segment changes.
– Changes to initialization values1 • Use of the functions for data
• During downloading2, the rule is: Initialization of a data backup not possible.
segment only if its version ID has changed.
• Use of the functions for data backup and initialization
possible.
Unit variables of a unit
Retentive unit • Several data blocks ( = declaration blocks)3 in each data • One data block in each data
variables in the segment possible. segment (also for several
interface section • Own version ID for each data block. declaration blocks)3
Retentive unit • The version identification of the data block changes for: • Common version ID for all
variables in the global declarations in a unit.
– Add or remove a variable in the associated
implementation declaration block • This version ID changes in
section response to the following
– Change of the identifier or the data type of a variable changes:
Non-retentive unit in the associated declaration block
– Variable declaration in a
variables in the – Change of a data type definition (from a separate or data segment
interface section imported4 unit) used in the associated declaration
block – Declaration of global data
Non-retentive unit types in the unit
variables in the – Add or remove declaration blocks within the same
data segment before the associated declaration block – Declaration in the interface
implementation
section of an imported4 unit.
section • This version ID does not change on:
• During downloading2, the rule
– Add or remove declaration blocks in other data is: Initialization of all data
segments segments if the version ID
– Add or remove declaration blocks within the same changes.
data segment after the associated declaration block • Use of the functions for data
– Changes in other data blocks backup only possible for: Non-
– Changes to initialization values1 retentive unit variables in the
interface section
– Changes to data type definitions that are not used in
the associated data block
– Changes to functions
• During downloading2, the rule is: Initialization of a data
block only if its version ID has changed.5
• Functions for data backup and initialization take into
account the version ID of the data blocks.
Data segment As of Version V3.2 of the SIMOTION kernel Up to Version V3.1 of the
SIMOTION kernel
1 Changed initialization values are not effective until the data block or data segment in question is initialized.
2If Initialization of all retentive global device variables and program data = No and Initialization of all non-retentive global
device variables and program data = No.
In the case of other settings: See the sections "Initialization of retentive global variables (Page 201)" and "Initialization of
non-retentive global variables (Page 202)".
3Several declaration blocks per data segment are possible only in the SIMOTION ST programming language. For the
SIMOTION MCC and SIMOTION LAD/FBD programming languages, only one declaration block per data segment will be
created.
4 The import of units depends on the programming language, refer to the associated section (Page 181).
5Also for the download in RUN, provided the associated prerequisites have been satisfied and the following
attribute (Page 247) has been specified in the associated declaration block within a pragma (Page 242) (only for the
SIMOTION ST programming language): { BlockInit_OnChange := TRUE; }.
For the download in RUN, see the SIMOTION Basic Functions Function Manual.
NOTICE
The total size of the unit variables that can be exported to HMI devices is limited to 64 KB
per unit.
The effect of the pragma { HMI_Export := FALSE; } and
{ HMI_Export := TRUE; } depends on the version of the SIMOTION Kernel:
• As of Version V4.1 of the SIMOTION Kernel:
The pragma affects the export of the corresponding declaration block to HMI devices
and the structure of the HMI address space:
– Only those variables in declaration blocks exported to HMI devices occupy the HMI
address space.
– Within the HMI address space, the variables are arranged according to order of their
declaration.
• Up to version V3.2 or V4.0 of the SIMOTION kernel:
The pragma affects only the export of the corresponding declaration block to HMI
devices.
The HMI address space is also occupied by unit variables of the interface section whose
declaration blocks are not assigned to HMI devices.
Within the HMI address space, the variables are sorted in the following order:
– Retentive unit variables of the interface section (exported and not exported).
– Retentive unit variables of the implementation section (only exported).
– Non-retentive unit variables of the interface section (exported and not exported).
– Non-retentive unit variables of the implementation section (only exported).
Within these segments, the variables are arranged according to order of their
declaration.
• Up to Version V3.1 of the SIMOTION kernel:
The pragma has no effect.
Table 5-27 Example for the control of the HMI export with the corresponding pragma
INTERFACE
VAR_GLOBAL
// HMI export
x1 : DINT;
END_VAR
VAR_GLOBAL
{ HMI_Export := FALSE; }
// No HMI export
x2 : DINT;
END_VAR
// ...
END_INTERFACE
IMPLEMENTATION
VAR_GLOBAL
// No HMI export
y1 : DINT;
END_VAR
VAR_GLOBAL
{ HMI_Export := TRUE; }
// HMI export
y2 : DINT;
END_VAR
// ...
END_IMPLEMENTATION
Note
An access via the process image is more efficient than direct access.
Table 5-28 Important features of direct access and process image access
Properties
Direct access to inputs and outputs and access to the process image of the cyclic task
always take place via I/O variables. The entire address range of the SIMOTION device (see
table below) can be used.
A comparison of the most important properties, also in comparison to the fixed process
image of the BackgroundTask (Page 220) is contained in "Important properties of direct
access and process image (Page 212)".
Direct access
The direct access is used to directly access the corresponding I/O address. Direct access is
used primarily for sequential programming (in MotionTasks). The access to the current value
of the inputs and outputs at a specific time is particularly important.
For direct access, you define an I/O variable (Page 217) without assigning it a task.
Note
An access via the process image is more efficient than direct access.
Table 5-29 Address range of the SIMOTION devices depending on the version of the
SIMOTION kernel
PROFIBUS DP line.
5For distributed I/O (over PROFINET), the transmission volume is restricted to 4096 bytes per
PROFINET segment.
Note
Observe the rules for I/O addresses for direct access and the process image of the cyclical
tasks (Page 216).
5.3.3.1 Rules for I/O addresses for direct access and the process image of the cyclical tasks
NOTICE
You must observe the following rules for the I/O variable addresses for direct access and
the process image of the cyclic task (Page 214). Compliance with the rules is checked
during the consistency check of the SIMOTION project (e.g. during the download).
1. Addresses used for I/O variables must be present in the I/O and configured
appropriately in the HW Config.
2. I/O variables comprising more than one byte must not contain addresses 63 and 64
contiguously.
The following I/O addresses are not permitted:
– Inputs: PIW63, PID61, PID62, PID63
– Outputs: PQW63, PQD61, PQD62, PQD63
3. All addresses of an I/O variable comprising more than one byte must be within an
address area configured in HW-config.
4. An I/O address (input or output) can only be used by a single I/O variable of data type
BYTE, WORD or DWORD or an array of these data types. Access to individual bits with
I/O variables of data type BOOL is possible.
5. If several processes (e.g. I/O variable, technology object, PROFIdrive telegram) access
an I/O address, the following applies:
– Only a single process can have write access to an I/O address of an output (BYTE,
WORD or DWORD data type).
Read access to an output with an I/O variable that is used by another process for
write access, is possible.
– All processes must use the same data type (BYTE, WORD, DWORD or ARRAY of
these data types) to access this I/O address. Access to individual bits is possible
irrespective of this.
Take care, for example, if you want to use an I/O variable to read the transferred
PROFIBUS telegram of a drive: The length of the I/O variables must match the
length of the telegram.
– Write access to different bits of an address is possible from several processes;
however, write access with the data types BYTE, WORD or DWORD is then not
possible.
Note
These rules do not apply to accesses to the fixed process image of the
BackgroundTask (Page 220). These accesses are not taken into account during the
consistency check of the project (e.g. during download).
5.3.3.2 Creating I/O variables for direct access or process image of cyclic tasks
You create I/O variables in the symbol browser of the detail view; to do this, you must be
working in offline mode.
Here is a brief overview of the procedure:
1. In the project navigator of SIMOTION SCOUT, select the I/O element in the subtree of the
SIMOTION device.
2. In the detail view, select the "Symbol browser" tab and scroll down to the end of the
variable table (empty row).
3. In the last (empty) row of the table, enter or select the following:
– Name of variable.
– I/O address according to the "syntax for entering I/O addresses (Page 219)".
– Optional for outputs:
Activate the "Read only" checkbox if you only want to have read access to the output.
You can then read an output that is already being written by another process (e.g.
output of an output cam, PROFIdrive telegram).
A read-only output variable cannot be assigned to the process image of a cyclic task.
– Data type of the variables in accordance with "Possible data types of the I/O
variables (Page 220)".
4. Optionally, you can also enter or select the following (not for data type BOOL):
– Array length (array size).
– Process image or direct access:
Can only be assigned if the "Read only" checkbox is cleared.
For process image, select the cyclic task to which you want to assign the I/O variable.
To select a task, it must have been activated in the execution system.
For direct access, select the blank entry.
– Strategy for the behavior in an error situation (see SIMOTION Basic Functions
Function Manual).
– Substitute value (if array, for each element).
– Display format (if array, for each element), when you monitor the variable in the
symbol browser.
You can now access this variable using the symbol browser or any program of the
SIMOTION device.
NOTICE
Note the following for the process image for cyclic tasks:
• A variable can only be assigned to one task.
• Each byte of an input or output can only be assigned to one I/O variable.
In the case of data type BOOL, please note:
• The process image for cyclic tasks and a strategy for errors cannot be defined. The
behavior defined via an I/O variable for the entire byte is applicable (default: direct
access or CPU stop).
• The individual bits of an I/O variable can also be accessed using the bit access
functions.
Take care when making changes within the I/O variables (e.g. inserting and deleting I/O
variables, changing names and addresses):
• In some cases the internal addressing of other I/O variables may change, making all I/O
variables inconsistent.
• If this happens, all program sources that contain accesses to I/O variables must be
recompiled.
Note
I/O variables can only be created in offline mode. You create the I/O variables in SIMOTION
SCOUT and then use them in your program sources (e.g. ST sources, MCC sources,
LAD/FBD sources).
Outputs can be read and written to, but inputs can only be read.
Before you can monitor and modify new or updated I/O variables, you must download the
project to the target system.
You can use I/O variables like any other variable, see "Access I/O variables (Page 226)".
Table 5-30 Syntax for the input of the I/O addresses for direct access or process image of the cyclic tasks
Examples:
Input at logic address 1022, WORD data type: PIW1022.
Output at logical address 63, bit 3, BOOL data type: PQ63.3.
Note
Observe the rules for I/O addresses for direct access and the process image of the cyclical
tasks (Page 216).
Table 5-31 Possible data types of the I/O variables for direct access and the process image of the
cyclical tasks
Data type of I/O address Possible data types for I/O variables
BOOL (PIn.x, PQn.x) BOOL
BYTE (PIBn, PQBn) BYTE, SINT, USINT
WORD (PIWn, PQWn) WORD, INT, UINT
DWORD (PIDn, PQDn) DWORD, DINT, UDINT
For details of the data type of the I/O address, see also "Syntax for entering I/O
addresses (Page 219)".
NOTICE
I/O addresses that are accessed with the process image of the cyclic tasks must not be
used. These addresses cannot be read or written to with the fixed process image of the
BackgroundTask.
Note
The rules for I/O addresses for direct access and the process image of the cyclical
tasks (Page 216) do not apply. The accesses to the fixed process image of the
BackgroundTask are not taken into account during the consistency check of the project (e.g.
during download).
Addresses not present in the I/O or not configured in HW Config are treated like normal
memory addresses.
You can access the fixed process image of the BackgroundTask by means of:
● Using an absolute PI access (Page 221): The absolute PI access identifier contains the
address of the input/output and the data type.
● Using a symbolic PI access (Page 223): You declare a variable that references the
relevant absolute PI access.
– A unit variable
– A static local variable in a program.
● Using an I/O variable (Page 225): In the symbol browser, you define a valid I/O variable
for the entire device that references the corresponding absolute PI access.
NOTICE
Please observe that if the inputs and outputs work with the Little Endian byte order (e.g. the
integrated digital inputs of the SIMOTION devices C230-2 or C240) and the following
conditions are fulfilled:
1. The inputs and outputs are configured to an address 0 .. 62.
2. An I/O variable for direct access (data type WORD, INT or UINT) has been created for
these inputs and outputs.
3. You also access these inputs and outputs via the fixed process image of the
BackgroundTask.
then the following is valid:
• Access with the data type WORD supplies the same result via the I/O variable and the
fixed process image of the BackgroundTask.
• The access to the individual bytes with the _getInOutByte function (see SIMOTION
Basic Functions Function Manual) supplies these in the Little Endian order.
• Access to the individual bytes or bits with the fixed process image of the
BackgroundTask supplies these in the Big Endian order.
For information on the order of the bytes Little Endian and Big Endian: Please refer to the
SIMOTION Basic Functions Function Manual.
5.3.4.1 Absolute access to the fixed process image of the BackgroundTask (absolute PI access)
You make absolute access to the fixed process image of the BackgroundTask (Page 220) by
directly using the identifier for the address (with implicit data type). The syntax of the
identifier (Page 222) is described in the following section.
You can use the identifier for the absolute PI access in the same manner as a normal
variable (Page 222).
Note
Outputs can be read and written to, but inputs can only be read.
5.3.4.2 Syntax for the identifier for an absolute process image access
For the absolute access to the fixed process image of the BackgroundTask (Page 221), use
the following syntax. This specifies not only the address, but also the data type of the access
and the mode of access (input/output).
You also use these identifiers:
● For the declaration of a symbolic access to the fixed process image of the
BackgroundTask (Page 223).
● For the creation of an I/O variables for accessing the fixed process image of the
BackgroundTask (Page 225).
Table 5-32 Syntax for the identifier for an absolute process image access
Examples
Input at logic address 62, WORD data type: %IW62.
Output at logical address 63, bit 3, BOOL data type: %Q63.3.
NOTICE
Addresses that are accessed with the process image of the cyclic tasks must not be used.
These addresses cannot be read or written to with the fixed process image of the
BackgroundTask.
Note
The rules for I/O addresses for direct access and the process image of the cyclical
tasks (Page 216) do not apply. The accesses to the fixed process image of the
BackgroundTask are not taken into account during the consistency check of the project (e.g.
during download).
Addresses not present in the I/O or not configured in HW Config are treated like normal
memory addresses.
Several examples for the assignment of variables of the same type follow:
5.3.4.3 Symbolic access to the fixed process image of the BackgroundTask (symbolic PI access)
You can access the fixed process image of the BackgroundTask (Page 220) symbolically
without needing to always specify the absolute process image access.
You can declare symbolic access:
● As a static variable of a program (within the VAR/END_VAR structure in the declaration
section)
● As a unit variable (within the VAR_GLOBAL / END_VAR structure in the interface or
implementation section of the ST source file)
The syntax for declaring a symbolic name for the PI access is shown in the figure:
6\PEROLF3,DFFHVV XQIRUPDWWHG
,QWHJHU
GDWDW\SH
$EVROXWH3,
,GHQWLILHU $7 DFFHVV
%LWGDWDW\SH
5DQJHRIGHFODUHGGDWDW\SHPXVW
FRUUHVSRQGWRWKHUDQJHRIWKH
DEVROXWHLGHQWLILHU
For the absolute PI access, see "Syntax for the identifier for an absolute PI
access (Page 222)".
The range of the declared integer or bit data type must correspond to the range of the
absolute PI access, see "Possible data types of the symbolic PI access (Page 224)". After
declaring a numerical data type, you can address the contents of the process image as an
integer.
See also Example for the declaration (Page 224).
VAR
myInput AT %IB10 : BYTE;
END_VAR
If you want to use the integer value of the memory area, declare the myInput variable as
follows:
VAR
myInput AT %IB10 : SINT;
END_VAR
If you want to use a CPU memory area other than %IB10 in your program at a later time, you
only need to change the absolute PI access in the variable declaration.
5.3.4.6 Creating an I/O variable for access to the fixed process image of the BackgroundTask
You create I/O variables in the symbol browser of the detail view; to do this, you must be
working in offline mode.
Here is a brief overview of the procedure:
1. In the project navigator of SIMOTION SCOUT, select the I/O element in the subtree of the
SIMOTION device.
2. In the detail view, select the Symbol browser tab and scroll down to the end of the
variable table (empty row).
3. In the last (empty) row of the table, enter or select the following:
– Name of variable.
– Under I/O address, the absolute PI access according to the "syntax for the identifier
for an absolute PI access (Page 222)"
(exception: The syntax %IXn.x or %QXn.x is not permitted for data type BOOL).
– Data type of the I/O variables according to the "possible data types of the symbolic PI
access (Page 224)".
4. Select optionally the display format used to monitor the variable in the symbol browser.
You can now access this variable using the symbol browser or any program of the
SIMOTION device.
Note
I/O variables can only be created in offline mode. You create the I/O variables in SIMOTION
SCOUT and use them in your program sources.
Note that you can read and write outputs but you can only read inputs.
Before you can monitor and modify new or updated I/O variables, you must download the
project to the target system.
You can use I/O variables like any other variable, see "Access I/O variables (Page 226)".
NOTICE
Consistency is only ensured for elementary data types.
When using arrays, the user is responsible for ensuring data consistency.
Note
If you have declared unit variables or local variables of the same name (e.g. var-name),
specify the I/O variable using _device.var-name (predefined namespace, see the
"Predefined namespaces" table in "Namespaces").
It is possible to directly access an I/O variable that you created as a process image of a
cyclic task. Specify direct access with _direct.var-name or _device._direct.var-name.
If you want to deviate from the default behavior when errors occur during variable access,
you can use the _getSafeValue and _setSafeValue functions (see SIMOTION Basic
Functions Function Manual).
For errors associated with access to I/O variables, see SIMOTION Basic Functions Function
Manual.
NOTICE
The same rules as for the names of program source files apply to the library names, see
Insert ST source file (Page 21). In particular, the permissible length of the name depends
on the SIMOTION Kernel version:
• As of Version V4.1 of the SIMOTION Kernel: maximum 128 characters.
• Up to Version V4.0 of the SIMOTION Kernel: maximum 8 characters.
With versions of the SIMOTION Kernel up to V4.0, a violation of the permissible length of
the library name may not be detected until a consistency check or a download of the project
is performed!
Prohibited commands:
• _getTaskId function (see SIMOTION Basic Functions Function Manual).
• _getAlarmId function (see SIMOTION Basic Functions Function Manual).
• _checkEqualTask function (see SIMOTION Basic Functions Function Manual).
• Following functions that are intended for SIMOTION kernel versions up to V3.0:
– Task control commands
– Commands for runtime measurement of tasks
– Commands for message programming
With these functions, the name of the task of the configured message is transferred.
• If the library is not device-dependent (i.e. compiled without reference to a SIMOTION device or
SIMOTION Kernel version):
– System functions of SIMOTION devices (see the Parameter Manual for SIMOTION devices)
– Version-dependent system functions
Note
The Program status debug function is not available in libraries.
NOTICE
If the library to be compiled imports another library, note the following:
1. For the imported library, at least the same devices and SIMOTION kernel versions must
be selected as for the importing library.
Alternatively, the imported library can be compiled independently of devices if the
prerequisites for this are fulfilled (refer to the SIMOTION Basic Functions Function
Manual).
2. The imported library must already be compiled individually with reference to all
configured devices, kernel versions and technology packages.
Compilation of the library as part of a project-wide compilation is generally not sufficient.
NOTICE
When performing project-wide compilation, note the following:
1. The system automatically identifies dependencies between libraries and selects the
appropriate compilation sequence.
2. A library is only compiled with reference to the SIMOTION devices (including versions of
the SIMOTION kernel) that are configured in the project and which use the library.
3. Other SIMOTION devices and kernel versions set for the library are ignored.
Note
If you export in XML format, the libraries or sources are exported in an encrypted form.
When importing the encoded XML files, the know-how protection, including login and
password, remains in place.
5.4.3 Using data types, functions and function blocks from libraries
Before using data types, functions or function blocks from libraries, you must make them
known to the ST source file. To do so, use the following construct in the interface section of
the ST source file:
In this case, library-name is the name of the library as it appears in the project navigator.
When multiple libraries are to be specified, enter them as a list separated by commas, e.g.:
You can use the optional AS namespace add-on to define a namespace (see
Namespaces (Page 233)).
● You can then access data types, functions, and function blocks in the library that have the
same name as such an ST source file of a SIMOTION device (in the PROGRAMS folder).
● You can also use namespaces to change the names of data types, functions and function
blocks in the library so that they have different names.
You can also assign the same namespace to different libraries.
IMPLEMENTATION
FUNCTION Function1 : VOID
VAR
ComID : CommandIdType;
END_VAR
ComId := _getCommandId();
END_FUNCTION
PROGRAM Main_program
function1(); // Function from this source
NS_1.Var1:=1;
NS_2.Var1:=2;
NS_1.function1(); // Function from the Bib1 library
NS_2.function1(); // Function from the Bib2 library
END_PROGRAM
END_IMPLEMENTATION
NOTICE
Under certain circumstances, the compiler may not issue a warning if, for example, the
associated technology package is not imported.
Identifiers in a unit
All following identifiers in a unit must be unique:
● Unit variables (declared in the interface or implementation section)
● Data types (declared in the interface or implementation section)
● Program organization units (POUs)
These must not be identical to the following identifiers either:
● Reserved identifiers.
● Unit variables, data types and POU imported units.
● Standard system functions, standard system function blocks and associated data types.
● System functions and system data types of the SIMOTION device.
● Program organization units (POU) and data types from imported libraries.
– This can be resolved by entering a user-defined namespace.
● System functions and system data types from imported technology packages.
– This can be resolved by entering a user-defined namespace.
The compiler issues a warning when the following identifiers are hidden:
● SIMOTION device variables (system variables, I/O variables, global device variables).
– This can be resolved by entering the predefined namespace _device.
● Technology objects configured on the SIMOTION device.
– This can be resolved by entering the predefined namespace _to.
Identifiers on the SIMOTION device (e.g., I/O variables, global device variables)
All the following identifiers on the SIMOTION device must be unique:
● I/O variables
● Global device variables
● System variables of the SIMOTION device
● System functions and system data types of the SIMOTION device.
These must not also be identical to the following identifiers:
● Reserved identifiers.
● Standard system functions, standard system function blocks and associated data types.
Example
The following example illustrates this situation. It shows that for use of identical names for
unit variables (large validity range) and FC variables (small variable scope), only the
variables declared in the function are valid within this source file section. The unit variables
are only valid in POUs in which no local variables of the same name were declared. See the
example.
VAR_GLOBAL
var_a, var_b : DINT; // Unit variables
END_VAR
5.5.2 Namespaces
You can also access data types, unit variables, functions, and function blocks defined
outside of a program source (e.g. in libraries, technology packages, and on the SIMOTION
device) using their names.
When compiling a program source, the compiler searches for identifiers beginning with the
current POU. The data types, variables, functions, or function blocks declared in a program
source therefore hide identifiers with the same name which have been defined outside the
source, see Use of the same identifiers (Page 231). In order to still access these hidden
identifiers, you can use namespaces in certain cases.
User-defined namespace
In the import instruction for libraries and technology packages, you can define namespaces
in order to reach the data types, functions, or function blocks of these libraries and
technology packages.
Example
The following example shows how to select the Cam technology package, assign it the
namespace Cam1 and use the namespace:
INTERFACE
USEPACKAGE Cam AS Cam1;
USES ST_2;
FUNCTION function1;
END_INTERFACE
IMPLEMENTATION
FUNCTION function1 : VOID
VAR_INPUT
p_Axis : posAxis;
END_VAR
VAR
retVal : DINT;
END_VAR
retVal:= Cam1._enableAxis (
axis := p_Axis,
nextCommand := Cam1.WHEN_COMMAND_DONE,
commandId := _getCommandId() );
END_FUNCTION
END_IMPLEMENTATION
NOTICE
If a namespace is defined for an imported library or technology package, this must always
be specified if a function, function block, or data type from this library or technology
package is being used. See above example: Cam1._enableAxis,
Cam1.WHEN_COMMAND_DONE.
Predefined namespace
Namespaces are predefined for device- and project-specific variables as well as TaskID and
AlarmID variables. If necessary, write their designation before the variable names, separated
by a period, for example, _device.var-name or _task.task-name
,GHQWLILHUVRIWKHQDPHVSDFHV +LHUDUFK\
3URMHFW
8VHUGHILQHG 7HFKQRORJ\SDFNDJHV
6\VWHPIXQFWLRQVDQGV\VWHPGDWDW\SHVRIWKH72
8VHUGHILQHG /LEUDULHV
)XQFWLRQV)XQFWLRQ%ORFNV'DWD7\SHV
BSURMHFW 'HYLFH
BWR 7HFKQRORJ\REMHFWV
&RQILJXUDWLRQGDWDRIWKH72
6\VWHPYDULDEOHVRIWKH72
BWDVN 7DVNQDPHV
BDODUP 0HVVDJHV
BGHYLFH 6\VWHPYDULDEOHVRIWKHGHYLFH
*OREDOGHYLFHYDULDEOHV
,2YDULDEOHV
3URFHVVLPDJHRIWKHF\FOLF7DVNV
BGLUHFW 'LUHFWDFFHVV
,(&DQGGHYLFHV\VWHPGDWDW\SHV
,(&DQGGHYLFHV\VWHPIXQFWLRQV
8QLWYDULDEOHVXQLWGDWDW\SHV
3URJUDPRUJDQL]DWLRQXQLWV
/RFDOYDULDEOHVDQGGDWDW\SHV
BSURMHFW 'HYLFH
BWR 7HFKQRORJ\REMHFWV
6\VWHPYDULDEOHVRIWKH72
See also
Cross-reference list (Page 237)
Program structure (Page 239)
Code attributes (Page 241)
Note
The generated cross-reference list is saved automatically and can be displayed
selectively after selecting the appropriate element in the project navigator. To display
the cross-reference list, select the Edit > Reference data > Display > Cross-Reference
List menu command.
When a cross-reference list is recreated, it is updated selectively (corresponding to the
selected element in the project navigator). Other existing cross-reference data are
retained and displayed, if applicable.
Note
Activated single-step monitoring in MCC programming
Each task is assigned two variables TSI#dwuser_1 and TSI#dwuser_2, which can be
written and read.
When single step monitoring is activated, the compiler uses these variables to control
single step monitoring if at least one MCC chart is assigned to the relevant task. The
user then cannot use these variables, because their contents are overwritten by single
step monitoring and may cause undesirable side effects.
Element Description
Base List separated by a comma
(declared POU or • Identifier of the program organization unit (POU) or task
task used))
• Identifier of the program source in which the POU or task was declared,
with add-on [UNIT]
• Minimum and maximum stack requirement (memory requirement of the
POU or task on the local data stack), in bytes [Min, Max]
• Minimum and maximum overall stack requirement (memory requirement of
the POU or task on the local data stack including all called POUs), in bytes
[Min, Max]
Referenced POU List separated by a comma:
• Identifier of called POU
• Optionally: Identifier of the program source / technology package in which
the POU was declared:
Add-on (UNIT): User-defined program source
Add-on (LIB): Library
Add-on (TP): System function from technology package
• Only for function blocks: Identifier of instance
• Only for function blocks: Identifier of program source in which the instance
was declared:
Add-on (UNIT): User-defined program source
Add-on (LIB): Library
• Line of (compiled) source in which the POU is called; several lines are
separated by "|".
3UDJPD XQIRUPDWWHG
3UHSURFHVVRUVWDWHPHQW
^ `
$WWULEXWH
NOTICE
Be sure to use the correct pragma syntax (e.g. upper- and lower-case notation of
attributes).
Unrecognized pragmas are ignored with no warning message.
Note
You can also view the text of the ST source file modified by the preprocessor:
1. Open the ST source file.
2. Select the ST source file > Execute preprocessor menu command.
The modified source text is shown in the "Compile/check output" tab of the detail view.
3UHSURFHVVRUVWDWHPHQW XQIRUPDWWHG
XQGHI ,GHQWLILHU
LIGHI ,GHQWLILHU
LIQGHI ,GHQWLILHU
HOVH
HQGLI
(DFKVWDWHPHQWPXVWEHJLQZLWKDQHZOLQHDQGHQGZLWKDOLQHEUHDN
7KHIROORZLQJRUGHUPXVWEHPDLQWDLQHGIRUWKHVWDWHPHQWVEHORZ
LIGHIಥHOVH RSWLRQDO ಥHQGLIRULIQGHIಥHOVH RSWLRQDO ಥHQGLI
7H[W6WULQJRIDQ\FKDUDFWHUVH[FHSW
? EDFNVODVK ಫ VLQJOHTXRWH DQGಯ GRXEOHTXRWH
7KHNH\ZRUGV86(686(/,%DQG86(3$&.$*(DUHQRWSHUPLWWHG
Statement Meaning
#define The specified identifier will be replaced below by the specified text.
Permissible characters: See table footnote.
#undef The replacement rule for the identifier is cancelled.
#ifdef For variant formation (conditional compilation)
If the specified identifier is defined, the following program lines (until the next
pragma that contains #else or #endif) are compiled by the compiler.
#ifndef For variant formation (conditional compilation)
If the specified identifier is not defined, the following program lines (until the next
pragma that contains #else or #endif) are compiled by the compiler.
#else For variant formation (conditional compilation)
Alternative branch to #ifdef or #ifndef.
The following program lines (until the next pragma containing #endif) are
compiled by the compiler, if the preceding query with #ifdef or #ifndef was not
fulfilled.
#endif Concludes variant formation with #ifdef or #ifndef.
Permissible characters:
• For identifiers: In accordance with the rules for identifiers (Page 73).
• For text: Sequence of any characters other than \ (backslash), ’ (single quote) and ” (double
quote). The keywords USES, USELIB and USEPACKAGE are not permitted.
Note
Each preprocessor statement must begin with a new line and end with a line break.
Consequently, the curly brackets ({ and }) enclosing the pragma must be placed in separate
lines of the ST source file!
In the case of pragmas with #define statements, please note:
• Pragmas with #define statements in the interface section of an ST source file are
exported. The defined identifiers can be imported with the USES statement into other ST
source files of the same SIMOTION device or of the same library.
• Identifiers defined in pragmas of libraries cannot be imported into ST source files of a
SIMOTION device.
• Redefinition of reserved identifiers is not possible.
You can also make preprocessor definitions in the property dialog box of the ST source file.
In the case of different definitions of the same identifiers, #define statements within the ST
source file have priority.
IMPLEMENTATION IMPLEMENTATION
FUNCTION f : INT FUNCTION f : INT
VAR_INPUT VAR_INPUT
i : INT; i : INT;
END_VAR END_VAR
f := i; f := i;
END_FUNCTION END_FUNCTION
$WWULEXWH XQIRUPDWWHG
$WWULEXWHLGHQWLILHU $WWULEXWHYDOXH
,GHQWLILHU 7H[W
NOTICE
Be sure to use the correct upper- and lower-case notation for attributes!
Note
The insert, delete or change of the HMI_Export, BlockInit_OnChange or
BlockInit_OnDeviceRun attributes in a declaration block does not change its version
identification!
IMPLEMENTATION
VAR_GLOBAL
{ HMI_Export := TRUE;
BlockInit_OnDeviceRun := ALWAYS; }
// HMI export, initialization for the STOP -> RUN transition
y : DINT;
END_VAR
FUNCTION_BLOCK fb1
VAR_INPUT
i_var : INT;
END_VAR
VAR_OUTPUT
o_var : INT;
END_VAR
{ _U7_PoeBld_CompilerOption := warning:2:on; }
o_var := REAL_TO_INT(1.0); // Warning 16004
{ _U7_PoeBld_CompilerOption := warning:2:off; }
o_var := REAL_TO_INT(1.0); // No warning 16004
{ _U7_PoeBld_CompilerOption := warning:16004:on; }
o_var := REAL_TO_INT(1.0); // Warning 16004
{ _U7_PoeBld_CompilerOption := warning:16004:off; }
o_var := REAL_TO_INT(1.0); // No warning 16004
{ _U7_PoeBld_CompilerOption := warning:2:off;
_U7_PoeBld_CompilerOption := warning:16004:on; }
o_var := REAL_TO_INT(1.0); // Warning 16004
END_FUNCTION_BLOCK
END_IMPLEMENTATION
Note
You should only use the GOTO statement in special circumstances (for example, for
troubleshooting). It should not be used at all according to the rules for structured
programming.
Jumps are only permitted within a POU.
The following jumps are illegal:
• Jumps to subordinate control structures (WHILE, FOR, etc.)
• Jumps from a WAITFORCONDITION structure
• Jumps within CASE statements
Jump labels can only be declared in the POU in which they are used. If jump labels are
declared, only the declared jump labels may be used.
Setting Meaning
Process mode Program execution on the SIMOTION device is optimized for maximum system performance.
The following diagnostic functions are available, although they may have only restricted
functionality because of the optimization for maximum system performance:
• Monitor variables in the symbol browser or a watch table.
• Program status (only restricted):
– Restricted monitoring of variables (e.g. variables in loops, return values for system
functions).
– As of version V4.0 of the SIMOTION kernel:
No more than one program source (e.g. ST source, MCC source, LAD/FBD source) can
be monitored per task.
– Up to version V3.2 of the SIMOTION kernel:
No more than one program source (e.g. ST source, MCC source, LAD/FBD source) can
be monitored.
• Trace tool (only restricted) with measuring functions for drives and function generator, see
online help:
– No more than one trace on each SIMOTION device.
Test mode The diagnostic functions of the process mode are available to the full extent:
• Monitor variables in the symbol browser or a watch table.
• Program status:
– Monitoring of all variables possible.
– As of version V4.0 of the SIMOTION kernel:
Several program sources (e.g. ST sources, MCC sources, LAD/FBD sources) can be
monitored per task.
– Up to version V3.2 of the SIMOTION kernel:
No more than one program source (e.g. ST source, MCC source, LAD/FBD source) can
be monitored per task.
• Trace tool with measuring functions for drives and function generator, see online help:
– No more than four traces on each SIMOTION device.
Note
Runtime and memory utilization increase as the use of diagnostic functions increases.
Debug mode This mode is available in SIMOTION kernel as of V3.2.
In addition to the diagnostic functions of the test mode, you can use the following functions:
• Breakpoints
Within a program source file, you can set breakpoints (Page 271). When an activated
breakpoint is reached, selected tasks will be stopped.
• Controlling MotionTasks
In the "Task Manager" tab of the device diagnostics, you can use task control commands for
MotionTasks, see the SIMOTION Basic Functions Function Manual.
No more than one SIMOTION device of the project can be switched to debug mode.
SIMOTION SCOUT is in online mode, i.e. connected with the target system.
Observe the following section: Important information about the life-sign monitoring (Page 254).
WARNING
You must observe the appropriate safety regulations.
Use the debug mode or a control panel only with the life-sign monitoring function activated
with a suitably short monitoring time! Otherwise, if problems occur in the communication
link between the PC and the SIMOTION device, the axis may start moving in an
uncontrollable manner.
The function is released exclusively for commissioning, diagnostic and service purposes.
The function should generally only be used by authorized technicians. The safety
shutdowns of the higher-level control have no effect.
Therefore, there must be an EMERGENCY STOP circuit in the hardware. The appropriate
measures must be taken by the user.
NOTICE
Pressing the spacebar or switching to a different Windows application causes:
• In debug mode for activated breakpoints:
– The SIMOTION device switches to STOP mode.
– The outputs are deactivated (ODIS).
• For controlling an axis or a drive using the control panel (control priority for the PC):
– The axis or the drive is brought to a standstill.
– The enables are reset.
WARNING
This function is not guaranteed in all operating modes. Therefore, there must be an
EMERGENCY STOP circuit in the hardware. The appropriate measures must be taken by
the user.
Field Description
Life-sign monitoring The SIMOTION device and SIMOTION SCOUT regularly
exchange life-sign signals to ensure a correctly functioning
connection. If the exchange of the life-sign is interrupted longer
than the set monitoring time, the following response occurs:
• In debug mode for activated breakpoints:
– The SIMOTION device switches to STOP mode.
– The outputs are deactivated (ODIS).
• For controlling an axis or a drive using the control panel
(control priority for the PC):
– The axis is brought to a standstill.
– The enables are reset.
The following parameterizations are possible:
• Active check box:
If the check box is selected, life-sign monitoring is active.
The deactivation of the life-sign monitoring is not always
possible.
• Monitoring time:
Enter the timeout.
Prudence
Do not make any changes to the defaults for life-sign
monitoring, if possible.
Changes should only be made in special circumstances and in
observance of all danger warnings.
Safety information Please observe the warning!
Click the button to obtain further safety information.
See: Important information about the life-sign
monitoring (Page 254)
Requirements
● Make sure that a connection to the target system has been established and a project has
been downloaded to the target system. To load the project with the sample program, see
"Executing the sample program (Page 66)".
● You can run the user program, but you do not have to. If the program is not run, you only
see the initial values of the variables.
The procedure depends on the memory area in which the variables to be monitored are
stored.
Note
You can monitor temporary variables (together with unit variables and static variables) with
Program status (see Properties of the program status (Page 265)).
Figure 6-1 Displaying the contents of variables using the symbol browser
NOTICE
Note when you change the values of several variables:
The values are written sequentially to the variables. It can take several milliseconds until
the next value is written. The variables are changed from top to bottom in the symbol
browser. There is therefore no guarantee of consistency.
LED Meaning
1.#QNAN Invalid bit pattern in accordance with IEEE 754 (NaN Not a Number) There is no
-1.#QNAN distinction between signaling NaN (NaNs) and quiet NaN (NaNq).
1.#INF Bit pattern for + infinity in accordance with IEEE 754
-1.#INF Bit pattern for – infinity in accordance with IEEE 754
-1.#IND Bit pattern for indeterminate
NOTICE
Note when you change the values of several variables:
The values are written sequentially to the variables. It can take several milliseconds until
the next value is written. The variables are changed from top to bottom in the watch table.
There is therefore no guarantee of consistency.
LED Meaning
1.#QNAN Invalid bit pattern in accordance with IEEE 754 (NaN Not a Number) There is no
-1.#QNAN distinction between signaling NaN (NaNs) and quiet NaN (NaNq).
1.#INF Bit pattern for + infinity in accordance with IEEE 754
-1.#INF Bit pattern for – infinity in accordance with IEEE 754
-1.#IND Bit pattern for indeterminate
Name Meaning
taskbind.hid Execution system
stdfunc.pck IEC library
device.pck Device-specific library
tp-name.pck Library of the tp-name technology package,
e.g. cam.pck for the library of the CAM technology package.
Field Description
Selected CPU The selected SIMOTION device is displayed.
Refresh Clicking the button reads the current code positions from the
SIMOTION device and shows them in the open window.
Calling task Select the task for which you want to determine the code position
being executed.
All configured tasks of the execution system.
Current code position The position being executed in the program code (e.g. line of an ST
source file) is displayed (with the name of the program source file,
line number, name of the POU).
is called by The code positions that call the code position being executed within
the selected task are shown recursively (with the name of the
program source file, line number, name of the POU, and name of the
function block instance, if applicable).
For names of the SIMOTION RT program sources, refer to the table in "Program
run (Page 263)".
Symbol Meaning
Display program run
Click this button to open the Program run call stack window. In this window, you can
display the currently active code position with its call path.
See: Program run: Display code position and call path (Page 263)
Note
Due to the restricted buffer capacity and the requirement for minimum runtime tampering, the
following variables cannot be displayed:
• Complete arrays
• Complete structures
Individual array elements or individual structure elements are displayed, however, provided
an assignment is made in the ST source file.
Table 6-8 Differences between process mode and test mode in Program Status
NOTICE
Program status requires additional CPU resources.
Please note if you want to monitor several programs at the same time with the status
program:
• Test mode must be activated (see Operating modes of the SIMOTION
devices (Page 252))
• Up to version V4.0 of the SIMOTION Kernel, the programs must be assigned to various
tasks.
4. Click the button for program status in the ST editor toolbar (Page 43) to start this test
mode.
The ST editor window is now divided vertically: You can see the ST source file in the left
pane; the right pane displays the selected variables and their values.
● Variables without values, e.g. variables in an unused IF branch are shown in green and
marked with a question mark.
If the display of the variable values changes too fast:
● Click the button for Stop monitoring of program variables in the ST editor
toolbar (Page 43) to stop the display.
● Click the button for Continue monitoring of program variables in the ST editor
toolbar (Page 43) to continue the display.
You can force the update of the displayed values:
● Click the button for Update on the ST editor toolbar (Page 43).
The buffer of the SIMOTION device is read, even if the selected monitoring range has not
yet been completely processed and the values are incomplete. This can be useful, for
example, if the program is waiting for a WAITFORCONDITION statement.
The monitoring of the program variables must have been activated.
NOTICE
Note the following if you use Program Status in devices with SIMOTION kernels up to V3.1:
• If the project was compiled using SIMOTION SCOUT up to version V3.1, the call path is
not available in the described format. You can only use the diagnosis functions available
at the time of compilation.
• You can only specify the call path if the project was compiled using SIMOTION SCOUT
version V3.2 or higher.
When performing a recompilation with the current version of the compiler, note the
following:
• Among other effects, this generates new version identifiers in the data storage areas of
the programs.
• All retentive and non-retentive data on the SIMOTION device is deleted and initialized.
• In some cases, minor changes to the program sources may be required.
• When converting back to the old project status, the project must be recompiled.
Field Description
Calling task Select the task.
All tasks in which the selected code position is called are available
for selection.
Current code position The selected section of the POU (code position) is shown (with the
name of the ST source file, line number, name of the POU)
is called by Select the calling code position.
The following are available:
• The code positions to be called within the selected task (with the
name of the program source, line number, name of the POU).
If the selected calling code position is in turn called by several
code positions, further lines are displayed in which you proceed
similarly.
• All:
All displayed code positions are selected. Moreover, all code
positions (up to the top level of the hierarchy) are selected from
which the displayed code positions are called.
6.2.6 Breakpoints
Requirement:
● The program source with the POU (e.g. ST source file, MCC chart, LAD/FBD program) is
open.
Proceed as follows
Follow these steps:
1. Select "Debug mode" for the associated SIMOTION device,
see Set debug mode (Page 271).
2. Specify the debug task group, see Specifying the debug task group (Page 273).
3. Set breakpoints, see Setting breakpoints (Page 276).
4. Define the call path, see Defining a call path for a single breakpoint (Page 279).
5. Activate the breakpoints, see Activating breakpoints (Page 285).
WARNING
You must observe the appropriate safety regulations.
Use the debug mode only with activated life-sign monitoring (Page 254) with a suitably
short monitoring time! Otherwise, if problems occur in the communication link between the
PC and the SIMOTION device, the axis may start moving in an uncontrollable manner.
The function is released exclusively for commissioning, diagnostic and service purposes.
The function should generally only be used by authorized technicians. The safety
shutdowns of the higher-level control have no effect!
Therefore, there must be an EMERGENCY STOP circuit in the hardware. The appropriate
measures must be taken by the user.
Note
You cannot change the program sources in debug mode!
NOTICE
Pressing the spacebar or switching to a different Windows application causes in debug
mode for activated breakpoints:
• The SIMOTION device switches to STOP mode.
• The outputs are deactivated (ODIS).
WARNING
This function is not guaranteed in all operating modes. Therefore, there must be an
EMERGENCY STOP circuit in the hardware. The appropriate measures must be taken by
the user.
Requirement
● The relevant SIMOTION device is in debug mode.
Proceed as follows
How to assign a task to the debug task group:
1. Highlight the relevant SIMOTION device in the project navigator.
2. Select Debug task group from the context menu.
The Debug Task group window opens.
3. Select the tasks to be stopped on reaching the breakpoint:
– If you only want to stop individual tasks (in RUN mode): Activate the Debug task group
selection option.
Assign all tasks to be stopped on reaching a breakpoint to the Tasks to be stopped
list.
– If you only want to stop individual tasks (in HALT mode): Activate the All tasks
selection option.
In this case, also select whether the outputs and technology objects are to be released
again after resumption of program execution.
NOTICE
Note the different behavior when an activated breakpoint is reached, see the following
table.
Table 6-10 Behavior at the breakpoint depending on the tasks to be stopped in the debug task group.
Note
You can only make changes to the debug task group if no breakpoints are active.
Proceed as follows:
1. Set breakpoints (see Setting breakpoints (Page 276)).
2. Define the call path (see Defining a call path for a single breakpoint (Page 279)).
3. Activate the breakpoints (see Activating breakpoints (Page 285)).
Field Description
Debug task group Select this selection option if you only want to stop individual tasks.
The SIMOTION device remains in RUN mode after an activated
breakpoint is reached. Outputs and technology objects remain
activated.
Assign all tasks to be stopped on reaching a breakpoint to the Tasks
to be stopped list.
All tasks Select this selection option if you only want to stop all user tasks.
The SIMOTION device remains in STOP mode after an activated
breakpoint is reached, all outputs and technology objects will be
deactivated (ODIS activated).
In this case, also select whether the outputs and technology objects
are to be released again after resumption of program execution.
'Resume' activates the outputs Only if All tasks is selected.
(ODIS deactivated). Activate the checkbox, to release again the outputs and technology
objects after program execution has been resumed.
All outputs and technology objects can only be released after a
download of the project with deactivated checkbox.
NOTICE
Note the different behavior at the activated breakpoint depending on the tasks to be
stopped, see table in Define the debug task group (Page 273).
You can only make changes to the debug task group if no breakpoints are active.
Field Description
Debug points (table)
Active The activation state of the breakpoint is displayed.
Click the checkbox to change the activation state.
See: Activating breakpoints (Page 285).
Source, line (POU) The code position is shown with the debug point set (with the name of
the program source file, line number, name of the POU).
Debug type The type of the debug point is shown (e.g. breakpoint, trace point).
Call path Click the button to define the call path for the breakpoint.
See: Defining the call path for a single breakpoint (Page 279).
All breakpoints ...
Activate Click the button to activate all breakpoints (in all program sources) of the
SIMOTION device.
See: Activating breakpoints (Page 285).
Deactivate Click the button to deactivate all breakpoints (in all program sources) of
the SIMOTION device.
See: Activating breakpoints (Page 285).
Delete Click the button to clear all breakpoints (in all program sources) of the
SIMOTION device.
See: Setting breakpoints (Page 276).
Requirements:
1. The program source with the POU (e.g. ST source file, MCC chart, LAD/FBD program) is
open.
2. The relevant SIMOTION device is in debug mode,
see Setting debug mode (Page 271).
3. The debug task group is defined, see Defining the debug task group (Page 273).
Proceed as follows
How to set a breakpoint:
1. Select the code location where no breakpoint has been set:
– SIMOTION ST: Place the cursor on a line in the ST source file that contains a
statement.
– SIMOTION MCC: Select an MCC command in the MCC chart (except module or
comment block).
– SIMOTION LAD/FBD: Set the cursor in a network of the LAD/FBD program.
2. Alternative:
– Select the Edit > Set breakpoint menu command.
– Click the button in the Breakpoints toolbar.
To remove a breakpoint, proceed as follows:
1. Select the code position with the breakpoint.
2. Alternative:
– Select the Edit > Set breakpoint menu command.
– Click the button in the Breakpoints toolbar.
To remove all breakpoints (in all program sources) of the SIMOTION device, proceed as
follows:
● Alternative:
– Select the Debug > Remove all breakpoints menu command.
– Click the button in the Breakpoints toolbar.
Note
You cannot set breakpoints:
• For SIMOTION ST: In lines that contain only comment.
• For SIMOTION MCC: On the module or comment block commands.
• For SIMOTION LAD/FBD: Within a network.
• At code locations in which other debug points (e.g. trigger points) have been set.
You can list the debug points in all program sources of the SIMOTION device in the debug
table:
• Click the button for "debug table" in the Breakpoints toolbar.
In the debug table, you can also remove all breakpoints (in all program sources) of the
SIMOTION device:
• Click the button for "Clear all breakpoints".
Set breakpoints remain saved also after leaving the "debug mode", they are displayed only
in debug mode.
You can use the program status (Page 266) diagnosis functions and breakpoints together in
a program source file or POU. However, the following restrictions apply depending on the
program languages:
● SIMOTION ST: For Version V3.2 of the SIMOTION Kernel, the (marked) ST source file
lines to be tested with program status must not contain a breakpoint.
● SIMOTION MCC and LAD/FBD: The commands of the MCC chart (or networks of the
LAD/FBD program) to be tested with program status must not contain a breakpoint.
Proceed as follows
1. Define the call path, see Defining a call path for a single breakpoint (Page 279).
2. Activate the breakpoints, see Activating breakpoints (Page 285).
Symbol Meaning
Set/remove breakpoint
Click this icon to set at breakpoint for the selected code position or to remove an
existing breakpoint.
See: Setting breakpoints (Page 276).
Activate/deactivate breakpoint
Click this icon to activate or deactivate the breakpoint at the selected code position.
See: Activating breakpoints (Page 285).
Edit the call path
Click this icon to define the call path for the breakpoints:
• If a code position with breakpoint is selected: The call path for this breakpoint.
• If a code position without breakpoint is selected: The call path for all breakpoints
of the POU.
See: Defining the call path for a single breakpoint (Page 279), Defining the call path
for all breakpoints (Page 282).
Activate all breakpoints
Click this icon to activate all breakpoints in the current program source or POU (e.g.
ST source file, MCC chart, LAD/FBD program).
See: Activating breakpoints (Page 285).
Deactivate all breakpoints
Click this icon to deactivate all breakpoints in the current program source or POU
(e.g. ST source file, MCC chart, LAD/FBD program).
See: Activating breakpoints (Page 285).
Remove all breakpoints
Click this icon to remove all breakpoints in the current program source or POU (e.g.
ST source file, MCC chart, LAD/FBD program).
See: Setting breakpoints (Page 276).
Symbol Meaning
Debug table
Click this icon to display the debug table.
See: Debug table parameters (Page 276).
Display call stack
Click this icon after reaching an activated breakpoint to:
• View the call path at the current breakpoint.
• View the code positions at which the other tasks of the debug task group have
been stopped together with their call path.
See: Displaying the call stack (Page 287).
Resume
Click this icon to continue the program execution after reaching an activated
breakpoint.
See: Activating breakpoints (Page 285), Displaying the call stack (Page 287).
Requirements:
1. The program source with the POU (e.g. ST source file, MCC chart, LAD/FBD program) is
open.
2. The relevant SIMOTION device is in debug mode,
see Setting debug mode (Page 271).
3. The debug task group is defined, see Defining the debug task group (Page 273).
4. Breakpoint is set, see Setting breakpoints (Page 276).
Proceed as follows
To define the call path for a single breakpoint, proceed as follows:
1. Select the code location where a breakpoint has already been set:
– SIMOTION ST: Set the cursor in an appropriate line of the ST source.
– SIMOTION MCC: Select an appropriate command in the MCC chart.
– SIMOTION LAD/FBD: Set the cursor in an appropriate network of the LAD/FBD
program.
2. Click the button for "edit call path" in the Breakpoints toolbar.
In the Call path / task selection breakpoint window, the marked code position is displayed
(with the name of the program source file, line number, name of the POU).
3. Select the task in which the user program (i.e. all tasks in the debug task group) will be
stopped when the selected breakpoint is reached.
Note
You can also define the call path to the individual breakpoints in the debug table:
1. Click the button for "debug table" in the Breakpoints toolbar.
The "Debug table" window opens.
2. Click the appropriate button in the "Call path" column.
3. Proceed in the same way as described above:
– Specify the task.
– Define the call path (only for functions and function blocks).
– Specify the number of passes after which the breakpoint is to be activated.
Proceed as follows:
Note
You can use the "Display call stack (Page 287)" function to view the call path at a current
breakpoint and the code positions at which the other tasks of the debug task group were
stopped.
See also
Defining the call path for all breakpoints (Page 282)
Field Description
Selected CPU The selected SIMOTION device is displayed.
Calling task Select the task in which the user program (i.e. all tasks in the debug
task group) will be stopped when the selected breakpoint is reached.
The following are available:
• All calling locations starting at this call level
The user program will always be started when the activated
breakpoint in any task of the debug task group is reached.
• The individual tasks from which the POU with the selected
breakpoint can be reached.
The user program will be stopped only when the breakpoint in
the selected task is reached. The task must be in the debug task
group.
The specification of a call path is possible.
Current code position The code position is shown with the set breakpoint (with the name of
the program source file, line number, name of the POU).
Field Description
is called by Only for functions and function blocks:
Select the call path, i.e. the code position to be called (in the calling
POU).
The following are available:
• All calling locations starting at this call level
No call path is specified. The user program will always be
stopped at the activated breakpoint when the POU in the tasks is
reached.
• Only when a single task is selected: The code positions to be
called within the selected task (with the name of the program
source, line number, name of the POU).
The call path is specified. The user program will be stopped at
the activated breakpoint only when the POU is called from the
selected code position.
If the POU of the selected calling code position is also called
from other code positions, further lines are displayed
successively in which you proceed similarly.
The breakpoint will be If you do not want the breakpoint to be activated until the code
activated at each nth pass. position has been reached a certain number of times, set this
number.
NOTICE
You can only make changes to the debug task group if no breakpoints are active.
Requirements
● The program source with the POU (e.g. ST source file, MCC chart, LAD/FBD program) is
open.
● The relevant SIMOTION device is in debug mode,
see Setting debug mode (Page 271).
● The debug task group is defined, see Defining the debug task group (Page 273).
Proceed as follows
To define the call path for all future breakpoints of a POU, proceed as follows:
1. Select the code location where no breakpoint has been set:
– SIMOTION ST: Set the cursor in an appropriate line of the ST source.
– SIMOTION MCC: Select an appropriate command in the MCC chart.
– SIMOTION LAD/FBD: Set the cursor in an appropriate network of the LAD/FBD
program.
2. Click the button for "edit call path" in the Breakpoints toolbar.
In the "Call path / task selection all breakpoints for each POU" window, the marked code
position is displayed (with the name of the program source file, line number, name of the
POU).
3. Select the task in which the user program (i.e. all tasks in the debug task group) will be
stopped when a breakpoint in this POU is reached.
The following are available:
– All calling locations starting at this call level
The user program will always be started when an activated breakpoint of the POU in
any task of the debug task group is reached.
– The individual tasks from which the selected breakpoint can be reached.
The user program will be stopped only when a breakpoint in the selected task is
reached. The task must be in the debug task group.
The specification of a call path is possible.
4. Only for functions and function blocks: Select the call path, i.e. the code position to be
called (in the calling POU).
The following are available:
– All calling locations starting at this call level
No call path is specified. The user program is always stopped at an activated
breakpoint when the POU in the selected tasks is called.
– Only when a single task is selected: The code positions to be called within the
selected task (with the name of the program source, line number, name of the POU).
The call path is specified. The user program will be stopped at an activated breakpoint
only when the POU is called from the selected code position.
If the selected calling code position is in turn called by other code positions, further
lines are displayed successively in which you proceed similarly.
5. If a breakpoint is only to be activated after the code position has been reached several
times, select the number of times.
6. If you want to accept and compare this call path for all previously set breakpoints in this
POU:
– Click Accept.
Proceed as follows:
● Activate the breakpoints, see Activating breakpoints (Page 285).
Note
You can use the "Display call stack (Page 287)" function to view the call path at a current
breakpoint and the code positions at which the other tasks of the debug task group were
stopped.
See also
Defining the call path for a single breakpoint (Page 279)
6.2.6.11 Call path / task selection parameters of all breakpoints per POU
Here you can define a presetting for the call path of all future breakpoints to be set in a POU.
Moreover, you can also accept this setting for all previously set breakpoints of this POU.
Table 6-15 Call path / task selection parameter description of all breakpoints per POU
Field Description
Selected CPU The selected SIMOTION device is displayed.
Calling task Select the task in which the user program (i.e. all tasks in the debug task
group) will be stopped when a breakpoint in this POU is reached.
The following are available:
• All calling locations starting at this call level
The user program will always be started when an activated breakpoint
of the POU in any task of the debug task group is reached.
• The individual tasks from which the selected breakpoint can be
reached.
The user program will be stopped only when an activated breakpoint in
the selected task is reached. The task must be in the debug task
group.
The specification of a call path is possible.
Current POU The POU in which the cursor is located is displayed (with the name of the
program source file, name of the POU).
Field Description
is called by Only for functions and function blocks:
Select the call path, i.e. the code position to be called (in the calling POU).
The following are available:
• All calling locations starting at this call level
No call path is specified. The user program will always be stopped at
an activated breakpoint when the POU in the selected tasks is called.
• Only when a single task is selected: The code positions to be called
within the selected task (with the name of the program source, line
number, name of the POU).
The call path is specified. The user program will be stopped at an
activated breakpoint only when the POU is called from the selected
code position.
If the POU of the selected calling code position is also called from
other code positions, further lines are displayed successively in which
you proceed similarly.
The breakpoint will be If you do not want the breakpoint to be activated until the code position
activated at each nth has been reached a certain number of times, set this number.
pass.
Apply this call path to all Click the Apply button, if you want to apply the call path to all previously
previous breakpoints of set breakpoints of the current POU. Any existing settings will be
this POU overwritten.
Requirements
1. The program source with the POU (e.g. ST source file, MCC chart, LAD/FBD program) is
open.
2. The relevant SIMOTION device is in debug mode,
see Setting debug mode (Page 271).
3. The debug task group is defined, see Defining the debug task group (Page 273).
4. Breakpoints are set, see Setting breakpoints (Page 276).
5. Call paths are defined, see Defining a call path for a single breakpoint (Page 279).
Activating breakpoints
How to activate a single breakpoint:
1. Select the code location where a breakpoint has already been set:
– SIMOTION ST: Set the cursor in an appropriate line of the ST source.
– SIMOTION MCC: Select an appropriate command in the MCC chart.
– SIMOTION LAD/FBD: Set the cursor in an appropriate network of the LAD/FBD
program.
2. Alternative:
– Select the Debug > Activate/deactivate breakpoint menu command.
– Click the button in the Breakpoints toolbar.
To activate all breakpoints (in all program sources) of the SIMOTION device, proceed as
follows:
● Alternative:
– Select the Debug > Activate all breakpoints menu command.
– Click the button in the Breakpoints toolbar.
Note
Breakpoints of all program sources of the SIMOTION device can also be activated and
deactivated in the debug table:
1. Click the button for "debug table" in the Breakpoints toolbar.
The "Debug table" window opens.
2. Perform the action below, depending on which breakpoints you want to activate or
deactivate:
– Single breakpoints: Check or clear the corresponding checkboxes.
– All breakpoints (in all program sources): Click the corresponding button.
Deactivate breakpoints
To deactivate a single breakpoint, proceed as follows:
1. Select the code position with the activated breakpoint.
2. Alternative:
– Select the Debug > Activate/deactivate breakpoint menu command.
– Click the button in the Breakpoints toolbar.
To deactivate all breakpoints (in all program sources) of the SIMOTION device, proceed as
follows:
● Alternative:
– Select the Debug > Deactivate all breakpoints menu command.
– Click the button in the Breakpoints toolbar.
Requirement
The user program is stopped at an activated breakpoint, i.e. the tasks of the debug task
group (Page 273) have been stopped.
Proceed as follows
To call the "Display call stack" function, proceed as follows:
● Click the button for "display call stack" in the Breakpoints toolbar.
The "Breakpoint call stack" dialog opens. The current call path (including the calling task
and the number of the set passes) is displayed.
The call path cannot be changed.
Field Description
Selected CPU The selected SIMOTION device is displayed.
Calling task Select the task for which you want to display the code position at
which the task was stopped.
All tasks of the debug task group can be selected.
Current code position The position in the program code (e.g. line of an ST source file) at
which the selected task was stopped is displayed (with the name of
the program source file, line number, name of the POU).
is called by The code positions that call the current code position within the
selected task are shown recursively (with the name of the program
source file, line number, name of the POU, and name of the function
block instance, if applicable).
For names of the SIMOTION RT program sources, refer to the table in "Program
run (Page 263)".
6.2.7 Trace
Using the trace tool, you can record and store the course of variable values over time (z. B.
unit variables, local variables, system variables, I/O variables). This allows you to document
the optimization, for example, of axes.
You can set the recording time, display up to four channels, select trigger conditions,
parameterize timing adjustments, select between different curve displays and scalings, etc.
Aside from isochronous recording, you can also select Recording at code position. This lets
you record the values of variables whenever the program runs through a specific point in the
ST source file.
The trace tool is described in detail in the online help.
,GHQWLILHU IRUPDWWHG
/HWWHU /HWWHU
B
/HWWHU 'LJLW
B 8QGHUVFRUH
'LJLW /HWWHU$=D]
8QGHUVFRUH 'LJLW
R_CONTROLLER3
_A_ARRAY
_100_3_3_10
9DOXHDVVLJQPHQW XQIRUPDWWHG
9DULDEOHRIWKH
HOHPHQWDU\GDWDW\SH
9DULDEOHRIWKH
HQXPHUDWRUGDWDW\SH
$UUD\YDULDEOH
6WUXFWXUHGYDULDEOH
$EVROXWH3,DFFHVV ([SUHVVLRQ
2XWSXWVRQO\
([WHUQDOWDJ
$FFHVVWR)%LQSXWSDUDPHWHUV !
'LUHFWELWDFFHVV !
!2QO\IRUDFWLYDWHG3HUPLWODQJXDJHH[WHQVLRQVFRPSLOHURSWLRQ
See also
Language description resources (Page 71)
A.1.2.6 Operators
Below is a list of all ST operators and the syntactic rules in which they are used.
Note
Variables must not be assigned the names of keywords or predefined identifiers. For more
information about identifiers, see Identifiers in ST. You will find an overview of the identifiers
reserved for technology objects and other reserved identifiers in Reserved identifiers.
A.1.3 Rules
The following syntax rules of the ST language are subdivided into rules with formatted
notation (lexical rules) and unformatted notation (syntactic rules). Language description
resources describes the differences between syntactic and lexical rules.
A.1.3.1 Identifiers
,GHQWLILHU IRUPDWWHG
/HWWHU /HWWHU
B
/HWWHU 'LJLW
B 8QGHUVFRUH
'LJLW /HWWHU$=D]
8QGHUVFRUH 'LJLW
1XPEHU IRUPDWWHG
'LJLW
'LJLW
Literals
/LWHUDO IRUPDWWHG
,QWHJHU
)ORDWLQJSRLQWQXPEHU
7LPHOLWHUDO
&KDUDFWHUVWULQJ
,QWHJHU IRUPDWWHG
,QWHJHUV 'HFLPDO
GDWDW\SH GLJLWVWULQJ
%LWGDWDW\SH
%LQDU\GLJLWVWULQJ
2FWDOGLJLWVWULQJ
2QO\IRUGDWDW\SHV
6,17,17DQG',17
+H[DGHFLPDOGLJLWVWULQJ
)ORDWLQJSRLQWQXPEHU IRUPDWWHG
)ORDWLQJSRLQWQXPEHU
GDWDW\SH
'HFLPDOGLJLW 'HFLPDOGLJLW
([SRQHQW
VWULQJ VWULQJ
$WOHDVWRQHRSWLRQPXVWEHRIIHUHG
([SRQHQW IRUPDWWHG
(
'HFLPDOGLJLWVWULQJ
H
7LPHOLWHUDO IRUPDWWHG
'DWH
7LPHRIGD\
'DWHDQGWLPH
'XUDWLRQ
&KDUDFWHUVWULQJ IRUPDWWHG
675,1*
$SRVWURSKH $SRVWURSKH
LQYHUWHGFRPPD &KDUDFWHUV LQYHUWHGFRPPD
&KDUDFWHUV IRUPDWWHG
+H[DGHFLPDOGLJLW +H[DGHFLPDOGLJLW
3ULQWDEOHFKDUDFWHU
$SRVWURSKHLQYHUWHGFRPPD
'ROODUVLJQ
/
/LQHIHHG/) $
O
1
&DUULDJH5HWXUQ/LQH)HHG&5/) '$
Q
3
)RUPIHHG)) &
S
5
&DUULDJHUHWXUQ&5 '
U
7
+RUL]RQWDOWDE+7
W
3ULQWDEOHFKDUDFWHU
$Q\FKDUDFWHUIURPWKHH[WHQGHG$6&,,FKDUDFWHUVHW $6&,,FRGH
WR(DQGWR))
H[FHSW 'ROODUVLJQ DQG
DSRVWURSKHLQYHUWHGFRPPD
+H[DGHFLPDOGLJLWV$)
Digit string
'HFLPDOGLJLWVWULQJ IRUPDWWHG
'HFLPDOGLJLW
B
8QGHUVFRUH
'HFLPDOGLJLWV
%LQDU\GLJLWVWULQJ IRUPDWWHG
%LQDU\GLJLW
B
%LQDU\GLJLWV 8QGHUVFRUH
2FWDOGLJLWVWULQJ IRUPDWWHG
2FWDOGLJLW
B
8QGHUVFRUH
2FWDOGLJLWV
+H[DGHFLPDOGLJLWVWULQJ IRUPDWWHG
+H[DGHFLPDOGLJLW
B
+H[DGHFLPDOGLJLWV$) 8QGHUVFRUH
'DWH IRUPDWWHG
'$7(
'DWHLQIRUPDWLRQ
'
'XUDWLRQ IRUPDWWHG
7,0( 'HFLPDOUHSUHVHQWDWLRQ
7LPHRIGD\ IRUPDWWHG
7,0(B2)B'$<
7LPHRIGD\LQIRUPDWLRQ
72'
'DWHDQGWLPH IRUPDWWHG
'$7(B$1'B7,0(
'DWHLQIRUPDWLRQ 7LPHRIGD\LQIRUPDWLRQ
'7
'DWHLQIRUPDWLRQ IRUPDWWHG
7LPHRIGD\SDUDPHWHU IRUPDWWHG
'HFLPDOGLJLWVWULQJ 'HFLPDOGLJLWVWULQJ
+RXU 0LQXWH
'HFLPDOGLJLWVWULQJ 'HFLPDOGLJLWVWULQJ
6HFRQG 0LOOLVHFRQG
6HTXHQFHUHSUHVHQWDWLRQ IRUPDWWHG
'HFLPDOGLJLWVWULQJ G B 'HFLPDOGLJLWVWULQJ K B
'D\V +RXUV>@
'HFLPDOGLJLWVWULQJ P B 'HFLPDOGLJLWVWULQJ V B
0LQXWHV>@ 6HFRQGV>@
'HFLPDOGLJLWVWULQJ PV
0LOOLVHFRQGV>@
$WOHDVWRQHHQWU\LVUHTXLUHG
7KHYDOXHUDQJHPD\EHH[FHHGHGLQWKHKLJKHVWRUGHUVHTXHQFH
'HFLPDOUHSUHVHQWDWLRQ IRUPDWWHG
'D\V
'HFLPDOGLJLWVWULQJ 'HFLPDOGLJLWVWULQJ G
KRXUV
'HFLPDOGLJLWVWULQJ 'HFLPDOGLJLWVWULQJ K
0LQXWHV
'HFLPDOGLJLWVWULQJ 'HFLPDOGLJLWVWULQJ P
VHFRQGV
'HFLPDOGLJLWVWULQJ 'HFLPDOGLJLWVWULQJ V
0LOOLVHFRQGV
'HFLPDOGLJLWVWULQJ 'HFLPDOGLJLWVWULQJ PV
7KHHQWU\WRGHFLPDOUHSUHVHQWDWLRQLVRQO\SRVVLEOHIRUWLPHXQLWVWKDWDUHQRW\HWGHILQHG
A.1.3.3 Comments
Note the following when inserting comments:
● Nesting of line comments is not allowed.
● Nesting of block comments is not allowed, but you can nest line comments in block
comments.
● Comments are allowed at any position in the unformatted (syntactic) rules.
● Comments are not allowed in formatted (lexical) rules.
&RPPHQW IRUPDWWHG
/LQHFRPPHQW
%ORFNFRPPHQW
/LQHFRPPHQW IRUPDWWHG
&DUULDJH5HWXUQ
(QWHURU5HWXUQNH\
%ORFNFRPPHQW IRUPDWWHG
&KDUDFWHUV
3DUWVRIWKH67VRXUFHILOH XQIRUPDWWHG
8QLW [SHU67VRXUFHILOH
,QWHUIDFH [SHU67VRXUFHILOH
,PSOHPHQWDWLRQ [SHU67VRXUFHILOH
8VHUGHILQHGGDWDW\SH [HDFKSHULQWHUIDFHDQGLPSOHPHQWD
WLRQSURJUDPVHFWLRQ
)XQFWLRQ
Q[SHU67VRXUFHILOH
)XQFWLRQEORFN Q[SHU67VRXUFHILOH
3URJUDP Q[SHU67VRXUFHILOH
'HFODUDWLRQEORFN Q[SHU67VRXUFHILOH
6WDWHPHQW Q[SHU67VRXUFHILOH
1RWLFH7KHILJXUHVKRZVRQO\WKHRSWLRQVIRUGHILQLQJVRXUFHILOHVHFWLRQV
7KHKLHUDUFK\RIWKHVHFWLRQVFDQQRWEHVKRZQRQRQHOHYHOUHIHUWRWKHH[SODQDWLRQV
LQWKHWH[WIRUPRUHGHWDLOV
67VRXUFHILOH XQIRUPDWWHG
,PSOHPHQWDWLRQ
8QLWGHILQLWLRQ ,QWHUIDFHVHFWLRQ VHFWLRQ
8QLWGHILQLWLRQ IRUPDWWHG
8QLWLGHQWLILHU 'HYLFHW\SH
,GHQWLFDOWRWKHLGHQWLILHURIWKH67
VRXUFHILOH
,QWHUIDFHVHFWLRQ XQIRUPDWWHG
86(/,%OLEUDU\LGHQWLILHU$6QDPHVSDFH
86(3$&.$*(WHFKQRORJ\SDFNDJHLGHQWLILHU$6QDPHVSDFH
86(6XQLWLGHQWLILHUV
)81&7,21IXQFWLRQLGHQWLILHUV
)81&7,21B%/2&.IXQFWLRQEORFNLGHQWLILHUV
352*5$0SURJUDPLGHQWLILHUV
8VHUGHILQHGGDWDW\SHV 8'7
8QLWYDULDEOHVJOREDOYDULDEOHEORFN
8QLWFRQVWDQWVJOREDOFRQVWDQWEORFN
5HWHQWLYHYDULDEOHEORFN
,PSOHPHQWDWLRQVHFWLRQ XQIRUPDWWHG
,PSOHPHQWDWLRQ
,03/(0(17$7,21 VWDWHPHQWV (1'B,03/(0(17$7,21
86(6XQLWLGHQWLILHUV
8VHUGHILQHGGDWDW\SHV 8'7
8QLWYDULDEOHVJOREDOYDULDEOHEORFN
8QLWFRQVWDQWVJOREDOFRQVWDQWEORFN
5HWHQWLYHYDULDEOHEORFN
)XQFWLRQV
)XQFWLRQEORFNV
([SUHVVLRQV
3URJUDPV
([SUHVVLRQ XQIRUPDWWHG
([SUHVVLRQLGHQWLILHU
(;35(66,21 ,GHQWLILHU
([SUHVVLRQGHFODUDWLRQ 6WDWHPHQW
VHFWLRQ VHFWLRQ (1'B(;35(66,21
1RWHWKDWDQH[SUHVVLRQRIWKH%22/GDWDW\SHPXVWEHDVVLJQHGWRWKHH[SUHVVLRQ
LGHQWLILHULQWKHVWDWHPHQWVHFWLRQ
)XQFWLRQ XQIRUPDWWHG
)XQFWLRQLGHQWLILHU 92,'
)81&7,21 ,GHQWLILHU
'DWDW\SH
6WDWHPHQW
)&GHFODUDWLRQVHFWLRQ VHFWLRQ (1'B)81&7,21
1RWHIRUIXQFWLRQVZLWKGDWDW\SH QRW92,'
7KHUHWXUQYDOXHRIWKHIXQFWLRQLGHQWLILHUPXVWEHDVVLJQHGLQWKHVWDWHPHQWVHFWLRQ
)XQFWLRQEORFN XQIRUPDWWHG
)XQFWLRQEORFNLGHQWLILHU
)81&7,21B%/2&. ,GHQWLILHU
3URJUDP XQIRUPDWWHG
3URJUDPLGHQWLILHU
352*5$0 ,GHQWLILHU
([SUHVVLRQGHFODUDWLRQVHFWLRQ XQIRUPDWWHG
&RQVWDQWEORFN !
7HPSRUDU\YDULDEOHEORFNLQ)& !
-XPSODEHOGHFODUDWLRQ !
!7KHEORFNLVSHUPLWWHGRQO\DVRI9HUVLRQ9RIWKH6,027,21NHUQHO
!7KLVEORFNPD\DSSHDUPRUHWKDQRQFHLQWKHGHFODUDWLRQVHFWLRQ
!7KLVEORFNPD\DSSHDUMXVWRQFHLQWKHGHFODUDWLRQVHFWLRQ
)&GHFODUDWLRQVHFWLRQ XQIRUPDWWHG
&RQVWDQWEORFN !
)&SDUDPHWHUEORFN !
7HPSRUDU\YDULDEOHEORFNLQ)& !
-XPSODEHOGHFODUDWLRQ !
!7KLVEORFNPD\DSSHDUPRUHWKDQRQFHLQWKHGHFODUDWLRQVHFWLRQ
!7KLVEORFNPD\DSSHDUMXVWRQFHLQWKHGHFODUDWLRQVHFWLRQ
)%GHFODUDWLRQVHFWLRQ XQIRUPDWWHG
&RQVWDQWEORFN !
)%SDUDPHWHUEORFN !
6WDWLFYDULDEOHEORFN !
7HPSRUDU\YDULDEOHEORFNLQ)%SURJUDP !
-XPSODEHOGHFODUDWLRQ !
!7KLVEORFNPD\DSSHDUPRUHWKDQRQFHLQWKHGHFODUDWLRQVHFWLRQ
!7KLVEORFNPD\DSSHDUMXVWRQFHLQWKHGHFODUDWLRQVHFWLRQ
3URJUDPGHFODUDWLRQVHFWLRQ XQIRUPDWWHG
&RQVWDQWEORFN !
6WDWLFYDULDEOHEORFN !
7HPSRUDU\YDULDEOHEORFNLQ)%SURJUDP !
-XPSODEHOGHFODUDWLRQ !
!7KLVEORFNPD\DSSHDUPRUHWKDQRQFHLQWKHGHFODUDWLRQVHFWLRQ
!7KLVEORFNPD\DSSHDUMXVWRQFHLQWKHGHFODUDWLRQVHFWLRQ
Constant blocks
&RQVWDQWEORFN XQIRUPDWWHG
8QLWFRQVWDQWVJOREDOFRQVWDQWEORFN XQIRUPDWWHG
Variable blocks
8QLW9DULDEOHV*OREDO9DULDEOH%ORFN 8QIRUPDWWHG
9DULDEOHGHFODUDWLRQ
,QVWDQFH
GHFODUDWLRQ
5HWHQWLYHYDULDEOHEORFN XQIRUPDWWHG
7HPSRUDU\YDULDEOHEORFNLQ)& XQIRUPDWWHG
9DULDEOHGHFODUDWLRQ
9$5 (1'B9$5
7HPSRUDU\YDULDEOHEORFNLQ)%DQGSURJUDP XQIRUPDWWHG
6WDWLFYDULDEOHEORFN XQIRUPDWWHG
9DULDEOHGHFODUDWLRQ
,QVWDQFH
GHFODUDWLRQ
Parameter fields
)%SDUDPHWHUEORFN XQIRUPDWWHG
9$5B,1387 )RUPDOSDUDPHWHU
)RULQSXWSDUDPHWHU
9DULDEOHGHFODUDWLRQ
9$5B287387 (1'B9$5
)RURXWSXWSDUDPHWHU
9DULDEOHGHFODUDWLRQ
9$5B,1B287
)RULQRXWSDUDPHWHU ,QVWDQFHGHFODUDWLRQ
,QLWLDOL]DWLRQQRWSRVVLEOH
7KH9$5B,13879$5B287387DQG9$5B,1B287NH\ZRUGVPD\EHXVHGMXVWRQFHLQWKH
GHFODUDWLRQVHFWLRQ
9$5B,1387 9DULDEOHGHFODUDWLRQ
)RULQSXWSDUDPHWHU
(1'B9$5
9DULDEOHGHFODUDWLRQ
9$5B,1B287
)RULQRXWSDUDPHWHU ,QVWDQFHGHFODUDWLRQ
,QLWLDOL]DWLRQQRWSRVVLEOH
7KH9$5B,1387DQG9$5B,1B287NH\ZRUGVPD\EHXVHGMXVWRQFHLQWKHGHFODUDWLRQVHFWLRQ
Jump labels
-XPSODEHOGHFODUDWLRQ XQIRUPDWWHG
-XPSODEHO
/$%(/ ,GHQWLILHU (1'B/$%(/
Declarations
&RQVWDQWGHFODUDWLRQ XQIRUPDWWHG
,GHQWLILHURIWKH
FRQVWDQWV $55$<
GDWDW\SH
VSHFLILFDWLRQ
9DULDEOHGHFODUDWLRQ XQIRUPDWWHG
6\PEROLF3,DFFHVV XQIRUPDWWHG
,QWHJHU
GDWDW\SH
$EVROXWH3,
,GHQWLILHU $7 DFFHVV
%LWGDWDW\SH
5DQJHRIGHFODUHGGDWDW\SHPXVW
FRUUHVSRQGWRWKHUDQJHRIWKH
DEVROXWHLGHQWLILHU
,QVWDQFHGHFODUDWLRQ XQIRUPDWWHG
)XQFWLRQEORFN
,GHQWLILHU
LGHQWLILHU
,QVWDQFHLGHQWLILHU
)%$55$<
VSHFLILFDWLRQ
)XQFWLRQEORFNVPXVWDOUHDG\H[LVW
,QLWLDOL]DWLRQQRWSRVVLEOH
)%$55$<VSHFLILFDWLRQ XQIRUPDWWHG
,QGH[VSHFLILFDWLRQ
,QLWLDOL]DWLRQ ,QLWLDOL]DWLRQ
$55$< > @
H[SUHVVLRQ H[SUHVVLRQ
',17GDWDW\SH ',17GDWDW\SH
)XQFWLRQEORFN
2)
LGHQWLILHU
Initialization
,QLWLDOL]DWLRQ XQIRUPDWWHG
&RQVWDQWH[SUHVVLRQ
,QLWLDOL]DWLRQRIHOHPHQWDU\GDWDW\SHV
> $UUD\LQLWLDOL]DWLRQOLVW @
,QLWLDOL]DWLRQRIDUUD\V
6WUXFWXUHLQLWLDOL]DWLRQOLVW
,QLWLDOL]DWLRQRILQGLYLGXDOFRPSRQHQWVZLWKLQVWUXFWXUHV
&RQVWDQWH[SUHVVLRQ XQIRUPDWWHG
&RQVWDQW
%DVLFORJLF
RSHUDWRU
%DVLFDULWKPHWLF
RSHUDWRU
&RQVWDQWH[SUHVVLRQ
8QDU\PLQXV
127
1HJDWLRQ
'DWDW\SHFRQYHUVLRQIXQFWLRQ
&RQVWDQW
H[SUHVVLRQ
52/
525
6+/
&RQVWDQW &RQVWDQW
6+5 H[SUHVVLRQ H[SUHVVLRQ
$UUD\LQLWLDOL]DWLRQOLVW XQIRUPDWWHG
&RQVWDQWH[SUHVVLRQ
&RQVWDQWH[SUHVVLRQ
'HFLPDOGLJLWVWULQJ
5HSHDWIDFWRU $UUD\LQLWLDOL]DWLRQOLVW
6WUXFWXUHLQLWLDOL]DWLRQOLVW XQIRUPDWWHG
,GHQWLILHU ,QLWLDOL]DWLRQ
'HVLJQDWLRQRIWKH
FRPSRQHQW
'DWDW\SH XQIRUPDWWHG
(OHPHQWDU\GDWDW\SH
8'7LGHQWLILHU
8VHUGHILQHGGDWDW\SHVಥ8'7
6\VWHPGDWDW\SH
72GDWDW\SH
(OHPHQWDU\GDWDW\SH XQIRUPDWWHG
%LWGDWDW\SH
1XPHULFGDWDW\SH
7LPHW\SH
6WULQJGDWDW\SH
%LWGDWDW\SH XQIRUPDWWHG
%22/ %LW
%<7( %\WH
:25' :RUG
':25' 'RXEOHZRUG
1XPHULFGDWDW\SH XQIRUPDWWHG
,QWHJHUGDWDW\SH
)ORDWLQJSRLQWQXPEHUGDWDW\SH
,QWHJHUGDWDW\SH XQIRUPDWWHG
6,17 6KRUWLQWHJHU
,17 ,QWHJHU
',17 'RXEOHSUHFLVLRQLQWHJHU
86,17 8QVLJQHGVKRUWLQWHJHU
8,17 8QVLJQHGLQWHJHU
8',17 8QVLJQHGLQWHJHUZLWKGRXEOHSUHFLVLRQ
)ORDWLQJSRLQWQXPEHUGDWDW\SH XQIRUPDWWHG
5($/ )ORDWLQJSRLQWQXPEHU
/5($/ /RQJIORDWLQJSRLQWQXPEHU
7LPHW\SH XQIRUPDWWHG
7,0( 7LPH
'$7( 'DWH
7,0(B2)B'$<
7LPHRIGD\
72'
'$7(B$1'B7,0(
'DWHDQGWLPH
'7
6WULQJGDWDW\SH XQIRUPDWWHG
675,1*
> &RQVWDQWH[SUHVVLRQ @
&KDUDFWHUVWULQJOHQJWK
,17GDWDW\SHYDOXH
'HIDXOW
8VHUGHILQHGGDWDW\SHVಥ8'7 XQIRUPDWWHG
7<3( ,GHQWLILHU
8'7LGHQWLILHU
'DWDW\SH
$55$<
GDWDW\SH ,QLWLDOL]DWLRQ (1'B7<3(
VSHFLILFDWLRQ
(QXPHUDWRU
GDWDW\SH
VSHFLILFDWLRQ
6758&7
GDWDW\SH
VSHFLILFDWLRQ
$55$<GDWDW\SHVSHFLILFDWLRQ XQIRUPDWWHG
,QGH[VSHFLILFDWLRQ
',17GDWDW\SH ',17GDWDW\SH
2) 'DWDW\SH
6758&7GDWDW\SHVSHFLILFDWLRQ XQIRUPDWWHG
&RPSRQHQWV
6758&7 GHFODUDWLRQ (1'B6758&7
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B6758&7NH\ZRUGZLWKDVHPLFRORQ
&RPSRQHQWGHFODUDWLRQ XQIRUPDWWHG
,GHQWLILHURIWKH
FRPSRQHQW
$55$<
GDWDW\SH
VSHFLILFDWLRQ
(QXPHUDWRUGDWDW\SHVSHFLILFDWLRQ XQIRUPDWWHG
(QXPHUDWRUHOHPHQW
,GHQWLILHU
6WDWHPHQWVHFWLRQ XQIRUPDWWHG
-XPSODEHO
,GHQWLILHU
6WDWHPHQW
6WDWHPHQW XQIRUPDWWHG
9DOXHDVVLJQPHQWV
6XEURXWLQHH[HFXWLRQ
&RQWUROVWDWHPHQW
9DOXHDVVLJQPHQW XQIRUPDWWHG
9DULDEOHRIWKH
HOHPHQWDU\GDWDW\SH
9DULDEOHRIWKH
HQXPHUDWRUGDWDW\SH
$UUD\YDULDEOH
6WUXFWXUHGYDULDEOH
$EVROXWH3,DFFHVV ([SUHVVLRQ
2XWSXWVRQO\
([WHUQDOWDJ
$FFHVVWR)%LQSXWSDUDPHWHUV !
'LUHFWELWDFFHVV !
!2QO\IRUDFWLYDWHG3HUPLWODQJXDJHH[WHQVLRQVFRPSLOHURSWLRQ
([SUHVVLRQ XQIRUPDWWHG
2SHUDQG
%DVLF
ORJLFRSHUDWRU
%DVLFDULWKPHWLF
RSHUDWRU
3RZHU ([SRQHQW
([SUHVVLRQ ([SUHVVLRQ
([SUHVVLRQ
8QDU\PLQXV
127
1HJDWLRQ
([SUHVVLRQ
Operands
2SHUDQG XQIRUPDWWHG
9DULDEOHRIWKHHOHPHQWDU\GDWDW\SH
9DULDEOHRIWKHHQXPHUDWRUGDWDW\SH
$UUD\YDULDEOH
6WUXFWXUHGYDULDEOH
$EVROXWH3,DFFHVV
,QSXWVDQGRXWSXWV
&RQVWDQW
)&FDOO
$FFHVVWR)%RXWSXWSDUDPHWHUV
([WHUQDOWDJ
$FFHVVWR)%LQSXWSDUDPHWHUV !
'LUHFWELWDFFHVV !
!2QO\IRUDFWLYDWHG3HUPLWODQJXDJHH[WHQVLRQVFRPSLOHURSWLRQ
6WUXFWXUHGYDULDEOH XQIRUPDWWHG
6WDUWRILGHQWLILHULVYDULDEOHQDPHRU
SDUDPHWHUQDPHFRPSRQHQWQDPHDIWHUWKHGRW
,GHQWLILHU
6LPSOHDUUD\
$EVROXWH3,$FFHVV IRUPDWWHG
%22/
; 1XPEHU 1XPEHU
,QSXW
%<7(
, % 1XPPHU
:25'
4 : 1XPEHU
2XWSXW
':25'
' 1XPEHU
&RQVWDQW XQIRUPDWWHG
/LWHUDO
,GHQWLILHURIWKHFRQVWDQWV
(QXPHUDWRUYDOXH
(QXPHUDWRUYDOXH IRUPDWWHG
(QXPHUDWRUHOHPHQW
8'7LGHQWLILHU
(QXPHUDWRUGDWDW\SH
([WHUQDOYDULDEOH XQIRUPDWWHG
6\VWHPYDULDEOHRUFRQILJXUDWLRQGDWDLWHP
RIWKHGHYLFH
6\VWHPYDULDEOHRUFRQILJXUDWLRQGDWDLWHP
RIDWHFKQRORJ\REMHFW
,2YDULDEOH
*OREDOGHYLFHYDULDEOH
$FFHVVWR)%RXWSXWSDUDPHWHU IRUPDWWHG
,GHQWLILHURIWKH
,GHQWLILHURIWKH)%LQVWDQFH
RXWSXWSDUDPHWHU
$FFHVVWR)%LQSXWSDUDPHWHUV IRUPDWWHG
2QO\IRUDFWLYDWHG3HUPLWODQJXDJHH[WHQVLRQVFRPSLOHURSWLRQ
,GHQWLILHURIWKH
,GHQWLILHURIWKH)%LQVWDQFH
LQSXWSDUDPHWHUV
'LUHFWELWDFFHVV IRUPDWWHG
2QO\IRUDFWLYDWHG3HUPLWODQJXDJHH[WHQVLRQVFRPSLOHURSWLRQ
6LPSOHYDULDEOH
$UUD\YDULDEOH
6WUXFWXUHGYDULDEOH
([WHUQDOWDJ &RQVWDQW
'DWDW\SH$1<B,17
$FFHVVWR)%RXWSXWSDUDPHWHUV
$FFHVVWR)%LQSXWSDUDPHWHUV
3HUPLWWHGGDWDW\SHV
HDFK%<7(:25'':25'
Operators
%DVLFORJLFDORSHUDWRU XQIRUPDWWHG
$ULWKPHWLFRSHUDWRU XQIRUPDWWHG
%DVLFDULWKPHWLFRSHUDWRU
%DVLFDULWKPHWLFRSHUDWRU XQIRUPDWWHG
02'
5HODWLRQDORSHUDWRU XQIRUPDWWHG
! ! !
)%FDOO XQIRUPDWWHG
,GHQWLILHU
,QVWDQFHQDPH
,QVWDQFHQDPH ,QGH[
',17GDWDW\SH
)%SDUDPHWHU
)&FDOO XQIRUPDWWHG
6\VWHPIXQFWLRQLGHQWLILHU
72IXQFWLRQLGHQWLILHU )&SDUDPHWHU
)XQFWLRQLGHQWLILHU
)%SDUDPHWHU XQIRUPDWWHG
,QSXWDVVLJQPHQW
,QRXWDVVLJQPHQW
2XWSXWDVVLJQPHQW
)&SDUDPHWHU XQIRUPDWWHG
([SUHVVLRQ
&DOOLQVKRUWIRUP
,QSXWDVVLJQPHQW
,QRXWDVVLJQPHQW
,QSXWDVVLJQPHQW XQIRUPDWWHG
)RUPDOSDUDPHWHU $FWXDOSDUDPHWHU
,GHQWLILHU ([SUHVVLRQ
,GHQWLILHURIWKH
LQSXWSDUDPHWHU
,QRXWDVVLJQPHQW XQIRUPDWWHG
)RUPDOSDUDPHWHU $FWXDOSDUDPHWHU
,GHQWLILHU 9DULDEOHLGHQWLILHU
'HVLJQDWLRQRIWKH 6LPSOHYDULDEOH
LQRXWSDUDPHWHU
2XWSXWDVVLJQPHQW XQIRUPDWWHG
)RUPDOSDUDPHWHU $FWXDOSDUDPHWHU
,GHQWLILHU ! 9DULDEOHLGHQWLILHU
,GHQWLILHURIWKH 6LPSOHYDULDEOH
LQRXWSDUDPHWHU
Branches
,)VWDWHPHQW XQIRUPDWWHG
&RQGLWLRQRIGDWDW\SH%22/
&RQGLWLRQRIGDWDW\SH%22/
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B,)NH\ZRUGZLWKDVHPLFRORQ
&$6(VWDWHPHQW XQIRUPDWWHG
9DULDEOH
(QXPHUDWRUGDWDW\SH
'DWDW\SH$1<B,17
9DOXHOLVW 6WDWHPHQWVHFWLRQ
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B&$6(NH\ZRUGZLWKDVHPLFRORQ
9DOXHOLVW XQIRUPDWWHG
&RQVWDQW
9DOXH
&RQVWDQW &RQVWDQW
9DOXH 9DOXH
9DOXH 9DOXH
5HSHWLWLRQVWDWHPHQWDQGMXPSVWDWHPHQW XQIRUPDWWHG
)25VWDWHPHQW
:+,/(VWDWHPHQW
5(3($7VWDWHPHQW
(;,7VWDWHPHQW
5(7851VWDWHPHQW
:$,7)25&21',7,21VWDWHPHQW
*272VWDWHPHQW
)25VWDWHPHQW XQIRUPDWWHG
9DULDEOHLGHQWLILHU
)25 ([SUHVVLRQ
6WDUWYDOXH
6LPSOHYDULDEOHGDWDW\SH
6,1786,17,178,17',17
(QGYDOXH ,QFUHPHQW
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B)25NH\ZRUGZLWKDVHPLFRORQ
:+,/(VWDWHPHQW XQIRUPDWWHG
&RQGLWLRQRIGDWDW\SH%22/
6WDWHPHQWVHFWLRQ (1'B:+,/(
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B:+,/(NH\ZRUGZLWKDVHPLFRORQ
5(3($7VWDWHPHQW XQIRUPDWWHG
([SUHVVLRQ (1'B5(3($7
&RQGLWLRQRIGDWDW\SH%22/
'RQRWIRUJHWWRWHUPLQDWHWKH(1'B5(3($7NH\ZRUGZLWKDVHPLFRORQ
(;,7VWDWHPHQW XQIRUPDWWHG
(;,7
5(7851VWDWHPHQW XQIRUPDWWHG
5(7851
:$,7)25&21',7,21VWDWHPHQW XQIRUPDWWHG
:$,7)25&21',7,21
([SUHVVLRQLGHQWLILHU )&SDUDPHWHU
&RQGLWLRQ 7KHFDOORIDQH[SUHVVLRQZLWKSDUDPHWHUVLV
1DPHRIDFRQVWUXFWGHFODUHGZLWK SHUPLWWHGRQO\DVRI9HUVLRQ9RIWKH
(;35(66,21 6,027,21NHUQHO
(GJHHYDOXDWLRQ
:,7+ ([SUHVVLRQ '2
%22/GDWDW\SH
758(5LVLQJHGJHRIWKHFRQGLWLRQLVHYDOXDWHG
)$/6(&RQGLWLRQLVHYDOXDWHGVWDWLFDOO\ GHIDXOWVHWWLQJ
6WDWHPHQWVHFWLRQ (1'B:$,7)25&21',7,21
'RQRWIRUJHWWRWHUPLQDWHWKH
(1'B:$,7)25&21',7,21NH\ZRUGZLWKDVHPLFRORQ
*272VWDWHPHQW
*272 -XPSODEHO
-XPSODEHOGHILQHGLQDVWDWHPHQWDQGRSWLRQDOO\
LQWKHMXPSODEHOGHFODUDWLRQ /$%(/
This section provides an overview of the compiler error messages and their correction.
Error Description
1000 A read/write error has occurred on file access.
1001 Unable to load the file with the plain text error messages; cannot output error message texts.
Please refer to the online help using the error number!
1002 The created code could not be stored. Please close some windows and recompile!
1003 A read/write error has occurred on opening the file. Please close the application and try again!
1100 The option for stating a preprocessor definition contains an invalid identifier as the defined token.
The correct syntax of the call option is: -D identifier[=[text]]
Examples:
• -D myident // Definition of myident; this can be queried using #ifdef.
• -D myident= // myident is defined as empty character string
• -D "myident=This is a text" // myident is defined as character string 'This is a text'. The
quotation marks only have to be used if the replacement text contains a blank.
Error Description
2001 The specified character is illegal.
2002 The specified identifier contains illegal characters or combinations of characters. According to
IEC 61131, an identifier must start with a letter or an underscore. Any number of letters, digits, or
underscores may follow, but no more than one underscore in a row.
Error Description
3002 Keyword "IMPLEMENTATION" to identify the code section of the load unit is expected.
3003 The specified declaration block is not permitted in this context.
3004 The VAR, VAR_INPUT, VAR_OUTPUT, VAR_IN_OUT, VAR CONSTANT variable declaration blocks are
permitted just once for each POU.
Up to Version V3.1 of the SIMOTION kernel, the VAR_GLOBAL, VAR_GLOBAL CONSTANT, VAR_GLOBAL
RETAIN declaration blocks are permitted just once in the interface or implementation section.
3005 TASK statement: The task link has already been made in the source file for the specified task. Further task
linking not possible.
3006 Incorrect stack size for task specified. Only positive integers are permitted.
3007 The specified identifier must be a task identifier; see task configuration.
3008 The specified identifier must be a program identifier. The declaration is made in the statement PROGRAM xx
... END_PROGRAM.
3009 The EXPRESSION keyword must be followed by an identifier. The declaration is made in the statement
EXPRESSION xx ... END_EXPRESSION.
3010 The specified identifier is not an EXPRESSION identifier. Check whether the declaration was made using the
statement EXPRESSION xx ... END_EXPRESSION.
3011 The TASK statement is not permitted in the unit. Use the task configuration in the Workbench.
3012 The specified identifier has already been declared at another position. It cannot be used again as a function
identifier.
3013 The specified identifier has already been declared at another position. It cannot be used again as a function
block identifier.
3014 The UNIT statement is expected. The following forms are permissible:
• UNIT myunit;
• UNIT myunit : dvtype;
The UNIT statement is only required when compiling at the ASCII file level. It is optional when the compiler is
called from the Workbench.
3015 The source file is not ended with END_IMPLEMENTATION. Observe the structure for a source file!
3016 No further statements may be specified after keyword END_IMPLEMENTATION.
3017 The task declaration is not ended with END_TASK. Observe the structure for a source file!
3018 The POU declaration is not ended with END_FUNCTION, END_FUNCTION_BLOCK, or END_PROGRAM.
Observe the structure for a source file!
3019 A POU starting with keywords FUNCTION, FUNCTION_BLOCK, or PROGRAM is expected.
3020 The task linking statement is expected. Configuration: TASK tname ... END_TASK;
3022 The keyword INTERFACE is expected. See the structure for a source file.
3023 Keyword INTERFACE or IMPLEMENTATION is expected. See the structure for a source file.
3024 Syntax error in TASK statement. Correct structure: TASK tname ... END_TASK;
3025 The specified identifier has already been declared at another position. It cannot be used again as a program
identifier.
Error Description
3026 The WAITFORCONDITION statement cannot be used recursively. An attempt was made to use a
WAITFORCONDITION statement a second time within a WAITFORCONDITION statement. This is not
possible.
3027 An attempt was made to insert a WAITFORCONDITION statement within an EXPRESSION ...
END_EXPRESSION block. This is not possible. The WAITFORCONDITION statement cannot be used within
an expression.
Error Description
4001 The specified identifier is a standard function identifier that cannot be overwritten. Choose a
different identifier.
4002 The specified identifier has already been used. Use as a type identifier is not possible. Choose a
different identifier.
4003 The specified identifier has already been used. Use as a constant identifier is not possible.
Choose a different identifier.
4004 The specified initialization value has an incorrect format. Choose the initialization value that
corresponds to the data type declaration.
4005 Syntax error in type declaration.
4006 Syntax error in the structure element specification in the structure declaration.
4007 Syntax error in declaration of an ARRAY data type.
4008 Syntax error in the identifier list specification. The identifiers must be separated by commas.
4009 The specified constant identifier has been assigned different values. This occurs when
enumeration data types are declared. Identical enumeration elements in different enumeration
data types must be located in the same position in the type declaration.
4010 The specified type identifier is not exported from the source file, although the POU in which it is
used, is exported. Use a different data type or declare the data type in the implementation
section.
4011 A constant declaration requires the specification of an initialization value. Example: x : DINT := 5;
4012 The specified data type must be declared outside the POU. For VAR_INPUT, VAR_OUTPUT,
and VAR_IN_OUT, the type identifiers must not be declared locally in the POU, as they must also
be known outside the POU for parameter transfer purposes.
4013 The specified value is used several times in the enumeration data type. The values in the
enumeration data type must differ, however.
4050 The data type or variable declaration creates a data type that is larger than the specified
maximum permissible data size.
4051 The variable declaration requires a memory area that is larger than the specified maximum
permissible memory size.
Table A-13 Declaration errors in variable declarations (5001 – 5016, 5100 – 5112, 5500 – 5509)
Error Description
5001 The specified constant value causes the value range to be exceeded and cannot be converted to the requested
type.
5002 The specified identifier has already been used. Use as a variable identifier is not possible. Choose a different
identifier.
5003 Syntax error in variable declaration.
5004 The specification of a data type is expected (simple or derived data type).
5005 The specified constant value has the wrong data type or causes the value range to be exceeded.
5006 Check the number of initialization values for array initialization.
5007 Syntax error in the specification of the time and date literals.
5008 A function block instance cannot be created at the specified position. For example, FB instances cannot be
created in functions. In addition, output parameters (VAR_OUTPUT) of function blocks cannot be FB instances.
5009 The data type specified in the declaration cannot be applied to the variable with absolute address. An integer or
bit data type with matching bit width must be used.
5010 An attempt was made to assign a memory address to a variable. This is not possible at the specified position.
Use this assignment only within the VAR_GLOBAL declaration of a unit or within the VAR declaration of a
PROGRAM.
5012 The specified variables cannot be preassigned an initialization value.
5014 Incorrect initialization of a data structure. The initialization value for a component was specified more than once.
5016 The initialization of variables and data types with technology objects defined in the project is not possible.
Technology objects are themselves variables and so cannot be used for the initialization.
5100 The specified variables cannot be preassigned an initialization value.
5110 Special characters can be specified via $... in the following way: $$, $', $L, $N, $P, $R, $T. Moreover, the
numeric value of a character can be specified via $xx, whereby xx stands for the two-digit hexadecimal
specification of the character code.
5111 The special character can only be specified via $... . This affects $L, $N, $P, $R, $T
5112 Multi-line character string constants are not permitted. To produce a new line in the output, use the appropriate
special character in the character string, e.g. $N, $R$L.
5500 The specified jump label identifier was already defined. Choose a different name.
5501 The specified jump label identifier has not been defined. Include this identifier in the LABEL declaration.
5502 The jump label identifier has been assigned more than once. However, each jump label can only be used once
as a label.
5503 The jump label is specified as a jump destination, but the associated label is missing.
5504 No jumps are possible in subordinate control structures (e.g. WHILE loops). The specified jump label cannot be
used at this position.
5505 No jumps are possible in subordinate control structures (e.g. WHILE loops). The specified jump destination
cannot be reached.
5506 No jumps are possible in WAITFORCONDITION blocks. The specified jump label cannot be used at this
position.
5507 No jumps are possible in WAITFORCONDITION blocks. The specified jump destination cannot be reached.
5509 Jump labels cannot be used within a CASE statement. The syntax does not allow any differentiation between a
jump label and the value list of the CASE statement.
Error Description
6001 Syntax error: A statement terminated with a semicolon is expected,
e.g. a := b*c;
6002 Syntax error: An expression is expected, e.g. x < y .
6003 The specified identifier is no variable identifier. You must specify a variable identifier. Check whether the
indicated identifier is covered.
Up to and including V4.0, access to global device identifiers was possible within a program or function block of
the same name despite warning 16021.
6004 The index for array access must be the DINT data type. Perform a suitable type conversion or use another
expression.
6005 Type conflict in expression. One of the operands cannot be converted to the data type of the calculation, or the
result assignment produces a type conflict.
6006 The specified variable cannot be accessed. Therefore it cannot be used in the expression. Possible causes:
• Variable cannot be read.
• Attempt to access a local variable of a function or function block from outside.
6007 Cannot write specified variable. A value assignment is not possible.
6008 The specified function does not supply a return value. An application in the expression is therefore not possible
(function declared with a return value of VOID).
6009 The specified identifier does not refer to a function or a function block instance. Therefore it cannot be used as
function identifier.
6010 The specified identifier is not included as an input parameter (VAR_INPUT) or in/out parameter (VAR_IN_OUT)
in the declaration of the POU (function or function block). It cannot be used in the POU call.
6011 The number of function arguments in the call differs from the declaration, or the call parameters required are
missing in the call.
6012 RETURN is not permitted syntactically at this position. RETURN may only be used in functions.
6013 EXIT is not permitted syntactically at this position. EXIT can only be used within FOR, WHILE, and REPEAT.
6014 The specified index value is outside the array limits. Only index values that match the array declaration are
permissible.
6015 The specified task control command cannot be applied to the task. It is not allowed for this type of task.
6016 The specified task is deactivated in the execution system. It must be enabled before it can be used.
6017 Syntax error on specifying programs within a task. The programs must be listed by name and separated by
commas.
6018 The specified identifier does not refer to a PROGRAM. Therefore it cannot be used as a program identifier.
6019 Multiple assignment of program to task. Only one assignment is possible.
6020 Syntax error on specifying directly displayed variables. Inputs must have the syntax %Ix.y and outputs the
syntax %Qx.y.
6021 The specified byte offset of the directly displayed variables lies outside the permissible address space.
6022 The specified byte offset of the directly displayed variables lies outside the permissible address space. Values 0
to 7 are permissible.
6023 The return value of the function was not assigned. An assignment is however imperative.
6024 A variable with the specified identifier is not included in the task start information.
Error Description
6025 The condition variable and condition values of a CASE statement must be of the data type SINT, INT, DINT,
USINT, UINT or UDINT. It must be possible to implicitly convert the condition values to the data type of the
condition variables.
6026 The specified message identifier is not contained in the message configuration. Switch to the message
configuration and add the identifier.
6027 System variable access is only possible directly by means of a technology object reference. Access by means of
a structure or array is not possible. Create a local variable of type TO and assign the TO reference to this
variable. You can then access the required system variable by means of this local TO variable.
6028 Type conflict in expression at specified operation. One of the operands cannot be converted to the data type of
the calculation, or the result assignment produces a type conflict. The specified data type in the expression is
expected.
6029 The specified function parameter does not have a default value, so it is imperative to specify a value when the
function is called.
6030 An attempt was made to transfer an expression to an in/out parameter (VAR_IN_OUT). This is not possible.
User variables must be specified as in/out parameters.
6031 An attempt was made to transfer a system variable (TO, I/O direct access) to an in/out parameter
(VAR_IN_OUT). This is not possible. User variables must be specified as in/out parameters.
6032 An attempt was made to transfer a variable in the process image to an in/out parameter (VAR_IN_OUT). This is
not possible. User variables must be specified as in/out parameters.
6033 An attempt was made to transfer a variable with a non-matching data type to an in/out parameter
(VAR_IN_OUT). However, an Implicit type conversion is not possible. User variables with the correct data type
must be specified as in/out parameters.
6034 An attempt was made to transfer a read only variable to an in/out parameter (VAR_IN_OUT). This is not
possible. In/out parameters must be read/write.
6035 An attempt was made to transfer a constant to an in/out parameter (VAR_IN_OUT). This is not possible. In/out
parameters must be user variables.
6036 An operation is applied to a constant. The value of the constant is outside the definition range for the function.
Examples are:
• Application of SQRT to a negative number.
• Use of logarithmic functions on a number <= 0.
• Use of ASIN or ACOS on a number outside the interval [0..1]
6037 An attempt was made to divide a constant by zero. This operation is not permitted.
6038 The specified function parameter occurs more than once in the argument list.
6039 The specified POU (function or function block) cannot be used. Possible causes:
• The definition of the POU in the implementation section is missing. Only the prototype was specified in the
interface section.
• The POU is fully defined only after its use (e.g. call, instance declaration). If necessary, move this POU in
the program source before the POU in which it is used.
• An instance of the function block cannot be declared as unit variable in the same program source in which
this function block is defined.
6040 Only simple variables may be used as semaphores; indexing is not possible.
6041 The message function requires an auxiliary value of the specified data type. Type conversion is not possible.
6042 The message function requires that you specify a message number. The specified message number is invalid.
6050 Type conflict in expression at specified operation/variable. One of the operands cannot be converted to the type
of the calculation, or the result assignment produces a type conflict. A conversion between source file type and
target type is not possible.
Error Description
6051 The expression contains a type conflict for the specified operation. One of the operands cannot be converted to
the data type of the other operand to perform the calculation, or the operand data types are not permitted for this
operation.
6052 Type conflict in expression. The specified data type cannot be used for the operation (see marshalling
functions).
6053 The expression contains a type conflict for the specified operation. This operation is not permissible on the
specified data type.
6054 Type conflict in expression. The specified variable cannot be used as indexed array variable.
6060 At the function call, there is a mixture of assignments of function arguments and setting parameters. Use one
form of the function call. Example:
• f (x, y); or
• f (in1 := x, in2 := y);
6061 The specified parameter of the function or the function block is an in/out parameter. Consequently, a variable
must be assigned when the POU is called.
6062 The specified identifier cannot be used as a function argument. Only variables from the declaration blocks
VAR_INPUT and VAR_IN_OUT are permitted.
6070 Access to configuration data is only possible for variables that have been specified completely. Append the
name according to the configuration data for the selected technology object.
6080 The specified variable is no input or output variable that can be directly accessed. Such a variable must be
declared in the I/O container of the respective device; it must have the syntax PI* or PQ*.
6100 The specified construct can only be compiled if the device type is set. Add the device type to the unit statement
or set the device type in the program container.
6110 The specified construct cannot be used in libraries.
6111 The specified construct cannot be used in libraries.
6112 The specified construct cannot be used in libraries.
6113 Access to technology objects and devices is not allowed in libraries.
6130 The specification of an interval is not permissible for the data type indicated in the CASE statement.
6140 The specification of a constant in ENUM_TO_DINT requires specifying the data type in the form of
enum_type#value.
6150 The specified bit offset lies outside the valid range for the specified data type.
6200 Only for "Permit language extensions" compiler option (-C lang_ext):
The called PROGRAM contains instance data (VAR … END_VAR declaration block) stored in the user memory
of the assigned task. This means a call of the PROGRAM from another POU is not possible. Compile the source
file with the "Create program instance data only once" compiler option (-C prog_once) or remove the instance
data.
6201 Only for "Permit language extensions" compiler option (-C lang_ext):
The call of a PROGRAM is not supported in functions. Such calls can be made only in function blocks or
another PROGRAM.
Error Description
7000 A syntax error has occurred. Possible causes:
• Incorrectly ended control structures (e.g. END_IF missing)
• Statements not terminated with ;
• Missing parentheses
7001 The specified identifier does not refer to a constant. Please enter one constant per value or
identifier.
7002 A signed integer is expected. The integer can be of data type SINT, INT, or DINT.
7003 When specifying the interval, the initial value must be less than or equal to the end value. This
applies to the declaration of arrays and the specification of the interval in CASE selection
conditions.
7004 An initialization value is expected. The value must be a constant. Constants can be assigned as
follows:
• Directly per value
• Symbolically via a preceding constant declaration
• As an expression containing constants only
7009 An expression that supplies data type BOOL is expected as condition for WHILE, REPEAT, and
IF. This can be specified as a variable of data type BOOL or via a comparison expression. You
can also specify a function with a return value of data type BOOL.
7010 A syntax error has occurred. Possible causes:
• Incorrectly terminated control structures (e.g. END_IF missing)
• Statements not terminated with ;
• Missing parentheses
7011 A syntax error has occurred. Possible causes:
• Incorrectly terminated control structures (e.g. END_IF missing)
• Statements not terminated with ;
• Missing parentheses
7012 A syntax error in the statement, that starts at the specified line, has occurred. Possible causes:
• Incorrectly terminated control structures (e.g. END_IF missing)
• Statements not terminated with ;
• Missing parentheses
7013 A syntax error has occurred. An illegal construct is being used.
7014 A syntax error has occurred. Possible causes:
• Incorrectly terminated control structures (e.g. END_IF missing)
• Statements not terminated with ;
• Missing parentheses
Error Description
8001 The specified POU has been exported to the INTERFACE section, but an IMPLEMENTATION section is
missing. Either delete the export statement or specify a valid implementation.
8100 The maximum size of the data area that can be reached using HMI is 65536 bytes. This limit has been
exceeded with the specified variable. All subsequent variables cannot be reached either.
A.2.9 Errors while loading the interface of another UNIT or technology package
Table A-17 Errors while loading the interface of another UNIT or a technology package
(10000 - 10037, 10100 - 10101)
Error Description
10000 The specified unit has an invalid file format. Probably, the unit was created using an older version of the
compiler or compiled using incompatible options. If a unit is involved, it should compiled first. Then repeat the
current compilation. If a package is involved, a newer version should be installed.
10001 The unit name has an invalid format. The rules for identifiers in ST are also true for unit names; the following
restrictions apply to their length:
• Up to Version V4.0 of the SIMOTION Kernel: 8 characters.
• As of Version V4.1 of the SIMOTION Kernel: 128 characters.
10002 Error while loading the interface of another UNIT, a library or technology package. The specified identifier is
contained in two different imported units, libraries or technology packages.
• Remove a unit, library or technology package from the import list or
• Establish uniqueness between the identifiers in imported units, libraries or technology packages. Change
the exporting units in the interface section or specify a namespace for a library or a technology package
(USELIB … AS namespace; USEPACKAGE … AS namespace; ).
10003 The specified data type has an invalid memory layout. Probably, the unit was created using an older version
of the compiler or compiled using incompatible options. If a unit is involved, it should compiled first. Then
repeat the current compilation. You can also perform "Save and recompile everything".
If a package is involved, a newer version should be installed.
If the error persists, inform the support department.
10004 The exported identifiers of the specified unit could not be loaded. Close some applications and try again.
10005 A recursion was detected on loading packages. The specified package has already been loaded with
USEPACKAGE and cannot be specified a second time.
10006 A recursion was detected on loading the unit. The specified unit has already been loaded with USES and
cannot be specified a second time.
10007 The maximum number of imported units which can be referenced in a unit was exceeded. A maximum of 223
imported units per load unit are permissible. Both units imported directly with USES and indirectly imported
units are counted.
10008 The number of imported packages that can be referenced in a unit has been exceeded. A maximum of 127
imported packages per load unit are permissible.
Error Description
10009 The specified package is used in the unit, but it is not available on the device. This error message occurs
when you compile with the "implicit package utilization" option and have programmed a USEPACKAGE
statement that has a different content than the packages specified on the device.
10010 The specified package is used in Unit a but not in Unit b. This error message occurs when different packages
have been specified with USEPACKAGE in units that reference each other with USES. Correct the
USEPACKAGE statements.
10011 The specified unit is used directly or indirectly by itself via one or more units. Correct the USES statements.
10012 The specified unit is imported directly or indirectly into several units in different compilation versions.
Recompile all units that reference the specified unit in the USES statement.
10013 The specified unit has not yet been compiled, or an error occurred during the last compilation. Compile this
unit first to ensure successful compilation.
10014 The type of specified technology object (TO) is not supported by the package specified previously during
compilation with USEPACKAGE. Use a package that contains the TO type.
10015 The maximum number of technology objects (TO) which can be referenced in a unit was exceeded. A
maximum of 65535 TOs can be referenced.
10016 The device type parameter is not available. If the unit to be compiled is not to be assigned to a device, use
the statement UNIT xx : dvtype;
10017 The device type has not been specified uniquely. In the unit, the statement UNIT xx : dvtype; specifies a
different device type than the one determined via the assignment of the unit to the device.
10018 The specified unit could not be found. Check whether the unit name is available in the PROGRAM container
of Workbench or whether the specified file is contained in the current working directory (only u7bt00ax -
command line).
10019 The specified technology package could not be found. Observe the preceding error outputs.
10020 Error occurred while loading the technology package. Observe further error outputs.
10021 The technology package is used in the specified source file, however, it is not selected on the device. Correct
the USEPACKAGE statement, or select the technology package on the device.
10022 The specified technology package is being used with different versions. Correct the settings for the
technology package selection on the device and, if required, in the library. Only one version of a technology
package can be used on a device.
10030 The device type has not been specified uniquely. In the unit, the statement UNIT xx : dvtype; specifies a
different device type than the one determined via the assignment of the unit to the library container.
10031 The specified library is used directly or indirectly by itself via one or more libraries. Correct the USELIB
statements.
10032 The specified library could not be found. Check your project.
10033 A recursion was detected on loading the library. The specified library has already been loaded with USELIB
and cannot be specified a second time.
10034 The specified library is not completely compiled. Possible causes:
• The library has not yet been compiled.
• The library has not been compiled for all device types specified for the library container (e.g. in project-
wide compilation).
• An error occurred in the last compilation.
First compile this library individually (accept and compile).
10035 The specified library could not be found. Check whether the library name is available in the Workbench
project or whether the specified file is contained in the current working directory (only u7bt00ax command
line).
Error Description
10036 The specified package is used in the source file, but it is not available in the library. Libraries are generally
compiled against the package versions specified in the library container. You have programmed a
USEPACKAGE statement that has a different content than the packages specified in the library. Either select
the correct package version or remove the USEPACKAGE statement from the source file.
10037 The code variant for the current device type is not selected for the specified library. This means this library
cannot be used. Activate the code variant for this library.
10100 The specified type of a technology object is contained in several packages that were referenced by the
source file. Please choose the technology package that meets your requirements.
10101 The specified technology object is not compatible with the types of technology objects supported by the
loaded packages Update the package or change the type of technology object.
Error Description
15001 The specified construct is not supported by the current version of the compiler.
15002 The currently selected device does not support the specified function. Select a different device version if you
want to use this function. To do so, replace the CPU in the hardware catalog and, if necessary, update the
firmware.
15003 The specified identifier is a keyword that is not supported and therefore cannot be used as user-specific in order
to ensure compatibility with later compiler versions.
15004 The specified identifier denotes a standard function that is not supported and cannot be used as user-specific
identifier in order to ensure compatibility with later compiler versions.
15005 The specified identifier denotes a non-supported standard function and cannot be used as user-specified
identifier in order to ensure compatibility with later compiler versions.
15006 The specified construct can only be used in source files generated with MCC. Usage in ST is not possible.
15007 A source/library/package is used in the implementation section either directly or indirectly without specifying a
namespace. In the interface section, it is used with a namespace. Solve this conflict by specifying a namespace
in the interface section for the specified source/library/package.
15070 The specified construct does not conform to the language standard, however, for compatibility reasons, is not
supported for old platforms. Convert the usage to the specified alternative.
15152 A USES, USELIB, or USEPACKAGE statement was found in a source file section hidden by conditional
compilation. This is illegal. Source file sections that contain these statements cannot be complied conditionally.
15153 The specified definition is not considered during code generation. It is not possible to define keywords
differently.
15200 The specification of a bit offset for a bitstring variable requires the "Permit language extensions" compiler option
(-C lang_ext).
A.2.11 Warnings
Error Description
16001 (Warning class: 0)
Only in conjunction with the "Selective Linking" compiler option. The specified function, the function block, or
the program are neither exported nor called in the current unit. No code is generated.
16002 (Warning class: 0)
Only in conjunction with the "Selective Linking" compiler option. The specified unit does not contain any
exported PROGRAM nor any task link. No code is generated for the unit.
16003 (Warning class: 2)
The operands of the comparison operation do not contain any explicit type definition. The data type listed in
the comparison can be seen in the warning message issued. Specify the data type of the used constants
explicitly with <type>#<value>.
16004 (Warning class: 2)
The specified type conversion may cause the variable value to change due to the reduced display width or
inadequate accuracy of the target data type.
16005 (Warning class: 2)
During type conversion, the dependency of the variable value can cause the sign to change.
16006 (Warning class: 2)
The specified value will be rounded to the next displayable value due to insufficient display width.
16007 (Warning class: 2)
A loss of accuracy occurred during type conversion. Not all decimal places are considered.
16008 (Warning class: 2)
A loss of accuracy occurred during initialization of the specified variables. The constant will be converted to the
specified data type. Not all decimal places are considered.
16009 (Warning class: 0)
Only in connection with compiler option Selective Linking. The specified unit does not contain any exported
PROGRAMs or any task linking. Unable to access unit code. Unable to call relevant POU.
16010 (Warning class: 0)
Specified program not exported to unit; therefore unable to use it in configuration of the execution level.
16011 (Warning class: 0)
The source file does not contain any exported global variables. No data are loaded to the target system.
16012 (Warning class: 0)
The specified source file name was taken over from the PROGRAMS container of the selected device. The
identifier of the source file in the UNIT statement was ignored.
16013 (Warning class: 2)
Because of the marshalling function, the specified data type is not portably convertible. Only use SIMOTION
devices in connection with this data type, or perform an explicit conversion of the data type.
16014 (Warning class: 2)
With the specified operation, a data type conversion is performed between signed and unsigned. Because the
bit string is adopted in this case, the resulting numerical value can differ from the specified value.
Error Description
16015 (Warning class: 2)
For the assignment of the character string constants to the variables, only part of the character string
constants is transferred, because the length of the variable is insufficient to accept all characters.
16016 (Warning class: 2)
The operands in the expression do not contain any explicit type definition. The data type of the operation is
determined by specifying the values. The resulting data type in which the expression is calculated can be seen
in the issued warning message. To define the data type:
• Specify the data type of the used constants explicitly with <type>#<value>.
• Use an explicit data type conversion.
16017 (Warning class: 2)
The operands in the expression contain only constants. The data type of the operation can be determined by
specifying the data type (in the form <type>#<value>) or explicit data type conversion.
This output is used for finding problems, in particular, for the use of symbolic constants, because the data type
of the operation cannot normally be determined easily.
16018 (Warning class: 2)
The data type of the comparison operation is defined using the value of a constant that has a larger value
range than the contained variable. The comparison is performed with the data type of the constant.
16020 (Warning class: 1)
The declaration hides the specified identifier, which has been globally defined in its own source file or an
imported source file. Access to the global identifier is no longer possible from the POU where this identifier is
declared locally.
16021 (Warning class: 1)
The declaration hides the specified identifier, which is defined on the device. You can access the global device
identifier with _device.<name>.
16022 (Warning class: 1)
The declaration hides the specified identifier, which is defined in the project (e.g. technology object or device).
You can access the global project identifier with _project.<name>.
16023 (Warning class: 1)
The declaration hides the specified identifier for the data type of a technology object. Access to the data type
identifier is no longer possible.
16024 (Warning class: 1)
The declaration hides the access to the technology object on the device. You can access this TO with
_to.<name>.
16025 (Warning class: 1)
The declaration hides the IEC standard function with the identical name. Access to this function is no longer
possible in the current context.
16026 (Warning class: 1)
The specified identifier is reserved by SIEMENS for potential extensions. The use of this identifier can cause
compiler errors in later versions. If you want to avoid this, change this identifier.
16030 (Warning class: 1)
A label has been specified several times in a CASE statement. Only the first label is ever evaluated. Other
specifications have no effect.
16102 (Warning class: 3)
The option for output of code for the program status diagnosis function is ignored because no debug
information was generated. Output of debug information was deactivated via compiler options.
Error Description
16103 (Warning class: 3)
The option for outputting code at the library for the program status diagnosis function is ignored. The code for
program status is generated as defined in the option in the individual source files.
16150 (Warning class: 7)
A new definition has been made for the specified identifier. Consequently, the previous definition is invalid.
This warning enables the work of the preprocessor to be tracked.
16151 (Warning class: 7)
An attempt has been made to delete the definition of the specified identifier with #undef. However, the
identifier is not defined or the definition is already deleted.
This warning enables the work of the preprocessor to be tracked.
16152 (Warning class: 7)
The specified definition is not considered during code generation. The cause for this can be that the
preprocessor is deactivated for the compiled source.
16153 (Warning class: 7)
The preprocessor is not active in the current source, even though preprocesssor statements are used. Activate
the preprocessor or remove the statements.
16170 (Warning class: -)
The definition from sources imported using USES are not considered during the code generation.
16171 (Warning class: -)
The definition from the specified sources imported using USES could not be loaded. Compile the specified
source file beforehand.
16200 (Warning class: 4)
The use of a semaphore requires a global variable to enable access to it from a different task. Local task
operations do not have to be blocked via semaphores.
16210 (Warning class: 4)
The basis of the exponential function (EXPT standard function or ** operator) is negative. The operation can
be executed at run time only under the following conditions:
1. It can be used on a device with a version of the SIMOTION kernel as of V4.1.
2. The exponent is an integer.
The ExecutionFaultTask will be initiated for non-integer exponents or for use on a device with a version of the
SIMOTION kernel up to V4.0. The program will be aborted here.
16220 (Warning class: 4)
The condition of an IF statement, WHILE statement or REPEAT statement is a constant expression.
16230 (Warning class: 4)
The expression with the specified values does not cause any change to the result; optimized code will be
created.
16240 (Warning class: 4)
The expression with the specified values exceeds the definition range of the operation. The result may be
incorrect.
16300 (Warning class: 5)
The auxiliary value has a data type that cannot be converted to the data type configured for the message.
16301 (Warning class: 5)
The specified auxiliary value is not evaluated during output of the message.
Error Description
16302 (Warning class: 5)
The data type of the auxiliary value cannot be determined from the message configuration. The specified data
type is used.
16303 (Warning class: 5)
No auxiliary value has been specified for the function although the message configuration requires such a
value. A default value of the corresponding data type was added.
16304 (Warning class: 5)
An alarm accompanying value is specified using a constant or a constant expression. The resulting data type
of the alarm accompanying value can be seen in the issued warning message. To define the data type:
• Specify the data type of the used constants explicitly with <type>#<value>.
• Use an explicit data type conversion.
16400 (Warning class: 6)
A global variable has been declared in a library. This may mean that the library cannot be used more than
once.
16420 (Warning class: 6)
The return value has not been assigned within the function. If such a function is called, it returns a random
value.
16421 (Warning class: 6)
A variable that has neither been assigned nor read in the code has been declared.
16450 (Warning class: –)
A global variable has been created in the retentive memory range. This declaration is not permissible at the
specified position.
16451 (Warning class: –)
The initialization of large arrays with values other than 0 causes a high data volume in the controller. This
results in long load times as well as high memory utilization.
16452 (Warning class: –)
The specified program has a large quantity of instance data to be initialized. This can lead to a runtime
violation when the task is started because both the initialization code and the user code are being executed. In
particular, caution is advised in the case of SynchronousTasks.
16470 (Warning class: -)
The specified construct does not conform to the language standard, however, for compatibility reasons, is not
supported for old platforms. Convert the usage to the specified alternative.
16600 (Warning class: 6)
The specified variable is not contained in the initialization list. The default initialization value is used.
16601 (Warning class: 6)
The specified variable is not contained in the initialization list. The default initialization value is used.
16602 (Warning class: 6)
The specified variable is not contained in the initialization list. The default initialization value is used.
A.2.12 Information
Error Description
32010 (Warning class: 6)
The specified jump label identifier has been declared but not used.
32020 (Warning class: –)
The specified variable was declared globally in this source file or in another source file with the indicated data
type.
This information helps when searching for the cause of compilation errors. It is issued together with error
messages.
32021 (Warning class: –)
The specified variable was declared on the device as an I/O variable, a global device variable, or a system
variable.
This information helps when searching for the cause of compilation errors. It is issued together with error
messages.
32022 (Warning class: –)
The specified variable was declared in the project as a global identifier.
This information helps when searching for the cause of compilation errors. It is issued together with error
messages.
32023 (Warning class: –)
Until now, no valid declaration has been found for the specified identifier.
This information is issued together with error messages.
32024 (Warning class: 0)
The specified variable has been declared as a global identifier in the current unit or in an importing unit.
This information helps when searching for the cause of compilation errors. It is issued together with error
messages.
32030 (Warning class: 0)
The specified array initialization does not conform to IEC 61131-3. For portable programs, the array initialization
values should be placed into square brackets. Example of field initialization in compliance with the standard:
x : ARRAY [0 to 1] OF INT := [1, 2];
32050 (Warning class: 0)
The maximum size that can be reached via an HMI is 65536 bytes. This limit has been exceeded with the
specified variable. All subsequent variables cannot be reached either.
32300 (Warning class: 1)
A label has been specified several times in a CASE statement. Only the first label is ever evaluated. Other
specifications have no effect.
32650 (Warning class: 7)
The specified identifier will be replaced thereafter by the output text.
This information enables the work of the preprocessor to be tracked.
32651 (Warning class: 7)
The definition of the specified identifier has been deleted with #undef.
This information enables the work of the preprocessor to be tracked.
Error Description
32652 (Warning class: 7)
The identifier will be used with the specified replacement text in the source file. Compilation takes place with the
replacement text.
This information enables the work of the preprocessor to be tracked.
32653 (Warning class: 7)
The specified identifier will be replaced thereafter by the output text. This information appears if additional
replacements are loaded with a USES statement.
This information enables the work of the preprocessor to be tracked.
//----------------------------------------------------------------------------
// Notes for the INITIALIZATION of the user data are available
// at the end of the template
//----------------------------------------------------------------------------
INTERFACE
// All statements added between INTERFACE and END_INTERFACE/
// Keywords are used to define which source contents
// (variables, functions, function blocks, etc.) also in other
// sources (units) are available or exported.
USEPACKAGE cam;
// The technology packages to be used are known here and thus
// made usable in the source. Technology object (TO)-specific
// Commands can be used in this UNIT only when the
// appropriate package has been included.
// If a source file that uses USEPACKAGE cam is integrated via USES,
// it will be "inherited". USEPACKAGE can then be omitted.
// The package used in this example is "cam". However, other
// technology packages can also be used (see documentation).
// USELIB testlib;
// If library functions are to be used in the source file, they must be made
// known in the source, too. If the library
// with the name "testlib" does not exist in the project,
// the error message
// "Error 10035, "testlib.lib" library could not be loaded"
// "Error 10032, "testlib" library could not be loaded"
// will be output.
// If libraries are not being used, this line can be
// deleted..
// USES header;
// ********************************************************
// * Type definition in the INTERFACE *
// ********************************************************
VAR_GLOBAL CONSTANT
PI : REAL := 3.1415;
ARRAY_MAX : INT := 3;
END_VAR
// Declaration of a global constant. In the source file
// no other value can be assigned to the identifier.
structCollection : STRUCT
toAxisX : posaxis;
aInStruct1dim : array1dim;
eTrafficInStruct : enumTrafficLight;
iCounter : INT;
bStatus : WORD;
END_STRUCT;
// A user-defined structure is created here. It is possible to
// combine elementary data types (here INT and WORD) or already defined
// user data types (here "array1dim" and "enumTrafficLight") into
// one structure. In addition, types
// of technology objects can also be used.
// In the example, the structure contains an element of
// a positioning axis (posAxis).
// In the definition, make certain to sort the variables
// by size in increasing sequence
// (ARRAY, STRUCT, LREAL, DWORD, INT, BOOL ...)
// ********************************************************
// * Variable declaration in the INTERFACE *
// ********************************************************
g_aMy2dim : array2dim;
// Example of a declaration of a two-dimensional array
g_aMy1dim : array1dim;
// Example of a declaration of a one-dimensional array with
// use of a type declaration.
g_sMyStruct : structCollection;
// Variable of the type or with the structure of
// user_struct.
g_aMyArrayOfStruct : arrayOfStruct;
// The variable generated here contains a field from
// structural elements as declared in section TYPE/END_TYPE
END_VAR
VAR_GLOBAL RETAIN
END_VAR
// The variables declared with the add-on RETAIN are
// stored in the RETAIN data area of the hardware platform used and
// are therefore safe from network failure.
// The declaration of VAR, VAR CONSTANT, VAR_TEMP, VAR_INPUT, VAR_OUTPUT
// and VAR_IN_OUT is not permissible here.
// Variables that are defined in this section and thus exported
// can be reimported by means of the USES "template" into another source file (UNIT)
FUNCTION FC_myFirst;
FUNCTION_BLOCK FB_myFirst;
PROGRAM myPRG;
// The function blocks (FBs),
// functions (FCs) and programs defined in the implementation part are exported here
in the interface part,
// so that they can be used in other units.
// Non-exported FBs and FCs can only be used in this source file
// ("information hiding", placing in the interface only
// what other units absolutely need).
// A program that has not been exported cannot be assigned to any TASK
// deleted..
END_INTERFACE
A.3.4 Implementation
// ******************************************************
// * IMPLEMENTATION section *
// ******************************************************
IMPLEMENTATION
// In the IMPLEMENTATION section of a unit, the executable code sections
// are stored in various program organization units (POUs).
// A POU can be a program, FC, or FB.
VAR_GLOBAL CONSTANT
END_VAR
TYPE
END_TYPE
// The type definition can also be made in the IMPLEMENTATION section.
// However, this definition cannot be imported in another source file.
The type definition can, however, be used for variables
// in all POUs of the source file "Template". The definition of types must
// be performed before the declaration of a variable.
VAR_GLOBAL // In the user memory of the UNIT
g_boDigInput1 : BOOL;
// Boolean variable for "EXPRESSION" example (see below).
END_VAR
VAR_GLOBAL RETAIN
END_VAR
// The variables declared with the add-on RETAIN are
// stored in the RETAIN data area of the hardware platform used and
// are therefore safe from network failure.
// Variable declaration in the IMPLEMENTATION section.
// The declaration of VAR, VAR CONSTANT, VAR_TEMP, VAR_INPUT, VAR_OUTPUT
// and VAR_IN_OUT is not permissible here.
EXPRESSION xCond
xCond := g_boDigInput1;
END_EXPRESSION
// Definition of an EXPRESSION.
// An EXPRESSION is a special function case, which recognizes only the
// return values TRUE and FALSE. It is used in conjunction with the
// statement WAITFORCONDITON (see myPRG) and should only be used
// if the program is executed as part of
// a MotionTask. If "dig_input_1" (usual in a digital input or a
// condition in the program) takes on the value 1, the return value of the
// EXPRESSION is TRUE.
A.3.5 Function
// ********************************************************
// * FUNCTION *
// ********************************************************
VAR CONSTANT
END_VAR
TYPE
END_TYPE
// The type declaration can also be made in POUs. The
// basic difference is the validity of the
// type declaration. A type declared in a POU can only
// be used for variables within associated POU.
// ********************************************
// * Area for FC code or statements *
// ********************************************)
// Code is in the user memory.
g_eMyTraffic := YELLOW; // e.g. change the traffic light.
FC_myFirst := 17;
// In this example, the function returns the value "17" to the
// calling program.
END_FUNCTION
// ******************************************************
// * FUNCTION_BLOCK *
// ******************************************************
FUNCTION_BLOCK FB_myFirst
// The statement section of the FUNCTION_BLOCK POU begins here.
// Instance data are dependent where the instance is formed
// (see comments at the template end) in the user memory of UNIT
// or TASK and are initialized with STOP->RUN or starting the TASK
VAR CONSTANT
END_VAR
// Variables declared with VAR and VAR CONSTANT are
// static, i.e., on the next block call, their contents remain
// available and valid.
TYPE
END_TYPE
// The type definition can also be made in POUs. The
// basic difference is the validity of the
// Type definition. A type defined in a POU can only
// be used for variables within associated POU.
// ********************************************
// * Area for FB code or statements *
// ********************************************
A.3.7 Program
// ******************************************************
// * PROGRAM *
// ******************************************************
PROGRAM myPRG
// The statement section of the POU PROGRAM begins here.
VAR CONSTANT
END_VAR
TYPE
END_TYPE
// The type definition can also be made in POUs. The
// basic difference is the validity of the
// Type definition. A type defined in a POU can only
// be used for variables within associated POU.
VAR // In the user memory of the TASK.
instFBMyFirst : FB_myFirst;
// In order to be able to call an FB, an area for static
// variables (forming an instance) must be generated. This has to do with
// the "memory" of the FB.
retFCMyFirst : INT;
// Variable for the return value of the function.
END_VAR
instFBMyFirst ();
// FB call with a valid instance.
END_PROGRAM
END_IMPLEMENTATION
//----------------------------------------------------------------------------
// The user memory (heap) is managed separately for each UNIT and for each
// TASK:
// ==========================================================================
// * The user memory of a UNIT contains the following data:
// - VAR_GLOBAL from INTERFACE and IMPLEMENTATION
// * These are initialized (delete / set to zero and write initial values
// from the program, if necessary):
// - During startup
// - During loading (if initialization of all non-retentive data is
// selected)
//
// * The user memory of a TASK contains the following data:
// VAR of PROGRAMs
// * These are initialized (delete / set to zero and write initial values
// from the program, if necessary):
// - For cyclic tasks, once when STOP->RUN
// - For non-cyclic tasks, at start of task
//
// * The instance data of FUNCTION_BLOCKs (VAR_INPUT, VAR_OUTPUT,
// VAR_IN_OUT (reference), VAR) are dependent on where the instance of the FB
// is formed, in the user memory of a UNIT or TASK.
// Instantiation of the FB in
// - VAR_GLOBAL: Instance is located in the user memory of the UNIT
// - VAR in the PROGRAM: Instance is located in the user memory of the TASK
// - VAR in the FB: Instance is located in the user memory according to
// higher-level FB
// * The instance data are initialized as described above.
// Which variable type is located in which data area can be obtained in
// comments in the template.
//----------------------------------------------------------------------------
# +
#define, 245
+, 123
#else, 245
#endif, 245
#ifdef, 245
<
#ifndef, 245
#undef, 245 <, 125
<=, 125
<>, 125
*
*, 123
=
**, 123
=, 125
=>, 155
/
/, 123
>
>, 125
: >=, 125
:, 95, 105
:=, 113, 153, 154
1
-1.#IND, 260, 262
_ 1.#INF, 260, 262
-1.#INF, 260
_additionObjectType, 102
-1.#INF, 262
_alarm, 235
1.#QNAN, 260, 262
_camTrackType, 102
-1.#QNAN, 260
_controllerObjectType, 102
-1.#QNAN, 262
_device, 226, 235
_direct, 211, 214, 226, 235
_fixedGearType, 102
A
_formulaObjectType, 102
_getSafeValue Absolute identifier
Application, 226 Overview, 297
_project, 235 Access times
_sensorType, 102 Parameter, 156
P Program section
See Source file section, 169
Parameter
Program structure, 239
Access times, 156
Program structuring, 130
Block (syntax), 150
program variables
Declaration, 149
Definition, 189
Declaration, general, 106
In the data model, 188
Function and function block, 149
Variable model, 184
Transfer (in/out parameter), 154
Programming environment, 17
Transfer (input parameter), 153
Project
Transfer (output parameter), 155
Opening, 60
Transfer (principle), 153
Prototypes, 179
Parameter fields
Syntax, 325
posAxis, 102
R
Pragma
Attribute, 247 REAL, 90
Preprocessor statement, 244 Real number
Preprocessor See Floating-point number, 83
Activating, 45, 48 Reference, 101
Controlling, 243 Reference data, 237
Preprocessor statement, 244 References, 5
Using, 45, 48 Relational expressions, 125
Warning class, 49 REPEAT statement
Preprocessor statement Description, 137
Example, 246 Repetition statements and jump statements
Printing Syntax, 347
ST source file, 54 Reserved identifiers, 75, 299
Process image RETAIN, 186
Features, 212 Retentive variables
principle and use, 211, 220 Definition, 188
Symbolic access, 223 Variable model, 184
Process image of the BackgroundTask, 211 RETURN statement
Process image of the cyclic tasks, 211, 214 Description, 138
Process mode, 253 Rules
Program Formatted, 291, 307
Assigning tasks, 66 Semantics, 72
Call path, 268 Unformatted, 293, 307
Compiling, 64 RUN
Connecting to target system, 67 Effect on variable initialization, 200
Creating (example), 62
Download, 69
Executing, 66, 70 S
Locating errors, 252
SCOUT Workbench > See Workbench, 17
Source file section, 174
sections
starting, 66, 70
Syntax, 317
Status (test tool), 265
Separators, 294
Testing, 252
Sequential program execution
Program organization units
Effect on I/O access, 211, 214
Source file section, 171
Effect on variable initialization, 200
Syntax, 319
Setting
Program run, 263
Compiler, 44
Toolbar, 264
Shortcuts, 27
U ARRAY, 118
ARRAY, 118
UDINT, 90
Battery-backed, 188
UDINT#MAX, 92
Declaration, 106
UDINT#MIN, 92
Declaration (source file section), 177
UDT
elementary, 114
See User-defined data type, 94
Enumerator data type, 117
UINT, 90
Enumerator data type, 117
UINT#MAX, 92
Function block, 152
UINT#MIN, 92
Functions, 152
Unit
Hiding validity ranges, 231
Source file section, 179
Identical names, 231
Template (example), 367
Initializing, description, 107
UNIT, 179
Instance declaration of FB, 157
Unit constants
Parameter declaration, 149
Definition;, 186
Process image, 211, 220
Unit variables, 187
Retentive, 188
Definition, 186
static, 189
Variable model, 184
structured, 118
USELIB, 170
Temporary, 189
USEPACKAGE, 170
timing of initialization, 200
User-defined data type
Validity, 184
Syntax, 95
Watch tables, 261
USES, 170, 171, 181
USINT, 90
USINT#MAX, 92
W
USINT#MIN, 92
Warning class, 49, 243
Watch tables, 261
V WHILE statement
Description, 136
Value assignments
WORD, 90
Description, 113
Workbench
Syntax, 336
Elements, 19
Variable blocks
Programming environment, 17
Syntax, 323
Variables, 105