SIETH
SIETH
SIETH
9
Doc. Revision U Apr 17, 2015
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
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:
General Information: Provides information needed to identify all the required components (hardware and
software) used to implement communication between Studio and the SIETH 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 products
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
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:
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.
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:
3/28
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
Version
Studio
Version
Operating System
Equipment
10.9
7.1 +
SP3
Windows XP/7/8
Windows CE 5.0 and 6.0
4/28
S7-1200 / S7-1500
For the PLCs of these families, you have to enable the communication to remote devices on the
SIEMENS TIA-Portal software.
Please follow the steps below to permit access communication from remote partners:
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-
6-
5/28
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.
3-
6/28
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
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
Caution:
For safety reasons, you must use caution when installing the physical hardware. Consult the hardware
manufacturers documentation for specific installation instructions.
9/28
10/28
Default Values
Valid Values
0 or 1
Description
This value will be default if you do not specify the Unsigned/Signed
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
Notes:
The Remote and Local TSAP are configured in S7-200 using Micro/WINs Ethernet Wizard. In that wizard,
TSAPs 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 TSAPs 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
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
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/WINs Ethernet Wizard. In that wizard,
TSAPs 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 TSAPs 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:
Note:
SIETH driver supports until 8 (eight) different stations, if you need more please contact your Studio
technical support representative
14/28
The following table lists all of the valid initial address (reference) values for the SIETH driver:
Header Address
SIETH Address
Byte 0
Byte 0
Byte 1
Byte 1
Byte 2
Byte 2
Byte 3
Byte 3
Byte 4
Byte 4
Byte 5
Byte 5
Byte 6
Byte 6
Byte 7
Byte 7
Byte 8
Byte 8
Byte 9
Byte 9
Byte 10
Byte 10
Byte 11
Byte 11
W1
W2
W3
W4
W5
W6
W7
W8
W9
W10
The next table lists all of the data types and address ranges that are valid for the SIETH driver:
Header Field Information
Data
Types
Sample Syntax
Comments
Flags
M:1 or M
Logical Flags
Special
Flags
SM:1 or SM
Special Flags
Timers
T:2 or T
Timer Values
Counters
Counter Values
Inputs
Outputs
Data Blocks
DB2:1, or DB2.DB
or DB2.DB:1
15/28
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.
M (Byte 6)
Header Field
Address Field
W5
M:5
W0
M:3
W2
B5
M:5
B0
M:1
B4
M:6
M:3
B3
ST7.10
SM
W5
SM:5
W0
SM:3
W2
SM
B5
SM:5
B0
16/28
T (33)
T(35)
C (3)
C (4)
DB5 (Byte 3)
DB5 (Address 8)
Header Field
Address Field
SM:1
B4
SM
B6
SM:6
B0
SM:3
B3
SM
ST7.10
SM:7
ST0.10
SM:4
ST3.10
33
T:30
T33
T0
T:35
T31
C:3
C0
C:2
C:4
C:2
DB5:0
W2
DB5:2
W0
DB5:1
W1
DB5.DB
B2
DB5:2
B0
DB5:1
B1
DB5.DB:0
B3
DB5:3
B0
DB5:2
B1
DB5:0
ST4.10
DB5:4
ST0.10
DB5:2
ST2.10
DB5:0
SST4.10
DB5:4
SST0.10
DB5:2
SST2.10
DB5:0
W7
DB5:7
W0
DB5:4
W3
DB5:0
B7
DB5:7
B0
DB5:4
B3
DB5:0
C8 (counter format)
DB5:8
T0 (timer format)
DB5:4
17/28
Header Field
Address Field
DB5.DB
D3
DB5:0
DW3
DB5.DB:2
DW1
I:0 or E:0
X1.4
I:1 or E:1
X0.4
I:0 or E:0
B1.4
Input (Byte 1)
I:0 or E:0
B1
I:1 or E:1
B0
Output(Address 1, bit 4)
Q:0 or A:0
X1.4
Q:1 or A:1
X0.4
Q:0 or A:0
B1.4
Q:0 or A:0
B1
Q:1 or A:1
B0
Output(Byte 1)
Caution:
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
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
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
Notes:
The Remote and Local TSAP are configured in S7-200 using Micro/WINs Ethernet Wizard. In that wizard,
TSAPs 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 TSAPs 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
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
<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:
T, TS and C data formats are most used for Data-Blocks operand, however they can be used for all
operands.
21/28
22/28
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 Code
Description
-33
-34
Invalid Address
-36
-38
Invalid Station
-39
OK
53
Invalid Message
60
Handshake Error
61
Invalid Connection
62
Invalid Message
244
245
246
247
248
249
250
251
252
253
254
255
256
508
Not all parameters can be changed because the adapter is already initialized
509
510
511
512
23/28
Error Code
Description
752
753
754
755
756
757
758
759
760
Initialization conflict
761
762
Checksum error
763
764
765
766
767
768
1019
1020
1021
1022
1023
1024
1260
1261
1262
Invalid address
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
Error Code
Description
1274
1275
1276
1277
1278
1279
1280
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1786
1787
1788
1789
1790
1791
1792
2038
2039
2040
2041
2042
2043
2044
Close received instead of ConnectOK (for example, wrong rack or slot number)
2045
2046
Error Code
Description
2047
2048
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, rightclick 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 devices 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 manufacturers documentation for this information.
26/28
Revision History
Doc.
Revision
Driver
Version
Author
Date
Description of Changes
1.00
Eric Vigiani
15 Jun 04
First version
1.01
Eric Vigiani
26 Jun 04
1.02
Eric Vigiani
29 Sept 04
1.04
Fabio Carvalho
19 Oct 05
1.05
Loureno Teodoro
28 Mar 06
1.06
Graziane C. Forti
11 Jul 06
1.07
Graziane C. Forti
07 Dec 06
3.00
Rafael R. Fernandes
26 Feb 08
3.01
Rafael R. Fernandes
24 Apr 08
10.1
Marcelo Carvalho
07 Jan 09
10.3
Fellipe Peternella
21 Apr 09
10.4
Loureno Teodoro
02 Dec 09
10.5
Fellipe Peternella
01 Apr 10
10.6
Andr Krbes
21 Jul 10
27/28
10.7
Andr Krbes
1 Jul 2011
10.8
Ajay Anumalla
12 Mar 2013
10.8
Andre Bastos
4 Jun 2013
- Updated documentation to show the configuration for S71200/1500 and Logo! No changes in the driver
10.8
Andr Krbes
8 Oct 2013
10.9
Paulo Balbino
16 Oct 2014
Felipe Andrade
U
10.9
Andre Bastos
28/28