SIETH
SIETH
Driver Guide
Version: 10.15
SIETH Driver Guide
Contents
Introduction .................................................................................................................. 5
General Information ..................................................................................................... 7
Device Characteristics ........................................................................................................................7
Link Characteristics .............................................................................................................................7
Driver Characteristics ..........................................................................................................................7
Conformance Testing ..........................................................................................................................8
Special Device Configurations ............................................................................................................8
Installing the Driver .................................................................................................... 13
Configuring the Driver ................................................................................................ 15
Setting the Communication Parameters ...........................................................................................15
Configuring the Driver Worksheet .....................................................................................................17
Main Driver Sheet (MDS) ..................................................................................................................24
Executing the Driver ................................................................................................... 27
Troubleshooting ......................................................................................................... 29
Revision History ......................................................................................................... 33
Version: 10.15 3
SIETH Driver Guide
C HAPTER 1
Introduction
SIETH Communication Driver - Driver for Ethernet Communication
Between Studio and Siemens DevicesThe 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.
Note: 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.
Version: 10.15 5
SIETH Driver Guide
C HAPTER 2
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.
Note: 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
Version: 10.15 7
SIETH Driver Guide General Information
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
8 Version: 10.15
General Information SIETH Driver Guide
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;
Version: 10.15 9
SIETH Driver Guide General Information
2. On menu Attributes disable the option (UNCHECK the box) "Optimized block access". See
screenshot below.
10 Version: 10.15
General Information SIETH Driver Guide
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.LOGO! (Acting as S7-200)
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.
Version: 10.15 11
SIETH Driver Guide General Information
Note: Please refer to the Communication Settings and the Station fields on the Driver Sheets on how to
properly configure the TSAP parameters.
12 Version: 10.15
SIETH Driver Guide
C HAPTER 3
Installing the Driver
When you install Studio version 5.1 or higher, all of the communication drivers are installed
automatically.
You must select the driver that is appropriate for the application you are using.
Perform the following steps to select the driver from within the application:
1. Open Studio from the Start menu.
2. From the Studio main menu bar, select File →Open Project to open your application.
3. Select Insert →Driver from the main menu bar to open the Communication Drivers dialog.
4. Select the SIETH driver from the Available Drivers list, and then click the Select button:
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.
Version: 10.15 13
SIETH Driver Guide
C HAPTER 4
Configuring the Driver
After opening Studio and selecting the SIETH driver, you must configure the driver. Configuring the
SIETH driver is done in two parts:
Specifying communication parameters
Defining communication tags and controls in the Communication tables or Driver worksheet
Worksheets are divided into two sections, a Header and a Body. The fields contained in these two
sections are standard for all communications drivers — except the Station, Header and Address fields,
which are driver-specific. This document explains how to configure the Station, Header and Address
fields only.
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.
Version: 10.15 15
SIETH Driver Guide Configuring the Driver
This driver does not have custom parameters. Specify the parameters as noted in the following table.
Parameters Default Valid Description
Values Values
1-Signed This value will be default if you do not specify the
0-Unsigned 0 0 or 1 Unsigned/Signed parameter for each format
Value address.
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.
16 Version: 10.15
Configuring the Driver SIETH Driver Guide
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.
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.
4. Click OK to close the dialog.
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.
Version: 10.15 17
SIETH Driver Guide Configuring the Driver
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.
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
18 Version: 10.15
Configuring the Driver SIETH Driver Guide
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
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
Note:
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).
Version: 10.15 19
SIETH Driver Guide Configuring the Driver
Note: SIETH driver supports until 8 (eight) different stations, if you need more please contact your Studio
technical support representative
Byte 0 Byte 0
W0
Byte 1 Byte 1 W1
Byte 2 Byte 2
W2
Byte 3 Byte 3 W3
Byte 4 Byte 4 W4
Byte 5 Byte 5 W5
Byte 6 Byte 6
W6
Byte 7 Byte 7 W7
Byte 8 Byte 8
W8
Byte 9 Byte 9 W9
Byte 10 Byte 10
W10
Byte 11 Byte 11
The next table lists all of the data types and address ranges that are valid for the SIETH driver:
Data
Types Sample Syntax Comments
20 Version: 10.15
Configuring the Driver SIETH Driver Guide
Data
Types Sample Syntax Comments
Note: T, TS and C data formats are most used for Data-Blocks operand, however they can be used for
all operands.
Version: 10.15 21
SIETH Driver Guide Configuring the Driver
22 Version: 10.15
Configuring the Driver SIETH Driver Guide
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.
Version: 10.15 23
SIETH Driver Guide Configuring the Driver
The MAIN DRIVER SHEET provides a simple way to associate Studio tags to addresses in the PLC.
Most of the MAIN DRIVER SHEET entries are standard for any driver. Refer to the Studio Technical
Reference Manual about the configuration of the standard fields. The fields that require specific syntax
for this driver are described below:
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
24 Version: 10.15
Configuring the Driver SIETH Driver Guide
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
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>]
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.
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
Note: 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).
<Address> is the device address. This number always refers to the Byte address number.
Version: 10.15 25
SIETH Driver Guide Configuring the Driver
<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).
<Len> is the length to read or to write. It is in bytes. String format only.
Note:
SIETH driver supports until 8 (eight) different stations, if you need more please contact your Studio
technical support representative
SIETH driver supports using hostnames in Station field.
T, TS and C data formats are most used for Data-Blocks operand, however they can be used for all
operands.
26 Version: 10.15
SIETH Driver Guide
C HAPTER 5
Executing the Driver
After adding the SIETH driver to a project, Studio sets the project to execute the driver automatically
when you start the run-time environment.
To verify that the driver run-time task is enabled and will start correctly, perform the following steps:
1. Select Project → Status from the main menu bar.
The Project Status dialog displays:
Version: 10.15 27
SIETH Driver Guide
C HAPTER 6
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.
Error
Description
Code
Version: 10.15 29
SIETH Driver Guide Troubleshooting
Error
Description
Code
30 Version: 10.15
Troubleshooting SIETH Driver Guide
Error
Description
Code
Version: 10.15 31
SIETH Driver Guide Troubleshooting
Error
Description
Code
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.
32 Version: 10.15
SIETH Driver Guide
C HAPTER 7
Revision History
Driver Date Description of Changes
Version
Version: 10.15 33
SIETH Driver Guide Revision History
34 Version: 10.15