Sieth
Sieth
Sieth
13
Doc. Revision Y – Aug 23, 2018
Contents
INTRODUCTION ........................................................................................................................................................2
GENERAL INFORMATION ........................................................................................................................................3
DEVICE CHARACTERISTICS .....................................................................................................................................3
LINK CHARACTERISTICS ..........................................................................................................................................3
DRIVER CHARACTERISTICS .....................................................................................................................................3
CONFORMANCE TESTING ........................................................................................................................................4
SPECIAL DEVICE CONFIGURATIONS .........................................................................................................................5
INSTALLING THE DRIVER .......................................................................................................................................9
CONFIGURING THE DRIVER ................................................................................................................................ 10
SETTING THE COMMUNICATION PARAMETERS ....................................................................................................... 10
CONFIGURING THE DRIVER WORKSHEET .............................................................................................................. 12
MAIN DRIVER SHEET (MDS) ................................................................................................................................ 18
EXECUTING THE DRIVER ..................................................................................................................................... 22
TROUBLESHOOTING ............................................................................................................................................ 23
REVISION HISTORY............................................................................................................................................... 27
1/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Introduction
The SIETH driver enables communication between Studio system and the Siemens devices using Ethernet,
according to the specifications discussed in this publication.
This publication was designed to help you install, configure, and execute the SIETH driver to enable
communication with the Siemens devices. The information in this publication is organized as follows:
Introduction: Provides an overview of the SIETH driver documentation.
General Information: Provides information needed to identify all the required components (hardware and
software) used to implement communication between Studio and the SIETH driver.
Installing the Driver: Explains how to install the SIETH driver.
Configuring the Driver: Explains how to configure the communication driver.
Executing the Driver: Explains how to execute the driver to verify that you installed and configured the
driver correctly.
Troubleshooting: Lists the most common error codes for this protocol.
Sample Application: Explains how to use a sample application to test the driver configuration.
Revision History: Provides a log of all modifications made to the driver and the documentation.
Notes:
• This document assumes that you have read the “Development Environment” chapter in the product’s
Technical Reference Manual.
• This document also assumes that you are familiar with the Windows XP/7/8 environment.
If you are unfamiliar with Windows XP/7/8, we suggest using the Help feature (available from the Windows
desktop Start menu) as you work through this guide.
2/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
General Information
This chapter explains how to identify all the hardware and software components used to implement
communication between the SIETH driver and Siemens devices.
The information is organized into the following sections:
Device Characteristics
Link Characteristics
Driver Characteristics
Conformance Testing
Device Characteristics
This driver has been tested successfully with the following devices:
Manufacturer: Siemens
Compatible Equipment: Any Siemens S7-200, Siemens S7-300/400 PLC communicating via an Industrial
Ethernet interface, S7-1200, S7-1500, and LOGO! in S7-200 mode
Siemens PLC Programmer Software: Step-7, Step7-MicroWin, TIA Portal
Link Characteristics
To establish communication, you must use links with the following specifications:
Device Communication Port: Ethernet Port
Physical Protocol: TCP/IP
Logic Protocol: S7 Messaging on Industrial Ethernet
Adapters/Converters: Standard Ethernet card
Driver Characteristics
The SIETH driver is composed of the following files:
SIETH.INI: Internal driver file. You must not modify this file.
SIETH.MSG: Internal driver file containing error messages for each error code.
You must not modify this file.
SIETH.PDF: Document providing detailed information about the SIETH driver.
SIETH.DLL: Compiled driver.
Notes:
• All of the preceding files are installed in the /DRV subdirectory of the Studio installation directory.
The SIETH driver requires the AGLINK.DLL into the /BIN.
You can use the SIETH driver on the following operating systems:
Windows XP/7/8 and Servers 2003/2008/2012
Windows CE
3/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Register Type Write Read Bit Byte Word DWord Float String
M (Flags)
SM (Special Flags)
T (Timers)
Z or C (Counters)
E or I (Inputs)
A or Q (Outputs)
DB or V (Data Blocks)
Note:
The V Register from S7-200 devices can be accessed with the DB1 Register
Conformance Testing
The following hardware/software was used for conformance testing:
Driver Configuration:
– PLC Program: Step 7
– Protocol: S7 Messaging on Industrial Ethernet
Driver Studio
Operating System Equipment
Version Version
S7-315 2DP with CP343
8.0 + Windows XP/7/8
S7-215 with CP-243
10.13 SP1 Windows CE 5.0 (x86) and
S7-1500 (CPU 1511-1 PN).
+P1 7.0 (ARMV4I)
S7-400 (CPU 412-2)
4/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
1- After adding the proper CPU to the PLC program, go to the device properties (e.g. right click on
the CPU name and pick Properties);
2- Under General tab select Protection at the menu list on the right side;
3- Under Protection make sure you have the access level “Full access (no protection)” selected;
4- At the bottom of this screen, under “Connection mechanisms” enable the option (CHECK the box)
“Permit access with PUT/GET communication from remote partner (PLC, HMI, OPC, …)”. See
screenshot below;
5/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
The Data Blocks (DB’s) on SIMATIC TIA Portal V12 are created by default with the option “Optimized
block access” enabled. This option provides data only over the variable names (Tags names). Since the
InduSoft drivers access the memory offsets, this options must be manually disabled.
1- Go to the Data Block properties dialog (e.g. right click on the desired DB and pick Properties);
2- On menu Attributes disable the option (UNCHECK the box) “Optimized block access”. See
screenshot below.
6/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Opening the Data Block view, the additional column “Offset” must be shown on the table which brings the
memory offsets to be used on the InduSoft drivers such as the SIETH.
Note:
For arrays, the main offset must be added with the element offset – e.g. DB1.DBB6 (Byte 6) refers to the
array element Static_3[2], DB1.DBB14 (byte 14) refers to the array element Static_3[10] on the Data
Block shown above.
7/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
When you have a LOGO! CPU with Ethernet, such as the Logo!12/24 RCE and Logo!230 RCE, you can
configure its communication to act as a S7-200 PLC.
The screenshot below shows where to configure the TSAP on the LOGO! Software. Also, be sure to
check the indicated boxes.
Note:
Please refer to the Communication Settings and the Station fields on the Driver Sheets on how to
properly configure the TSAP parameters.
8/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
5. When the SIETH driver displays in the Selected Drivers list, click the OK button to close the dialog.
Attention:
For safety reasons, you must be careful when installing the physical hardware. Consult the hardware
manufacturer’s documentation for specific installation instructions.
9/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Notes:
For a detailed description of the Studio Standard and MAIN Driver Worksheets, and information about
configuring the standard fields, review the product’s Technical Reference Manual.
10/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
4. This driver does not have custom parameters. Specify the parameters as noted in the following table.
1-Signed 0 0 or 1 This value will be default if you do not specify the Unsigned/Signed
0-Unsigned Value parameter for each format address.
5. For S7-200 communication (as well as LOGO!), configure the Remote TSAP in the Station field in the
advanced settings. If Station field is left empty, the default Remote TSAP of 0x4D57 is used. In the Station of
Protocol, we can configure the Remote TSAP value.
11/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Notes:
The Remote and Local TSAP are configured in S7-200 using Micro/WIN’s Ethernet Wizard. In that wizard,
TSAP’s are configured in the format XX.YY. In SIETH driver, write these values as XXYY. The Remote
and Local TSAPs are shown in this documentation using the same perspective as Micro/WIN. That is,
configure the TSAP’s with the same values in both driver and Micro/WIN. For Configuration of Local TSAP
refer to configuration of the worksheets.
Note:
Additional communication settings can be accessed in the Advanced Settings dialog. To open this dialog,
simply click the Advanced button in the Communication Settings dialog.
Simultaneous connection are supported on this driver for configuring this settings please check the
“Simutaneos Requests” field on the advanced settings dialog. The maximum supported simultaneous
connections are 32 and 16 per station.
Note:
To optimize communication and ensure better system performance, you must tie the tags in different
driver worksheets to the events that trigger communication between each tag group and the period in
which each tag group must be read or written. Also, we recommend configuring the communication
addresses in sequential blocks to improve performance.
12/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
In general, all parameters on the Driver worksheet (except the Station, Header and Address fields) are standard
for all communication drivers, and they will not be discussed in this publication. For detailed information about
configuring the standard parameters, consult the Studio Technical Reference Manual.
4. Use the following information to complete the Station, Header, and Address fields on this worksheet:
Station field: Use this field to specify the IP Address, Rack, Slot and Local TSAP.
Syntax:
For S7-300, S7-400, S7-1200 and S7-1500:
<IP Address>:<Rack>:<Slot>[:<Port>]
The user may also prefix the syntax above with S7-300: or S7-400: if desired, however this is optional.
Examples
192.168.0.10:0:2
S7-300:192.168.0.10:1:1
192.168.0.10:0:1
Note:
The most common configuration for S7-300 and S7-400 is to have the CPU on the Slot number 2 of the
Rack 0. In that case, the Station would look like: <IP Address>:0:2
As for the S7-1200 and S7-1500, usually the CPU is seen on the Slot number 1 of the Rack 0, which
would then cause the Station field to like: <IP Address>:0:1
13/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
For S7-200 and connected to the network via a CP243 module, and LOGO! use the syntax:
S7-200:<IP Address>[:<Port>]
The port parameter is optional and defaults to 102.
Or:
S7-200:<IP Address>:<Port>[:<Local TSAP>]
The Local TSAP parameter is optional and default to 4D57. To include the Local TSAP, you must include the Port
number.
Examples:
S7-200:192.168.0.21
S7-200:192.168.0.21:102
S7-200:192.168.0.21:102:1100
S7-200:192.168.0.21:102:1200
Notes:
The Remote and Local TSAP are configured in S7-200 using Micro/WIN’s Ethernet Wizard. In that wizard,
TSAP’s are configured in the format XX.YY. In SIETH driver, write these values as XXYY. The Remote
and Local TSAPs are shown in this documentation using the same perspective as Micro/WIN. That is,
configure the TSAP’s with the same values in both driver and Micro/WIN. For Configuration of Remote
TSAP refer to configuration of the driver settings.
Header field: Use the information in the following table to define the type of variables that will be read from or
written to the device and a reference to the initial address.
These variables must comply with the following syntax:
For Flags, Special Flags, Timers, Counters, Inputs and Outputs:
<Type>:<optAddressReference> (for example: M:1)
For Data Blocks:
<Type><TypeGroup>:<optAddressReference> (for example: DB2:1) or
<Type><TypeGroup>.DB :<optAddressReference> (for example: DB2.DB or DB2.DB:1)
Where:
– <Type> is the register type. (M=Flags, SM=Special Flags, T=Timers, Z or C=Counters, E or
I=Inputs, A or Q=Outputs,
and DB=Data Blocks)
– <TypeGroup> is the group number of the configured register type (for Data Block types only).
– <optAddressReference> (optional) is the initial address reference of the configured group. If
it is not configured, it assumes the value 0 (zero). This number always refers to the Byte address
number (see the following table).
Note:
SIETH driver supports until 8 (eight) different stations, if you need more please contact your Studio
technical support representative
14/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
The following table lists all of the valid initial address (reference) values for the SIETH driver:
The next table lists all of the data types and address ranges that are valid for the SIETH driver:
Counters Z:10 , C:10 or Z,C Varies according to the equipment Counter Values
Inputs E:5 , I:5 or E,I Varies according to the equipment Physical Input Values
Outputs A:8 , Q:8 or A,Q Varies according to the equipment Physical Output Values
Data Blocks DB2:1, or DB2.DB Varies according to the equipment Data block values, where:
or DB2.DB:1 Number following DB(2) specifies the data block number
Number following the colon specifies the word offset in the data block
15/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Address field: Use the information provided in the following table to associate each tag to its respective device
address.
Type the tag from your application database into the Tag Name column. This tag will receive values from or
send values to an address on the device. The address must comply with the following syntax:
[Signed/Unsigned]<Format><AddressOffset>.<Bit> (for example: X10.2)
<Format><AddressOffset>.<Len> (for example: ST2.10, SST2.10) – String format only
Where:
[Signed/Unsigned] (optional parameter used for integer values only): If you do not specify
this parameter, Studio inserts an integer value based on the parameters you set in the
Communication Parameters dialog. Valid values are S (signed) and U (unsigned). Dword does
not use U (unsigned).
<Format> defines how Studio treats the value read or written from/to the device.
(X=Bit, B=Byte or Bit, W=Word, D or DW=Dword, F=Float, ST=String, SST= S7 String format).
For Data-Blocks:
T=Timer Format (S5T), TS=Timer in String format (hh:mm:ss:ms), C=Counter Format
<AddressOffset> is a parameter added to the AddressReference parameter (configured in the
Header field) to compose the group address configured in the Header field.
<Bit> is the bit number (from 0 – 7) from the Byte address. This parameter is optional, and it is
supported only when the format is Byte or Bit(B or X).
<Len> is the length to read or to write. It is in bytes. String format only.
Note:
T, TS and C data formats are most used for Data-Blocks operand, however they can be used for all
operands.
16/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
17/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Attention:
You must not configure a range of addresses in the same worksheet that is greater than the maximum
block size (data buffer length) supported by the protocol. The maximum data buffer length for this driver
is 1024 bytes in each Standard Driver worksheet.
If you are using a S7-200 the block size restrictions are different than for other families. For timers the
limitation is of 12 operands, counters are limited on 21 operands and the other headers are limited on 64
bytes.
18/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Syntax:
For S7-300, S7-400, S7-1200 and S7:1500
<IP Address>:<Rack>:<Slot>[:<Port>]
The user may also prefix the syntax above with S7-300: or S7-400: if desired, however this is optional.
Examples
192.168.0.10:0:2
S7-300:192.168.0.10:1:1
192.168.0.10:0:1
Note:
The most common configuration for S7-300 and S7-400 is to have the CPU on the Slot number 2 of the
Rack 0. In that case, the Station would look like: <IP Address>:0:2
As for the S7-1200 and S7-1500, usually the CPU is seen on the Slot number 1 of the Rack 0, which
would then cause the Station field to like: <IP Address>:0:1
19/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
If the device is a S7-200 connected to the network via a CP243 module, or a LOGO!, use the syntax:
S7-200:<IP Address>[:<Port>]
Examples:
192.168.0.10:0:2
S7-300:192.168.0.10:1:1
S7-200:192.168.0.21
S7-200:192.168.0.21:102
S7-200:192.168.0.21:102:1100
S7-200:192.168.0.21:102:1200
S7-200:192.168.0.21:102:1700
Notes:
The Remote and Local TSAP are configured in S7-200 using Micro/WIN’s Ethernet Wizard. In that wizard,
TSAP’s are configured in the format XX.YY. In SIETH driver, write these values as XXYY. The Remote
and Local TSAPs are shown in this documentation using the same perspective as Micro/WIN. That is,
configure the TSAP’s with the same values in both driver and Micro/WIN. For Configuration of Remote
TSAP refer to configuration of the driver settings.
I/O Address: Address of each register from the PLC. The syntax used in this field is described below:
For Flags, Special Flags, Timers, Counters, Inputs and Outputs:
<Type>[Signed/Unsigned]<Format><Address>.<Bit> (for example: MB10.2)
<Type><Format><Address>.<Len> (for example: MST2.10) – String format only
For Data Blocks:
<Type><TypeGroup>[Signed/Unsigned]<Format><Address>.<Bit> (for example: DB2W1)
<Type><TypeGroup>.DB[Signed/Unsigned]<Format><Address>.<Bit> (for example:
DB2.DBB1, DB2.DBUB5, DB2.DBD20)
<Type><TypeGroup><Format><Address>.<Len> (for example: DB2:ST2.10) – String format
only
Where:
– [Signed/Unsigned] (optional): Parameter used for integer values only. If you do not specify this
parameter, Studio uses the Communication Parameters settings to configure integers.
Valid values for this parameter are S (Signed) or U (Unsigned). Dword does not use U (Unsigned).
– <Type> is the register type. (M=Flags, SM=Special Flags, T=Timers, Z or C=Counters, E or I=Inputs, A
or Q=Outputs,
and DB=Data Blocks)
– <TypeGroup> is the group number of the configured register type (for Data Block types only).
20/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
– <Address> is the device address. This number always refers to the Byte address number.
– <Format> defines how Studio treats the value read or written from/to the device (X=Bit, B=Byte or
Bit, W=Word, D or DW=DWord, F=Float, ST=String). (String format does not support bits)
For Data-Blocks:
T=Timer Format (S5T), TS=Timer in String format (hh:mm:ss:ms), C=Counter Format
– <Bit> is the bit number (from 0 – 7) from the Byte address. This parameter is optional, and it is
supported only when the format is Byte or Bit (B or X).
Note:
SIETH driver supports until 8 (eight) different stations, if you need more please contact your Studio
technical support representative
Note:
SIETH driver supports using hostnames in Station field.
Note:
T, TS and C data formats are most used for Data-Blocks operand, however they can be used for all
operands.
21/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
22/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Troubleshooting
If the SIETH driver fails to communicate with the device, the tag you configured for the Read Status or Write Status
fields will receive an error code. Use this error code and the following table to identify what kind of failure
occurred.
23/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
24/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
25/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Tip:
You can verify communication status using the Studio development environment Output window (LogWin
module). To establish an event log for Field Read Commands, Field Write Commands, and Protocol Analyzer, right-
click in the Output window. When the pop-up menu displays, select the option to set the log events.
If you are unable to establish communication with the PLC, try to establish communication between the PLC
Programming Tool and the PLC.
Try pinging the PLC, or telnet to the default port, which is usually 102.
Quite frequently, communication is not possible because you have a hardware or cable problem, or a PLC
configuration error. After successfully establishing communication between the device’s Programming Tool and
the PLC, you can retest the supervisory driver.
If you must contact us for technical support, please have the following information available:
Operating system (type and version): To find this information, select Tools → System Information.
Project Information: To find this information, select Help → Support Information.
Driver version and communication log: Displays in the Studio Output window when the driver is running.
Device model and boards: Consult the hardware manufacturer’s documentation for this information.
26/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Revision History
B 1.01 Eric Vigiani 26 Jun 04 Fixed bug with bit writing and reading
C 1.02 Eric Vigiani 29 Sept 04 Fixed bug in the MDS with DB data type
E 1.04 Fabio Carvalho 19 Oct 05 Fixed bug on mapping functions. Changed from (AGLINK_API)
to (WINAPI)
H 1.07 Graziane C. Forti 07 Dec 06 Created Initial ID to Connection (to use more than one driver)
Implemented "Initial ID Connection” field in Communication
Parameters
I 3.00 Rafael R. Fernandes 26 Feb 08 Data types X and D (equivalent to Bit and DWord) were
created.
Driver was changed for Colon ( : ) to be optional in MAIN
DRIVER SHEET
New syntaxes to Data Blocks operand were added.
Included TS data type (Timer in string format)
Included Special Flags operand (SM).
K 10.1 Marcelo Carvalho 07 Jan 09 Updated driver version, no changes in the contents.
L 10.3 Fellipe Peternella 21 Apr 09 Modified the driver to support SST format
M 10.4 Lourenço Teodoro 02 Dec 09 - Modified the driver to create less communication groups and
optimize the communication
N 10.5 Fellipe Peternella 01 Apr 10 Fixed problem when communicating with multiple stations
O 10.6 André Körbes 21 Jul 10 - Siemens drivers are allowed to coexist on the same
application
- Added support to S7-200 ethernet communication via CP243
module
27/28
SIETH – Driver Version 10.13
Doc. Revision Y – Aug 23, 2018
Q 10.8 Ajay Anumalla 12 Mar 2013 - Included configuration of Remote and Local TSAP for S7-200.
- Fixed issues with subnets
- Fixed issues with Bit writing on S7-200
- Fixed address offset issue when above 10000
- Fixed a communication issue with WinAC SoftPLC
R 10.8 Andre Bastos 4 Jun 2013 - Updated documentation to show the configuration for S7-
1200/1500 and Logo! No changes in the driver
S 10.8 André Körbes 8 Oct 2013 - Updated documentation of the S7-300 and S7-400 station
examples to use Rack 0 and Slot 2.
U 10.9 Andre Bastos 17 Apr 2015 - Updated documentation only. No changes in the driver
V 10.10 Anushree Phanse 10 Jan 2017 - Added support to using hostnames in the station field.
- Changed INI file to increase range allowed for DB header
W 10.11 Anushree Phanse 10 Feb 2017 -Fixed issue of driver not running on CE devices after previous
release.
X 10.12 Anushree Phanse 23 Aug 2017 - Fixed issue of reading long reals or double floats with poor
precision and now they read as 64 bit reals
Y 10.13 Anushree Phanse 23 Aug 2018 - Added support for PLC port in station parameters
28/28