Library Description 10/2015

SIMATIC S7 Library for the

Integration of SIEMENS
IO-Link Devices
ET 200SP CM 4 X IO-Link ST, S7-1200 SM 4 X IO-Link Master
ET 200S 4SI IO-Link, ET 200eco PN IO-Link Master, ET 200AL CM 4 X IO-Link

https://support.industry.siemens.com/cs/ww/en/view/90529409
 Warranty and Liability

Warranty and Liability

Note The Application Examples are not binding and do not claim to be complete with
regard to configuration, equipment or any contingencies. The Application
Examples do not represent customer-specific solutions. They are only intended
to provide support for typical applications. You are responsible for the correct
operation of the described products. These Application Examples do not relieve
you of the responsibility of safely and professionally using, installing, operating
and servicing equipment. When using these Application Examples, you
recognize that we cannot be made liable for any damage/claims beyond the
liability clause described. We reserve the right to make changes to these
Application Examples at any time and without prior notice. If there are any
deviations between the recommendations provided in this Application Example
and other Siemens publications – e.g. catalogs – the contents of the other
documents have priority.

We do not accept any liability for the information contained in this document.
Any claims against us – based on whatever legal reason – resulting from the use of
the examples, information, programs, engineering and performance data etc.,
described in this application example will be excluded. Such an exclusion will not
apply in the case of mandatory liability, e.g. under the German Product Liability Act
(“Produkthaftungsgesetz”), in case of intent, gross negligence, or injury of life, body
or health, guarantee for the quality of a product, fraudulent concealment of a
deficiency or breach of a condition which goes to the root of the contract
 Siemens AG 2015 All rights reserved

(“wesentliche Vertragspflichten”). The compensation for damages due to a breach

of a fundamental contractual obligation is, however, limited to the foreseeable
damage, typical for the type of contract, except in the event of intent or gross
negligence or injury to life, body or health. The above provisions do not imply a
change of the burden of proof to your detriment.
Any form of duplication or distribution of these Application Examples or excerpts
hereof is prohibited without the expressed consent of Siemens AG.

Security Siemens provides products and solutions with industrial security functions that
informa- support the secure operation of plants, solutions, machines, equipment and/or
tion networks. They are important components in a holistic industrial security
concept. With this in mind, Siemens’ products and solutions undergo continuous
development. Siemens recommends strongly that you regularly check for
product updates.
For the secure operation of Siemens products and solutions, it is necessary to
take suitable preventive action (e.g. cell protection concept) and integrate each
component into a holistic, state-of-the-art industrial security concept. Third-party
products that may be in use should also be considered. For more information
about industrial security, visit http://www.siemens.com/industrialsecurity.
To stay informed about product updates as they occur, sign up for a product-
specific newsletter. For more information, visit
http://support.automation.siemens.com.

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 2
 Table of Contents

Table of Contents
Warranty and Liability ................................................................................................. 2
1 Library Overview “Siemens IO-Link Devices” ................................................ 5
1.1 User scenarios ..................................................................................... 6
1.2 Functionality of the blocks .................................................................... 7
1.3 Hardware and software requirements .................................................. 8
1.4 Library resources .................................................................................. 9
2 Blocks of the Library ....................................................................................... 10
2.1 Library for STEP 7 V5.5 ..................................................................... 10
2.2 Library for STEP 7 V13 SP1............................................................... 13
2.3 Explanations on FB IO_LINK_3SU1_IDKey-Switch (FB5210)Fehler! Textmarke nicht def
2.3.1 Interface and parameters .............. Fehler! Textmarke nicht definiert.
2.4 Explanation on FB IO_LINK_DEVICE (FB5001) .............................. 14
2.4.1 Interface and parameters ................................................................... 14
2.4.2 Mode of Operation .............................................................................. 16
2.4.3 Status and error displays.................................................................... 17
2.5 Joint parameters for all IO-Link device blocks ................................... 19
2.6 Explanation on FB IO_LINK_3RAxy (FB5100) .................................. 20
2.6.1 Interface and parameters ................................................................... 20
2.6.2 Mode of Operation .............................................................................. 21
2.7 Explanation on FB IO_LINK_3RB24 (FB5110) .................................. 22
2.7.1 Interface and parameters ................................................................... 22
 Siemens AG 2015 All rights reserved

2.7.2 Mode of Operation .............................................................................. 23

2.8 Explanation on FB IO_LINK_3RR24 (FB5120) .................................. 24
2.8.1 Interface and parameters ................................................................... 24
2.8.2 Mode of Operation .............................................................................. 25
2.9 Explanation on FB IO_LINK_3RS1x (FB5130) .................................. 26
2.9.1 Interface and parameters ................................................................... 26
2.9.2 Mode of Operation .............................................................................. 27
2.10 Explanation on FB IO_LINK_3UG481x (FB5140) .............................. 28
2.10.1 Interface and parameters ................................................................... 28
2.10.2 Mode of Operation .............................................................................. 29
2.11 Explanation on FB IO_LINK_3UG4822 (FB5150) ............................. 30
2.11.1 Interface and parameters ................................................................... 30
2.11.2 Mode of Operation .............................................................................. 31
2.12 Explanation on FB IO_LINK_3UG4825 (FB5160) ............................. 32
2.12.1 Interface and parameters ................................................................... 32
2.12.2 Mode of Operation .............................................................................. 33
2.13 Explanation on FB IO_LINK_3UG4832 (FB5170) ............................. 34
2.13.1 Interface and parameters ................................................................... 34
2.13.2 Mode of Operation .............................................................................. 35
2.14 Explanation on FB IO_LINK_3UG4841 (FB5180) ............................. 36
2.14.1 Interface and parameters ................................................................... 36
2.14.2 Mode of Operation .............................................................................. 37
2.15 Explanation on FB IO_LINK_3UG4851 (FB5190) ............................. 38
2.15.1 Interface and parameters ................................................................... 38
2.15.2 Mode of Operation .............................................................................. 39
2.16 Explanation on FB IO_LINK_RFID (FB5200)..................................... 40
2.16.1 Interface and parameters ................................................................... 40
2.16.2 Mode of Operation .............................................................................. 41
2.17 Explanation on FB IO_LINK_3SU1_IDKey-Switch (FB5210) ............ 42
2.17.1 Interface and parameters ................................................................... 42
2.17.2 Mode of Operation .............................................................................. 43
2.18 Explanation on FB IO_LINK_3SU1_Electronic (FB5220) .................. 44
2.18.1 Interface and parameters ................................................................... 44

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 3
 Table of Contents

2.18.2 Mode of Operation .............................................................................. 45

3 Working with the Library in STEP 7 V5.5 ...................................................... 46
3.1 Integrating the library.......................................................................... 46
3.2 Using library blocks ............................................................................ 47
4 Working with the Library as of STEP 7 V13SP1 ........................................... 50
4.1 Integrating the library.......................................................................... 50
4.2 Using library blocks ............................................................................ 51
4.2.1 Use with S7-300/400, S7-1200/1500 ................................................. 51
4.3 Calling a user-defined documentation ................................................ 53
5 Links & Literature ............................................................................................ 54
6 History............................................................................................................... 54
 Siemens AG 2015 All rights reserved

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 4
 1 Library Overview “Siemens IO-Link Devices”
1.1 User scenarios

1 Library Overview “Siemens IO-Link

Devices”
What will I get?
The present document describes the “Siemens IO-Link Devices” block library. You
receive a tested code for the communication with IO-Link components together
with the block library with uniquely defined interfaces. They can be used as a basis
for your task to be implemented.
The main focus of this document is to describe
 all blocks pertaining to the block library
 the functionality implemented through these blocks.
The present documentation furthermore illustrates possible applications, and the
included step-by-step instructions help you integrate the library into your STEP 7
project.

Scope of validity of the libraries

 STEP 7 V5.5 SP3 and higher
 STEP 7 ≥ V13 SP1
 Siemens AG 2015 All rights reserved

 SIMATIC S7-300
 SIMATIC S7-400
 SIMATIC S7-1200
 SIMATIC S7-1500
 S7-1200, SM 4 X IO-Link master module
 ET 200SP, CM 4 X IO-Link master module
 ET 200AL, CM 4 X IO-Link master module
 ET 200S electronic module 4SI IO-Link
 ET 200S, IO-Link master for Sirius industrial controls
 ET 200eco PN IO-Link Master

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 5
 1 Library Overview “Siemens IO-Link Devices”
1.1 User scenarios

1.1 User scenarios

Motivation
The different Siemens IO-Link devices provide different data, according to their
functionality.
The data that is provided by the individual devices, differ in parts regarding content
and storage location.
In order to read out data from the individual devices or to write them into the
individual devices, each individual structure of the data storage has to be
observed. Working with the devices can thus become quickly unclear and involves
great effort.
The library provided here, facilitates your work considerably.

Application
1
The library provides function blocks and UDTs for all IO-Link devices from the
Siemens portfolio, which facilitates and makes communication with the IO-Link
devices easier.
The function blocks have a uniform interface for the individual devices. For each
read/write job, the data record specified at the input is read or written.
 Siemens AG 2015 All rights reserved

1
A UDT (User Defined Data type, or also PLC data type) is a self-defined data type, which
makes it possible, for example, to easily create multiply-used structures.

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 6
 1 Library Overview “Siemens IO-Link Devices”
1.2 Functionality of the blocks

1.2 Functionality of the blocks

The individual blocks of the library each illustrate one or several IO-Link devices.
The function of the blocks is shown by the following program flow chart:

Figure 1-1

Start

Positive No
edge detected at
REQ?

Yes

Read
RD_WR=0 Read
or write
access

Write
RD_WR=1
 Siemens AG 2015 All rights reserved

Which Which
data record data record
selected? selected?

Read
Write
selected data
selected data
record via FB
record via FB
IO_LINK_DEVICE
IO_LINK_DEVICE

End

The individual blocks of the library get the specified data record from the IO-Link
devices, by logically connecting the block input.
When several data records are switched at the input, then the first selected data
record is read out.

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 7
 1 Library Overview “Siemens IO-Link Devices”
1.3 Hardware and software requirements

1.3 Hardware and software requirements

Requirements for this library
To make use of the full functionality of the library described here, the hardware and
software requirements listed below must be met:

Hardware
You can use the library with the following master modules:
 ET 200SP, CM 4 X IO-Link master module
 S7-1200, SM 4 X IO-Link master module
 ET 200S electronic module 4SI IO-Link
 ET 200S, IO-Link master for Sirius industrial controls
 ET 200eco PN, IO-Link Master
 ET 200AL, CM 4xIO-Link Master

Using the distributed I/O system ET 200S, ET 200eco PN, ET 200AL and
ET 200SP requires a PNIO controller. The following devices are possible:
 S7-300/S7-400/WinAC CPU
 S7-1200 CPU as of FW V2.2
 Siemens AG 2015 All rights reserved

 S7-1500 CPU as of FW V1.0

The IO-Link master SM1278 can only be operated with a S7-1200 CPU.

Software
Table 1-1
No. Component Article number
1. SIMATIC STEP 7 V5.5 SP3 6ES7810-4CC10-0YA5
2. SIMATIC STEP 7 V13 SP1 6ES7822-1AA03-0YA5
3. S7-PCT V3.3 see \3\

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 8
 1 Library Overview “Siemens IO-Link Devices”
1.4 Library resources

1.4 Library resources

The overview below shows the assignment of the main memory by the “Siemens
IO-Link Devices” library blocks.

Overall occupancy
All blocks belonging to the “Siemens IO-Link Devices” library occupy a total of
57 kBytes in the main memory, without the system function blocks used.
Normally not all blocks are used at the same time, since not all possible IO-Link
devices are used at the same time.
To be able to use the library, you also have to plan for respective storage space for
data blocks and instance data blocks.

Assignment of memory space to the individual blocks

Table 1-2
Block Symbol Size of main memory
FB1 IO_LINK_DEVICE 2486 bytes
FB5100 IO_LINK_3RAxy 4418 bytes
FB5110 IO_LINK_3RB24 4402 bytes
FB5120 IO_LINK_3RR24 4380 bytes
 Siemens AG 2015 All rights reserved

FB5130 IO_LINK_3RS1x 4136 bytes

FB5140 IO_LINK_3UG481x 4218 bytes
FB5150 IO_LINK_3UG4822 4250 bytes
FB5160 IO_LINK_3UG4825 4252 bytes
FB5170 IO_LINK_3UG4832 4122 bytes
FB5180 IO_LINK_3UG4841 4290 bytes
FB5190 IO_LINK_3UG4851 4130 bytes
FB5200 IO_LINK_RFID 3806 bytes
FB5210 IO_LINK_3SU1_IDKey 3049 bytes
FB5220 IO_LINK_3SU1_Electronic 2898 bytes

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 9
 2 Blocks of the Library
2.1 Library for STEP 7 V5.5

2 Blocks of the Library

The following chapters list all blocks of the “SIEMENS IO-Link Devices” library for
STEP 7 V5.5 and STEP 7 V13 SP1.

2.1 Library for STEP 7 V5.5

Each of the respective UDTs belongs to the blocks for the structure of the data.
These are listed in Table 2-3.
Table 2-1
Block Symbol Modules
FB1 IO_LINK_DEVICE Subordinate IO-Link block. For details see \4\.
FB5100 IO_LINK_3RAxy Compact starter 3RA64/3RA65; function module
3RA27.
FB5110 IO_LINK_3RB24 Overload relay 3RB24.
FB5120 IO_LINK_3RR24 Monitoring relay 3RR2441/3RR2442/3RR2443.
FB5130 IO_LINK_3RS1x Temperature monitoring relay 3RS1x.
FB5140 IO_LINK_3UG481x Monitoring relay 3UG481x.
FB5150 IO_LINK_3UG4822 Current monitoring relay 3UG4822.
FB5160 IO_LINK_3UG4825 Error current monitoring relay 3UG4825.
 Siemens AG 2015 All rights reserved

FB5170 IO_LINK_3UG4832 Monitoring relay 3UG4832.

FB5180 IO_LINK_3UG4841 Cos-phi and active current monitoring 3UG4841.
FB5190 IO_LINK_3UG4851 Speed monitoring, 3UG4851.
FB5200 IO_LINK_RFID RFID reader for IO-Link.
FB5210 IO_LINK_3SU1_IDKey ID key switch
FB5220 IO_LINK_3SU1_Electronic DI/DO electronic modules for IO-Link

In addition, the following system function blocks from the standard library are used.
Table 2-2
Block Symbol Classification
SFB4 TON Standard STEP 7 library
SFB52 RDREC Standard STEP 7 library
SFB53 WRREC Standard STEP 7 library

For the individual IO-Link devices the following UDTs (User Defined Data types)
are included in the library:
Table 2-3
Block Symbol Note
UDT 5000 ParameterPage0 As “standard” UDT as part of other UDTs (e.g. UDT
5100)
UDT 5100 3RAxy For function block 5100
UDT 5101 ParameterPage1_3
RAxy
Subordinate to UDT 5100
UDT 5102 DIAG_3RAxy
UDT 5103 PARA_3RAxy

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 10
 2 Blocks of the Library
2.1 Library for STEP 7 V5.5

Block Symbol Note

UDT 5110 3RB24 For function block 5110
UDT 5111 DIAG_3RB24
UDT 5112 MEAS_3RB24
UDT 5113 PresetConfigOP_3 Subordinate to UDT 5110
RB24
UDT 5114 TechnoFunctions_3
RB24
UDT 5120 3RR24 For function block 5120
UDT 5121 DIAG_3RR24
UDT 5122 MEAS_3RR24 Subordinate to UDT 5120
UDT 5123 PARA_3RR24
UDT 5130 3RS1x For function block 5130
UDT 5131 DIAG_3RS1x
UDT 5132 MEAS_3RS1x Subordinate to UDT 5130
UDT 5133 PARA_3RS1x
UDT 5140 3UG481x For function block 5140
UDT 5141 DIAG_3UG481x
UDT 5142 MEAS_3UG481x Subordinate to UDT 5140
 Siemens AG 2015 All rights reserved

UDT 5144 PARA_3UG481x

UDT 5150 3UG4822 For function block 5150
UDT 5151 DIAG_3UG4822
UDT 5152 MEAS_3UG4822 Subordinate to UDT 5150
UDT 5153 PARA_3UG4822
UDT 5160 3UG4825 For function block 5160
UDT 5161 DIAG_3UG4825
UDT 5162 MEAS_3UG4825 Subordinate to UDT 5160
UDT 5163 PARA_3UG4825
UDT 5170 3UG4832 For function block 5170
UDT 5171 DIAG_3UG4832
UDT 5172 MEAS_3UG4832 Subordinate to UDT 5170
UDT 5173 PARA_3UG4832
UDT 5180 3UG4841 For function block 5180
UDT 5181 DIAG_3UG4841
UDT 5182 MEAS_3UG4841 Subordinate to UDT 5180
UDT 5183 PARA_3UG4841
UDT 5190 3UG4851 For function block 5190
UDT 5191 DIAG_3UG4851
UDT 5192 MEAS_3UG4851 Subordinate to UDT 5190
UDT 5193 PARA_3UG4851
UDT 5200 RFID For function block 5200
UDT 5201 RFID_Event_Histor
y
Subordinate to UDT 5200
UDT 5202 RFID_Reader_Stat
us

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 11
 2 Blocks of the Library
2.1 Library for STEP 7 V5.5

Block Symbol Note

UDT 5203 RFID_Tag_Status
UDT 5204 RFID_UID_History
UDTxyz 3SU1_IDKey- For function block 5210
Switch
UDT5210 3SU1_IDKeySwitch
UDT5211 3SU1_IDKeySwitch
_DS81
UDT5212 3SU1_IDKeySwitch
_DS82 Subordinate to UDT 5210
UDT5213 3SU1_IDKeySwitch
_DS92
UDT5214 3SU1_IDKeySwitch
_DS94
UDT5220 3SU1_Electronic For function block 5220
UDT5221 3SU1_Electronic_D
S92
UDT5222 SU1_Electronic_DS
Subordinate to UDT 5220
94
UDT5223 SU1_Electronic_DS
131
 Siemens AG 2015 All rights reserved

NOTICE You can call the block parallel or in several instances for several devices.
Please note that depending on the CPU used, only a certain number of
block calls for RDREC/WRREC must be active at the same time (see \5\).

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 12
 2 Blocks of the Library
2.2 Library for STEP 7 V13 SP1

2.2 Library for STEP 7 V13 SP1

The blocks for STEP 7 V5.5 listed in section “Library for STEP 7 V5.5” also
correspond to the blocks for the STEP 7 V13 SP1 library. They contain the identical
symbols, however, the absolute addresses, the UDTs for example, can be changed
when inserting the library into a project of STEP 7.
For each CPU, the library includes a folder with respectively suitable function
blocks. Only use the appropriate blocks depending on the CPU.
See also Chapter 4 “Working with the Library as of STEP 7 V13”.

Figure 2-1
 Siemens AG 2015 All rights reserved

The following chapters list all blocks of the “SIEMENS IO-Link Devices” library. In
this documentation, the screenshots were created with STEP 7 V5.5 SP4.
The description of the individual blocks applies for STEP7 V5.5 as well as the
STEP 7 V13 SP1 library.

Note Only integrate those blocks into your project that refer to the respective CPU. For
more information refer to Chapter 2.16.

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 13
 2 Blocks of the Library
2.3 Explanation on FB IO_LINK_DEVICE (FB5001)

2.3 Explanation on FB IO_LINK_DEVICE (FB5001)

2.3.1 Interface and parameters

Interface
Figure 2-2
 Siemens AG 2015 All rights reserved

Note The IO_LINK_DEVICE block is called internally by the other function blocks of
the library (see Chapter 1.2 “Functionality of the blocks”). A detailed description
of the block is available in \4\.

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 14
 2 Blocks of the Library
2.3 Explanation on FB IO_LINK_DEVICE (FB5001)

Input parameters
Table 2-4
Parameter Data type Memory area Description
REQ BOOL I, Q, M, D Positive edge: Triggers data transfer
ID HW_IO I, Q, M, D, L, For S7-1200/1500
const Hardware identifier of the IO-Link
communication module
(for ET200ecoPN the
HW_ID of the IO-Link submodule
must be used)
DWORD For S7-300/400
Logic address of the IO-Link
communication module (module or
submodule)
CAP DINT I, Q, M, D, L, Access point of the
(S7- const IO_LINK_DEVICE function (Siemens
1200/1500) AG = 227 decimal)
INT
(S7-300/400)
RD_WR BOOL I, Q, M, D, L, Read or write access
const 0: read
 Siemens AG 2015 All rights reserved

1: write
PORT INT I, Q, M, D, L, Port number at which the IO-Link
const device is operated.
Possible values: 1..63
IOL_INDEX INT I, Q, M, D, L, Parameter index
const Possible values: 0..32767

IOL_SUBINDEX INT I, Q, M, D, L, Parameter subindex

const 0 : total record
1..255: Parameter from record
LEN INT I, Q, M, D, L, Length of the data to be written (net
const data)
Read: 0..232 (not relevant)
Write: 1..232

Output parameters
Table 2-5
Parameter Data type Memory area Description
DONE_VALID BOOL I, Q, M, D, L Validity:
0: Data not valid
1: Data valid
BUSY BOOL I, Q, M, D, L Job in progress:
0: Job completed (valid or error)
1: Job being processed
ERROR BOOL I, Q, M, D, L Error status:
0: No error
1: Abort with error

Siemens IO-Link Device Library

Entry ID: 90529409, V2.1, 10/2015 15