>

>

Device Manual

IO-Link Master with EtherNet/IP Interface

CabinetLine
8 Ports
IP 20

AL1920

HW Revision: AB
Firmware: 2.3.x
LR DEVICE: 1.5.0.x

English
04 / 2019
80284064 / 00
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Contents

1 Preliminary note 5
1.1 Legal and copyright information ...........................................................................................5
1.2 Purpose of the document .....................................................................................................5
1.3 Explanation of Symbols .......................................................................................................6
1.4 Modification history ..............................................................................................................6

2 Safety instructions 7
2.1 General ................................................................................................................................7
2.2 Required background knowledge ........................................................................................7
2.3 Safety symbols on the device ..............................................................................................7
2.4 IT safety ...............................................................................................................................8
2.5 Tampering with the unit ........................................................................................................8

3 Intended use 9
3.1 Permitted use .......................................................................................................................9
3.2 Prohibited use ......................................................................................................................9

4 Function 10
4.1 Communication, parameter setting, evaluation .................................................................11
4.1.1 IO-Link ........................................................................................................................................ 11
4.1.2 EtherNet/IP ................................................................................................................................. 11
4.1.3 Internet of Things (IoT) ............................................................................................................... 12
4.1.4 Security mode ............................................................................................................................ 12
4.1.5 Parameter setting ....................................................................................................................... 12
4.1.6 Visual indication ......................................................................................................................... 12
4.2 Digital inputs .......................................................................................................................13
4.3 IO-Link supply ....................................................................................................................13

5 Mounting 14
5.1 Install the device ................................................................................................................14

6 Electrical connection 15
6.1 Notes ..................................................................................................................................15
6.2 EtherNet/IP ports................................................................................................................16
6.3 IoT port ...............................................................................................................................16
6.4 IO-Link ports.......................................................................................................................17
6.4.1 Connect IO-Link devices for Class A operation .......................................................................... 17
6.4.2 Connect IO-Link devices for Class B operation .......................................................................... 18
6.5 Connect the device ............................................................................................................19

7 Operating and display elements 20

7.1 Overview ............................................................................................................................20
7.2 LED indicators ....................................................................................................................21
7.2.1 Status LEDs ............................................................................................................................... 21
7.2.2 Ethernet interface ....................................................................................................................... 21
7.2.3 IoT port ....................................................................................................................................... 22
7.2.4 Power supply .............................................................................................................................. 22
7.2.5 IO-Link ports (Class A) ............................................................................................................... 22

2
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

8 Set-up 23
8.1 Read device and diagnostic information ............................................................................24

9 Configuration 25
9.1 LR DEVICE ........................................................................................................................26
9.1.1 Remarks ..................................................................................................................................... 27
9.1.2 IoT: Configure IP settings ........................................................................................................... 28
9.1.3 IoT: Configure security mode ..................................................................................................... 29
9.1.4 IoT: Configure access rights ....................................................................................................... 30
9.1.5 IoT: Configure the interface to LR AGENT or LR SMARTOBSERVER ...................................... 31
9.1.6 Fieldbus: Configure IP settings ................................................................................................... 32
9.1.7 Fieldbus: set the configuration mode .......................................................................................... 33
9.1.8 IO-Link ports: Activate data transfer to LR AGENT or LR SMARTOBSERVER ......................... 34
9.1.9 IO-Link ports: Configure operating mode.................................................................................... 35
9.1.10 IO-Link ports: Set the device validation and data storage .......................................................... 36
9.1.11 IO-Link Ports: Set fails-safe values ............................................................................................ 37
9.1.12 Info: Show device information .................................................................................................... 37
9.1.13 Firmware: Reset device to factory settings ................................................................................. 38
9.1.14 Firmware: Reboot the device...................................................................................................... 38
9.1.15 Configure IO-Link devices .......................................................................................................... 39
9.2 ifm IoT Core .......................................................................................................................40
9.2.1 First steps ................................................................................................................................... 40
9.2.2 General functions ....................................................................................................................... 41
9.2.3 Configure IoT interface ............................................................................................................... 42
9.2.4 IoT interface: Configure security mode ....................................................................................... 43
9.2.5 Configure the fieldbus interface .................................................................................................. 46
9.2.6 Configure IO-Link ports .............................................................................................................. 47
9.2.7 Configure IO-Link devices .......................................................................................................... 49
9.2.8 Set application identification ....................................................................................................... 51
9.2.9 Read / write cyclic process data ................................................................................................. 52
9.2.10 Control IO-Link master ............................................................................................................... 53
9.2.11 Read diagnostic data of the AL1920 .......................................................................................... 55
9.2.12 Read device information of the IO-Link master .......................................................................... 56
9.2.13 Read information about IO-Link devices .................................................................................... 56
9.2.14 Subscribe to events .................................................................................................................... 57
9.2.15 MQTT support ............................................................................................................................ 59
9.2.16 Programmers' notes ................................................................................................................... 60
9.3 EtherNet/IP.........................................................................................................................65
9.3.1 Registration of the EDS file ........................................................................................................ 65
9.3.2 Integrate the AL1920 into the EtherNet/IP project ...................................................................... 66
9.3.3 Set connection types and RPI .................................................................................................... 67
9.3.4 Configure AL1920 ...................................................................................................................... 68
9.3.5 Configure IO-Link ports .............................................................................................................. 69
9.3.6 Configure IO-Link devices .......................................................................................................... 71
9.3.7 Read cyclic input data ................................................................................................................ 72
9.3.8 Write cyclic output data .............................................................................................................. 72
9.3.9 Read diagnostic and status information ..................................................................................... 73
9.3.10 EtherNet/IP: Programmers' notes ............................................................................................... 74

3
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

10 Maintenance, repair and disposal 77

10.1 Cleaning process ...............................................................................................................77
10.2 Update firmware .................................................................................................................78
10.3 Replace IO-Link device ......................................................................................................79

11 Factory settings 80

12 Accessories 81

13 Appendix 82
13.1 Technical data ....................................................................................................................83
13.1.1 Application .................................................................................................................................. 83
13.1.2 Electrical data ............................................................................................................................. 83
13.1.3 Inputs / outputs ........................................................................................................................... 83
13.1.4 Inputs.......................................................................................................................................... 84
13.1.5 Outputs ....................................................................................................................................... 84
13.1.6 Interfaces.................................................................................................................................... 84
13.1.7 Environmental conditions ........................................................................................................... 85
13.1.8 Approvals / tests ......................................................................................................................... 85
13.1.9 Mechanical data ......................................................................................................................... 85
13.1.10 Electrical connection .................................................................................................................. 86
13.2 EtherNet/IP.........................................................................................................................87
13.2.1 Supported connection types ....................................................................................................... 87
13.2.2 Parameter data........................................................................................................................... 88
13.2.3 Cyclic data .................................................................................................................................. 92
13.2.4 Acyclic data .............................................................................................................................. 103
13.3 ifm IoT Core .....................................................................................................................138
13.3.1 Overview: IoT profile ................................................................................................................ 139
13.3.2 Overview: IoT types .................................................................................................................. 144
13.3.3 Overview: IoT services ............................................................................................................. 145

14 Index 154

4
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

1 Preliminary note
Content
Legal and copyright information ...............................................................................................................5
Purpose of the document .........................................................................................................................5
Explanation of Symbols ............................................................................................................................6
Modification history ...................................................................................................................................6
33203
>

1.1 Legal and copyright information

33117

© All rights reserved by ifm electronic gmbh. No part of this manual may be reproduced and used
without the consent of ifm electronic gmbh.
All product names, pictures, companies or other brands used on our pages are the property of the
respective rights owners:
 AS-i is the property of the AS-International Association, (→ www.as-interface.net)
 CAN is the property of the CiA (CAN in Automation e.V.), Germany (→ www.can-cia.org)
 CODESYS™ is the property of the 3S – Smart Software Solutions GmbH, Germany
(→ www.codesys.com)
 DeviceNet™ is the property of the ODVA™ (Open DeviceNet Vendor Association), USA
(→ www.odva.org)
 EtherNet/IP® is the property of the → ODVA™
 EtherCAT® is a registered trade mark and patented technology, licensed by Beckhoff Automation
GmbH, Germany
 IO-Link® is the property of the → PROFIBUS Nutzerorganisation e.V., Germany
(→ www.io-link.com)
 ISOBUS is the property of the AEF – Agricultural Industry Electronics Foundation e.V.,
Deutschland (→ www.aef-online.org)
 Microsoft® is the property of the Microsoft Corporation, USA (→ www.microsoft.com)
 Modbus® is the property of the Schneider Electric SE, France (→ www.schneider-electric.com)
 PROFIBUS® is the property of the PROFIBUS Nutzerorganisation e.V., Germany
(→ www.profibus.com)
 PROFINET® is the property of the → PROFIBUS Nutzerorganisation e.V., Germany
 Windows® is the property of the → Microsoft Corporation, USA
>

1.2 Purpose of the document

34227

This document is only for device types "IO-Link master - EtherNet/IP gateway (CabinetLine) 8 port IP
20" (art. no.: AL1920).
It is part of the device and contains information about the correct handling of the product.
► Read this document before using the device.
► Keep this document during the service life of the device.

5
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

1.3 Explanation of Symbols

34171

WARNING!
Death or serious irreversible injuries may result.

CAUTION!
Slight reversible injuries may result.

NOTICE!
Property damage is to be expected or may result.

Important note
Non-compliance can result in malfunction or interference
Information
Supplementary note
► ... Request for action
> ... Reaction, result
→ ... "see"
abc Cross-reference
123 Decimal number
0x123 Hexadecimal number
0b010 Binary number
[...] Designation of pushbuttons, buttons or indications

>

1.4 Modification history

34492

Version Topic Date

00 New creation of document 04 / 2019

6
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

2 Safety instructions
Content
General .....................................................................................................................................................7
Required background knowledge .............................................................................................................7
Safety symbols on the device ...................................................................................................................7
IT safety ....................................................................................................................................................8
Tampering with the unit ............................................................................................................................8
28333
>

2.1 General
33834

The plant manufacturer is responsible for the safety of the plant in which the device is
installed.
If the device is used in a way that is not intended by the manufacturer, the protection
supported by the device may be impaired.
Non-observance of the instructions, operation which is not in accordance with use as
prescribed below, wrong installation or incorrect handling can affect the safety of operators
and machinery.
► Observe these operating instructions.
► Adhere to the warning notes on the product.

>

2.2 Required background knowledge

34185

This document is intended for specialists. Specialists are people who, based on their relevant training
and experience, are capable of identifying risks and avoiding potential hazards that may be caused
during operation or maintenance of the product.
The document contains information about the correct handling of the product.
>

2.3 Safety symbols on the device

34199

General warning
Observe instructions in chapter "Electrical connection" (→ Electrical connection (→ S. 15))!

>

7
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

2.4 IT safety
54678

NOTICE!
If the device is operated in an unprotected network environment.
> Unauthorised read or write access to data is possible.
> Unauthorised manipulation of the device function is possible.
► Check and restrict access options to the device:
 Restrict access to authorised persons.
 Do not connect the device to open networks or the internet.
If access from the internet is inevitable:
► choose a safe method to connect with the device (e. g. VPN).
► Use encrypted data transmission (e. g. https / TLS).

>

2.5 Tampering with the unit

33190

WARNING!
Tampering with the unit.
> In case of non-compliance:
 Possible affects on safety of operators and machinery
 Expiration of liability and warranty
► Do not open the devices!
► Do not insert any objects into the devices!
► Prevent metal foreign bodies from penetrating!

8
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

3 Intended use
Content
Permitted use ...........................................................................................................................................9
Prohibited use ...........................................................................................................................................9
34079
>

3.1 Permitted use

34208

The IO-Link master serves as a gateway between intelligent IO-Link devices and the EtherNet/IP
network. The device is designed for use as cabinet module in plant construction.
>

3.2 Prohibited use

34228

The device may not be used beyond the limits of the technical data (→ Technical data (→ S. 83))!

9
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

4 Function
Content
Communication, parameter setting, evaluation ......................................................................................11
Digital inputs ...........................................................................................................................................13
IO-Link supply .........................................................................................................................................13
33836

10
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

4.1 Communication, parameter setting, evaluation

Content
IO-Link ....................................................................................................................................................11
EtherNet/IP .............................................................................................................................................11
Internet of Things (IoT) ...........................................................................................................................12
Security mode .........................................................................................................................................12
Parameter setting ...................................................................................................................................12
Visual indication ......................................................................................................................................12
33860
>

4.1.1 IO-Link
34084

The device offers the following IO-Link functions:

 IO-Link master (IO-Link revision 1.0 and 1.1)
 8 IO-Link ports for connection of IO-Link devices
 Provision of process data of the connected IO-Link devices for LR SMARTOBSERVER monitoring
software (→ www.ifm.com)
>

4.1.2 EtherNet/IP
52585

The device offers the following EtherNet/IP functions:

 EtherNet/IP Device
 2 port switch for access to the EtherNet/IP interface
 Gateway for transmission of the process and parameter data between the connected IO-Link
devices and the higher-level EtherNet/IP controller
 Min. cycle time: 1 ms (RPI)
 Connection classes: 1, 3
 Connection Application types: Exclusive Owner, Input Only, Listen Only Connections
 UCMM supported
 Predefined standard objects:
 Identity Object (0x01)
 Message Router Object (0x02)
 Assembly Object (0x04)
 Connection Manager (0x06)
 DLR Object (0x47)
 QoS Object (0x48)
 TCP/IP Interface Object (0xF5)
 Ethernet Link Object (0xF6)
 Supported protocols: DHCP, BOOTP, ACD, DLR
 Device description: EDS file

11
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

4.1.3 Internet of Things (IoT)

54679

The device offers the following IoT functions:

 Gateway for the transmission of process, parameter and monitoring data between IO-Linkmaster /
IO-Link devices and the IT network level
 REST-API to access process and parameter data
 Supported protocols: TCP/IP JSON, MQTT
>

4.1.4 Security mode

54697

The IoT interface offers the following optional sercurity functions:

 Secure data transfer via encrypted connection (Secure Layer Transport - TLS)
 Access protection via authentification
>

4.1.5 Parameter setting

34210

The device provides the following configuration options:

 Parameter setting of the IO-Link master of the AL1920 with LR DEVICE parameter setting
software, EtherNet/IP projection software or ifm IoT-Core services.
 Parameter setting of the connected IO-Link devices (sensors, actuators) with LR DEVICE
parameter setting software, EtherNet/IP projection software or ifm IoT-Core services
 Storage of parameter sets of the connected IO-Link devices for automatic recovery (data storage)
>

4.1.6 Visual indication

34192

The device has the following visual indicators:

 Status and error indication of the gateway, of the EtherNet/IP connection and of the system
 Status display of the voltage supply
 Status and activity display of the Ethernet connection
 Status, error and short circuit/overload indication of the IO-Link ports

12
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

4.2 Digital inputs

33817

The device has 8 additional digital inputs (type 2 according to EN 61131-2).

The digital inputs are on clamp 2 of the IO-Link ports X01...X08.
All inputs refer to the potential of the device supply (clamp 3).
>

4.3 IO-Link supply

34077

The device has 8 supplies for IO-Link devices.

The IO-Link ports X01...X08 are ports class A.
Every supply provides short circuit monitoring.
The device ensures fire protection for the connected IO-Link devices by providing a power-restricted
circuit at the IO-Link ports (according to IEC61010-1 and Class 2 according to UL1310).

13
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

5 Mounting
Content
Install the device .....................................................................................................................................14
34058
>

5.1 Install the device

34070

► Disconnect power before installation.

The device contains components that can be damaged or destroyed by electrostatic
discharge.
► When handling the device, observe the necessary safety precautions against electrostatic
discharge (ESD).
► Only operate the device when mounted on a grounded DIN rail.

► Install the device in a control cabinet of protection rating IP 54 or higher. The control cabinet has
to be installed in accordance with local and national regulations.
► Fix the device vertically onto a 35 mm raised rail.
► Leave enough space between the unit and the top or bottom of the control cabinet as well as to
adjacent devices to enable air circulation and to avoid inadmissible heating.

14
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

6 Electrical connection
Content
Notes ......................................................................................................................................................15
EtherNet/IP ports ....................................................................................................................................16
IoT port ...................................................................................................................................................16
IO-Link ports ...........................................................................................................................................17
Connect the device .................................................................................................................................19
33805
>

6.1 Notes
34181

The unit must be connected by a qualified electrician.

► The national and international regulations for the installation of electrical equipment must
be adhered to.
The unit is only suitable for operation using SELV/PELV voltages.
► Observe the information concerning IO-Link circuits!
The IP rating of the overall system depends on the protection ratings of the individual devices
and the applied connection elements.
For UL applications:
► To connect the IO-Link master, only use cables with AWG 26 to 12 and a minimum
temperature range of 75 °C.
Wiring: → Technical data (→ S. 83)

The circuits are separated from each other and from device surfaces that could be touched by means
of basic insulation according to EN61010-1 (secondary circuit with 30 V DC maximum, supplied from
mains circuit up to 300 V of overvoltage category II).
The communication interfaces are separated from each other and from device surfaces that could be
touched by means of basic insulation according to EN61010-1 (secondary circuit with 30 V DC
maximum, supplied from mains circuit up to 300 V of overvoltage category II). They are designed for
network environment 0 according to IEC TR62102.

15
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

6.2 EtherNet/IP ports

33678

► Connect the unit via the sockets X21 and/or X22 to the EtherNet/IP
network.
► To connect the devices, use connectors with protection rating IP 20
or higher (→ Accessories (→ S. 81)).

>

6.3 IoT port

34045

► Connect the device via the socket X23 to the IT network (e.g.
laptop/PC with LR DEVICE parameter setting software, laptop/PC
with LR SMARTOBSERVER monitoring software, laptop/PC with
http request enabled software).
► To connect the devices, use connectors with protection rating IP 20
or higher (→ Accessories (→ S. 81)).

16
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

6.4 IO-Link ports

52232

The IO-Link ports of the device meet the requirements of the IO-Link specification 1.0 to 1.1.2.
► Please note the information concerning IO-Link wiring!

WARNING!
Supply of energy to the IO-Link ports of the IO-Link master
> Risk of fire!
► Prevent supply and feedback of energy to the IO-Link ports.
► Before set-up check the correct connection of the supply cables.

>

6.4.1 Connect IO-Link devices for Class A operation

52233

Wiring information:
 The connected IO-Link devices must be supplied exclusively via the IO-Link master.
 The additional digital inputs of the IO-Link ports X01...X08 (clamp 2) have a type 2 behaviour
according to the standard EN61131-2. The connected electronics must be electrically suited for
this.

► Connect IO-Link devices to the ports X01...X08.

 Maximum cable length per IO-Link port: 20 m
► To connect the devices, only use cables with protection rating IP 20
or higher.

17
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

6.4.2 Connect IO-Link devices for Class B operation

52234

Wiring information:
 For the Class B operation, the IO-Link device must be supplied with an additional auxiliary voltage
UA.
 Wiring diagram:
+24 V
US
GND

+24 V
UA
GND

AL19 IO-Link
Device
+24 V
X31
GND L+ (UA)
L- (UA)
L+ L+ (US) IO-Link Port
X0n L- L- (US)
C/Q C/Q

 Permitted maximum current intensity for UA: 4A

WARNING!
Non-compliance with the electrical separation of the circuits
> Risk of fire!
► Ensure that the external supply UA is galvanically separated from the circuit of the
IO-Link Master by assuring basic insulation (according to IEC 61010-1, secondary circuit
with 30 V DC maximum, supplied from mains circuit up to 300 V of overvoltage category
II).
► Ensure that the IO-Link devices and the connection technology support the galvanic
separation.

► Connect the IO-Link devices to the ports X01 ... X08.

 Maximum cable length per IO-Link port: 20 m
► Connect the IO-Link devices to UA with 24 V DC
(20...30 V SELV/PELV).
► To connect the IO-Link devices, only use cables with protection
rating IP 20 or higher.

>

18
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

6.5 Connect the device

33890

► Disconnect power.
► Connect the IO-Link master via port X31 to 24 V DC
(20...30 V SELV/PELV; according to EN61010-1, secondary circuit
with maximum 30 V DC supplied by mains circuit up to 300 V of
overvoltage category II).
 Recommended maximum cable length: 25 m
► To connect the device, use cables with protection rating IP 20 or
higher.

With cable lengths greater than 25 m observe the voltage drop and the necessary minimum
supply voltage of 20 V!

19
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

7 Operating and display elements

Content
Overview .................................................................................................................................................20
LED indicators ........................................................................................................................................21
34063
>

7.1 Overview
34353

1 IOL and DI status-LEDs of the IO-Link port (X01...X08

(→ IO-Link ports (Class A) (→ S. 22))
1 2 PWR status LED of the voltage supply (X31) (→ Power
supply (→ S. 22)
2 RDY, NET and MOD Status LEDs (→Status LEDs
(→ S. 21)
1 IoT status LED of the IoT port (X23) (→ IoT port
1
(→ S. 22))
4
3 LNK status LED of the IoT port (X23) (→ IoT port
3 (→ S. 22))

1 4 LNK and ACT status LEDs of the EtherNet/IP

ports 1 (X21) and 2 (X22) (→ Ethernet interface
(→ S. 21))

20
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

7.2 LED indicators

34047

The device only has the following LED indicators:

>

7.2.1 Status LEDs

34408

The RDY LED indicates the status of the gateway.

The NET LED (Network Status) indicates the status of the network.
The MOD LED (Module Status) indicates the status of the EtherNet/IP module.

Status LED Description

RDY green on Status: OK

flashes 5 Hz Status: Error
flashes (200 ms on, Status: Firmware update is running
800 ms off)
off Status: Gateway not running or gateway booting
NET green / red off Not powered or powered, but IP address not yet configured
flashes Device self-testing
green flashes No connection: no CIP connection established and a Exclusive Owner
connection has not timed out
on Connection: at least one CIP connection established and an Exclusive
Owner connection has not timed out
red flashes Connection timeout: an Exclusive Owner connection has timed out
on Duplicate IP address: IP address aready in use
MOD green / red off No voltage or voltage too low
flashes Device self-testing
green flashes Standby: device not yet configured (no IP address)
on Operational
red flashes Major recoverable fault (e.g. incorrect configuration)
on Major unrecoverable fault (e.g. module failed)

>

7.2.2 Ethernet interface

34348

Each Ethernet interface (X21, X22) has 2 LEDs (LNK and ACT). The LEDs indicate the status of the
Ethernet connection.
Status LED Description

LNK green on Ethernet connection established

off No Ethernet connection
ACT yellow flashes Data is transmitted via the Ethernet interface.
off No data transmission

>

21
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

7.2.3 IoT port

34043

The IoT port (X23) has the 3 LNK, ACT and IoT LEDs. The LEDs indicate the status of the Ethernet
connection and the device identification.
Status LED Description

LNK green on Ethernet connection established

off No Ethernet connection
ACT yellow flashes Data is transmitted via the Ethernet interface.
off No data transmission
IoT green flashes Device identification active

>

7.2.4 Power supply

34203

The interface for voltage supply (X31) has the PWR LED. The LED indicates the status of the voltage
supply.
Status LED Description
PWR green on Supply voltage Us is applied
off No supply voltage is applied or the applied supply voltage is too low

>

7.2.5 IO-Link ports (Class A)

34074

Each IO-Link port Class A has 2 LEDs marked as IOL and DI. The LEDs indicate the status of the
IO-Link port.
Status LED Description
IOL yellow off Port configured as DI / DO: clamp 4 (C/Q) = OFF
on Port configured as DI / DO: clamp 4 (C/Q) =ON
green flashes 1 Hz Port configured as IO-Link: no IO-Link device detected
flashes 2 Hz Port configured as IO-Link: PROOPERATE state
on Port configured as IO-Link: OPERATE state
red flashes 2 Hz Port configuration error or short circuit or overload (US)
on Transmission error
DI yellow off Digital input : clamp 2 (DI) = OFF
on Digital input: clamp 2 (DI) = ON

22
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

8 Set-up
Content
Read device and diagnostic information ................................................................................................24
52357

When the supply voltage is switched on, the AL1920 starts with the factory settings. The display
elements signal the current operating mode (→ Operating and display elements (→ S. 20)).
To enable parameter setting of the AL1920, the IoT interface and / or the fieldbus interface must be
configured according to the network environment.
► Configure IoT interface (LR DEVICE: → IoT: Configure IP settings (→ S. 28) or → Configure
IoT interface (→ S. 42)).
► Configure fieldbus interface (LR DEVICE: → Fieldbus: Configure IP settings (→ S. 32) or IoT:
→ Configure the fieldbus interface (→ S. 46)).
> IoT / fieldbus interface has valid IP settings.
> User can set the parameters of the AL1920.

Further steps:
 Optional: Update firmware of AL1920 (→ Update firmware (→ S. 78)).
 Set the parameters of the AL1920 (→ Configuration (→ S. 25)).

23
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

8.1 Read device and diagnostic information

34216

In order to read the diagnostic information about the current device status via the web interface:
► Connect laptop/PC and AL1920 via the Ethernet internet.
► Start web browser.
► Enter the IP address of the AL1920 into the address field of the browser and press [ENTER] to confirm.
> Web browser shows the web interface of the device.
> The page shows the following data:
 Table with connected IO-Link devices
Name Description

[Port] Number of the IO-Link interface

[Mode] Operating mode of the IO-Link interface
[Comm. Mode] Baud rate of the IO-Link interface
[MasterCycleTime] Cycle time
[Vendor ID] ID of the manufacturer of the IO-Link device
[Device ID] ID of the IO-Link device
[Name] Article number of the IO-Link device
 For ifm articles: This article number is stored along with a link to the produkt page on
the ifm website.
[Serial] Serial number of the IO-Link device
[LR Mode / Interval] Cycle time for the communication with the SmartObserver

 Diagnostic information of the device

Name Description

[SW-Version]
[Current] Current (in mA)
[Voltage] Voltage (in mV)
[Short Circuit] Number of detected short circuits
[Overload] Number of detected overloads
[Undervoltage] Number of detected under voltages
[Temperature] Device temperature (in °C)

 Version information of the installed firmware components

Name Description

[Firmware] Firmware version

[Container] Version of the firmware container
[Bootloader Version] Version of the boot loader
[Fieldbus Firmware] Version of the EtherNet/IP firmware

24
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

9 Configuration
Content
LR DEVICE .............................................................................................................................................26
ifm IoT Core ............................................................................................................................................40
EtherNet/IP .............................................................................................................................................65
33858

25
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1 LR DEVICE
Content
Remarks .................................................................................................................................................27
IoT: Configure IP settings .......................................................................................................................28
IoT: Configure security mode .................................................................................................................29
IoT: Configure access rights ...................................................................................................................30
IoT: Configure the interface to LR AGENT or LR SMARTOBSERVER .................................................31
Fieldbus: Configure IP settings ..............................................................................................................32
Fieldbus: set the configuration mode .....................................................................................................33
IO-Link ports: Activate data transfer to LR AGENT or LR SMARTOBSERVER ..................................34
IO-Link ports: Configure operating mode ...............................................................................................35
IO-Link ports: Set the device validation and data storage ......................................................................36
IO-Link Ports: Set fails-safe values .......................................................................................................37
Info: Show device information ................................................................................................................37
Firmware: Reset device to factory settings ............................................................................................38
Firmware: Reboot the device..................................................................................................................38
Configure IO-Link devices ......................................................................................................................39
33692

On delivery, the AL1920 is configured with the factory settings (→ Factory settings (→ S. 80)).
Required software: LR DEVICE (1.5.0.x or higher) (art.-no.: QA0011/QA0012)

26
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.1 Remarks
Content
Offline parameter setting ........................................................................................................................27
VPN connection ......................................................................................................................................27
34180
>

Offline parameter setting

34060

The AL1920 supports the offline parameter setting. In this context, the user creates and stores a
configuration for the IO-Link master and the connected IO-Link devices without being connected to the
AL1920 (OFFLINE mode). The configuration created in this way can be stored as a file (*.lrp) and
loaded to the AL1920 and activated at a later date.

Further information about offline parameter setting: → Operating instructions LR DEVICE

>

VPN connection
34382

An active VPN connection blocks the access of the parameter setting software LR DEVICE to
the EtherNet/IP interface of the AL1920.
► Deactivate the VPN connection in order to be able to access the AL1920 with the LR
DEVICE.

27
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.2 IoT: Configure IP settings

34049

For access to the IO-Link master via the IT infrastructure the user has to set the IP settings of the IoT
port.

To configure the IP settings with DHCP, a DHCP server has to be active in the IT network. If
no DHCP server can be reached in the IT network, an IP address is automatically assigned to
the IoT port with the Zeroconfig protocol (address range: → Factory settings (→ S. 80)).

To configure the IP settings of the IoT interface:

► Select [IoT] menu.
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values
[DHCP] Activate/deactivate the DHCP client of the [Static IP] IP settings were set by the user
device
[DHCP] IP settings are set by a DHCP
server in the network.
[IP address]* IP address of the IoT port Factory setting: 169.254.X.X
[Subnet mask]* Subnet mask of the Ethernet network Factory setting: 255.255.0.0
[Default gateway IP address]* IP address of the network gateway Factory setting: 0.0.0.0
[MAC address] MAC address of the IoT port The value is firmly set.
* ... can only be edited if parameter [DHCP] = [Static IP]

► Save changed values on the device.

28
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.3 IoT: Configure security mode

54680

The IoT interface of the IO-Link offers a security mode. It enables secure data transmission via
transport encryption and restriction of the access to IO-Link masters and IO-Link devices via user
authentication.
To configure the security mode:
► Select [IoT] menu.
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values

[Security mode HTTPS] Set the security mode [Disabled] Security mode disabled

[Enabled] Security mode enabled

[Security password] Password
Note: The set password is not displayed.

► Save changed values on the device.

The security mode only protects the access to the device via the IoT interface.
The user name "administrator" cannot be changed.

The security mode can be enabled without setting the password. During the attempt to write to
the device, LR DEVICE requires to enter and confirm the password.
After entering the password, the user has unrestricted access to IO-Link masters and
connected IO-Link devices. The password will only be requested again if the current LR
DEVICE session is over (e. g. after rebooting the LR DEVICE).
To change the set password:
► Sign in with a valid password.
► Enter the new password in the field [Security password].
► Write changes to the device.
> The new password is set.
> LR DEVICE requires entering the new password to be able to access to the IO-Link
master.

29
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.4 IoT: Configure access rights

34046

The access rights define which instance may read and / or write the parameter data, process data and
event/diagnostic messages.
In order to configure the access rights to the IO-Link master:
► Select [IoT] menu.
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values
[Access Rights] The access rights to the [EtherNet/IP + IoT]  EtherNet/IP and IoT Core have read
parameter data, process data and write access rights to parameters
and the event/diagnostic and process data
messages of the IO-Link master  EtherNet/IP and <IoT Core> have read
as well as the connected IO-Link access rights to events/alarms
devices
[EtherNet/IP + IoT  EtherNet/IP has read and write access
(read-only)] rights to parameters and process data
 EtherNet/IP has read access rights to
events/alarms
 IoT Core only has read access rights to
parameters, process data and
events/alarms
[IoT only]  IoT Core has read and write access
rights to parameters and process data
 IoT has read access rights to
events/alarms
 EtherNet/IP has no access rights

► Save changed values on the device.

If the parameter [Access rights] is set to [EtherNet/IP + IoT] via IoT and EtherNet/IP projection,
then the parameter values set in the EtherNet/IP projection software apply.
If the parameter [Access rights] is set to [IoT only] via IoT, then set the parameter [Access
rights] to [Keep settings] in the EtherNet/IP projection software.
Changes of the parameter [Access Rights] are only effective after restarting the device
(→ Firmware: Reboot the device (→ S. 38))

30
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.5 IoT: Configure the interface to LR AGENT or LR SMARTOBSERVER

34048

To enable transfer of process data from the IO-Link master to LR AGENT or LR SMARTOBSERVER,
the interface has to be configured accordingly.
► Select [IoT] menu.
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values

[IP address LR Agent or IP address of LR AGENT or Factory setting: 255.255.255.255

SMARTOBSERVER] LR SMARTOBSERVER
[Port LR Agent or Port number that is used to send process data 0 Factory setting:: 35100
SMARTOBSERVER] to LR AGENT or LR SMARTOBSERVER ...
65535
[Interval LR Agent or Cycle time for the transfer of the process data to [Off] no transfer
SMARTOBSERVER] LR AGENT or LR SMARTOBSERVER (value in
milliseconds) 500 500 ms
... ...
2147483647 2147483647 ms
[Application Tag] Source identifier of the IO-Link master in the Factory setting: AL1920
structure of LR AGENT or
LR SMARTOBSERVER (String32)

After changing the parameter [Port LR Agent or SMARTOBSERVER] or [Application Tag], it

may take 120 seconds before the device establishes a new TCP connection.
To prevent the delay:
► Reboot the device after changing the the parameter.

► Save changed values on the device.

31
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.6 Fieldbus: Configure IP settings

54692

For communication with the EtherNet/IP network, the EtherNet/IP interface must be configured.
► Select [Fieldbus] menu.
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values

[DHCP] Enable / disable the DHCP client of the device [Static IP] IP parameters are set by the
user
[DHCP] IP parameters are set by a
DHCP server in the network.
[BOOTP] IP parameters are set via the
Bootstrap Protocol (BOOTP)
[IP address]* IP address of the EtherNet/IP port Factory setting: 192.168.1.250
[Subnet mask]* Subnet mask of the IP network Factory setting: 255.255.255.0
[Default gateway IP address]* IP address of the gateway Factory setting: 0.0.0.0
[Host name] Name of the device in the EtherNet/IP network e.g. al1xxx
[MAC address] MAC address of the device The value is firmly set.

[Fieldbus firmware] e.g. 3.4.04 (EtherNet/IP Adapter)

* ... Parameter can only be edited if parameter [DHCP] = [Static IP]

► Save changed values on the device.

32
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.7 Fieldbus: set the configuration mode

54693

The AL1920 supports the EtherNet/IP configuration modes "top-down" and "independent".
Additionally, the user can configure the length of the transmitted process data and select the required
connection types.
► Select [Fieldbus] menu.
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values
[Configuration]* EtherNet/IP configuration mode Independent mode off Configuration via fieldbus PLC
Independent mode on Configuration via AL1920
[Process data length]* Length of process data per IO-Link 2 bytes input 2 bytes 2 bytes input data, 2 bytes output
port output data
4 bytes input 4 bytes 4 bytes input data, 4 bytes output
output data
8 bytes input 8 bytes 8 bytes input data, 8 bytes output
output data
16 bytes input 16 bytes 16 bytes input data, 16 bytes output
output data
32 bytes input 32 bytes 32 bytes input data, 32 bytes output
output data
[Swap]* Sequence of bytes in the data off as Array of Bytes
word
on as Integer16 value; during an
update of the process data, the
bytes are exchanged
[Explicitpdmode]** Enable / disable explicit PD mode Explicit process data Explicit PD mode disabled
and select the process data to be mode off
transmitted (connection types)
Explicit process data Explicit PD mode enabled: IO-Link
mode with IO-Link I/O + inputs /outputs, acyclic data and
Acyclic + Diag diagnostic data are transmitted
Explicit process data Explicit PD mode enabled: IO-Link
mode with IO-Link I/O + inputs/outputs and acyclic data are
Acyclic transmitted
Explicit process data Explicit PD mode enabled: IO-Link
mode with IO-Link I/O inputs/outputs are transmitted
* ... Parameter can only be changed if the EtherNet/IP controller is disconnected
** ... Parameter only valid if [Configuration] = [Independent mode on]

► Save changed values on the device.

33
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.8 IO-Link ports: Activate data transfer to LR AGENT or

LR SMARTOBSERVER
33690

The user can decide separately for each IO-Link port whether the process data of the connected
IO-Link devices should be transferred to LR AGENT or LR SMARTOBSERVER.

To transfer process data the interface to the LR AGENT or LR SMARTOBSERVER has to be

correctly configured (→ IoT: Configure the interface to LR AGENT or LR
SMARTOBSERVER (→ S. 31)).

To activate / deactivate data transfer:

► Select [Port x] menu (x = 1...8).
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values

[Transmission to LR Transfer of process data of the connected [Disabled] Transfer process data
Agent IO-Link device to LR AGENT oder
or SMARTOBSERVER] LR SMARTOBSERVER [Enabled] Don't transfer process data

► Save changed values on the device.

34
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.9 IO-Link ports: Configure operating mode

33694

The IO-Link ports X01...X08 of the device support the following operating modes:
 Digital input (DI): binary input signal at clamp 4 (C/Q) of the IO-Link port
 Digital output (DO): binary output signal at clamp 4 (C/Q) of the IO-Link port
 IO-Link: IO-Link data transfer via clamp 4 (C/Q) of the IO-Link port

The user can set the operating mode separately for each IO-Link port.
To set the operating mode of an IO-Link port:
► Select [Port x] menu (x = 1...8).
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values
[Mode] Operating mode of the IO-Link port [Disabled] Port deactivated

[DI] Operation as digital input

[DO] Operation as digital output

[IO-Link] Operation as IO-Link interface

[Cycle time actual]** Current cycle time of the data transfer between Parameter can only be read
IO-Link master and IO-Link device on the port
(value in microseconds)
[Cycle time preset]* Cycle time of the data transfer between the IO-Link 0 The device automatically sets
master and the IO-Link device at the port (value in the fastest possible cycle time.
microseconds)
1 1 microsecond
... ...
132800 132800 microseconds
[Bitrate]** Current transmission rate of the data transfer Parameter can only be read
between the IO-Link master and the IO-Link device
on the port
* ... Parameter only available if [Mode] = [IO-Link]
** ... Parameter only visible if the IO-Link device is connected to the IO-Link port.

► Save changed values on the device.

35
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.10 IO-Link ports: Set the device validation and data storage
33697

The user can choose how the IO-Link ports are to behave with regard to the device validation and the
storage / recovery of parameter data of the connected IO-Link device.
The following options are available:
Option Validation of the IO-Link Storage of the parameter values Recovery of the parameter
device values

[No check and clear] no no no

[Type compatible yes, test the compatibility with no no
V1.0 device] IO-Link standard V1.0
[Type compatible yes, test the compatibility with no no
V1.1 device] IO-Link standard V1.1
[Type compatible yes, test the compatibility with yes, automatic storage of the yes, recovery of the parameter
V1.1 device with IO-Link standard V1.1 and parameter values; changes of the values when connecting an
Backup + Restore] identity of design (vendor ID current parameter values will be identical IO-Link device with
and device ID) stored factory settings
[Type compatible yes, test the compatibility with no, there is no automatic storage yes, recovery of the parameter
V1.1 device with IO-Link standard V1.1 and changes of the current parameter values when connecting an
Restore] identity of design (vendor ID values will not be stored identical IO-Link device with
and device ID) factory settings

The options only apply if the IO-Link port is in the operating mode "IO-Link".
For options [Type compatible V1.1 device with Backup + Restore] and [Type compatible V1.1
device with Restore]: If the vendor ID and device ID are changed in the online mode, the data
memory will be deleted and a new backup of the parameter values of the connected IO-Link
device will be created in the IO-Link master.

To configure the device validation and the data storage:

► select [Port x] menu (x = 1...8).
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values
[Validation / Data Supported IO-Link standard and behaviour of the [No check and clear]
Storage] IO-Link master when connecting a new IO-Link
device at port x (x = 1...8) [Type compatible V1.0
device]
[Type compatible V1.1
device]
[Type compatible V1.1 device
with Backup + Restore]
[Type compatible V1.1 device
with Restore]
[Vendor ID] ID of the manufacturer that is to be validated 0...65535 Factory setting: 0#
ifm electronic: 310
[Device ID] ID of the IO-Link device that is to be validated 0...16777215 Factory setting: 0

► Save changed values on the device.

>

36
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

9.1.11 IO-Link Ports: Set fails-safe values

34329

For the configuration mode "Independent" the user can set fail-safe values for the outputs of IO-Link
ports X01...X08. The fail-safe values will be activated in case of an interuption of the EtherNet/IP
conection.
To set the fail-safe values:
► Select [Port x] menu (x = 1...8).
> The menu page shows the current settings.
► Set the following parameters as required:
Name Description Possible values

[Fail-safe digital out]* Fail-safe value of the output for operating mode [Reset] OFF
"Digital Output (DO)"
[Old] old value
[Set] ON
[Fail-safe IO-Link]* Fail-safe value of the output for operating mode [Off] no Fail-safe
"IO-Link"
[Reset] Fail-safe: OFF
[Old Fail-safe: old value
[Pattern] Fail-safe: byte pattern
* ... Parameter only changeable, if the connection to the EtherNet/IP controller is closed

► Save changed values on the device.

>

9.1.12 Info: Show device information

34065

To read the general information of the ifm IO-Link master:

► Select [Info] menu.
> The menu page shows the current settings.
Name Description Possible values

[Product code] Article number of the IO-Link master AL1920

[Device family] Device family of the IO-Link master IO-Link master
[Vendor] Vendor ifm electronic gmbh
[SW-Revision] Firmware of the IO-Link master
[HW revision] Hardware version of the IO-Link master
[Bootloader revision] Bootloader version of the IO-Link master
[Serial number] Serial number

37
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.13 Firmware: Reset device to factory settings

33838

When the IO-Link master is reset, all parameters are set to the factory settings:
To reset the device to factory settings:
► Select [Firmware] menu.
> The menu page shows the current settings.
► Click on [Factory Reset] to reset the device.
> LR DEVICE sets the device to the factory settings.
>

9.1.14 Firmware: Reboot the device

33832

When rebooting the device, all settings are kept.

To restart the AL1920:
► Select [Firmware] menu.
> The menu page shows the current settings.
► Click on [Reboot] to reboot the device.
> LR DEVICE reboots the ifm IO-Link master.

38
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.1.15 Configure IO-Link devices

33856

To configure the IO-Link devices connected to the device with the LR DEVICE parameter setting
software:
Requirements:
> IO-Link master is correctly installed and connected to the LR DEVICE parameter setting software.
> The IO-Link device is correctly connected to the AL1920.
> Operating mode of the IO-Link port is "IO-Link" (→ IO-Link ports: Configure operating mode
(→ S. 35)).
> IoT has write access rights to the IO-Link master (→ IoT: Configure access rights (→ S. 30)).
1 Select IO-Link master
► Start LR DEVICE.
► Update IODD file library
OR:
Import IODD file of the IO-Link device manually.
► Scan network for devices.
> LR DEVICE detects IO-Link master.
2 Add IO-Link device
► Under [ONLINE]: Click on the required IO-Link master.
> LR DEVICE automatically detects the IO-Link devices connected to the IO-Link master (e.g. ifm sensor KG5065).

3 Configure IO-Link device

► Mouse click on the port to which the IO-Link device is connected.
> LR DEVICE reads and shows the current parameter values of the IO-Link device.
► Configure IO-Link device.

Information about the available parameters of the IO-Link device: → IO Device Description
(IODD) of the IO-Link device

► Save the changed configuration on the IO-Link device.

39
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2 ifm IoT Core

Content
First steps ..............................................................................................................................................40
General functions ...................................................................................................................................41
Configure IoT interface ...........................................................................................................................42
IoT interface: Configure security mode ..................................................................................................43
Configure the fieldbus interface ..............................................................................................................46
Configure IO-Link ports ..........................................................................................................................47
Configure IO-Link devices ......................................................................................................................49
Set application identification ...................................................................................................................51
Read / write cyclic process data ...........................................................................................................52
Control IO-Link master ...........................................................................................................................53
Read diagnostic data of the AL1920 ......................................................................................................55
Read device information of the IO-Link master ......................................................................................56
Read information about IO-Link devices ................................................................................................56
Subscribe to events ................................................................................................................................57
MQTT support .......................................................................................................................................59
Programmers' notes ...............................................................................................................................60
52244

General notes on the ifm IoT Core: → Programmers' notes (→ S. 60)

>

9.2.1 First steps

52245

To read the device description of the AL1920:

► Send the following POST request to the AL1920:
{"code":"request","cid":-1,"adr":"gettree"}
> AL1920 returns the device description as structured JSON object.
► Identify all substructures and the data points contained therein in the tree structure of the JSON
object.
► Identify the applicable services for the access to substructures and the data points contained
therein.

40
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.2 General functions

52246

The AL1920 is of type device (→ Overview: IoT types (→ S. 144)).

Besides gettree, the following services can be applied to the root element of type device.
Service Description
../getidentity Read device information
../getdatamulti Read several parameter values sequentially
../getelementinfo Read the uid of the AL1920
../setelementinfo Write the uid of the AL1920

Depending on the read and write access rights, the following services can be applied to elements of
type data:
Service Description

../getdata Read the value of the element

../setdata Write the value of the element

41
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.3 Configure IoT interface

33888

Via the IoT interface the AL1920 wil be integrated in the IT network.
Substructure: iotsetup
Avalable data points:
Name Description Access

../accessrights Access rights to the IO-Link master rw

../smobip IP address of the LR SMARTOBSERVER rw
../smobport Port number of the LR SMARTOBSERVER rw
../smobinterval Cycle time for data transmission to LR SMARTOBERVER (value in rw
milliseconds)
../network/dhcp Configuration of the IP settings of the IoT port rw
../network/ipaddress IP address of the IoT port rw
../network/subnetmask Subnet mask of the network segment rw
../network/ipdefaultgateway IP address of the network gateway rw
rw ... read and write

Applicable services:
Name Description

../network/setblock Write all values of the substructure at once

If the parameter [Access rights] is set to [EtherNet/IP + IoT] using IoT and EtherNet/IP
projection, then the parameter values set in the EtherNet/IP projection software apply.
If the parameter [Access rights] is set to [IoT only] via IoT, then set the parameter [Access
rights] to [Keep settings] in the EtherNet/IP projection software.
Changes of the parameter [Access Rights] are only effective after restarting the device
(→ Firmware: Reboot the device (→ S. 38))

42
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.4 IoT interface: Configure security mode

54683

The access to the IoT interface of the IO-Link master can be protected with a security mode:
Sub-structure: iotsetup
Available data points:
Name Description Access

../security/securitymode active security mode rw

../security/password Password for authentication (Base64 coded) w

rw ... read and write

w ... write only

Valid character set for the Base64 coding / decoding of the password: UTF-8
Online tool for coding / decoding: → www.base64encode.org

>

Note: Security mode

54684

The security mode enables restricting access to the IO-Link master and the connected IO-Link devices
from the IT network. In the activated security mode, the following restrictions apply:
 Access only with authentication (password-protected user account)
 Access only via secure https connection (Transport Layer Security - TLS)

The security mode only protects the access to the device via the IoT interface.
The standard value for users is: administrator
The set password cannot be read with getdata.

The current status of the security function can be read with the getidentity service (→ Service:
getidentity (→ S. 148)).
For the authentication, the user must additionally provide the POST requests with a valid user name
and password in the field "auth". The user name and the password will be shown as Base64-coded
character strings (→ Example: Request with authentication (→ S. 45)).
The following requests can be done if the security mode is enabled, also without authentication:
 /getidentity
 /deviceinfo/vendor/getdata
 /deviceinfo/productcode/getdata

43
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: Activate security mode

54701

Task: Activate the security mode of the IO-Link interface of the IO-Link master. Set the password
"password" (Base64 coded: cGFzc3dvcmQ=)
Solution: The activation sonsists of 2 steps:
1 Activate security mode
Use service setdata with datapoint iotsetup/security/securitymode to activate the security mode.
 Request:
{
"code":"request",
"cid":-1,
"adr":"/iotsetup/security/securitymode/setdata",
"data":{"newvalue":"1"}
}
 Response:
{
"cid":-1,
"code":200
}

2 Set required password

Use service setdata with data point iotsetup/security/password to set the required password.
 Request:
{
"code":"request",
"cid":-1,
"adr":"/iotsetup/security/password/setdata",
"data":{"newvalue":"cGFzc3dvcmQ="}
}
 Response:
{
"cid":-1,
"code":200
}

44
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: Request with authentication

54685

Task: The temperature of the IO-Link master is to be read. The security function is enabled (current
password: password).
Solution: Read the data point processdatamaster/temperature with the getdata service. The request
must be sent using https. The user name and the password are transferred as a Base64-coded
character string ("administrator" = "YWRtaW5pc3RyYXRvcg==", "password" = "cGFzc3dvcmQ=")
 Request:
{
"code":"request",
"cid":-1,
"adr":"processdatamaster/temperature/getdata",
"auth":{"user":"YWRtaW5pc3RyYXRvcg==","passwd":"cGFzc3dvcmQ="}
}
 Response:
{
"cid":-1,
"data":{"value":37},
"code":200
}
>

Example: reset password

54686

Task: The existing password is to be reset.

Solution: To reset a password, disable the security mode. To disable it, enter the user name and the
password (the fields "user" and "passwd").
 Request:
{
"code":"request",
"cid":-1,
"adr":"iotsetup/security/securitymode/setdata",
"data":{"newvalue":0},
"auth":{"user":"YWRtaW5pc3RyYXRvcg==","passwd":"SW9UNGlmbQ=="}
}
 Response:
{
"cid":-1,
"code":200
}

45
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.5 Configure the fieldbus interface

54702

Via the fieldbus interface (ports X21 / X22) the AL1920 will be integrated in the EtherNet/IP network.
Substructure: fieldbussetup
Available data points:
Name Description Access

../hostname Name of the IO-Link master in the fieldbus project rw

../fieldbusfirmware Firmware version of the IO-Link master r
../network/macaddress MAC address of the fieldbus port r
../network/ipaddress IP address of the fieldbus port rw*
../network/subnetmask Subnet mask of the network segment rw*
../network/ipdefaultgateway IP address of the network gateway rw*
../network/dhcp Configuration of the IP settings of the fieldbus interface rw
../connectionstatus Status of the connection to the EtherNet/IP network r
../configuration/independentmode Set the configuration mode (Top-down, Independent) r/w*
../configuration/explicitpdmode Connection types r/w*
../configuration/processdataconfiguration Length of the process input data and process output data rw*

../configuration/swap Byte order of process data r/w*

../configuration/port[n]/failsafedigital Failsafe value of the digital output - pin 4 (DO) r/w*
.../configuration/port[n]/failsafeiolink Failsafe value of the IO-Link output data r/w*
n ... 1...8
r ... read only
rw ... read and write
* ... parameter only changeable, if the connection to the EtherNet/IP controller is closed

Applicable services:
Name Description

../network/setblock Write all values of the substructure at once

46
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.6 Configure IO-Link ports

52248

The user can configure the IO-Link ports X01...X08 separately.

Substructure: iolinkmaster/port[n] (n = 1...8).
Available data points:
Name Description Access

../senddatatosmob Send process data to LR SMARTOBSERVER rw*

../mastercycletime_preset Cycle time of the data transfer at the IO-Link port (value in microseconds) rw
../mastercycletime_actual Current cycle time of the data transfer at the IO-Link port (value in r
microseconds)
../portevent Activity display rw
../mode Operating mode of the IO-Link port rw*
../comspeed Data transfer rate of the IO-Link port rw
../validation_datastorage_mode Response of the IO-Link port when a new IO-Link device is connected rw*
../validation_vendorid IO-Link ID of the manufacturer that is to be validated rw*
../validation_deviceid IO-Link ID of the device that is to be validated rw*
../datastorage Data storage area of the port rw
../datastorage/maxsize Maximum size of the data storage area (in bytes) r
../datastorage/chunksize Size of a data segment (in bytes) r
../datastorage/size Size of the data storage area (in bytes) r
r ... read only
rw ... read and write
* ... parameter only editable, if connection to the EtherNet/IP plc is interupted

Applicable services:
Service Description

../validation_useconnecteddevice Validate the IO-Link device connected to the IO-Link port

../datastorage/getblobdata Read the content of the data storage area
../datastorage/stream_set Transfer an individual data segment
../datastorage/start_stream_set Start sequential transmission of several data segments

47
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: Clone the Data Storage of an IO-Link port

52344

Task: Save the Data Storage of IO-Link port X02 of IO-Link master 1 and restore the data at IO-Link
master 2.
Solution: The cloning process consists of 2 steps. In the first step, the Data Storage of the IO-Link
port of IO-Link master 1 is saved. In the second step, the saved data is restored at the Data Storage of
port IO-Link port of IO-Link master 2.
Save Data Storage:
1 Preparations
► Read size of segments of Data Storage (h = number of bytes):
{"code":"request", "cid": -1,"adr":"/iolinkmaster/port[2]/datastorage/chunksize/getdata"}
Example: h = 256
► Read total size of Data Storage area (g = number of bytes):
{"code": "request", "cid": -1, "adr": "/iolinkmaster/port[2]/datastorage/size/getdata"}
Example: g = 550
► Calcuate the number of reading steps n: n = first integer value to which the following applies: g < n*h
Example: n= 3, because 550 < 3*256
2 Read Data Storage of IO-Link port
► Read Data Storage segment by segment ("pos" is the byte offset, at which the reading process with length "length"
starts).
{"code": "request", "cid": -1, "adr": "/iolinkmaster/port[2]/datastorage/getblobdata", "data": {"pos": 0, "length": h}}
{"code": "request", "cid": -1, "adr": "/iolinkmaster/port[2]/datastorage/getblobdata", "data": {"pos": h, "length": h}}
{"code": "request", "cid": -1, "adr": "/iolinkmaster/port[2]/datastorage/getblobdata", "data": {"pos": 2*h, "length": h}}
...
{"code": "request", "cid": -1, "adr": "/iolinkmaster/port[2]/datastorage/getblobdata", "data": {"pos": n*h, "length": h}}
Example:
1st read request: pos = 0, length = 256
2nd read resquest: pos = 256, length =256
3rd read request: pos = 512, length = 256
> Each segment value will be returned as BASE64 coded string.
► Join segments.

Restore Data Storage:

1 Preparations
► Determine the size of the saved Data Storage value (n = number of bytes).
Example: n = 550
► Read size of segments (s = number of bytes):
{"code":"request", "cid": -1,"adr":"/iolinkmaster/port[1]/datastorage/chunksize/getdata"}
Example: s = 256
2 Transfer Data Storage strings
► Start transfer of Data Storage string ("size" = size of Data Storage string):
{"code":"request", "cid": -1, "adr":"/iolinkmaster/port[1]/datastorage/start_stream_set", "data": {"size": n}}
Example: size = 550
► Transfer Data Storage string segment by segment ("value" = string value of length s):
{"code": "request", "cid": -1, "adr": "/iolinkmaster/port[1]/datastorage/stream_set", "data": {"value":
"aWZtfgIAAABBTDF4NXhfY25faXRfdDIuMi43Nw..."}

48
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.7 Configure IO-Link devices

52249

The ifm IoT Core supports the configuration of the connected IO-Link devices. A parameter is
accessed via IO-Link index and subindex (→ IO Device Description (IODD) of the device).
Substructure: iolinkmaster/port[n]/iolinkdevice (n = 1...8)
Applicable services:
Service Description

../iolreadacyclic Read a parameter of an IO-Link device (acyclic)

../iolwriteacyclic Write a parameter of an IO-Link device (acyclic)

>

Example: Read the parameter value of an IO-Link device

33847

Task: Read the serial number of the ifm temperature sensor TN2531 at IO-Link port X02
Solution: Read the serial number with the iolreadacyclic service from the IO-Link device (index:
21, subindex: 0)
 Request:
{
"code":"request",
"cid":4711,
"adr":"/iolinkmaster/port[2]/iolinkdevice/iolreadacyclic",
"data":{"index":21,"subindex":0}
}
 Return:
{
"cid":4711,
"data":{"value":"4730323134323830373130"},
"code":200
}

The returned value is given in hexadecimal format. The conversion of the HEX value in a STRING
value is: G0214280710

49
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: Change the parameter value of an IO-Link device

33844

Task: Set the output configuration OUT1 of the ifm temperature sensor TN2531 at IO-Link port X02 to
the value "Hnc / hysteresis function, normally closed".
Solution: Change the parameter [ou1] of the sensor to the value 4 using the iolwriteacyclicdata
service. The parameter can be accessed via IO-Link index 580, subindex 0 (→ IO-Link description of
the sensor).
 Request:
{
"code":"request",
"cid":4711,
"adr":"/iolinkmaster/port[2]/iolinkdevice/iolwriteacyclic",
"data":{"index":580,"subindex":0,"value":"34"}
}
The value has to be given in hexadecimal format. The conversion of the STRING value in a HEX value
is: 34.
 Response:
{
"cid":4711,
"code":200
}

50
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.8 Set application identification

52337

The user can set the application name of the IO-Link master:
Substructure: devicetag
Available data points:
Name Description Access

../applicationtag Name of the IO-Link master (application tag) rw

rw ... read and write
>

Example: Change name of the IO-Link master

a33823

Task: Set the name of the IO-Link master to AL1920 for the representation in the
LR SMARTOBSERVER.
Solution: Change the parameter [Application Tag] with the setdata service to the value [AL1920].
The data point of the parameter [Application Tag] in the device description object is
/devicetag/applicationtag.
 Request:
{
"code":"request",
"cid":4711,
"adr":"/devicetag/applicationtag/setdata",
"data":{"newvalue":"AL1920"}
}
 Response:
{"cid":4711,"code":200}

51
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.9 Read / write cyclic process data

52250

To access the cyclic process data of the IO-Link ports X01...X08:

Substructure: iolinkmaster/port[n] (n = 1...8)
Available data points:
Name Description Access

../pin2in Value of the digital input on clamp 2 of the IO-Link port r

../iolinkdevice/pdin Value of the IO-Link input on clamp 4 of the IO-Link port r
../iolinkdevice/pdout Value of the IO-Link output on clamp 4 of the IO-Link port rw*
r = only read
rw = read and write
* = only changeable, if not connected to fieldbus PLC
>

Example: Read process data of an IO-Link device

33842

Task: Read the current measured value of the ifm temperature sensor TN2531 at IO-Link port X02
Solution: Read the data point for the process input data with the getdata service.
 Request:
{
"code":"request",
"cid":4711,
"adr":"/iolinkmaster/port[2]/iolinkdevice/pdin/getdata"
}
 Response:
{
"cid":4711,
"data":{"value": "03C9"},
"code":200
}

The return value is given in hexadecimal format. Besides the temperature value the return value
comprises additional information (→ IO Device Description (IODD) of the sensor). The temperature
value is shown in bits 2 to 15.
0x03C9 = 0b1111001001
Temperature value: 0b11110010 = 242
Therefore: The current temperature value is 24.2 °C.

52
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.10 Control IO-Link master

52251

Different services and management functions can be carried out on the IO-Link master.
Substructure: firmware
Available data points:
Name Description Access

../version Software version r

../type Software type r
../container Area for updating the firmware w
../container/maxsize Maximum size of the container area (in bytes) r
../container/chunksize Size of a data segment (in bytes) r
../container/size Size of the container area (in bytes) r
r = only read
w = write only
Applicable services:
Name Description
../factoryreset Reset IO-Link master to factory settings
../reboot Reboot IO-Link master
../signal Trigger the flashing of the status LED
../install Install firmware transferred to the IO-Link master
../container/stream_set Transfer an individual data segment
../container/start_stream_set Start sequential transmission of several data segments

53
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: Update firmware

52252

Task:
Update the firmware of the device; size of the firmware file: 356676 bytes
Solution:
The firmware is transferred to the device in fragments (chunks). The size of the fragments depends on
the size of the flash memory of the IO-Link master. To transfer the firmware, the firmware file must be
converted into a character string using BASE64.
1 Preparations
► Determine the size of the fragments (g = number of bytes):
{"code":"request", "cid": -1, "adr":"/firmware/container/chunksize/getdata"}
► Convert the firmware file into a BASE64 string.
2 Start the transfer of the firmware
► Start the transfer of the firmware via the service start_stream_set (parameter "size": size of the firmware file):
{"code":"request", "cid": -1, "adr":"/firmware/container/start_stream_set", "data":{"size":356676}}
3 Load the firmware into the flash memory of the IO-Link master
► Send the BASE64 string of the firmware file to the IO-Link master fragment by fragment (value = string value with
length g).
{"code": "request", "cid": -1, "adr": "/firmware/container/stream_set", "cid": -1, "data": {"value":
"aWZtfgIAAABBTDF4NXhfY25faXRfdDIuMi43Nw..."}
► Repeat step 3 until all fragments of the firmware file have been sent to the IO-Link master.
> IO-Link master stores the segments received in the container area.
4 Install firmware
► Start the installation of the transmitted firmware.
{"code": "request", "cid": -1, "adr": "/firmware/install", "data": {}}

54
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.11 Read diagnostic data of the AL1920

52253

The user can read diagnostic data of the status of the IO-Link masters.
Substructure: processdatamaster
Available data points:
Name Description Access

../temperature Temperature of the IO-Link master (value in °C) r

../voltage Voltage applied (value in V) r
../current Current (value in A) r
../supervisionstatus Diagnostic information of the device supply r
r ... read only
>

Example: Read several parameter values of the IO-Link master simultaneously

33840

Task: The following current values are to be read by the IO-Link master: temperature, serial number
Solution: Read the current parameter values using the getdatamulti service (data point temperature:
/processdatamaster/temperature; data point serial number: /deviceinfo/serialnumber)
 Request:
{
"code":"request",
"cid":4711,
"adr":"/getdatamulti",
"data":{"datatosend":["/processdatamaster/temperature","/deviceinfo/serialnumber"]
}
}
 Response:
{
"cid":4711,
"data":{"processdatamaster/temperature":{"code":200,"data":44},
"deviceinfo/serialnumber":{"code":200,"data":"000174210147"}},
"code":200
}

55
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.12 Read device information of the IO-Link master

52254

To read the device information of the AL1920:

Substructure: deviceinfo
Available data points:
Name Description Access

../productcode Article number r

../vendor Producer r
../devicefamily Device family r
../hwrevision Hardware revision r
../serialnumber Serial number r
../swrevision Firmware version r
../bootloaderrevision Bootloader version r
../extensionrevisions Firmware and bootloader version r
../fieldbustype Fieldbus r
r ... read only
Additional information about the AL1920 can be read with the getidentity service (→ Service:
getidentity (→ S. 148)).
>

9.2.13 Read information about IO-Link devices

52339

The user can obtain information about the IO-Link devices connected to the IO-Link ports.
Substructure: iolinkmaster/port[n]/iolinkdevice (n = 1...8)
Available data points:
Name Description Access

../status Status of the connected IO-Link device r

../vendorid IO-Link ID of the vendor r
../deviceid IO-Link ID of the IO-Link device r
../productname Product name of the IO-Link device r
../serial Serial number of the IO-Link device r
../applicationspecifictag Device-specific identification (application tag) rw
r ... read only
rw ... read and write

56
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.14 Subscribe to events

52255

If a data point has the subelement datachanged, the user can subscribe to events.
Available data points:
Name Description Access
timer[n]/counter Current value that can be subscribed to r
timer[n]/interval Cycle time of the update of the subscribed values rw
iolinkmaster/port[n]/portevent Display of the following events on IO-Link port n: r
 IO-Link device connected
 IO-Link device disconnected
 Operating mode of the IO-Link port changed
iolinkmaster/port[n]/iolinkdevice/iolinkevent Display of IO-Link events r
r ... read only
rw ... read and write

Applicable services:
Name Description
../datachanged/subscribe Subscribe to an event message
../datachanged/unsubsribe Unsubscribe from an event message
../datachanged/getsubscriptioninfo Show information about event messages

57
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: Subscribe to event

33853

Task: The current values of the following parameters should be sent regularly to a network server with
IP address 192.168.0.4: product name of the IO-Link device at IO-Link port X02, cyclic input data of
the IO-Link device at IO-Link port X02 and the operating temperature of the IO-Link master.
Solution: Subscribe to the required data using the subscribe service.
 Request:
{
"code":"request",
"cid":4711,
"adr":"/timer[1]/counter/datachanged/subscribe",
"data":{"callback":"http://192.168.0.44:80/temp",
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/productname",
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/temperature"]
}
}

Additionally the interval of the timer[1] has to be set to a value between 500 ms and 2147483647 ms.
 Request:
{
"code":"request",
"cid":4712,
"adr":"/timer[1]/interval/setdata",
"data":{"newvalue":500}
}
 Response:
{
"cid":4712,
"code":200
}

58
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.15 MQTT support

54699

The AL1920 can operate as a client in a MQTT-based communication environment. By using the
subscribe service it is possible to send messages to a MQTT broker (PUBLISH).
>

Example: Publish the temperature to an MQTT broker

54687

Task: Publish the temperature of an IO-Link master to an MQTT broker (IP address MQTT broker:
192.168.82.100, port: 1883, Topic:abc).
Solution:
 Request:
{
"code":"request",
"cid":-1,
"adr":"iolinkmaster/port[1]/portevent/datachanged/subscribe",
"data":{
"callback":"mqtt://192.168.82.100:1883/abc",
"datatosend":["processdatamaster/temperature"}
}
 Response:
{
"cid":-1,
"code":200
}

59
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.2.16 Programmers' notes

Content
IoT Core: General information ................................................................................................................60
Access the ifm IoT Core .........................................................................................................................61
IoT Core: Diagnostic codes ....................................................................................................................64
34229
>

IoT Core: General information

52256

The CabinetLine device family has an IoT Core. The IoT Core allows the user to address the AL1920
from IT networks via a REST API and to integrate it into Internet-of-Things applications.
A device description is stored on the AL1920. This device description is a structured,
machine-readable data object in JSON format. All current values of parameters, process data,
diagnostic data and device information are mapped in this data object. These data values can be read
and changed by means of services.

60
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Access the ifm IoT Core

52257

The user can access the ifm IoT Core via HTTP requests. The following request methods are
available.
>

GET request
33804

Using the GET method the user has read access to a data point.
The syntax of the request to the IoT Core is:
http://ip/datapoint/service

Parameter Description

ip IP address of the IoT interface

data_point Data point which is to be accessed

service Service

The syntax of the return of the IoT Core is:

{
"cid":id,
"data":{"value":resp_data},
"code":diag_code
}

Parameter Description

id Correlation ID for the assignment of request and return

resp_data Value of the data point; depending on the data type of the data point
diag_code Diagnostic code (→ IoT Core: Diagnostic codes (→ S. 64))

>

Example: GET request

54033

Request (via browser):

http://192.168.0.250/devicetag/applicationtag/getdata

Response:
{
"cid":-1,
"data":{"value":"AL1920"},
"code":200
}

61
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

POST request
54700

Using a POST request the user has read and write access to a data point.
The syntax of the request to the IoT Core is:
{
"code":"code_id",
"cid":id,
"adr":"data_point/service",
"data":{req_data},
"auth":{"user":"usr_id","passwd":"password"}
}

Field Parameter Description

code code_id Service class

 request Request
 transaction Transaction
 event Event
cid id Correlation ID for the assignment of request and response; vom Nutzer frei vergebbare
Kennung
adr data_point Data point of the element tree which is to be accessed
service Service to be performed (→ Overview: IoT services (→ S. 145))

data* req_data Data to be transferred to the IoT Core (e.g. new values); syntax depending on the service
auth** usr_id user name (base64 coded); default value: administrator
password password (base64 coded)
* = optional; only required for services, that submit data to the IoT core (e. g. setdata)
** = optional; only required, if security mode is activated

The syntax of the return of the IoT Core is:

{
"cid":id,
"data":{resp_data},
"code":diag_code
}

Field Parameter Description

cid id Correlation ID for the assignment of request and response (see request)
data* resp_data Value of the data point; syntax depending on the service
code diag_code Diagnostic code (→ IoT Core: Diagnostic codes (→ S. 64))

* = optional; only required for services, that receive data from the IoT core (e.g. gettdata)

62
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: POST request

54035

Request:
{
"code":"request",
"cid":4711,
"adr":"devicetag/applicationtag/getdata"
}

Response:
{
"cid":4711,
"data":{"value":"AL1920"},
"code":200
}

63
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

IoT Core: Diagnostic codes

54688

Code Text Description

200 OK Request successfully processed

230 OK but needs reboot Request successfully processed; IO-Link master must be restarted
231 OK but block request not finished Request successfully processed; blockwise request, but not yet
finished
232 Data has been accepted, but internally modified New values have been accepted, but were adjusted by the IO-Link
master
233 IP settings of the IoT core changed; application IP settings have been successfully changed, IO-Link master will be
has to reboot the device; Wait for min. 1 second restarted; wait for at least 1 second
before the device is rebooted
400 Bad request Invalid request
401 Unauthorized Non authorised request
403 Forbidden Forbidden request
500 Internal Server Error Internal fault

503 Service Unavailable The service is not available (e. g. IO-Link port in wrong operating
mode; no IO-Link device at IO-Link port)
530 The requested data is invalid Invalid process data
531 IO-Link error Error in IO-Link master / device
532 PLC connected Error Error: The IO-Link master is still connected with the fieldbus PLC

64
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3 EtherNet/IP
Content
Registration of the EDS file ....................................................................................................................65
Integrate the AL1920 into the EtherNet/IP project .................................................................................66
Set connection types and RPI ................................................................................................................67
Configure AL1920 ...................................................................................................................................68
Configure IO-Link ports ..........................................................................................................................69
Configure IO-Link devices ......................................................................................................................71
Read cyclic input data ............................................................................................................................72
Write cyclic output data ..........................................................................................................................72
Read diagnostic and status information .................................................................................................73
EtherNet/IP: Programmers' notes ...........................................................................................................74
34391

On the fieldbus side, the device can be configured with any EtherNet/IP compatible projection
software.
The information in the following sections refers to the EtherNet/IP projection software RSLogix 5000.
>

9.3.1 Registration of the EDS file

34324

ifm provides an EDS file to integrate the AL1920 in a EtherNet/IP projection software. The user can
download the EDS file from the ifm website (→ www.ifm.com). In the EDS file, all parameters, process
data, and their valid value ranges are defined.
To add the AL1920 to the device catalogue of RSLogix5000:
► Download the EDS file of the AL1920 from the ifm website.
► Start RSLogix5000.
► Select [Tools] > [EDS Hardware Installation Tool].
> EDS Wizard appears.
► Register the downloaded EDS file of the AL1920 with the EDS Wizard.
> EDS Wizard installs the EDS file and adds the AL1920 to the device catalogue.

65
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3.2 Integrate the AL1920 into the EtherNet/IP project

34392

The device is integrated as module of an I/O scanner in the EtherNet/IP project.

Requirements:
> The EDS file of the AL1920 is installed (→ Registration of the EDS file (→ S. 65)).
1 Create/open EtherNet/IP project
► Start RSLogix 5000.
► Create new EtherNet/IP project.
OR
Open an existing EtherNet/IP project.
2 Configure EtherNet/IP PLC and IO scanner
► Select and configure EtherNet/IP controller and IO scanner.
> EtherNet/IP project includes a EtherNet/IP controller and an IO scanner.
3 Integrate AL1920 in project
► In the Controller Organizer: Right mouse click on the IO scanner.
> Context menu appears.
► In the context menu: Select [New Module...].
> The window [Select Module Type] appears.
► Select AL1920 and click on [Create].
> The [New Module] window appears.
► Enter name and IP address of the AL1920.
► Click on [OK] to adopt the entered values.
> RSLogix 5000 adds AL1920 as sub-element of the IO scanner to the project.
4 Save the project
► Save EtherNet/IP project

66
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3.3 Set connection types and RPI

34407

The IO-Link master supports different connection types (→ Supported connection types (→ S. 87)).
The user can choose which object instances of the input assembly and the output assembly are used.
This makes it possible to adapt the size of the transmitted and received data. Additionaly the Request
Package Interval (RPI) can be selected.
To set the connection type:
Requirements:
> AL1920 is correctly integrated into the EtherNet/IP project (→ Integrate the AL1920 into the
EtherNet/IP project (→ S. 66)).
1 Open the module properties
► In the Controller Organizer: Double-click on the IO-Link master node
> Dialogue window appears.
2 Set connection type
► Click on [Change...].
> The [Module Definition] dialogue window appears.
► Select the required connection type from the list [Connections].
► Click on [OK] to apply the changes.
3 Change RPI
► Click on [Connection] tab.
> The connection settings appear.
► Select required time value from [RPI] list.
► Click on [OK] to apply the changes.

67
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3.4 Configure AL1920

34357

The AL1920 is configured via the controller tags.

Requirements:
> AL1920 is correctly integrated in the EtherNet/IP project (→ Integrate the AL1920 into the EtherNet/IP
project (→ S. 66)).
1 Open controller tags
► In the Controller Organizer: Double click on [Controller Name_of_Project] > [Controller Tags]
> [Controller Tags] window appears.
► In the tree view: Click on [AL1920:C].
> Controller tags for the configuration of the device appear.
2 Configure AL1920
► Set the following controller tags as required:
Name Description Possible values

[AL1920:C.Communication_Profile] The access rights to the 0x00 EtherNet/IP + LineRecorder

parameter data, process data  EtherNet/IP and LR DEVICE have read
and events/diagnostic and write access rights to parameters and
messages of the IO-Link process data
master and the connected
IO-Link devices  EtherNet/IP and LR DEVICE have read
access rights to events/alarms
0x01 EtherNet/IP + LineRecorder (ro)
 EtherNet/IP has read and write access
rights to parameters and process data
 EtherNet/IP has read access rights to
events/alarms
 LR DEVICE only has read access rights to
parameters, process data and
events/alarms
0x02 EtherNet/IP only
 EtherNet/IP has read and write access
rights to parameters and process data
 EtherNet/IP has read access rights to
events/alarms
 LR DEVICE has no access rights
(parameters, process data, events/alarms,
web interface, firmware update)
0x03 Continue in Use Case
previous setting is valid
[AL1920:C.Port_Process_Data_Size] Length of the process input 0x00 2 bytes input, 2 bytes output
data and process output data
0x01 4 bytes input, 4 bytes output
0x02 8 bytes input, 8 bytes output
0x03 16 bytes input, 16 bytes output
0x04 32 bytes input, 32 bytes output

► Save EtherNet/IP project

68
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3.5 Configure IO-Link ports

34365

The IO-Link ports are configured via the controller tags. The user can configure each IO-Link port
separately.
To configure the IO-Link ports:
Requirements:
> AL1920 is correctly integrated in the EtherNet/IP project (→ Integrate the AL1920 into the EtherNet/IP
project (→ S. 66)).
1 Open controller tags
► In the Controller Organizer: Double click on [Controller Name_of_Project] > [Controller Tags]
> [Controller Tags] window appears.
► In the tree view: Click on [AL1920:C].
> Controller tags for the configuration of the device appear.
2 Configure IO-Link ports
► Configure the following tags for each IO-Link port at will:
Name Description Possible values
[AL1920:C.Port_Mode_Port_x] Operating mode of the 0x00 Interface deactivated
IO-Link port
0x01 Operation as digital input (DI)
0x02 Operation as digital output (DO)
0x03 Operation as IO-Link interface
[AL1920:C.Port_Cycle_Time_Port_x] Cycle time of the data 0x00 The device automatically sets the fastest
transmission between the possible cycle time
IO-Link master and the
IO-Link device 0x01 2 milliseconds
0x02 4 milliseconds
0x03 8 milliseconds
0x04 16 milliseconds
0x05 32 milliseconds
0x06 64 milliseconds
0x07 128 milliseconds
[AL1920:C.Swap_Port_x] Visualisation of the process 0x00 Byte swapping for IO-Linkdata
data deactivated
(EtherNet/IP uses Little 0x01 Byte swapping for IO-Linkdata activated
Endian Format (Intel), IO-Link
uses Big Endian Format
(Motorola))
[AL1920:C.Validation_Data_Storage_Port_x] Supported IO-Link standard 0x00 No validation
and behaviour of the IO-Link
master when connecting new 0x01 Type compatible V1.0 device
IO-Link devices to the IO-Link
0x02 Type compatible V1.1 device
port
0x03 Type compatible V1.1 device with
Backup + Restore
0x04 Type compatible V1.1 device with
Restore
[AL1920:C.Vendor_ID_Port_x] Vendor ID of the 0x0000...0xFFFF
manufacturer of the device on ifm electronic: 0x136
the IO-Link port
[AL1920:C.Device_ID_Port_x] Device ID of the device on the 0x000000...0xFFFFFF
IO-Link port

69
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Name Description Possible values

[AL1920:C.Fail_Safe_Mode_Port_x] Fail-safe mode for output data 0x00 No Failsafe

when the EtherNet/IP
connection is interrupted 0x01 Failsafe Reset Value
0x02 Failsafe Old Value
0x03 Failsafe with Pattern
[AL1920:C.Fail_Safe_Value_DO_Port_x] Fail-safe value for the 0x00 Failsafe Reset Value
operating mode "digital output
(DO)" 0x01 Failsafe Old Value
0x02 Failsafe Set Value
x = 1...8

► Save EtherNet/IP project.

70
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3.6 Configure IO-Link devices

34359

The AL1920 supports the configuration of the connected IO-Link devices from the EtherNet/IP
projection software. For this, ifm offers the EtherNet/IP object "IO-Link Request" (→ IO-Link requests
(object class: 0x80) (→ S. 124)). The object enables direct read and write access to IO-Link objects
of the IO-Link device. The extent of the configurable parameters depends on the IO-Link device.
The following services are available:
Name Description Reference

Read request Send a request to read an IO-Link object → Read_ISDU (→ S. 125)

Write request Send a request to write an IO-Link object → Write_ISDU (→ S. 128)

Information for the execution of acyclic commands: → Use acyclic services (→ S. 75)
Available parameters of the IO-Link devices: → Operating instructions of the IO-Link device

71
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3.7 Read cyclic input data

34360

The user can access the cyclic input data of the connected sensors and IO-Link devices via the
controller tags of the AL1920.

To check the validity of the cyclic process data, evaluate the PQI byte (→ Mapping: PQI
(→ S. 97)).
Even with an interruption of the fieldbus connection the PQI byte indicates that the process
data is valid. This can have unintended impact on the control process.
► Take suitable measures to detect an interruption of the fieldbus connection.

To access the input data:

► Starting RSLogix5000.
► Open the EtherNet/IP project.
► In the project tree: Mouse click on [Controller Tags] > [AL1920.I]
> The window shows the data structure with cyclic input data ([AL1920.I:Data])

Mapping of the inputs to the data structure [AL1920.I:Data]: → Cyclic data (→ S. 92))

>

9.3.8 Write cyclic output data

34386

The user can access the cyclic output data of the connected actuators and IO-Link devices via the
controller tags of the AL1920.

To check the validity of the cyclic process data, evaluate the PQI byte (→ Mapping: PQI
(→ S. 97)).
Even with an interruption of the fieldbus connection the PQI byte indicates that the process
data is valid. This can have unintended impact on the control process.
► Take suitable measures to detect an interruption of the fieldbus connection.

To access the cyclic output data:

► Starting RSLogix5000.
► Open the EtherNet/IP project.
► In the project tree: Mouse click on [Controller Tags] > [AL1920.O]
> The window shows the data structure with cyclic output data ([AL1920.O:Data])

Mapping of the outputs to the data structure [AL1920.C:O]: → Cyclic data (→ S. 92)).

72
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3.9 Read diagnostic and status information

34364

Diagnostic and status information is a part of the cyclically transmitted process data. The input
assembly includes the following information:
Byte Content

2 Indication of short circuit/overload of the IO-Link ports X01...X08

3 Status indication of the voltage supply of the device
43 Port X01: Status information + events
58 Port X02: Status information + events
73 Port X03: Status information + events
88 Port X04: Status information + events
103 Port X05: Status information + events
118 Port X06: Status information + events
133 Port X07: Status information + events
148 Port X08: Status information + events

To access the cyclically transmitted diagnostic and status information:

► Starting RSLogix5000.
► Open a EtherNet/IP project.
► In the project tree: Mouse click on [Controller Tags] > [AL1920.I]
> The window shows cyclic input data (Input Assembly).
► Link diagnostic and status information with variables.

Mapping of the diagnostic and status information on the data structure [AL1920.C:I]: → Cyclic
data (→ S. 92).

73
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

9.3.10 EtherNet/IP: Programmers' notes

34400

The programmer can access the following data from the PLC application:
 Read cyclic input and output data of the IO-Link devices
 Read diagnostic and status information
 Change parameters of the IO-Link port of the AL1920
 Read and change parameters of the connected IO-Link devices

The following sections show the available options.

>

Supported EtherNet/IP configuration modes

34383

The AL1920 supports the following EtherNet/IP configuration modes:

 Top down
 Configuration of the EtherNet/IP slave with the EtherNet/IP projection software (Configuration
Assembly)
 EtherNet/IP plc transmitts the created configuration to the EtherNet/IP slave, where it is stored
 Independent
 Configuration of the EtherNet/IP slave with LR DEVICE oder IoT core
 Confiuration Assembly in EtherNet/IP project is not evaluated

74
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Use acyclic services

34381

The AL1920 offers the following options to execute acyclic commands:

>

Command channels in cyclic process data

34318

Within the cyclic input and output data, special areas are available for the acyclic data transmission.
Both read and write access can be implemented via the areas.
>

Principle of the command channels

34343

General process of an acyclic communication:

1 Write command request
► In the request channel: write requested command data (without [Trigger] bit)
► Set [Trigger] = 1.
> Change of [Trigger] = 1 indicates a new command.
> In the response channel: all bytes are set to 0.
> Command processing is started.
2 Check status
► In the response channel: check [Handshake] bit.
 If [Handshake] <> 0: command processing completed, continue with step 3.
 If [Handshake] == 0: command is processed, repeat step 2.
3 Read command response
► In the response channel: read responsed user data.
► In the request channel: set [Trigger] = 0.

75
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Acyclic port commands

34336

For the acyclic access to the configuration of the IO-Link ports of the AL1920, the following commands
are available:
Command Description Reference
Set mode Set the operating type of the IO-Link port → Command 0x10 – Set mode (→ S. 109)
Set Validation ID / Data Storage Adjust the supported IO-Link standard and → Command 0x20 – Set validation ID /
the behaviour of the IO-Link master when data storage (→ S. 111)
connecting a new IO-Link device to the
IO-Link port
Set fail-safe data pattern Behaviour of the outputs when the → Command 0x30 – Set fail-safe data
EtherNet/IP connection is interrupted and pattern (→ S. 113)
setting of the corresponding fail-safe values

The port commands use the same mechanisms as the acyclic command channel (→ Acyclic
command channel (→ S. 103)).
>

EtherNet/IP mechanisms for acyclic commands

34404

Acyclic commands can be executed with the EtherNet/IP command Message (MSG).

Parameters of the available field bus objects: → Field bus objects (→ S. 115)
For detailed information about the Message (MSG) command: → Operating instructions
RSLogix 5000

76
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

10 Maintenance, repair and disposal

Content
Cleaning process ....................................................................................................................................77
Update firmware .....................................................................................................................................78
Replace IO-Link device ..........................................................................................................................79
51990

The operation of the unit is maintenance-free.

► Dispose of the unit in an environmentally friendly way in accordance with the applicable national
regulations when it is no longer used.
>

10.1 Cleaning process

51991

► Clean the surface of the unit when necessary.

► Do not use any caustic cleaning agents for this!

77
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

10.2 Update firmware

52258

The firmware of the IO-Link master can be updated with the following options:
 IoT Core: → Example: Update firmware (→ S. 54)
 Web interface:

If the firmware update is not successful, deactivate all connections to the LR

SMARTOBSERVER and LR DEVICE and repeat the process.
► Deactivate the connection to the EtherNet/IP PLC.
► Set the parameter [IP address LR SMARTOBSERVER] to 255.255.255.255 or 0.0.0.0
(→ IoT: Configure the interface to LR AGENT or LR SMARTOBSERVER (→ S. 31)).
► Stop the LRAgent.LRDevice service in the Windows task manager.
After the firmware update, check the settings of the interface to the LR SMARTOBSERVER!

Prerequisites
> Zip file with new firmware has been downloaded and unpacked.
> Ethernet connection between laptop/PC and device is established.
> Security mode is disabled.
1 Call up web interface
► Start web browser.
► Enter the following into the address field of the browser and confirm with [ENTER]:
http://<IP address of the device>/web/update
> Web browser shows the [Firmware Update] page.
2 Load new firmware to AL1920
► Click on [Select file].
> Dialogue window appears.
► Select the firmware file (.bin) and click on [Open].
► Click on [Submit] to start the firmware update.
> Firmware is being loaded to the device.
> After successful storage, the success message is displayed.
3 Restart the device
► Click on [Restart device now] to restart the device.
> The status LED RDY flashes quickly.
> Firmware is updating.
► Follow the instructions in the browser.

78
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

10.3 Replace IO-Link device

34182

To replace an IO-Link device:

Requirement:
> IO-Link device is with factory settings.
> IO-Link device supports IO-Link standard 1.1 or higher.
1 Set data storage
► Set the following parameters of the IO-Link port:
Validation and Data Storage = [Type compatible V1.1 device with Restore]
► Save changes.
2 Replace IO-Link device
► Disconnect old IO-Link device from IO-Link master.
► Connect new IO-Link device with the same IO-Link port of the AL1920.
> IO-Link master copies parameter values from the data memory to the new IO-Link device.
>

79
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

11 Factory settings
34509

In the factory settings, the device has the following parameter settings:
Parameter Factory setting

[IP address] (EtherNet/IP) 192.168.1.250

[Subnet mask] (EtherNet/IP) 255.255.255.0
[IP gateway address] (EtherNet/IP) 0.0.0.0
[IP address] (IoT interface) 169.254.X.X
[Subnet mask] (IoT interface) 255.255.0.0
[IP gateway address] (IoT interface) 0.0.0.0
[EtherNet/IP name] blank
Data memory (Data Storage) empty

80
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

12 Accessories
33870

List of accessories of AL1920: → www.ifm.com > Product page > Accessories

81
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

13 Appendix
Content
Technical data ........................................................................................................................................83
EtherNet/IP .............................................................................................................................................87
ifm IoT Core ..........................................................................................................................................138
33879

82
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.1 Technical data

Content
Application ..............................................................................................................................................83
Electrical data .........................................................................................................................................83
Inputs / outputs .......................................................................................................................................83
Inputs ......................................................................................................................................................84
Outputs ...................................................................................................................................................84
Interfaces ................................................................................................................................................84
Environmental conditions .......................................................................................................................85
Approvals / tests .....................................................................................................................................85
Mechanical data ....................................................................................................................................85
Electrical connection ...............................................................................................................................86
34188
>

13.1.1 Application
33878

Application

Application I/O modules for control cabinet

Daisy-chain function Fieldbus interface

>

13.1.2 Electrical data

33808

Electrical data
Operating voltage [V] 20...30 DC; (US; to SELV/PELV)
Current Consumption [mA] 300...3900; (US)
Protection class III

Sensor supply US

Max. current load total [A] 3.6

>

13.1.3 Inputs / outputs

34068

Inputs / outputs
Total number of inputs and outputs 16; (configurable)
Number of Inputs and Outputs Number of digital inputs: 16; Number of digital outputs: 8

83
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.1.4 Inputs
34069

Inputs
Number of digital inputs 16; (IO-Link Port Class A)
Switching level high [V] 11...30
Switching level low [V] 0...5
Digital inputs protected against short circuits yes

>

13.1.5 Outputs
34053

Outputs
Number of digital outputs 8; (IO-Link Port Class A)
Max. current load per output [mA] 200
Short-circuit protection yes

>

13.1.6 Interfaces
34389

Interfaces

Communication interface Ethernet; IO-Link

Communication interface IO-Link; TCP/IP; EtherNet/IP

Ethernet

Transmission standard 10Base-T; 100Base-TX

Transmission rate [MBit/s] 10; 100
Protocol TCP/IP; EtherNet/IP
Factory settings  IP address: 192.168.1.250
 Subnet mask: 255.255.255.0
 Gateway IP address: 0.0.0.0
 MAC address: see type label

IO-Link master

Type of transmission COM 1 / COM 2 / COM 3

IO-Link revision V1.1
Number of ports Class A 8
IoT interface
Transmission standard 10Base-T; 100Base-TX
Transmission rate [Mbits/s] 10; 100
Protocol DCP, DCHP, Auto IP
Factory settings  IP address: 169.254.X.X
 Subnet mask: 255.255.0.0
 Gateway IP address: 0.0.0.0
 MAC address: see type label

>

84
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

13.1.7 Environmental conditions

33811

Environmental conditions

Applications Control cabinet

Ambient temperature [°C] -25...65
Storage temperature [°C] -25...85
Max. perm. relative air humidity [%] 90, linearly decreasing to 50 % (40 °C)
Max. height above sea level [m] 2000
Protection IP 20
Degree of soiling 2

>

13.1.8 Approvals / tests

33877

Approval / tests
EMC  EN 61000-6-2
 EN 61000-6-4
MTTF [Years] 90

>

13.1.9 Mechanical data

34050

Mechanical data

Weight [g] 329

Materials Housing: PA

85
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.1.10 Electrical connection

33807

Voltage supply IN X31

Plug and socket connection COMBICON
Wiring 1: GND (US)
2: GND (US)
3: + 24 V DC (US)
4: + 24 V DC (US)

Process connection IO-Link ports Class A X01...X08

Plug and socket connection COMBICON

Wiring 1: Sensor supply (US) L+

2: DI
3: Sensor supply (US) L-
4: C/Q IO-Link

Ethernet IN / OUT X21, X22

Plug and socket connection RJ-45

IoT X32
Plug and socket connection RJ-45

86
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.2 EtherNet/IP
Content
Supported connection types ...................................................................................................................87
Parameter data .......................................................................................................................................88
Cyclic data ..............................................................................................................................................92
Acyclic data ..........................................................................................................................................103
33674
>

13.2.1 Supported connection types

34410

Name Configuration Input Assembly - Output Assembly -

Assemby Instance Instance

Exclusive Owner IO-Acyc-Diag 199 100 150

Exclusive Owner IO-Acyc 199 101 150
Exclusive Owner IO 199 102 151
Input only 199 100 193 (empty)
Listen only 199 100 192 (empty)

87
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.2.2 Parameter data

Content
Configuration Assembly (Instance 199) .................................................................................................89
34170

88
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Configuration Assembly (Instance 199)

34358

The values of the Configuration Assembly are set in RSLogix 5000 via the controller tags of
the EtherNet/IP project.

Bytes Contents

0 Access Rights
1 Process Data Length
2...13 Port X01: Port configuration (→ Mapping: Port configuration (→ S. 90))

14...25 Port X02: Port configuration (→ Mapping: Port configuration (→ S. 90))

26...37 Port X03: Port configuration (→ Mapping: Port configuration (→ S. 90))

38...49 Port X04: Port configuration (→ Mapping: Port configuration (→ S. 90))

50...61 Port X05: Port configuration (→ Mapping: Port configuration (→ S. 90))

62...73 Port X06: Port configuration (→ Mapping: Port configuration (→ S. 90))

74...85 Port X07: Port configuration (→ Mapping: Port configuration (→ S. 90))
86...97 Port X08: Port configuration (→ Mapping: Port configuration (→ S. 90))

Legend:
 [Access Rights] Access rights to parameter, process data 1 Byte 0x00 EtherNet/IP + IoT
and events / diagnostics data of the
IO-Link master and the connected 0x01 EtherNet/IP + IoT (ro)
IO-Link devices 0x02 EtherNet/IP only
0x03 Keep setting (default)

 [Process Data Length of the process input data and 1 Byte 0x00 2 Bytes Input / 2 Bytes Output Data
Length] process output data  Input Assembly: 206 Bytes
 Output Assembly: 62 Bytes
0x01 4 Bytes Input / 4 Bytes Output Data
 Input Assembly: 222 Bytes
 Output Assembly: 78 Bytes
0x02 8 Bytes Input / 8 Bytes Output Data
 Input Assembly: 254 Bytes
 Output Assembly: 110 Bytes
0x03 16 Bytes Input / 16 Bytes Output Data
 Input Assembly: 318 Bytes
 Output Assembly: 174 Bytes
0x04 32 Bytes Input / 32 Bytes Output Data
 Input Assembly: 446 Bytes
 Output Assembly: 302 Bytes

89
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Mapping: Port configuration

34394

Byte
Port Mode
Master Cycle Time
Byte Swap
Validation ID
Vendor ID (MSB)
Vendor ID (LSB)
Device ID (MSB)
Device ID
Device ID (LSB)
reserved
Failsafe Mode -- IO-Link
Failsafe Mode -- clamp 4 (DO)
Legend:
 [Port Mode] Operating mode of the IO-Link port 1 byte 0x00 Interface deactivated
0x01 Operation as digital input (DI)
0x02 Operation as digital output (D=)
0x03 Operation as IO-Link port
 [Master Cycle Cycle time of the data transmission 1 byte 0x00 As fast as possible
Time] between the IO-Link master and the
IO-Link device 0x01 2 milliseconds
0x02 4 milliseconds
0x03 8 milliseconds
0x04 16 milliseconds
0x05 32 milliseconds
0x06 64 milliseconds
0x07 128 milliseconds
 [Byte Swap] Visualisation of the process data 1 byte 0x00 Byte swapping for IO-Link process data
(EtherNet/IP uses Little Endian Format deactivated
(Intel), IO-Link uses Big Endian Format
(Motorola)) 0x01 Byte swapping for IO-Link process data
activated
 [Validation ID] Supported IO-Link standard and 1 byte 0x00 No validation
behaviour of the IO-Link master when
connecting new IO-Link devices to the 0x01 V1.0 device
IO-Link port 0x02 V1.1 device
0x03 V1.1 device with Backup + Restore
0x04 V1.1 device with Backup

90
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

 [Vendor ID] Vendor ID of the manufacturer of the 2 Bytes pro Byte: 0x00...0xFF
device on the IO-Link port
Vendor ID = 0x1234
 Vendor ID (MSB) = 0x12
 Vendor ID (LSB) = 0x34
 [Device ID] Device ID of the device on the IO-Link 3 bytes pro Byte: 0x00...0xFF
port
Device ID = 0x123456
 Device ID (MSB) = 0x12
 Device ID = 0x34
 Device ID (LSB) = 0x56
 [Failsafe Mode -- Fail-safe mode for output data when the 1 byte 0x00 No Failsafe
IO-Link] EtherNet/IP connection is interrupted
0x01 Failsafe Reset Value
0x02 Failsafe Old Value
0x03 Failsafe with Pattern
 [Failsafe Mode -- Fail-safe value for the operating mode 1 byte 0x00 Failsafe Reset Value
clamp 4 (DO)] "digital output (DO)"
0x01 Failsafe Old Value
0x02 Failsafe Set Value

91
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.2.3 Cyclic data

Content
Input assembly (Instance 100): I/O data + acyclic data + diagnosis data ..............................................93
Input Assembly (Instance 101): I/O data + acyclic data .........................................................................94
Input Assembly (Instance 102): I/O data ................................................................................................95
Output assembly (Instance 150): I/O data + acyclic data ...................................................................100
Output Assembly (Instance 151): I/O data ...........................................................................................101
33814

92
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Input assembly (Instance 100): I/O data + acyclic data + diagnosis data
34344

Byte Content

0...1 Port X01...X08: Digital input - clamp 2 / 4 (DI) (→ Mapping: digital input data (DI) (→ S. 96))

2...3 Status information (→ Mapping: Status information (→ S. 96))

4...45 Acyclic command area: Response channel (→ Response channel (→ S. 105))

46...47 Port X01: PQI (→ Mapping: PQI (→ S. 97))

48...63 Port X01: Diagnostic, vendor ID, device ID, events (→ Mapping: IO-Link port information (→ S. 98))
64...65 Port X02: PQI (→ Mapping: PQI (→ S. 97))

66...81 Port X02: Diagnostic, vendor ID, device ID, results (→ Mapping: IO-Link port information (→ S. 98))

82...83 Port X03: PQI (→ Mapping: PQI (→ S. 97))

84...99 Port X03: Diagnostic, vendor ID, device ID, events (→ Mapping: IO-Link port information (→ S. 98))

100...101 Port X04: PQI (→ Mapping: PQI (→ S. 97))

102...117 Port X04: Diagnostic, vendor ID, device ID, events (→ Mapping: IO-Link port information (→ S. 98))

118...119 Port X05: PQI (→ Mapping: PQI (→ S. 97))

120...135 Port X05: Diagnostic, vendor ID, device ID, events (→ Mapping: IO-Link port information (→ S. 98))
136...137 Port X06: PQI (→ Mapping: PQI (→ S. 97))

138...153 Port X06: Diagnostic, vendor ID, device ID, events (→ Mapping: IO-Link port information (→ S. 98))

154...155 Port X07: PQI (→ Mapping: PQI (→ S. 97))

156...171 Port X07: Diagnostic, vendor ID, device ID, events (→ Mapping: IO-Link port information (→ S. 98))
172...173 Port X08: PQI (→ Mapping: PQI (→ S. 97))
174...189 Port X08: Diagnostic, vendor ID, device ID, events (→ Mapping: IO-Link port information (→ S. 98))
190 Port X01: Input data IO-Link (n bytes)
190+n Port X02: Input data IO-Link (n bytes)
190+2n Port X03: Input data IO-Link (n bytes)
190+3n Port X04: Input data IO-Link (n bytes)
190+4n Port X05: Input data IO-Link (n bytes)
190+5n Port X06: Input data IO-Link (n bytes)
190+6n Port X07: Input data IO-Link (n bytes)
190+7n Port X08: Input data IO-Link (n bytes)
Legend:
n = [2,4,8,16,32]; is determined by the parameter [Prozess_Data_Length] (→ Configuration Assembly (Instance 199)
(→ S. 89)

93
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Input Assembly (Instance 101): I/O data + acyclic data

34369

Byte Content

0...1 Port X01...X08: Digital Input clamp 2 / 4 (DI) (→ Mapping: digital input data (DI) (→ S. 96))

2...3 Status information (→ Mapping: Status information (→ S. 96))

4...45 Acyclic commando area: Response channel (→ Response channel (→ S. 105))

46...47 Port X01: PQI (→ Mapping: PQI (→ S. 97))

48...49 Port X02: PQI (→ Mapping: PQI (→ S. 97))
50...51 Port X03: PQI (→ Mapping: PQI (→ S. 97))

52...53 Port X04: PQI (→ Mapping: PQI (→ S. 97))

54...55 Port X05: PQI (→ Mapping: PQI (→ S. 97))

56...57 Port X06: PQI (→ Mapping: PQI (→ S. 97))

58...59 Port X07: PQI (→ Mapping: PQI (→ S. 97))

60...61 Port X08: PQI (→ Mapping: PQI (→ S. 97))

62 Port X01: Input data IO-Link (n bytes)

62+n Port X02: Input data IO-Link (n bytes)
62+2n Port X03: Input data IO-Link (n bytes)
62+3n Port X04: Input data IO-Link (n bytes)
62+4n Port X05: Input data IO-Link (n bytes)
62+5n Port X06: Input data IO-Link (n bytes)
62+6n Port X07: Input data IO-Link (n bytes)
62+7n Port X08: Input data IO-Link (n bytes)
Legend:
n = [2,4,8,16,32]; is determined by the parameter [Prozess Data Length] (→ Configuration Assembly (Instance 199)
(→ S. 89))

94
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Input Assembly (Instance 102): I/O data

34372

Byte Content

0...1 Digital inputs of the IO-Link ports in DI operating mode (→ Mapping: digital input data (DI) (→ S. 96))

2...3 Status information (→ Mapping: Status information (→ S. 96))

4...5 Port X01: PQI (→ Mapping: PQI (→ S. 97))

6...7 Port X02: PQI (→ Mapping: PQI (→ S. 97))

8...9 Port X03: PQI (→ Mapping: PQI (→ S. 97))

10...11 Port X04: PQI (→ Mapping: PQI (→ S. 97))

12...13 Port X05: PQI (→ Mapping: PQI (→ S. 97))
14...15 Port X06: PQI (→ Mapping: PQI (→ S. 97))

16...17 Port X07: PQI (→ Mapping: PQI (→ S. 97))

18...19 Port X08: PQI (→ Mapping: PQI (→ S. 97))

20 Port X01: Cyclic input data (n bytes)
20+n Port X02: Cyclic input data (n bytes)
20+2n Port X03: Cyclic input data (n bytes)
20+3n Port X04: Cyclic input data (n bytes)
20+4n Port X05: Cyclic input data (n bytes)
20+5n Port X06: Cyclic input data (n bytes)
20+6n Port X07: Cyclic input data (n bytes)
20+7n Port X08: cyclic input data (n bytes)
Legend:
n = [2,4,8,16,32]; is determined by the parameter [Prozess Data Length] (→ Configuration Assembly (Instance 199)
(→ S. 89))

95
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Mapping: digital input data (DI)

34380

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

X08: clamp 4 X07: clamp 4 X06: clamp4 X05: clamp 4 X04: clamp 4 X03: clamp 4 X02: clamp 4 X01: clamp 4
X08: clamp 2 X05: clamp 2 X06: clamp 2 X05: clamp 2 X04: clamp 2 X03: clamp 2 X02: clamp 2 X01: clamp 2
Legend:
 [clamp 4] Signal level on clamp 4 of the IO-Link port 1 bit 0x0 LOW
0x1 HIGH
 [clamp 2] Signal level on clamp 2 of the IO-Link port 1 bit 0x0 LOW
0x1 HIGH

>

Mapping: Status information

34396

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

X08: X07: X06: X05: X04: X03: X02: X01:
Short / OL Short / OL Short / OL Short /OL Short / OL Short / OL Short / OL Short / OL
reserved reserved reserved reserved reserved reserved Sensor PWR AUX PWR
Legend:
 [Short / OL] Occurrence of a short circuit or of an overvoltage on 1 bit 0x0 no error
the IO-Link port
0x1 short circuit or overvoltage
detected
 [Sensor PWR] Status of the supply voltage US 1 bit 0x0 no error
0x1 error
 [AUX PWR] Status of the supply voltage UA 1 bit 0x0 UA present and no error
0x1 no error

96
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Mapping: PQI
34393

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

Diagnosis Wrong PD Wrong PD Wrong Wrong Invalid Data Dev Not Conn IOL Mode
present Output Length Input Length Cycle Time VID / DID Bit
reserved
Legend:
 [IOL Mode] Operating mode of the IO-Link port 1 bit 0x0 not IO-Link
0x1 IO-Link
 [Dev Not Conn] Connection between IO-Link Device and IO-Link port 1 bit 0x0 connected
0x1 not connected
 [Invalid Data] Status of the process input data on the IO-Link port 1 bit 0x0 valid Data
0x1 invalid Data
 [Wrong VID/DID] Evaluation, whether actual and projected Vendor ID 1 bit 0x0 OK
and Device ID match
0x1 wrong VID and/or DID
 [Wrong Cycle Evaluation, whether actual and projected cycle time 1 bit 0x0 OK
Time] match
0x1 wrong cycle time
 [Wrong PD Input Evaluation, whether actual and projected input process 1 bit 0x0 OK
Length] data length match
0x1 projected length too small
 [Wrong PD Evaluation, whether actal and projected output process 1 bit 0x0 OK
Output Length] data length match
0x1 projected length too small
 [Diagnosis Signals a new diagnosis event (Coming Event, Single 1 Bit 0x0 no event
present] Shot Event)
0x1 New event present
 Coming Events are removed when if the related
Disappearing Event appears
 Single Shot Events are removed automatically

97
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Mapping: IO-Link port information

34413

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

VID (LSB)
VID (MSB)
DID (LSB)
DID
DID (MSB)
reserved
Event 1: Mode Event 1: Type Event 1: Src Event 1: Instance
Event 1: Code (LSB)
Event 1: Code (MSB)
Event 2: Mode Event 2: Type Event 2: Src Event 2: Instance
Event 2: Code (LSB)
Event 2: Code (MSB)
Event 3: Mode Event 3: Type Event 3: Src Event 3: Instance
Event 3: Code (LSB)
Event 3: Code (MSB)
reserved
Legend:
 [VID] Vendor ID of the connected IO-Link device 2 bytes pro Byte: 0x00...0xFF
VID = 0x1234
 DID (MSB) = 0x12
 DID (LSB) = 0x34
 [DID] Device ID of the connected IO-Link device 3 bytes pro Byte: 0x00...0xFF
DID = 0x123456
 DID (MSB) = 0x12
 DID = 0x34
 DID (LSB) = 0x56
 [Event m: Mode: Events mode 2 bits 0x0 reserved
Mode]
0x1 Single-shot event
0x2 disappearing event
0x3 appearing event
 [Event m: Type] Type: Event category 2 bits 0x0 reserved
0x1 Notification
0x2 Warning
0x3 Error

 [Event m: Src] Source: Events source 1 bit 0x0 IO-Link Device

0x1 IO-Link Master
 [Event m: Type: Event instance 3 bits 0x0 Unknown
Instance]
0x1... reserved
0x3
0x4 Application

98
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

0x5... reserved
0x7
 [Event m: Code: Event code; device-dependent 2 bytes depends on device (→ IODD
Code] Code = 0x1234 instructionsof the IO-Link device)
 Code (MSB) = 0x12
 Code (LSB) = 0x34

99
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Output assembly (Instance 150): I/O data + acyclic data

34370

Byte Content

0 Port X01...X08: Digital output - clamp 4 (DO) (→ Mapping: Digital output data (DO) (→ S. 102))

1 reserved
2 reserved
3 reserved
4...45 Acyclic command area: Request channel (→ Request channel (→ S. 104))
46 Port X01: Output data IO-Link (n bytes)
46+n Port X02: Output data IO-Link (n bytes)
46+2n Port X03: Output data IO-Link (n bytes)
46+3n Port X04: Output data IO-Link (n bytes)
46+4n Port X05: Output data IO-Link (n bytes)
46+5n Port X06: Output data IO-Link (n bytes)
46+6n Port X07: Output data IO-Link (n bytes)
46+7n Port X08: Output data IO-Link (n bytes)
Legend:
n = [2,4,8,16,32]; is determined by the parameter [Prozess_Data_Length] (→ Configuration Assembly (Instance 199)
(→ S. 89)

100
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Output Assembly (Instance 151): I/O data

34341

Byte Content

0 Port X01...X08: Digital output - clamp 4 (DO) (→ Mapping: Digital output data (DO) (→ S. 102))

1 reserved
2 Port X01: Output data IO-Link (n bytes)
2+n Port X02: Output data IO-Link (n bytes)

2+2n Port X03: Output data IO-Link (n bytes)

2+3n Port X04: Output data IO-Link (n bytes)
2+4n Port X05: Output data IO-Link (n bytes)
2+5n Port X06: Output data IO-Link (n bytes)
2+6n Port X07: Output data IO-Link (n bytes)
2+7n Port X08: Output data IO-Link (n bytes)
Legend:
n = [2,4,8,16,32]; is determined by the parameter [Process_Data_Length] (→ Configuration Assembly (Instance 199)
(→ S. 89)

101
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Mapping: Digital output data (DO)

34411

Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

X08: clamp 4 X07: clamp 4 X06: clamp4 X05: clamp 4 X04: clamp 4 X03: clamp 4 X02: clamp 4 X01: clamp 4
Legend:
 [clamp 4] Signal level on clamp 4 of the IO-Link port 1 bit 0x0 LOW
0x1 HIGH

102
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.2.4 Acyclic data

Content
Acyclic command channel ....................................................................................................................103
Acyclic commands ................................................................................................................................108
Field bus objects ...................................................................................................................................115
33868
>

Acyclic command channel

34325

In the cyclic process data, command channels for the transmission of acyclic data is available.
Object Contents Bytes Access

Output assembly Request channel (field bus PLC >>> IO-Link master) 4...45 r/w
→ Request channel (→ S. 104)

Input assembly Response channel (IO-Link master >>> fieldbus PLC) 4...45 r
→ Response channel (→ S. 105)
Legend:
r = only read access rights
r/w = read and write access rights

103
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Request channel
34398

Byte Content
4 Port No. (LSB)
5 Port No. (MSB)
6 Index (LSB)
7 Index (MSB)
8 Sub-index (LSB)
9 Sub-index (MSB)
10 Trigger Command id
11 Length of the user data (number of bytes)
12 Data (byte 0)
13 Data (byte 1)
.. ...
43 Data (byte 31)
44 reserved
45 reserved
Legend:
 [Port No.] Number of the IO-Link port 8 Bit 0x01 Port X01
Port No. = 0x1234
 Port No. (MSB) = 0x12 0x02 Port X02
 Port No. (LSB) = 0x34 ...
0x08 Port X08
 [Index] Index of the IO-Link object 8 Bit per byte: 0x00...0xFF
Index = 0x1234
 Index (MSB) = 0x12
 Index (LSB) = 0x34
 [Subindex] Subindex of the IO-Link object 8 Bit per byte: 0x00...0xFF
Subindex = 0x1234
 Subindex (MSB) = 0x12
 Subindex (LSB) = 0x34
 [Trigger] Control of the command execution 1 Bit 0x0 do not process command
0x1 execute command
 [Command ID] Command number 7 Bit 0x01 read
0x02 write
 [Length of user data Number of bytes that contain relevant user data 8 Bit 0x00 0 bytes
(number of bytes)]
...
0x20 32 bytes
 [Data (byte n)] User data 8 Bit per byte: 0x00...0xFF

104
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Response channel
34401

Byte Contents
4 Port No. (LSB)
5 Port No. (MSB)
6 Index (LSB)
7 Index (MSB)
8 Sub-index (LSB)
9 Sub-index (MSB)
10 Handshake Command ID
11 Result
12 Length of response data (number of bytes)
13 Data (byte 0) or Error Code
14 Data (byte 1) or Additional Code

... ...
44 Data (byte 31)
45 reserved
Legend:
 [Port No.] Number of the IO-Link port 8 bits 0x01 Port X01
Port No. = 0x1234 0x02 Port X02
 Port No. (MSB) = 0x12
...
 Port No. (LSB) = 0x34
0x08 Port X08
 [Index] Index of the IO-Link object 8 bits per byte: 0x00...0xFF
Index = 0x1234
 Index (MSB) = 0x12
 Index (LSB) = 0x34
 [Subindex] Subindex of the IO-Link object 8 bits per byte: 0x00...0xFF
Subindex = 0x1234
 Subindex (MSB) = 0x12
 Subindex (LSB) = 0x34
 [Handshake] Validity of the IO-Link response data 1 bit 0x0 Data invalid
0x1 Data valid
 [Command ID] Command number 7 bits 0x01 Read
0x02 Write
 [Result] Status of the command processing 8 bits 0x00 OK
0x0F OK, data read >32 bytes
0xFF Error occurred
 [Length of response Number of bytes that contain relevant user 8 bits 0x00 0 bytes
data (number of data
bytes)] ...
0x20 32 bytes

105
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

 [Data (byte 0) or User data (byte 0) or error codes 8 bits User data: 0x00...0xFF
Error Code] Error Code: → Error codes (→ S. 107)
 [Data (byte 1) or User data (byte1) or additional error codes 8 bits User data: 0x00...0xFF
Additional Code] Additional Code: → Additional Codes
(→ S. 107)
 [Data (byte n)] User data (byte n) 8 bits 0x00...0xFF

106
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Error codes
34342

Error code Description

0x71 Service not available (unknown command has been sent to the IO-Link port)
0x72 Port blocked (another cyclic process accesses the IO-Link port)
0x73 Forbidden (access rights don't allow command processing)
0x74 Invalid data (wrong parameter has been sent in the command)
0x76 Wrong port (wrong port number)
0x77 Wrong port function (wrong port function or wrong parameter has been sent to the device)
0x78 Invalid length (set length is > 0x20)
0x80 Error in the device application; observe additional code (→ Additional Codes (→ S. 107))

>

Additional Codes
54584

Code Name Description

0x00 APP_DEV Device application error - no details

0x11 IDX_NOTAVAIL Index not available

0x12 SUBIDX_NOTAVAIL Subindex not available

0x20 SERV_NOTAVAIL Service temporarily not available

0x21 SERV_NOTAVAIL_LOCCTRL Service temporarily not available - local control

0x22 SERV_NOTAVAIL_DEVCTRL Service temporarily not available - device control
0x23 IDX_NOT_WRITEABLE Access denied
0x30 PAR_VALOUTOFRNG Parameter value out of range
0x31 PAR_VALGTLIM Parameter value above limit
0x32 PAR_VALLTLIM Parameter value below limit
0x33 VAL_LENOVRRUN Parameter length overrun
0x34 VAL_LENUNDRUN Parameter length underrun
0x35 FUNC_NOTAVAIL Function not available
0x36 FUNC_UNAVAILTEMP Function temporarily not available
0x40 PAR_SETINVALID Invalid parameter set
0x41 PAR_SETINCONSIST Inconsistent parameter set
0x82 APP_DEVNOTRDY Application not ready

Additional Codes are only available, if Error Code = 0x80 (→ Error codes (→ S. 107))

107
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Acyclic commands
Content
Command 0x10 – Set mode .................................................................................................................109
Command 0x20 – Set validation ID / data storage ...............................................................................111
Command 0x30 – Set fail-safe data pattern .........................................................................................113
34331

108
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Command 0x10 – Set mode

34322

The command changes the operating mode of an IO-Link port of the AL1920.

Corresponding parameter: [Port Mode] (→ Mapping: Port configuration (→ S. 90))

>

Command request
34314

Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

4 Port No. (LSB)

5 Port No. (MSB)
6 reserved
7 reserved
8 reserved
9 reserved
10 Trigger 0x10
11 Target Mode
12...45 reserved
Legend:
 [Port No.] Number of the IO-Link port 16 Bit 0x01 Port X01
Port No. = 0x1234 0x02 Port X02
 Port No. (MSB) = 0x12
...
 Port No. (LSB) = 0x34
0x08 Port X08
 [Trigger] Control of the command execution 1 Bit 0x0 do not process command
0x1 execute command
 [Target Mode] Operating type of the IO-Link port 8 Bit 0x00 deactivated
0x01 operation as digital input (DI)
0x02 operation as digital output (DO)
0x03 operation as IO-Link intervals

109
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Command response
34316

Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

4 Port No. (LSB)

5 Port No. (MSB)
6 reserved
7 reserved
8 reserved
9 reserved
10 Handshake 0x10
11 Result
12 Target Mode
13...45 reserved
Legend:
 [Port No.] Number of the IO-Link port 2 Byte 0x01 Port X01
Port No. = 0x1234 0x02 Port X02
 Port No. (MSB) = 0x12
...
 Port No. (LSB) = 0x34
0x08 Port X08
 [Handshake] Status of the execution of the command 1 Bit 0x0 command is executed
0x1 execution of the command was
successful
 [Result] Error indication 1 Byte 0x00 no error
0x01 error occured
 [Target Mode] Operating type of the IO-Link port 1 Byte 0x00 deactivated
0x01 operation as digital input (DI)
0x02 operation as digital output (DO)
0x03 operation as IO-Link intervals

110
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Command 0x20 – Set validation ID / data storage

34321

The command sets the behaviour of the IO-Link master when connecting a new IO-Link device to an
IO-Linkport of the device.

Corresponding parameter: [Validation ID] (→ Mapping: Port configuration (→ S. 90))

>

Command request
34315

Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

4 Port No. (LSB)

5 Port No. (MSB)
6 reserved
7 reserved
8 reserved
9 reserved
10 Trigger 0x20
11 Validation ID
12...42 reserved
Legend:
 [Port No.] Number of the IO-Link port 2 byte 0x01 Port X01
Port No. = 0x1234 0x02 Port X02
 Port No. (MSB) = 0x12
...
 Port No. (LSB) = 0x34
0x08 Port X08
 [Trigger] Control command execution 1 Bit 0x0 do not process command
0x1 execute command
 [Validation ID] Behaviour of the IO-Link master when 1 byte 0x0 No check
connecting an IO-Link device to the IO-Link port
0x1 Type compatible V1.0 Device
0x2 Type compatible V1.1 Device
0x3 Type compatible V1.1 Device with
Backup + Restore
0x4 Type compatible V1.1 Device with
Restore

111
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Command response
34362

Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

4 Port No. (LSB)

5 Port No. (MSB)
6 reserved
7 reserved
8 reserved
9 reserved
10 Handshake 0x20
11 Result
12 Validation ID
13..45 reserved
Legend:
 [Port No.] Number of the IO-Link port 2 byte 0x01 Port X01
Port No. = 0x1234 0x02 Port X02
 Port No. (MSB) = 0x12
...
 Port No. (LSB) = 0x34
0x08 Port X08
 [Handshake] Status of the execution of the command 1 bit 0x0 command is executed
0x1 execution of the command was
successful
 [Result] Error indication 1 byte 0x00 no error
0x01 errors occurred
 [Validation ID] Behaviour of the IO-Link master when 1 byte 0x0 No check
connecting an IO-Link device to the IO-Link port
0x1 Type compatible V1.0 Device
0x2 Type compatible V1.1 Device
0x3 Type compatible V1.1 Device with
Backup + Restore
0x4 Type compatible V1.1 Device with
Restore

112
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Command 0x30 – Set fail-safe data pattern

34379

The command sets the behaviour of the outputs when the EtherNet/IP connection and the
corresponding fail-safe values are interrupted.

Corresponding parameter: [Fail-safe Mode] (→ Mapping: Port configuration (→ S. 90)

The number of the required fail-safe values results from the size of the output data
(→ Configuration Assembly (Instance 199) (→ S. 89)).

>

Command request
34317

Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

4 Port No. (LSB)

5 Port No. (MSB)
6 reserved
7 reserved
8 reserved
9 reserved
10 Trigger 0x30
11 Fail-safe mode
12 Byte Length N
13 Fail-safe data (byte 0)
... ...
44 Fail-safe data (byte 31)
45 reserved
Legend:
 [Port No.] Number of the IO-Link port 16 Bit 0x01 Port X01
Port No. = 0x1234 0x02 Port X02
 Port No. (MSB) = 0x12
...
 Port No. (LSB) = 0x34
0x08 Port X08
 [Trigger] Control command execution 1 Bit 0x0 do not process command
0x1 execute command
 [Fail-safe Mode] Behaviour of the outputs when the 8 Bit 0x00 No Fail-safe
EtherNet/IP connection is interrupted and
setting of the corresponding fail-safe values 0x01 Fail-safe Reset Value
0x02 Fail-safe Old Value
0x03 Fail-safe with Pattern
 [Byte Length N] Number of the bytes that contain fail-safe 8 Bit 0x00 0 Bytes
values
...
0x20 32 Bytes
 [Fail-safe Data (Byte n)] Fail-Safe value n (n = 0...31) 8 Bit per byte: 0x00...0xFF

113
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Command response
34361

Byte Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

4 Port No. (LSB)

5 Port No. (MSB)
6 reserved
7 reserved
8 reserved
9 reserved
10 Handshake 0x30
11 Result
12 Fail-safe mode
13...45 reserved
Legend:
 [Port No.] Number of the IO-Link port 16 Bit 0x01 Port X01
Port No. = 0x1234 0x02 Port X02
 Port No. (MSB) = 0x12
...
 Port No. (LSB) = 0x34
0x08 Port X08
 [Handshake] Status of the execution of the command 1 Bit 0x0 command is executed
0x1 execution of the command was
successful
 [Result] Error indication 1 Bit 0x0 no error
0x1 error occured
 [Fail-safe Mode] Behaviour of the outputs when the 8 Bit 0x00 No Fail-safe
EtherNet/IP connection is interrupted
0x01 Fail-safe Reset Value
0x02 Fail-safe Old Value
0x03 Fail-safe with Pattern

114
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Field bus objects

Content
CIP class services ................................................................................................................................115
CIP object classes ................................................................................................................................116
Identity Object (object class: 0x01) ......................................................................................................117
Message Router Object (object class: 0x02) ........................................................................................119
Assembly Object (object class: 0x04) ..................................................................................................120
Connection Manager Object (object class: 0x06) ................................................................................121
Device Level Ring Object (object class: 0x47) .....................................................................................122
Quality of Service (object class: 0x48) .................................................................................................123
IO-Link requests (object class: 0x80) ...................................................................................................124
TCP/IP object (object class: 0xF5) .......................................................................................................134
Ethernet Link Object (object class: 0xF6) .............................................................................................136
34352
>

CIP class services

34335

The device supports the following class and instance services:

Class code Service Description

dec hex
01 01 Get Attribute All Read all attribute values of the class or instance
02 02 Set Attribute All Change all attribute values of the class or instance
05 05 Reset Reset
09 09 Delete Delete
14 0E Get Attribute Single Read single attribute value of the class or instance
16 10 Set Attribute Single Change single attribute value of the class or instance
75 4B Read ISDU Read ISDU
76 4C Write ISDU Write ISDU
77 4D Write Failsafe Pattern Write failsafe pattern
78 4E Forward Close Close connection
84 54 Forward Open Open new connection

115
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

CIP object classes

34334

The device supports the following CIP object classes:

Class code Object type Reference

dec hex
01 01 Identity Object → Identity Object (object class: 0x01) (→ S. 117)

02 02 Message Router Object → Message Router Object (object class: 0x02) (→ S. 119)

04 04 Assembly Object → Assembly Object (object class: 0x04) (→ S. 120)

06 06 Connection Manager Object → Connection Manager Object (object class: 0x06)
(→ S. 121)
71 47 Device Level Ring Object → Device Level Ring Object (object class: 0x47) (→ S. 122)

72 48 Quality of Service → Quality of Service (object class: 0x48) (→ S. 123)

128 80 IO-Link Requests → IO-Link requests (object class: 0x80) (→ S. 124)

245 F5 TCP/IP Object → TCP/IP object (object class: 0xF5) (→ S. 134)

246 F6 Ethernet Link Object → Ethernet Link Object (object class: 0xF6) (→ S. 136)

116
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Identity Object (object class: 0x01)

34340

The Identity Object contains the general information about the device.
>

Class attributes
34310

Attr. ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 1
2 Get Max instance UINT Max. number of instances of the object 1
6 Get Maximum ID Number UINT ID of the last class attribute 7
Class Attributes
7 Get Maximum ID Number UINT ID of the last instance attribute 9
Instance Attributes

>

Instance attributes
34339

Attr. ID Access Name Data type Description Preset

1 Get Vendor ID UINT Manufacturer ID 322
2 Get Device type UINT Type of unit 12
3 Get Product code UINT Identification of a particular product of a vendor 1920
4 Get Revision STRUCT Revision of the article that is represented by the 1.1
Identity Object
 Major USINT Main revision (1...127) 1
revision
 Minor USINT Side revision (3 digits, if necessary with zeros in the 1
revision beginning)
5 Get Status WORD Status of the device
6 Get Serial number UDINT Serial number of the device
7 Get Product Name SHORT Readable device designation (max. 32 ASCII IO-Link Master CL
STRING characters) EIP 8P IP20
8 Get State USINT Current status of the device (according to status
transition diagram)
0 Nonexistent
1 Device Self Testing
2 Standby
3 Operational
4 Major Recoverable Fault
5 Major Unrecoverable Fault

6...254 Reserved
255 Default for Get_Attributes_All service
9 Get Configuration UINT The content shows the configuration of the device 0
Consistency
Value

>

117
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Supported services
34377

Service code Name Class Attribute Description

dec hex

01 01 Get_Attribute_All yes yes Read all attributes

05 05 Reset yes yes Reset

14 0E Get_Attribute_Single yes yes Read single attribute

16 10 Set_Attribute_Single yes yes Change single attribute

If an Identity Object receives a reset request, it carries out the following actions:
 It checks if it supports the requested reset type.
 It responds to the request.
 It tries to execute the requested reset type.

Supported reset types:

 0 Reboot the device (obligatory for all EtherNet/IP devices).
 1 Restore factory settings and reboot the device.

118
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Message Router Object (object class: 0x02)

34390

The Message Router Object provides an access with which an EtherNet/IP client can address a
service to any object class or instance in the physical device.
>

Class attributes
34320

Attr. ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 1
2 Get Max instance UINT Max. number of instances of the object 1
3 Get Number of Instances UINT Number of instances 1
6 Get Maximum ID Number UINT ID of the last class attribute 7
Class Attributes
7 Get Maximum ID Number UINT ID of the last instance attribute 0
Instance Attributes

>

Instance attributes
34402

The object has no instance attributes.

>

Supported services
34374

Service code Name Class Attribute Description

dec hex
14 0E Get_Attribute_Single yes no Read single attribute value

119
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Assembly Object (object class: 0x04)

34332

The Assembly Object combines attributes of several objects to allow data to be sent to or received
from each object via one connection.
>

Class attributes
34309

Attr. ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 2
2 Get Max instance UINT Max. number of instances of the object 0x00C7
3 Get Number of Instances UINT Number of instances 3
6 Get Maximum ID Number UINT ID of the last class attribute 7
Class Attributes
7 Get Maximum ID Number UINT ID of the last instance attribute 4
Instance Attributes

>

Instance attributes
34403

Attr. ID Access Name Data type Description Preset

100 Get Input assembly STRUCT Cyclic input data (→ Input assembly (Instance --
100): I/O data + acyclic data + diagnosis data
(→ S. 93))
101 Get Input assembly STRUCT Cyclic input data (→ Input Assembly (Instance --
101): I/O data + acyclic data (→ S. 94))
102 Get Input assembly STRUCT Cyclic input data (→ Input Assembly (Instance --
102): I/O data (→ S. 95))
150 Get, Set Output assembly STRUCT Cyclic output data (→ Output assembly (Instance --
150): I/O data + acyclic data (→ S. 100))
151 Get, Set Output assembly STRUCT Cyclic output data (→ Output Assembly (Instance --
151): I/O data (→ S. 101))
199 Get, Set Configuration STRUCT Configuration data (→ Configuration Assembly --
assembly (Instance 199) (→ S. 89))

>

Supported services
34376

Service code Name Class Attribute Description

dec hex
14 0E Get_Attribute_Single yes yes Read attribute value
16 10 Set_Attribute_Single no yes Change attribute value

120
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Connection Manager Object (object class: 0x06)

34367

The Connection Manager Object structures and manages the internal resources that are used for the
connection.
>

Class attributes
34319

Attr ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 1
2 Get Max instance UINT Max. number of instances of the object 1
3 Get Number of Instances UINT Number of instances 3
6 Get Maximum ID Number UINT ID of the last class attribute 7
Class Attributes
7 Get Maximum ID Number UINT ID of the last instance attribute 0
Instance Attributes

>

Instance attributes
34402

The object has no instance attributes.

>

Supported services
34375

Service code Name Class Attribute Description

dec hex
14 0E Get_Attribute_Single yes yes Read single attribute
16 10 Set_Attribute_Single no yes Change single attribute
78 4E Forward_Close yes no Close connection
84 54 Forward_Open yes no Open new connection

121
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Device Level Ring Object (object class: 0x47)

34345

The Device Level Ring (DLR) Object represents the interface for configuration and status information.
>

Class attributes
34313

Attr ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 3
2 Get Max instance UINT Max. number of instances of the object 1
6 Get Maximum ID Number UINT ID of the last class attribute 7
Class Attributes
7 Get Maximum ID Number UINT ID of the last instance attribute 12
Instance Attributes

>

Instance attributes
34327

Attr. ID Access Name Data type Description Preset

1 Get Network USINT current network topology 0
Topology
2 Get Network status USINT current network status 0
10 Get Active Supervisor STRUCT of Identification of the supervisor 0
 UDINT IP address of the supervisor
 ARRAY MAC address of the supervisor
of 6
USINT
s
12 Get Capability Flags DWORD DLR functions of the device 0x82
Bit 0 Announced-based ring node 0
Bit 1 Beacon-based ring node 1
Bit 2...4 reserved --
Bit 5 Supervisor capable 0
Bit 6 Redundant Gateway capable 0
Bit 7 Flush_Table frame capable 1
Bit 8..31 reserved --
l
>

Supported services
34409

Service code Name Class Attribute Description

dec hex
1 01 Get_Attribute_All no yes Read all attribute values
14 0E Get_Attribute_Single yes yes Read single attribute value

122
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Quality of Service (object class: 0x48)

34371

Quality of Service (QoS) enables prioritising of Ethernet frames. The priorities of the Ethernet frames
can be influenced with the attributes "Differentiate Service Code Points" (DSCP) or "802.1Q Tag".
>

Class attributes
34307

Attr ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 3
2 Get Max instance UINT Max. number of instances of the object 1
6 Get Maximum ID Number UINT ID of the last class attribute 7
Class Attributes
7 Get Maximum ID Number UINT ID of the last instance attribute 8
Instance Attributes

>

Instance attributes
34328

Attr ID Access Name Data type Description Value

1 Get 802.1Q tagRevision USINT Current network topology 0
2 Get, Set DSCP PTP Event USINT DSCP value for PTP event frames 59
3 Get, Set DSCP PTP general USINT DSCP value for PTP general frames 47
4 Get, Set DSCP PTP Urgent USINT DSCP value for implicit messages with "urgent" 55
priority
5 Get, Set DSCP Scheduled USINT DSCP value for implicit messages with "scheduled" 47
priority
6 Get, Set DSCP High USINT DSCP value for implicit messages with "high" priority 43
7 Get, Set DSCP Low USINT DSCP value for implicit messages with "low" priority 31
8 Get, Set DSCP explicit USINT DSCP value for explicit messages with "scheduled" 27
priority

>

Supported services
34406

Service code Name Class Attribute Description

dec hex

01 01 Get_Attribute_All yes yes Read all attribute values

14 0E Get_Attribute_Single no yes Read single attribute value

123
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

IO-Link requests (object class: 0x80)

34412

The manufacturer-specific object "IO-Link Requests" enables read and write access to the IO-Link
objects of an IO-Link device connected to a AL1920 via ISDU (Index Service Data Unit). The object
projects the mechanisms of the CIP addressing on the IO-Link protocol.
>

Class attributes
34308

Attr ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 4
2 Get Max instance UINT Max. number of instances of the object 2
6 Get Maximum ID Number UINT Number of instances of the object 8
Class Attributes

>

Instance attributes
34399

The required IO-Link port of the device is addressed via the instance attribute.
>

Supported services
34378

Service code Name Class Attribute Description

dec hex
75 4B → Read_ISDU (→ S. 125) no yes Read ISDU
76 4C → Write_ISDU (→ S. 128) no yes Read ISDU
77 4D → Write Failsafe Pattern no yes Write failsafe values of IO-Link port
(→ S. 131)

124
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Read_ISDU
34323

With Read_ISDU, parameters of a connected IO-Link device can be read.

>

Request
34337

CIP Attribute determines the IO-Link port to which the IO-Link device is connected. The area CIP User
Specific Service Data contains the IO-Link index and the IO-Link sub-index of the IO-Link object
whose value is to be read:
CIP format Data type MSG Config IO-Link mapping
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x01...0x08 Port number
CIP Service code ID USINT 0x4B Request "Read_ISDU"
CIP User specific service data UINT 0x0000...0xFFFF IO-Link ISDU object index
USINT 0x00...0xFF IO-Link ISDU object sub-index

>

Response
34326

 Positive response
If the service has been executed successfully (CIP Error Code = 0), the read data are returned bit by
bit (CIP User Specific Service Data). The answer has the following format:
CIP format Data type MSG Config IO-Link mapping
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x01...0x08 Port number
CIP Service Code ID USINT 0x4C Response "Read_ISDU"
CIP Error Code USINT 0x00 --
CIP Extended Error Code USINT 0x00 --
CIP User Specific Service Data USINT 0x00...0xFF Data (byte 0)
USINT 0x00...0xFF Data (byte 1)
... ...
USINT 0x00...0xFF Data (byte n)

The read data is in the IO-Link format. If necessary, the user needs to adapt the byte
arrangement of the read data to the CIP format.

125
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

 Negative response
If an error occurs while executing the service (CIP Error Code <> 0), an extended error code is
transmitted. If the CIP Error Code = 0x1E, then the CIP Extended Error Code = 0x00 and the CIP User
Specific Service Data area contains the IO-Link Error Code as well as IO-Link Additional Code. The
answer has the following format:
CIP format Data type MSG Config IO-Link mapping
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x01...0x08 Port number
CIP Service Code ID USINT 0x4B Response "Read_ISDU"
CIP Error Code USINT <> 0x00 Error code: see table below
CIP Extended Error Code USINT 0x00 Extended error code
CIP User Specific Service Data USINT <> 0x00 IO-Link Error Code: → Error codes (→ S. 107)
(only if CIP Error Code = 0x1E)
USINT <> 0x00 IO-Link Additional Code: → Additional Codes
(→ S. 107)
(only if CIP Error Code = 0x1E)

CIP Error Code:

Code Description
0x02 Resource not available: The IO-Link port is busy processing another acyclic service.
0x05 Invalid class ID or instance ID
0x08 Wrong service ID: only service code 0x4B or 0x4C is permitted
0x09 Wrong attribute ID: wrong port number
0x20 Invalid parameter value (e.g. invalid length)
0x1E Embedded service, error: Error occurred during an IO-Link service. Byte 0 and byte 1 of the User Specific Service
Data contain the IO-Link error code and an additional code that are returned by the IO-Link master.

126
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: reading the parameter value of anIO-Link device

34350

Task: reading the value of the parameter X of an IO-Link device

 IO-Link device at the port: 0x02
 Parameter X in the object directory of an IO-Link device: Index: 90, sub-index 3

From this, the following results for the configuration of the EtherNet/IP command Message (MSG):
CIP format Data type MSG Config Description
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x02 Port number
CIP Service Code ID USINT 0x4B Request "ISDU_Read"
CIP User Specific Service Data UINT 0x005A IO-Link ISDU object index
USINT 0x03 IO-Link ISDU object sub-index

After successful execution of the request, the response area has the following content:
CIP format Data type MSG Config Description
CIP Class ID UINT 0x80 Object class "IO-Link requests"
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x02 Port number
CIP Service Code ID USINT 0x4B Response "ISDU_Read"
CIP Error Code USINT 0x00 Request processed successfully
CIP Extended Error Code USINT 0x00 --
CIP User Specific Service Data USINT e.g. 0x12 Parameter value that has been read (byte 0)
USINT e.g. 0x34 Parameter value that has been read (byte 1)

If an error occurs while the request is executed, the response area has the following content:
CIP format Data type MSG Config Description
CIP Class ID UINT 0x80 Object class "IO-Link requests"
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x02 Port number
CIP Service code ID USINT 0x4B Response "ISDU_Read"
CIP Error code USINT 0x1E Error code: Embedded service error
CIP Extended error code USINT 0x00 --
CIP User specific service data USINT e.g. 0x80 IO-Link Error Code: Error in device application
USINT e.g. 0x20 IO-Link Additional Code: Service temporarily
unavailable

127
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Write_ISDU
34385

With Write_ISDU, the parameters of a connected IO-Link device can be changed.

>

Request
34387

CIP Attribute determines the IO-Link port to which the IO-Link device is connected. The area CIP User
Specific Service Data contains the IO-Link index, the IO-Link sub-index of the IO-Link object whose
value is to be changed. It is followed, bit by bit, by the value that is to be assigned to the parameter.
CIP format Data type MSG Config IO-Link mapping
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x1 IO-Link master
CIP Attribute USINT 0x01...0x08 Port number
CIP Service Code ID USINT 0x4C Request "Write_ISDU"
CIP User Specific Service Data UINT 0x0000...0xFFFF IO-Link ISDU object index
USINT 0x00...0xFF IO-Link ISDU object sub-index
USINT 0x00...0xFF IO-Link ISDU data (byte 0)
USINT 0x00...0xFF IO-Link ISDU data (byte 1)

>

Response
34384

 Positive response
If the service has been executed successfully (CIP Error Code = 0), the area CIP User Specific
Service Data stays empty The answer has the following format:
CIP format Data type MSG Config IO-Link mapping
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attribute USINT 0x01...0x08 Port number
CIP Service Code ID USINT 0x4C Response "Write_ISDU"
CIP Error Code USINT 0x00 --
CIP Extended Error Code USINT 0x00 --

128
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

 Negative response
If an error occurs while executing the service (CIP Error Code <> 0), an extended error code is
transmitted. If the CIP Error Code = 0x1E, then the CIP Extended Error Code = 0x00 and the CIP User
Specific Service Data area contains the IO-Link Error Code as well as IO-Link Additional Code. The
answer has the following format:
CIP format Data type MSG Config IO-Link mapping
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x01...0x08 Port number
CIP Service Code ID USINT 0x4C Response "Write_ISDU"
CIP Error Code USINT <> 0x00 Error code. see table below
CIP Extended Error Code USINT 0x00 Extended error code
CIP User Specific Service Data USINT <> 0x00 IO-Link Error Code: → Error codes (→ S. 107)
(only if CIP Error Code = 0x1E)
USINT <> 0x00 IO-Link Additional Code: → Additional Codes
(→ S. 107)
(only if CIP Error Code = 0x1E)

CIP Error Code:

Code description
0x02 Resource not available: The IO-Link port is busy processing another acyclic service.
0x05 Invalid class ID or instance ID
0x08 Wrong service ID: only service code 0x4B or 0x4C is permitted
0x09 Wrong attribute ID: wrong port number
0x20 Invalid parameter value (e.g. invalid length)
0x1E Embedded service, error: Error occurred during an IO-Link service. Byte 0 and byte 1 of the User Specific Service
Data contain the IO-Link error code and an additional code that are returned by the IO-Link master (see below).

129
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: changing the parameter value of an IO-Link device

34355

Task: changing the parameter X of an IO-Link device

 IO-Link device at the port: 0x03
 Parameter X in the object directory of an IO-Link device: Index: 91, sub-index 5
 new parameter value: 0xABCD

From this, the following results for the configuration of the EtherNet/IP command Message (MSG):
CIP format Data type MSG Config Description
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x03 Port number
CIP Service code ID USINT 0x4C Service "Write_ISDU"
CIP User specific service data UINT 0x005B IO-Link ISDU object index
USINT 0x05 IO-Link ISDU object sub-index
USINT 0xAB New parameter value (MSB)
USINT 0xCD New parameter value (LSB)

After successful execution of the request, the response area has the following content:
CIP format Data type MSG Config Description
CIP Class ID UINT 0x80 Object class "IO-Link Requests"
CIP Instance ID UINT 0x01 IO-Link master
CIP Attributes USINT 0x03 Port number
CIP Service code ID USINT 0x4B Service "Write_ISDU"
CIP Error code USINT 0x00 Request processed successfully
CIP Extended error code USINT 0x00 --

If an error occurs while the request is executed, the response area has the following content:
CIP format Data type MSG Config Description
CIP Class ID UINT 0x80 Object class "IO-Link Requests"
CIP Instance ID UINT 0x01 IO-Link master

CIP Attributes USINT 0x03 Port number

CIP Service code ID USINT 0x4B Service "Write_ISDU"

CIP Error code USINT 0x1E Error code: Embedded Service Error

CIP Extended error code USINT 0x00 --

CIP User specific service data USINT 0x80 IO-Link Error Code: Error in device application
USINT 0x23 IO-Link Additional Code: Access denied

130
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Write Failsafe Pattern

54597

By using Write Failsafe Pattern the fail-safe value of a IO-Link port can be written.
>

Request
54694

CIP Attribute determines the IO-Link port. The area CIP User Specific Service Data includes the
fail-safe mode and the fail-safe value (Failsafe Pattern).
CIP Format Data type MSG Config Description
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attribute USINT 0x01...0x08 Port number
CIP Service Code ID USINT 0x4D Request "Write Failsafe Pattern"
CIP User Specific Service Data USINT 0x00 = No Fail-safe Failsafe Mode
0x01 = Fail-safe Reset Value
0x02 = Fail-safe Old Value
0x03 = Fail-safe with Pattern
USINT 0x00...0xFF Failsafe Pattern (MSB)
USINT 0x00...0xFF Failsafe Pattern (LSB)

>

Response
54695

 Positive response
If the service was executed successfully (CIP Error Code = 0), the area "User Specific Data" will
remain empty. The response has the following format:
CIP Format Data type MSG Config Description
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attribute USINT 0x01...0x08 Port number
CIP Service Code ID USINT 0x4D Response "Write Failsafe Pattern"
CIP Error Code USINT 0x00 --
CIP Extended Error Code USINT 0x00 --

131
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

 Negative response
If an error occurs while executing the service (CIP Error Code <> 0), an extended error code is
transmitted (CIP Extended Error Code). The answer has the following format:
CIP-Format Data type MSG Config Description

CIP Class ID UINT 0x80 IO-Link acyclic access

CIP Instance ID UINT 0x01 IO-Link master
CIP Attribute USINT 0x01...0x08 Port number
CIP Service Code ID USINT 0x4D Response "Write Failsafe Pattern"
CIP Error Code USINT <> 0x00 Error code: see below
CIP Extended Error Code USINT <> 0x00 Extended error code

CIP Error Code:

Code Description

0x02 Resource not available: The IO-Link port is busy processing another acyclic service.
0x05 Invalid class ID or instance ID
0x08 Wrong service ID: only service 0x4B, 0x4C or 0x4D is permitted
0x09 Wrong attribute ID: wrong port number
0x20 Invalid parameter value (e.g. invalid length)
0x1E Embedded service, error: Error occurred during an IO-Link service. Byte 0 and byte 1 of the User Specific Service
Data contain the IO-Link error code and an additional code that are returned by the IO-Link master (see below).
0x0F Insufficient access rights

132
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Example: Write fail-safe value

54696

Task: Write fail-safe mode for IO-Link port X02 to "Fail-safe with pattern" and fail-safe value to 0x1234
 IO-Link device in the port: 0x02
 Fail-safe mode: 0x03
 Fail-safe value: 0x1234

From this, the following results for the configuration of the EtherNet/IP command message (MSG):
CIP Format Data type MSG Config Description
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attribute USINT 0x02 Port number
CIP Service Code ID USINT 0x4D Request "Write Failsafe Pattern"
CIP User Specific Service Data USINT 0x03 "Fail-safe with Pattern" mode
USINT 0x12 Failsafe Pattern (MSB)
USINT 0x34 Failsafe Pattern (LSB)

After successful execution of the request, the response area has the following content:
CIP-Format Data type MSG Config Description
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master
CIP Attribute USINT 0x02 Port number
CIP Service Code ID USINT 0x4D Response "Write Failsafe Pattern"
CIP Error Code USINT 0x00 Request processed successfully
CIP Exended Error Code USINT 0x00 --

If an error occurs while the request is executed, the response area will have the following content:
CIP-Format Data type MSG Config Description
CIP Class ID UINT 0x80 IO-Link acyclic access
CIP Instance ID UINT 0x01 IO-Link master

CIP Attribute USINT 0x02 Port number

CIP Service Code ID USINT 0x4D Response "Write Failsafe Pattern"

CIP Error Code USINT e. g. 0x0F Error code: Insufficient access rights

CIP Exended Error Code USINT 0x00 no additional information

133
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

TCP/IP object (object class: 0xF5)

34388

TCP/IP Interface Object enables the configuration of the physical network interface of the device.
>

Class attributes
34311

Attr ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 4
2 Get Max instance UINT Max. number of instances of the object 1

>

Instance attributes
34330

Attr.
ID Access Name Data type Description Preset
1 Get Status DWORD Status of the TCP/IP interface
Bit Configuration status of the interface
0...3
Bit 4 Mcast pending (always 0)
Bit 5 Interface configuration pending
Bit 6 ACD Status
Bit 7 ACD Fault
Bit reserved
8...31
2 Get Configuration Capability DWORD Functions of the interface (flags) 0x95
(BOOTP,DHCP
Bit 0 BOOTP Client Client,TCP/IP
Bit 1 reserved configurable,
ACD capable)
Bit 2 DHCP Client
Bit 3 reserved
Bit 4 TCP/IP configurable via EtherNet/IP
Bit 5 reserved
Bit 6 reserved
Bit 7 ACD Capable
Bit reserved
8...31
3 Get, Configuration Control DWORD Interface control (control flags): 0
Set
Bit Start-up configuration
0...3
0 Static IP configuration
1 Configuration via BOOTP
2 Configuration via DHCP
Bit 4 reserved
Bit reserved
5...31
4 Get Physical Link Object path STRUCT: Logical path to the physical communication
interface: the Ethernet Link object
 Path Size  UINT Length (in Little Endian Format as WORD) 02 00

134
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Attr.
ID Access Name Data type Description Preset
 Path  Padded Path 20 F6 24 01
EPATH
Class ID = 0xF6 Ethernet Link Object
Instance ID = 1
5 Get, Interface Configuration STRUCT: TCP/IP configuration
Set
 IP Address  UDINT IP adress 192.168.1.250
 Network mask  UDINT Subnet mask 255.255.255.0
 Gateway address  UDINT Default gateway address 0.0.0.0
 Name Server  UDINT 1. Name Server 0.0.0.0
 Name Server 2  UDINT 2. Name Server 0.0.0.0
 Domain Name  STRING Default domain name 0
6 Get, Host name STRING Host name 0
Set
0 no name configured
8 Get TTL value TTL value 1
9 Get Mcast Config 0
10 Get, SelectAcd BOOL activate ACD 1
Set
0 deactivate
1 activate
11 Get, Last Conflict Detected STRUCT: Structure with information via the latest 0
Set detected conflict
 USINT Condition of the ACD activity with the latest
detected conflict
0 Noconflictdetetcted
1 Probelpv4Address
2 OngoingDetection
3 SemiActiveProbe
 ARRAY MAC address
of 6
USINT
 ARRAY Copy of the data of the ARP PDU in which the
of 28 conflict was detected
USINT
13 Get, Encapsulation Inactivity UINT Inactivity before the TCP connection is 120
Set Timeout deactivated (in seconds)

>

Supported services
34416

Service code Name Class Attribute Description

dec hex
01 01 Get_Attribute_All no yes Read all attributes
14 0E Get_Attribute_Single yes yes Read single attribute
16 10 Set_Attribute_Single no yes Change single attribute

135
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Ethernet Link Object (object class: 0xF6)

34354

The Ethernet Link Object contains status information of the Ethernet interface.
>

Class attributes
34312

Attr ID Access Name Data type Description Value

1 Get Revision UINT Revision of the object 4
2 Get Max Instance UINT Max. number of instances of the object 2
3 Get Number of Instances UINT Number of instances of the object 2

>

Instance attributes
34333

Attr. ID Access Name Data type Description Preset

1 Get Interface Speed UDINT Current data rate (in bytes/s) 100
10 Mbps,100 Mbps.
2 Get Interface Status DWORD Status flag of the interface 0x20
Flags
Bit 0 Link status
Bit 1 Half/full duplex
Bit 2...4 Auto negotiation status
Bit 5 Manual setting requires reset
Bit 6 Local Hardware Fault
Bit 7...31 reserved
3 Get Physical Address ARRAY of 6 MAC address
USINTS
4 Get Interface Counters STRUCT of Interface-specific counter
11 UDINTs
5 Get Media counters STRUCT of Medium-specific counter
12 UDINTs
6 Get, Set Interface control STRUCT of Control bits: 0
Bit 0: Auto negotiate
Bit 1: Forced Duplex Mode (full 1, half 0)
 WORD Control bits of the interface
Bit 0 0 = auto-negotiation active
1 = auto-negotiation inactive
Bit 1 0 = Half duplex
1 = Full duplex
Bit 2..15 reserved
 UINT Data rate of the interface
10 10 Mbps
100 100 Mpbs
7 Get Interface Type USINT Physical interface type 2
0 unknown

1 Internal interface

136
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Attr. ID Access Name Data type Description Preset

2 Twisted pair
3 Optical fibre
4...255 reserved
8 Get Interface state USINT Current status of the interface 0
0 unknown
1 active; ready for transmission and
reception
2 not active
3 Test mode
4...255 reserved

9 Get Admin State USINT Control of the access to the interface 1

0 reserved
1 Activate interface
2 Deactivate interface
3...255 reserved
10 Get Interface label SHORT_ Designation of the interface "X21" (instance 1)
STRING "X22" (instance 2)
11 Get Interface capability STRUCT of Capabilities of the interface
 DWORD Transmission rate
10 10 Mbps
100 100 Mbps
 DWORD Duplex mode
HD Half duplex
FD Full duplex

300 Get, Set MDIX ??? MDIX configuration 3

0
1 MDI
2 MDIX
3 autoMDI
4...255 reserved

>

Supported services
34414

Service code Name Class Attribute Description

dec hex

01 01 Get_Attribute_All no yes Read all attribute values

14 0E Get_Attribute_Single yes yes Read single attribute value
16 10 Set_Attribute_Single no yes Change single attribute value

137
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.3 ifm IoT Core

Content
Overview: IoT profile .............................................................................................................................139
Overview: IoT types ..............................................................................................................................144
Overview: IoT services .........................................................................................................................145
33803

138
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.3.1 Overview: IoT profile

Content
Profile: blob ...........................................................................................................................................139
Profile: deviceinfo .................................................................................................................................140
Profile: devicetag ..................................................................................................................................140
Profile: iolinkdevice_full ........................................................................................................................141
Profile: iolinkmaster ..............................................................................................................................141
Profile: network .....................................................................................................................................142
Profile: parameter .................................................................................................................................142
Profile: processdata ..............................................................................................................................142
Profile: service ......................................................................................................................................142
Profile: software ....................................................................................................................................143
Profile: software/uploadedablesoftware ...............................................................................................143
Profile: timer .........................................................................................................................................143
34054
>

Profile: blob
52264

Element (identifier) Characteristics Mandatory Comments

blobname  type = data Characterises the element as device

 profiles = blob information

../size type = data mandatory

../chunksize type = data mandatory
../setblobdata type = service optional
../getblobdata type = service optional
../start_stream_set type = service optional
../stream_set type = service optional
../clear type = service optional
../getcrc type = service optional
../getmd5 type = service optional
../getdata type = service optional
../setdata type = service optional

139
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Profile: deviceinfo
34207

Element (identifier) Properties mandatory Comments

deviceinfo  type = structure characterises the element as device

 profile = deviceinfo information

../devicename type = data optional

../devicefamiliy type = data optional
../devicevariant type = data optional
../devicesymbol type = data optional
../deviceicon type = data optional
../serialnumber type = data mandatory
../productid type = data optional
../productname type = data optional
../productcode type = data mandatory
../producttext type = data optional
../ordernumber type = data optional
../productiondate type = data optional
../productioncode type = data optional
../hwrevision type = data mandatory
../swrevision type = data mandatory
../bootloaderrevision type = data optional
../vendor type = data optional
../vendortext type = data optional
../vendorurl type = data optional
../vendorlogo type = data optional
../productwebsite type = data optional
../supportcontact type = data optional
../icon type = data optional
../image type = data optional
../standards type = data optional

>

Profile: devicetag
34206

Element (identifier) Properties mandatory Comments

devicetag  type = structure
 profile = devicetag
../applicationtag type = data mandatory
../applicationgroup type = data optional
../machinecode type = data optional
../tenant type = data optional

>

140
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Profile: iolinkdevice_full
52265

Element (identifier) Characteristics Mandatory Comments

iolinkdevice  type = structure Structure of an IO-Link device

 profile = iolinkdevice_full
../vendorid type = data mandatory
../deviceid type = data mandatory
../productname type = data mandatory
../serial type = data mandatory
../applicationspecifictag type = data mandatory
../pdin type = data mandatory
../pdout type = data mandatory
../status type = data mandatory
../iolreadacyclic type = data mandatory
../iolwriteacyclic type = data mandatory
../iolinkevent type = data mandatory

>

Profile: iolinkmaster
34205

Element (identifier) Properties mandatory Comments

masterport  type = structure Executable service
 profile = iolinkmaster
../mode  type = data mandatory
 profile = parameter
../comspeed  type = data mandatory
 profile = parameter
../mastercycletime_actual  type = data mandatory
 profile = parameter
../mastercycletime_preset  type = data mandatory
 profile = parameter
../validation_datastorage_mode  type = data mandatory
 profile = parameter
../validation_vendorid  type = data mandatory
 profile = parameter
../validation_deviceid  type = data mandatory
 profile = parameter
../additionalpins_in  type = data optional
 profile = processdata
../additionalpins_out  type = data optional
 profile = processdata
../portevent  type = data mandatory
../iolinkdevice  type = structure mandatory
 profile = iolinkdevice_full

>

141
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Profile: network
52266

Element (identifier) Characteristics Mandatory Comments

network  type = structure Characterises the element as device

 profiles = deviceinfo information

../macaddress  type = data mandatory

 profile = parameter
../ipaddress  type = data optional
 profile = parameter
../ipv6address  type = data mandatory
 profile = parameter
../subnetmask  type = data mandatory
 profile = parameter
../ipdefaultgateway  type = data mandatory
 profile = parameter
../dhcp  type = data optional
 profile = parameter
../ipversion  type = data optional
 profile = parameter
../hostname  type = data optional
 profile = parameter
../autonegotiation  type = data optional
 profile = parameter
../portspeed  type = data optional
 profile = parameter
../enablenetwork type = service optional
../disablenetwork type = service optional

>

Profile: parameter
34215

The profile is used to mark the elements of type data as parameters (acyclic data). The profile defines
no substructure.
>

Profile: processdata
34225

The profile is used to mark the elements of type data as process data (cyclic data). The profile does
not define a substructure.
>

Profile: service
34224

Element (identifier) Properties mandatory Comments

service  type = service Executable service
 profile = service

>

142
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Profile: software
34223

Element (identifier) Properties mandatory Comments

software  type = structure characterises the element as software

 profile = software
../version type = data mandatory
../type type = data mandatory
../status type = structure optional
../diag type = structure optional

>

Profile: software/uploadedablesoftware
52267

Element (identifier) Characteristics Mandatory Comments

software  type = structure Software that can be loaded to the device via
 profiles = the IoT Core
software/uploadablesoft
ware
../lastinstall type = data optional
../installhistory type = data optional
../container  type = data mandatory
 profile = blob
../preinstall type = service optional
../install type = service mandatory
../postinstall type = service optional
../abortinstall type = service optional
../installstatus type = data optional

>

Profile: timer
34226

Element (identifier) Properties mandatory Comments

timer  type = structure Executable service
 profile = timer
../counter  type = data mandatory
 profile = parameter
../interval  type = data optional
 profile = parameter
../start type = service optional
../stop type = service optional

143
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.3.2 Overview: IoT types

34055

The ifm IoT Core uses the following element types:

Name Description
structure Element is a structure element (like a folder in a file system)
service Element is a service that can be addressed from the network
event Element is an event that can be started by the firmware and sends messages.
data Element is a data point
device Root element a device represents

144
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

13.3.3 Overview: IoT services

Content
Service: factoryreset .............................................................................................................................145
Service: gettree ....................................................................................................................................146
Service: getdata ....................................................................................................................................146
Service: getdatamulti ............................................................................................................................147
Service: getidentity ...............................................................................................................................148
Service: getsubscriptioninfo..................................................................................................................149
Service: iolreadacyclic ..........................................................................................................................150
Service: iolwriteacyclic ..........................................................................................................................150
Service: reboot .....................................................................................................................................150
Service: setblock ..................................................................................................................................151
Service: setdata ....................................................................................................................................151
Service: setelementinfo ........................................................................................................................152
Service: signal ......................................................................................................................................152
Service: subscribe ................................................................................................................................153
Service: unsubscribe ............................................................................................................................153
34056
>

Service: factoryreset
34184

Name: factoryreset
Description: The service sets the parameters of the device to the factory settings.
Request data (field "data"): none
Response data (field "data"): none

Example:
{"code": "request", "cid": 4711, "adr": "/firmware/factoryreset"}

145
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Service: gettree
34175

Name: gettree
Description: The service reads the complete device description of the AL1920 and provides it as
JSON object.
Request data (field "data"): none
Response data (field "data"):
Data field Required field Data type Description

Identifier mandatory STRING Identifier of the root element

type mandatory STRING Type of the element
format optional JSON object Format of the data content
uid optional STRING
profiles optional JSON array
subs mandatory JSON array Subelements
hash optional STRING

Example:
{
"code":"request",
"cid":4,
"adr":"/gettree"
}
>

Service: getdata
34183

Name: getdata
Description: Service reads the value of a data point and provides it.
Request data (field "data"): none
Return data (field "data"):
Data field Required field Data type Description
value mandatory STRING Value of the element/data point

Example:
{
"code":"request",
"cid":4711,
"adr":"devicetag/applicationtag/getdata"
}

146
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Service: getdatamulti
34174

Name: getdatamulti
Description: The service sequentially reads the values of several data points and provides them. The
value and the diagnostic code are provided for each data point.
Request data (field "data"):
Data field Required field Data type Description

datatosend mandatory ARRAY OF List of data points to be requested; data points must support the
STRINGS service getdata ("datatosend":["url1","url2",...,"urlx"])
consistent optional BOOL

Response data (field "data"): for each requested data point

Data field Required field Data type Description

url mandatory STRING Data point request

code mandatory INT Diagnostic code of the request
data mandatory STRING Value of the data point

147
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Service: getidentity
54690

Name: getidentity
Description: The service reads the device information of the AL1920 and issues it.
Request data ("data" field): none
Return data ("data" field):
Data field Required Data type Description
field

iot Device Device description as JSON object

iot.name mandatory STRING
iot.uid optional STRING
iot.version mandatory STRING
iot.catalogue optional ARRAY OF
OBJECTS
iot.deviceclass optional ARRAY OF
STRING
iot.serverlist optional ARRAY OF
OBJECTS
device optional AL1920
device.serialnumber optional Serial number
device.hwrevision optional Hardware version
device.swrevision optional Software version
device.custom optional
Security optional Security options
security.securitymode optional ENUM shows if the security mode is activated
security.authscheme optional ENUM shows the active authentication scheme
security.ispasswordset optional BOOL shows whether a password has been set
security.activeconnection optional ENUM shows the currently used communication interface
 tcp_if unencrypted http connection at the IoT interface, port
80
 tls_if encrypted https connection at the IoT interface, port
443
 fb_if unencrypted http connection at the fieldbus interface,
port 80

148
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Service: getsubscriptioninfo
34172

Name: getsubscriptioninfo
Description: The service provides information about an existing subscription (subscribe).
Request data (field "data"):
Data field Required field Data type Description

callback mandatory STRING Address to which IoT Core event notifications are to be sent; complete
URL: http://ipaddress:port/path

Response data (field "data"):

Data field Required field Data type Description

callback mandatory STRING Address to which IoT Core event notifications are to be sent; complete
URL: http://ipaddress:port/path
datatosend mandatory ARRAY List of subscribed data points
OF
STRINGS

Example:
 Request:
{
"code":"request",
"cid": 4715,
"adr":"/timer[1]/counter/datachanged/getsubscriptioninfo",
"data":{
"callback":"http://192.168.0.44:80/temp"}
}
 Response:
{
"cid": 4715,
"data":{
"callback":"http://192.168.0.44:80/temp",
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/productname",
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/temperature"]},
"code":200
}

149
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Service: iolreadacyclic
34178

Name: iolreadacyclic
Description: The service acyclically reads the parameter value of an IO-Link device. The parameter is
accessed via IO-Link index and subindex.
Request data (field "data"):
Data field Required field Data type Description

index mandatory NUMBER IO-Link index of the parameter

subindex mandatory NUMBER IO-Link subindex of the parameter

Response data (field "data"):

Data field Required field Data type Description
value mandatory STRING Value of the parameter; Value in hexadecimal format

>

Service: iolwriteacyclic
34177

Name: iolwriteacyclic
Description: The service acyclically writes the parameter value of an IO-Link device. The parameter
is accessed via IO-Link index and subindex.
Request data (field "data"):
Data field Required field Data type Description

index mandatory NUMBER IO-Link index of the parameter

subindex mandatory NUMBER IO-Link subindex of the parameter
value mandatory STRING New value of the parameter; Value in hexadecimal format

Response data (field "data"): none

>

Service: reboot
34176

Name: reboot
Description: The service reboots the device.
Request data (field "data"): none
Return data (field "data"): none
Example:
{
"code":"request",
"cid":4,
"adr":"firmware/reboot"
}

150
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Service: setblock
34186

Name: setblock
Description: The service simultaneously sets the values of several data points of a structure.
Request data (field "data"):
Data field Required field Data type Description

datatosend mandatory ARRAY OF List of data points and their new values; data points must support the
(STRINGS) service setdata

consistent optional BOOL

Response data (field "data"): none

Example:
{
"code":"request",
"cid":4711,
"adr":"/iotsetup/network/setblock",
"data":{"consistent":true,"datatosend":["ipaddress":"192.168.0.6","ipdefaultgatewa
y":"192.168.0.250"]}
}
>

Service: setdata
34196

Name: setdata
Description: The service sets the value of the data point.
Request data (field "data"):
Data field Required field Data type Description
newvalue mandatory STRING New value of the element/data point

Response data (field "data"): none

Example:
{
"code":"request",
"cid":4711,
"adr":"devicetag/applicationtag/setdata",
"data":{"newvalue":"ifm IO-Link master"}
}

151
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Service: setelementinfo
34195

Name: setelementinfo
Description: The service sets the uid of an element.
Request data (field "data"):
Data field Required field Data type Description

url mandatory STRING URL of the element to be changed

uid optional STRING UID to be set
profiles optional JSON array
format optional JSON object

Response data (field "data"):

Data field Required field Data type Description

identifier mandatory STRING Identifier of the element

type mandatory STRING Type of the element
format optional JSON object Format of the data or the service content
uid optional STRING
profiles optional JSON array
hash optional STRING

>

Service: signal
33819

Name: signal
Description: The service starts the flashing of the status LEDs of the AL1920.
Request data (field "data"): none
Return data (field "data"): none

Example:
{
"code":"request",
"cid":4711,
"adr":"firmware/signal"
}

152
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

>

Service: subscribe
34194

Name: subscribe
Description: The service subscribes to the values of data points. The data points to be subscribed are
transferred as a list. The IO-Link master sends changes to the data drain defined in callback.
Request data (field "data"):
Data field Required field Data type Description

callback mandatory STRING Address to which IoT Core event notifications are to be sent; complete
URL: http://ipaddress:port/path
datatosend mandatory ARRAY OF List from URLs of data elements; elements have to support getdata
STRINGS

Response data (field "data"): none

>

Service: unsubscribe
34197

Name: unsubscribe
Description: The service deletes an existing subscription. unsubcribe is successful if cid and the
callback address are registered for a subscription (subscribe). If the STRING "DELETE" is provided in
callback, the IO-Link master deletes all active subscriptions.
Request data (field "data"):
Data field Required field Data type Description

callback mandatory STRING Address to which IoT Core event notifications are to be sent; complete
URL: http://ipaddress:port/path

Response data (field "data"): none

153
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

EtherNet/IP ports ...................................................................................16

14 Index Example
Activate security mode .................................................................................. 44
A Change name of the IO-Link master............................................................. 51
Change the parameter value of an IO-Link device ....................................... 50
Access the ifm IoT Core ........................................................................61 changing the parameter value of an IO-Link device ................................... 130
Accessories ...........................................................................................81 Clone the Data Storage of an IO-Link port ................................................... 48
Acyclic command channel ...................................................................103 GET request .................................................................................................. 61
Acyclic commands ...............................................................................108 POST request ................................................................................................ 63
Acyclic data ..........................................................................................103 Publish the temperature to an MQTT broker ................................................ 59
Acyclic port commands..........................................................................76 Read process data of an IO-Link device ...................................................... 52
Read several parameter values of the IO-Link master simultaneously ....... 55
Additional Codes..................................................................................107
Read the parameter value of an IO-Link device ........................................... 49
Appendix ................................................................................................82
reading the parameter value of anIO-Link device ...................................... 127
Application .............................................................................................83
Request with authentication .......................................................................... 45
Approvals / tests ....................................................................................85 reset password .............................................................................................. 45
Assembly Object (object class Subscribe to event ......................................................................................... 58
0x04) ............................................................................................................ 120 Update firmware ............................................................................................ 54
Write fail-safe value ..................................................................................... 133
C Explanation of Symbols ...........................................................................6
CIP class services ...............................................................................115
CIP object classes ...............................................................................116
F
Class attributes ................... 117, 119, 120, 121, 122, 123, 124, 134, 136 Factory settings .....................................................................................80
Cleaning process ...................................................................................77 Field bus objects ..................................................................................115
Command 0x10 – Set mode ................................................................109 Fieldbus
Command 0x20 – Set validation ID / data storage..............................111 Configure IP settings ..................................................................................... 32
Command 0x30 – Set fail-safe data pattern........................................113 set the configuration mode ............................................................................ 33
Command channels in cyclic process data ...........................................75 Firmware
Command request .............................................................. 109, 111, 113 Reboot the device ......................................................................................... 38
Reset device to factory settings .................................................................... 38
Command response ........................................................... 110, 112, 114
First steps ..............................................................................................40
Communication, parameter setting, evaluation .....................................11
Function .................................................................................................10
Configuration .........................................................................................25
Configuration Assembly (Instance 199) ................................................89 G
Configure AL1920 ..................................................................................68
Configure IO-Link devices ........................................................ 39, 49, 71 General ....................................................................................................7
Configure IO-Link ports ...................................................................47, 69 General functions...................................................................................41
Configure IoT interface ..........................................................................42 GET request ..........................................................................................61
Configure the fieldbus interface.............................................................46
I
Connect IO-Link devices for Class A operation ....................................17
Connect IO-Link devices for Class B operation ....................................18 Identity Object (object class
Connect the device ................................................................................19 0x01) ............................................................................................................ 117
Connection Manager Object (object class ifm IoT Core ...................................................................................40, 138
0x06) ............................................................................................................ 121 Info
Control IO-Link master ..........................................................................53 Show device information ............................................................................... 37
Cyclic data .............................................................................................92 Input assembly (Instance 100)
I/O data + acyclic data + diagnosis data ....................................................... 93
D Input Assembly (Instance 101)
I/O data + acyclic data................................................................................... 94
Device Level Ring Object (object class
Input Assembly (Instance 102)
0x47) ............................................................................................................ 122
I/O data .......................................................................................................... 95
Digital inputs ..........................................................................................13
Inputs .....................................................................................................84
E Inputs / outputs ......................................................................................83
Install the device ....................................................................................14
Electrical connection ........................................................................15, 86 Instance attributes .............. 117, 119, 120, 121, 122, 123, 124, 134, 136
Electrical data ........................................................................................83 Integrate the AL1920 into the EtherNet/IP project ................................66
Environmental conditions ......................................................................85 Intended use ............................................................................................9
Error codes ..........................................................................................107 Interfaces ...............................................................................................84
Ethernet interface ..................................................................................21 Internet of Things (IoT) ..........................................................................12
Ethernet Link Object (object class IO-Link ...................................................................................................11
0xF6) ............................................................................................................ 136
IO-Link ports ..........................................................................................17
EtherNet/IP ............................................................................... 11, 65, 87 Activate data transfer to LR AGENT or LR SMARTOBSERVER ................ 34
Programmers' notes ...................................................................................... 74
Configure operating mode............................................................................. 35
EtherNet/IP mechanisms for acyclic commands ...................................76 Set the device validation and data storage................................................... 36

154
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

IO-Link Ports POST request ........................................................................................62

Set fails-safe values ...................................................................................... 37 Power supply .........................................................................................22
IO-Link ports (Class A) ..........................................................................22 Preliminary note .......................................................................................5
IO-Link requests (object class Principle of the command channels ......................................................75
0x80) ............................................................................................................ 124 Profile
IO-Link supply ........................................................................................13 blob .............................................................................................................. 139
IoT deviceinfo..................................................................................................... 140
Configure access rights................................................................................. 30 devicetag ..................................................................................................... 140
Configure IP settings ..................................................................................... 28 iolinkdevice_full ........................................................................................... 141
Configure security mode ............................................................................... 29 iolinkmaster ................................................................................................. 141
Configure the interface to LR AGENT or LR SMARTOBSERVER .............. 31 network ........................................................................................................ 142
IoT Core parameter .................................................................................................... 142
Diagnostic codes ........................................................................................... 64 processdata ................................................................................................. 142
General information ....................................................................................... 60 service ......................................................................................................... 142
IoT interface software ....................................................................................................... 143
Configure security mode ............................................................................... 43 software/uploadedablesoftware .................................................................. 143
IoT port.............................................................................................16, 22 timer ............................................................................................................. 143

IT safety ...................................................................................................8 Programmers' notes ..............................................................................60

Prohibited use ..........................................................................................9
L Purpose of the document ........................................................................5

LED indicators .......................................................................................21 Q

Legal and copyright information ..............................................................5
LR DEVICE ............................................................................................26 Quality of Service (object class
0x48) ............................................................................................................ 123
M
R
Maintenance, repair and disposal .........................................................77
Read / write cyclic process data ............................................................52
Mapping
digital input data (DI) ..................................................................................... 96
Read cyclic input data ...........................................................................72
Digital output data (DO) .............................................................................. 102 Read device and diagnostic information ...............................................24
IO-Link port information................................................................................. 98 Read device information of the IO-Link master .....................................56
Port configuration .......................................................................................... 90 Read diagnostic and status information ................................................73
PQI ................................................................................................................. 97 Read diagnostic data of the AL1920 .....................................................55
Status information ......................................................................................... 96 Read information about IO-Link devices ...............................................56
Mechanical data.....................................................................................85 Read_ISDU..........................................................................................125
Message Router Object (object class Registration of the EDS file ...................................................................65
0x02) ............................................................................................................ 119 Remarks.................................................................................................27
Modification history ..................................................................................6 Replace IO-Link device .........................................................................79
Mounting ................................................................................................14 Request............................................................................... 125, 128, 131
MQTT support........................................................................................59 Request channel ..................................................................................104
Required background knowledge ............................................................7
N
Response ............................................................................ 125, 128, 131
Note Response channel ...............................................................................105
Security mode ............................................................................................... 43
Notes......................................................................................................15 S
O Safety instructions ...................................................................................7
Safety symbols on the device ..................................................................7
Offline parameter setting .......................................................................27 Security mode ........................................................................................12
Operating and display elements ............................................................20 Service
Output assembly (Instance 150) factoryreset .................................................................................................. 145
I/O data + acyclic data ................................................................................ 100 getdata ......................................................................................................... 146
Output Assembly (Instance 151) getdatamulti ................................................................................................. 147
I/O data ........................................................................................................ 101 getidentity .................................................................................................... 148
Outputs ..................................................................................................84 getsubscriptioninfo ...................................................................................... 149
Overview ................................................................................................20 gettree.......................................................................................................... 146
IoT profile ..................................................................................................... 139 iolreadacyclic ............................................................................................... 150
IoT services ................................................................................................. 145 iolwriteacyclic............................................................................................... 150
IoT types ...................................................................................................... 144 reboot ........................................................................................................... 150
setblock........................................................................................................ 151
P setdata ......................................................................................................... 151
setelementinfo ............................................................................................. 152
Parameter data ......................................................................................88
signal ........................................................................................................... 152
Parameter setting ..................................................................................12 subscribe ..................................................................................................... 153
Permitted use...........................................................................................9 unsubscribe ................................................................................................. 153

155
IO-Link Master with EtherNet/IP Interface CabinetLine 8 Ports IP 20

Set application identification ..................................................................51

Set connection types and RPI ...............................................................67
Set-up ....................................................................................................23
Status LEDs ...........................................................................................21
Subscribe to events ...............................................................................57
Supported connection types ..................................................................87
Supported EtherNet/IP configuration modes.........................................74
Supported services ............. 118, 119, 120, 121, 122, 123, 124, 135, 137

T
Tampering with the unit ...........................................................................8
TCP/IP object (object class
0xF5) ............................................................................................................ 134
Technical data .......................................................................................83

U
Update firmware ....................................................................................78
Use acyclic services ..............................................................................75

V
Visual indication .....................................................................................12
VPN connection .....................................................................................27

W
Write cyclic output data .........................................................................72
Write Failsafe Pattern ..........................................................................131
Write_ISDU ..........................................................................................128

156