Használati útmutató IFM AL1323

IFM nincs kategorizálva AL1323

Olvassa el alább 📖 a magyar nyelvű használati útmutatót IFM AL1323 (170 oldal) a nincs kategorizálva kategóriában. Ezt az útmutatót 2 ember találta hasznosnak és 2 felhasználó értékelte átlagosan 4.5 csillagra

Letöltés PDF
Oldal 1/170
>
>
80284133 / 03 10 / 2021
Operating instructions
IO-Link master with EtherNet/IP interface
DataLine
8 ports
IP 65 / IP 66 / IP 67 / IP 69K
AL1323
Firmware: 3.1 or higher
English
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
2
Contents
1 Preliminary note 5
1.1 Legal and copyright information ........................................................................................... 5
1.2 Purpose of the document ..................................................................................................... 5
1.3 Explanation of Symbols ....................................................................................................... 5
1.4 Change 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 security ............................................................................................................................. 8
3 Functions and features 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) ............................................................................................................... 11
4.1.4 Security mode ............................................................................................................................ 12
4.1.5 Parameter setting ....................................................................................................................... 12
4.1.6 Visual indication .........................................................................................................................12
4.2 Digital inputs ....................................................................................................................... 12
4.3 -Link supply IO .................................................................................................................... 12
5 Mounting 13
5.1 Mount the device ................................................................................................................ 13
6 Electrical connection 14
6.1 Notes .................................................................................................................................. 14
6.2 Connecting the EtherNet/IP ports ...................................................................................... 15
6.3 Connecting the IoT port ..................................................................................................... 15
6.4 -Link ports IO ....................................................................................................................... 16
6.4.1 Connecting IO-Link devices for Class A operati on ..................................................................... 16
6.5 Connecting the device ....................................................................................................... 17
7 Operating and display elements 18
7.1 Overview ............................................................................................................................ 18
7.2 LED indicators .................................................................................................................... 19
7.2.1 Status LEDs ............................................................................................................................... 19
7.2.2 Ethernet ports ............................................................................................................................. 19
7.2.3 IoT port ....................................................................................................................................... 20
7.2.4 Voltage supply ............................................................................................................................ 20
7.2.5 -Link Ports (Class A) IO ............................................................................................................... 20
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
3
8 Set- up 21
9 Configuration 22
9.1 LR DEVICE ........................................................................................................................ 23
9.1.1 Remarks ..................................................................................................................................... 24
9.1.2 IoT: Congure IP settings ........................................................................................................... 24
9.1.3 IoT: Congure security mode ..................................................................................................... 25
9.1.4 IoT: Conguring access rights .................................................................................................... 26
9.1.5 IoT: Congure the interface to LR AGENT or LR SMARTOBSERVER ...................................... 27
9.1.6 Fieldbus: Congure IP settings ................................................................................................... 28
9.1.7 Fieldbus: set the conguration mode .......................................................................................... 29
9.1.8 - ports: Activate data transfer to LR AGENT or LR SMARTOBSERVER IO Link ......................... 30
9.1.9 -Link ports: Congure operating mode IO ....................................................................................31
9.1.10 -Link ports: Set the device validation and data storage IO .......................................................... 32
9.1.11 -Link ports: Setting fail-safe values IO ......................................................................................... 33
9.1.12 Info: Show device information .................................................................................................... 33
9.1.13 Firmware: Reset device to factory settings ................................................................................. 34
9.1.14 Firmware: Reboot the device ...................................................................................................... 34
9.1.15 Congure IO-Link devices .......................................................................................................... 35
9.2 ifm IoT Core ....................................................................................................................... 36
9.2.1 Programmers' notes ................................................................................................................... 37
9.2.2 First steps ................................................................................................................................... 40
9.2.3 General functions ....................................................................................................................... 41
9.2.4 IoT: Conguring access rights .................................................................................................... 45
9.2.5 IoT: Conguring IP settings ........................................................................................................ 45
9.2.6 IoT: Conguring the LR AGENT or LR SMARTOBSERVER interface ....................................... 46
9.2.7 IoT: Conguring security mode ................................................................................................... 46
9.2.8 Fieldbus: Conguring IP settings ................................................................................................ 49
9.2.9 Fieldbus: Selecting the conguration mode ................................................................................ 49
9.2.10 Fieldbus: Setting fail-safe values ................................................................................................ 50
9.2.11 -Link ports: Setting the operating mode of pin 4 (US) IO ............................................................. 50
9.2.12 -Link ports: Conguring device validation and data storage IO ................................................... 50
9.2.13 -Link ports: Conguring data transfer to LR AGENT or LR SMARTOBSERVER IO .................... 52
9.2.14 -Link ports: Reading / writing process data IO ............................................................................. 52
9.2.15 -Link ports: Indicating port events IO ........................................................................................... 55
9.2.16 -Link devices: Accessing parameters IO ..................................................................................... 55
9.2.17 -Link devices: Reading an writing device information IO ............................................................. 57
9.2.18 -Link devices: Indicating IO-Link events IO ................................................................................. 57
9.2.19 Gateway: Resetting, rebooting and localising the device ........................................................... 57
9.2.20 Gateway: Reading device information ........................................................................................ 58
9.2.21 Gateway: Reading status and diagnostic information ................................................................. 58
9.2.22 Gateway: Updating the rmware ................................................................................................ 59
9.2.23 Gateway: Setting the application tag .......................................................................................... 60
9.2.24 Subscribing to notications ......................................................................................................... 61
9.2.25 Using Web Socket ...................................................................................................................... 64
9.2.26 MQTT support ............................................................................................................................ 66
9.2.27 Using the IoT-Core Visualizer ..................................................................................................... 70
9.3 EtherNet/IP ......................................................................................................................... 77
9.3.1 Registration of the EDS le ........................................................................................................ 77
9.3.2 Integrate the IO-Link Master into the EtherNet/IP project ........................................................... 77
9.3.3 Set connection types and RPI .................................................................................................... 78
9.3.4 Congure AL1323 ......................................................................................................................79
9.3.5 Congure IO-Link ports .............................................................................................................. 80
9.3.6 Congure IO-Link devices .......................................................................................................... 81
9.3.7 Read process data ..................................................................................................................... 82
9.3.8 Write process data .....................................................................................................................82
9.3.9 Read diagnostic and status information .....................................................................................83
9.3.10 EtherNet/IP: Programmers' notes ............................................................................................... 84
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
4
10 86 Operation
10.1 Using web-based management ......................................................................................... 86
11 87 Maintenance, repair and disposal
11.1 Cleaning process ............................................................................................................... 87
11.2 Updating the rmware ........................................................................................................ 87
11.3 Replacing IO-Link device ................................................................................................... 87
12 88 Factory settings
13 89 Accessories
14 90 Appendix
14.1 Technical data .................................................................................................................... 91
14.1.1 Application .................................................................................................................................. 91
14.1.2 Electrical data ............................................................................................................................. 91
14.1.3 Inputs / outputs ........................................................................................................................... 91
14.1.4 Inputs .........................................................................................................................................92
14.1.5 Outputs ....................................................................................................................................... 92
14.1.6 Interfaces .................................................................................................................................... 92
14.1.7 Operating conditions ..................................................................................................................93
14.1.8 Approvals / tests ......................................................................................................................... 93
14.1.9 Mechanical data ......................................................................................................................... 93
14.1.10 Electrical connection ..................................................................................................................94
14.2 EtherNet/IP ......................................................................................................................... 95
14.2.1 Supported connection types ....................................................................................................... 95
14.2.2 Parameter data ........................................................................................................................... 96
14.2.3 Cyclic data .................................................................................................................................. 99
14.2.4 Acyclic data .............................................................................................................................. 110
14.3 ifm IoT Core .....................................................................................................................145
14.3.1 Overview: IoT prole ................................................................................................................146
14.3.2 Overview: IoT types .................................................................................................................. 153
14.3.3 Overview: IoT services ............................................................................................................. 154
15 168 Index
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
5
1 Preliminary note
Content
Legal and copyright information ............................................................................................................... 5
Purpose of the document ......................................................................................................................... 5
Explanation of Symbols ............................................................................................................................ 5
Change 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:
• -i is the property of the AS-International Association, ( AS →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 CODESYS 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 Beckho Automation
GmbH, Germany
• -LinkIO ® 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.probus.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- nk master - EtherNet/IP gateway (DataLine) 8 port IP 65 / Li
IP 66 / IP 67 / IP 69K" (art. no.: AL1323).
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.
>
1.3 Explanation of Symbols
34171
WARNING
Warning of serious personal injury.
Death or serious irreversible injuries may result.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
6
CAUTION
Warning of personaly injury.
Slight reversible injuries may result.
NOTICE
Warning of damage to property
Important note
Non-compliance can result in malfunction or interference
Information
Supplementary note
► ...
Request for action
> ...
Reaction, result
→ ...
"see"
abc
Cross-reference
123
0x123
0b010
Decimal number
Hexadecimal number
Binary number
[...]
Designation of pushbuttons, buttons or indications
>
1.4 Change history
61118
Version
Topic
Date
00
New creation of the document
04 / 2019
01
Correction: Technical data - current rating per output
09 / 2019
02
▪ Added: New IoT core functions
▪ Added: IoT Core Visualizer
▪ Correction: Description of the IoT Core Service getsubscriptioninfo
10 / 2020
03
Deleted: ifm IoT Core DNS support –
10 / 2021
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
7
2 Safety instructions
Content
General ..................................................................................................................................................... 7
Required background knowledge ............................................................................................................. 7
Safety symbols on the device ................................................................................................................... 7
IT security ................................................................................................................................................. 8
28333
>
2.1 General
58525
• The device described is a subcomponent for integration into a system. The manufacturer is
responsible for the safety of the system. The system manufacturer undertakes to perform a risk
assessment and to create documentation in accordance with legal and normative requirements to
be provided to the operator and user of the system. This documentation must contain all
necessary information and safety instructions for the operator, the user and, if applicable, for any
service personnel authorised by the manufacturer of the system.
• Read this document before setting up the product and keep it during the entire service life.
• The product must be suitable for the corresponding applications and environmental conditions
without any restrictions.
• Only use the product for its intended purpose ( →Functions and features ( →p. 9)).
• If the operating instructions or the technical data are not adhered to, personal injury and/or
damage to property may occur.
• The manufacturer assumes no liability or warranty for any consequences caused by tampering
with the product or incorrect use by the operator.
• Installation, electrical connection, set-up, programming, conguration, operation and maintenance
of the product must be carried out by personnel qualied and authorised for the respective activity.
• Protect units and cables against damage.
>
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 ( →p. 14))!
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
8
2.4 IT security
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).
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
10
4 Function
Content
Communication, parameter setting, evaluation ...................................................................................... 11
Digital inputs ........................................................................................................................................... 12
IO-Link supply ......................................................................................................................................... 12
33836
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
11
4.1 Communication, parameter setting, evaluation
Content
IO-Link .................................................................................................................................................... 11
EtherNet/IP ............................................................................................................................................. 11
Internet of Things (IoT) ........................................................................................................................... 11
Security mode ......................................................................................................................................... 12
Parameter setting ................................................................................................................................... 12
Visual indication ...................................................................................................................................... 12
33860
>
4.1.1 -Link IO
34084
The device oers the following IO-Link functions:
• -Link master (IO-Link revision 1.0 and 1.1) IO
• 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 oers 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
• Predened 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 le
>
4.1.3 Internet of Things (IoT)
54679
The device oers 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
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
12
• Supported protocols: TCP/IP JSON, MQTT
>
4.1.4 Security mode
54697
The IoT interface oers the following optional sercurity functions:
• Secure data transfer via encrypted connection (Secure Layer Transport - TLS)
• Access protection via authentication
>
4.1.5 Parameter setting
34210
The device provides the following conguration options:
• Parameter setting of the IO-Link master of the AL1323 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
>
4.2 Digital inputs
33817
The device has 8 additional digital inputs (type 2 according to EN 61131-2).
The digital inputs are on pin 2 of the ports X01...X04.
All inputs refer to the potential of the device supply (pin 3).
>
4.3 -Link supply IO
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 re 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).
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
13
5 Mounting
Content
Mount the device .................................................................................................................................... 13
34058
>
5.1 Mount the device
34059
► Disconnect the system from power before installation.
► For installation choose a at mounting surface.
► Please observe the maximum tightening torque.
► the unit to the mounting surface using 2 M5 mounting screws and washers. Fix
▪ Tightening torque: 1.8 Nm
► Ground the unit via the two mounting screws of the upper mounting lugs.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
14
6 Electrical connection
Content
Notes ...................................................................................................................................................... 14
Connecting the EtherNet/IP ports ........................................................................................................... 15
Connecting the IoT port .......................................................................................................................... 15
IO-Link ports ........................................................................................................................................... 16
Connecting the device ............................................................................................................................ 17
33805
>
6.1 Notes
51957
A qualied electrician must connect the unit.
► The national and international for regulations setting up electrical equipment must be
complied with.
The unit is only suitable for operation using SELV/PELV voltages.
► Please note the information concerning IO-Link wiring!
This unit contains components that may be damaged or destroyed by electrostatic discharge
(ESD).
► Please observe the required precautions against electrostatic discharge!
The M12 connection parts in the device comply with the ingress resistance requirements of
the standard EN 61076-2-101. To adhere to the protection rating, only cables certied to this
standard must be used. The system creators undertake to ensure ingress resistance for
cables which they cut to length themselves.
► Carry out the tting according to the indications of the cable manufacturer. A maximum of
0.8 Nm is permitted.
► During installation, place the M12 connector vertically so that the coupling nut will not
damage the thread.
► Depending on the mounting conditions, cables must be provided with a strain relief to
avoid unacceptable loads on the mounting points and M12 connections.
► Make sure that the M12 connection parts are correctly seated and mounted correctly. The
specied protection rating can not be guaranteed if this is not observed.
For UL applications:
► To connect the IO-Link master and the IO-Link devices, only use UL-certied cables of the
CYJV or PVVA category with a minimum temperature of 80 °C (75 °C in case of maximum
ambient temperature of 40 °C).
Wiring: ( ) →Technical data →p. 91
By means of basic insulation according to EN61010-1, the circuits are separated from each other and
from device surfaces that could be touched (secondary circuit with 28 V DC maximum, supplied from
mains circuit up to 300 V overvoltage category II).
By means of basic insulation according to EN61010-1, the communication interfaces are separated
from each other and from device surfaces that could be touched (secondary circuit with 28 V DC
maximum, supplied from mains circuit up to 300 V overvoltage category II). They are designed for
network environment 0 according to IEC TR62102.
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
15
6.2 Connecting the EtherNet/IP ports
33671
► Connect the device via the M12 socket X21 and/or X22 to the
EtherNet/IP network
(e.g. EtherNet/IP PLC, additional EtherNet/IP device)
► To connect the devices, use M12 connectors with protection rating
IP 65 / IP 66 / IP 67 / IP 69K or higher ( ( →Accessories →p. 89)).
► Cover the unused sockets with M12 protective caps (art no.
E12542).
>
6.3 Connecting the IoT port
34044
► Connect the device via the M12 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
software capable of processing http requests).
► To connect the devices, use M12 connectors with protection rating
IP 65 / IP 66 / IP 67 / IP 69K or higher ( ( →Accessories →p. 89)).
► Cover the unused sockets with M12 protective caps (art no.
E12542)
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
16
6.4 -Link ports IO
51958
The IO-Link ports of the AL1323 meet the requirements of the IO-Link specications 1.0 to 1.1.2.
► Please note the information concerning IO-Link wiring!
► Cover unused sockets with M12 protective caps (art. no.: E12542 ).
>
6.4.1 Connecting IO-Link devices for Class A operation
51959
Wiring information:
• The connected IO-Link devices must be supplied exclusively via the IO-Link master.
• The additional digital inputs IO-Link ports X01...X08 (pin 2) have a type 2 behaviour according to
the standard EN61131-2. The connected electronics must be electrically suited for this.
► Connect the connectors of the IO-Link devices with the M12
sockets of the IO-Link ports X01...X08.
▪ Maximum cable length per IO-Link port: 20 m
► To connect the devices, use M12 connectors with protection
rating IP 65 / IP 66 / IP 67 / IP 69K or higher ( →Accessories
( )). →p. 89
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
17
6.5 Connecting the device
33882
► Disconnect power.
► Connect the IO-Link Master via M12 socket X31 to 24 V DC
(20...28 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).
▪ Maximum cable length: 25 m
► To connect the device, use M12 connectors with protection rating IP
65 / IP 66 / IP 67 / IP 69K or higher ( ( →Accessories →p. 89)).
When using cable length greater than 25 m keep in mind the voltage drop as well as the
required minimum voltage supply of 20 V!
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
18
7 Operating and display elements
Content
Overview ................................................................................................................................................. 18
LED indicators ........................................................................................................................................ 19
34063
>
7.1 Overview
34356
1
RDY, NET and MOD status LEDs
→ → (Status LEDs ) p. 19
2
LNK and ACT status LEDs of the EtherNet/IP
interfaces 1 (X21) and 2 (X22)
→ → (Ethernet ports ) p. 19
3
LNK, ACT status-LEDs and IoT LED of the IoT
interface (X23)
→ → (IoT port ) p. 20
4
IOL and DI status-LEDs of the IO-Link port (X01...X08)
→ → (IO-Link Ports (Class A) p. 20)
5
PWR status LED of the voltage supply (X31)
→ → (Voltage supply p. 20)
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
19
>
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
ashes 5 Hz
Status: Error
ashes (200 ms on,
800 ms o)
Status: Firmware update is running
off
Status: Gateway not running or gateway booting
NET
green / red
off
Not powered or powered, but IP address not yet configured
ashes
Device self-testing
green
ashes
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
ashes
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
ashes
Device self-testing
green
ashes
Standby: device not yet congured (no IP address)
on
Operational
red
ashes
Major recoverable fault (e.g. incorrect conguration)
on
Major unrecoverable fault (e.g. module failed)
>
7.2.2 Ethernet ports
34348
Each Ethernet port 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
ashes
Data is transmitted via the Ethernet interface.
off
No data transmission
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
20
7.2.3 IoT port
34043
The IoT port has the 3 LNK, ACT and IoT LEDs. The LEDs indicate the status of the Ethernet
connection and the device identication.
Status LED
Description
LNK
green
on
Ethernet connection established
off
No Ethernet connection
ACT
yellow
ashes
Data is transmitted via the Ethernet interface.
off
No data transmission
IoT
green
flashes
Device identication active
>
7.2.4 Voltage supply
34191
The interface for voltage supply (X31) has the LED that is marked as US. The LED indicates the status
of the voltage supply.
Status LED
Description
US
green
on
The supply voltage Us is applied.
off
No supply voltage is applied or the applied supply voltage is too low.
>
7.2.5 -Link Ports (Class A) IO
34074
Each IO-Link Port Class A has 2 LEDs labelled IOL and DI. The LEDs indicate the status of the
IO-Link port.
Status LED
Description
IOL
yellow
O
Port congured as DI/DO: pin 4 (C/Q) = OFF
on
Port congured as DI/DO: pin 4 (C/Q) =ON
green
ashing 1 Hz
Port congured asIO-Link: no IO-Link device found
Flashing with 2 Hz
Port congured asIO-Link: Status PREOPERATE
on
Port congured asIO-Link: Status OPERATE
red
Flashing with 2 Hz
Port conguration error or short circuit / overload on US
on
Transmission Error
DI
yellow
O
Digital input: pin 2 = OFF
on
Digital input: pin 2 = ON
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
21
8 Set- up
52357
When the supply voltage is switched on, the AL1323 starts with the factory settings. The display
elements signal the current operating mode ( →Operating and display elements ( )). →p. 18
To enable parameter setting of the AL1323, the IoT interface and / or the eldbus interface must be
congured according to the network environment.
► Congure IoT interface (LR DEVICE: →IoT: Congure IP settings IoT: ( ) or →p. 24 →
Conguring IP settings ( →p. 45)).
► Congure eldbus interface (LR DEVICE: →Fieldbus: Congure IP settings ( →p. 28) or IoT:
→ Feldbus-Schnittstelle kongurieren).
> IoT / eldbus interface has valid IP settings.
> User can set the parameters of the AL1323.
Further steps:
• Optional: Update rmware of AL1323 ( →Updating the rmware ( )). →p. 87
• Set the parameters of the AL1323 ( ( )). →Conguration →p. 22
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
22
9 Conguration
Content
LR DEVICE ............................................................................................................................................. 23
ifm IoT Core ............................................................................................................................................ 36
EtherNet/IP ............................................................................................................................................. 77
33858
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
23
9.1 LR DEVICE
Content
Remarks ................................................................................................................................................. 24
IoT: Congure IP settings ....................................................................................................................... 24
IoT: Congure security mode ................................................................................................................. 25
IoT: Conguring access rights ................................................................................................................ 26
IoT: Congure the interface to LR AGENT or LR SMARTOBSERVER ................................................. 27
Fieldbus: Congure IP settings .............................................................................................................. 28
Fieldbus: set the conguration mode ..................................................................................................... 29
IO-Link ports: Activate data transfer to LR AGENT or LR SMARTOBSERVER .................................. 30
IO-Link ports: Congure operating mode ............................................................................................... 31
IO-Link ports: Set the device validation and data storage ...................................................................... 32
IO- nk ports: Setting fail-safe values Li ................................................................................................... 33
Info: Show device information ................................................................................................................ 33
Firmware: Reset device to factory settings ............................................................................................ 34
Firmware: Reboot the device.................................................................................................................. 34
Congure IO-Link devices ...................................................................................................................... 35
33692
On delivery, the AL1323 is congured with the factory settings ( ( )). →Factory settings →p. 88
Required software: LR DEVICE (1.5.0.x or higher) (art.-no.: QA0011/QA0012)
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
24
9.1.1 Remarks
Content
Oine parameter setting ........................................................................................................................ 24
VPN connection ...................................................................................................................................... 24
34180
>
Offline parameter setting
34060
The AL1323 supports the ofine parameter setting. In this context, the user creates and stores a
conguration for the IO-Link master and the connected IO-Link devices without being connected to the
AL1323 (OFFLINE mode). The configuration created in this way can be stored as a le (*.lrp) and
loaded to the AL1323 and activated at a later date.
Further information about oine 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 AL1323.
► Deactivate the VPN connection in order to be able to access the AL1323 with the LR
DEVICE.
>
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 congure 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 Zerocong protocol (address range: ( →Factory settings →p. 88)).
To congure 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
device
[Static IP]
IP settings were set by the user
[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 rmly set.
* ... can only be edited if parameter [DHCP] = [Static IP]
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
25
► Save changed values on the device.
>
9.1.3 IoT: Configure security mode
54680
The IoT interface of the IO-Link oers 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 congure 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 conrm 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 restarting the LR DEVICE).
To change the set password:
► Sign in with a valid password.
► Enter the new password in the eld [Security password].
► Write changes to the device.
> The new password is set.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
26
>
9.1.4 IoT: Configuring 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
parameter data, process data
and the event/diagnostic
messages of the IO-Link master
as well as the connected IO-Link
devices
[EtherNet/IP + IoT]*
▪ EtherNet/IP and IoT Core have read
and write access rights to parameters
and process data
▪ EtherNet/IP and IoT Core have read
access rights to events/alarms
[EtherNet/IP + IoT
(read-only)]
▪ EtherNet/IP has read and write access
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
* ... Factory setting
► Save changed values on the device.
If in LR DEVICE and EtherNet/IP projection software the parameter [Access Rights] is =
[EtherNet/IP + IoT], the parameter values set in the EtherNet/IP projection software will always
apply.
If the parameter [Access Rights] in LR DEVICE is = [IoT only], set the parameter [Access
Rights] = [Keep settings] in the EtherNet/IP projection software.
If the parameter [Access Rigts] in LR DEVICE is = [<Fieldbus> + IoT (read-only)], write access
to the device configuration via LR DEVICE and IoT core services is blocked. To enable write
access again, set the parameter to [<Fieldbus> + IoT] via fieldbus configuration software.
Changes of the parameter [Access Rights] will only be effective after restarting the IO-Link
master ( → Firmware: Reboot the device ( )). → p. 34
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
27
>
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
SMARTOBSERVER]
IP address of LR AGENT or
LR SMARTOBSERVER
Factory setting: 255.255.255.255
[Port LR Agent or
SMARTOBSERVER]
Port number that is used to send process data
to LR AGENT or LR SMARTOBSERVER
0
...
65535
Factory setting:: 35100
[Interval LR Agent or
SMARTOBSERVER]
Cycle time for the transfer of the process data to
LR AGENT or LR SMARTOBSERVER (value in
milliseconds)
[Off]
no transfer
500
...
2147483647
500 ms
...
2147483647 ms
[Application Tag]
Source identifier of the IO-Link master in the
structure of LR AGENT or
LR SMARTOBSERVER (String32)
Factory setting: AL1323
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.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
28
>
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.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
29
>
9.1.7 Fieldbus: set the configuration mode
54693
The AL1323 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 AL1323
[Process data length]*
Length of process data per IO-Link
port
2 bytes input 2 bytes
output
2 bytes input data, 2 bytes output
data
4 bytes input 4 bytes
output
4 bytes input data, 4 bytes output
data
8 bytes input 8 bytes
output
8 bytes input data, 8 bytes output
data
16 bytes input 16 bytes
output
16 bytes input data, 16 bytes output
data
32 bytes input 32 bytes
output
32 bytes input data, 32 bytes output
data
[Swap]*
Sequence of bytes in the data
word
off
as Array of Bytes
on
as Integer16 value; during an
update of the process data, the
bytes are exchanged
[Explicitpdmode]**
Enable / disable explicit PD mode
and select the process data to be
transmitted (connection types)
Explicit process data
mode off
Explicit PD mode disabled
Explicit process data
mode with IO-Link I/O +
Acyclic + Diag
Explicit PD mode enabled: IO-Link
inputs /outputs, acyclic data and
diagnostic data are transmitted
Explicit process data
mode with IO-Link I/O +
Acyclic
Explicit PD mode enabled: IO-Link
inputs/outputs and acyclic data are
transmitted
Explicit process data
mode with IO-Link I/O
Explicit PD mode enabled: IO-Link
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.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
30
>
9.1.8 -Link ports: Activate data transfer to LR AGENT or IO
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 ENT or LR SMARTOBSERVER. AG
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 ( → p. 27)).
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
Agent
or SMARTOBSERVER]
Transfer of process data of the connected
IO-Link device to LR AGENT oder
LR SMARTOBSERVER
[Disabled]
Transfer process data
[Enabled]
Don't transfer process data
► Save changed values on the device.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
31
>
9.1.9 -Link ports: Configure operating mode IO
33694
The IO-Link ports X01...X08 of the device support the following operating modes:
• Disabled: no data transfer at pin 4 (C/Q) of the IO- nk port Li
• Digital input (DI): binary input signal at pin 4 (C/Q) of the IO-Link port
• Digital output (DO): binary output signal at pin 4 (C/Q) of the IO-Link port
• -Link: IO-Link data transfer via pin 4 (C/Q) of the IO-Link port IO
The user can set the operating mode separately for each -Link port. IO
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 Pin4 US]
Operating mode of pin 4 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
IO IO-Link master and -Link device on the port
(value in microseconds)
Parameter can only be read
[Cycle time preset]*
Cycle time of the data transfer between the IO-Link
master and the IO-Link device at the port (value in
microseconds)
0
The device matically sets auto
the fastest possible cycle time.
1
...
132800
1 microsecond
...
132800 microseconds
[Bitrate]**
Current transmission rate of the data transfer
between the IO-Link master and the IO-Link device
on the port
Parameter can only be read
* ... 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.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
32
>
9.1.10 -Link ports: Set the device validation and data storage IO
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
device
Storage of the parameter values
Recovery of the parameter
values
[No check and clear]
no
no
no
[Type compatible
V1.0 device]
yes, test the compatibility with
IO-Link standard V1.0
no
no
[Type compatible
V1.1 device]
yes, test the compatibility with
IO-Link standard V1.1
no
no
[Type compatible
V1.1 device with
Backup + Restore]
yes, test the compatibility with
IO-Link standard V1.1 and
identity of design (vendor ID
and device ID)
yes, automatic storage of the
parameter values; changes of the
current parameter values will be
stored
yes, recovery of the parameter
values when connecting an
identical IO-Link device with
factory settings
[Type compatible
V1.1 device with
Restore]
yes, test the compatibility with
IO-Link standard V1.1 and
identity of design (vendor ID
and device ID)
no, there is no automatic storage
changes of the current parameter
values will not be stored
yes, recovery of the parameter
values when connecting an
identical IO-Link device with
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 -Link IO
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
Storage]
Supported IO-Link standard and behaviour of the
IO-Link master when connecting a new IO-Link
device at port x (x = 1...8)
[No check and clear]
[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 that i-Link device s to be validated
0...16777215
Factory setting: 0
► Save changed values on the device.
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
33
9.1.11 -Link ports: Setting fail-safe values IO
34329
For the configuration mode "Independent" the user can set fail-safe values for the outputs of IO-Link
ports. 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
"Digital Output (DO)"
[Reset]
OFF
[Old]
old value
[Set]
ON
[Fail-safe IO-Link]*
Fail-safe value of ting mode the output for opera
"IO-Link"
[Off]
no Fail-safe
[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
AL1323
[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
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
34
>
9.1.13 Firmware: Reset device to factory settings
33838
When the -Link master is reset, all parameters are set to the factory settings: IO
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 AL1323:
► 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.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
35
>
9.1.15 Configure IO-Link devices
33856
To configure the IO-Link devices connected to the device with the LR DEVICEparameter setting
software:
Requirements:
> IO-Link master is correctly installed and connected to the LR DEVICE parameter setting software.
> The IO-Link device is connected correctly with the AL1323.
> Operating mode of the IO-Link port is "IO-Link" ( → IO-Link ports: Configure operating mode
( )). → p. 31
> IoT has write access rights to the IO-Link master ( → IoT: Configuring access rights ( → p. 26)).
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 -Link master. IO
> 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) des IO-Link Devices
► Save the changed configuration on the IO-Link device.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
36
9.2 ifm IoT Core
Content
Programmers' notes ............................................................................................................................... 37
First steps ..............................................................................................................................................40
General functions ................................................................................................................................... 41
IoT: Configuring access rights ................................................................................................................ 45
IoT: Configuring IP settings .................................................................................................................... 45
IoT: Configuring the LR AGENT or LR SMARTOBSERVER interface .................................................. 46
IoT: Configuring security mode ..............................................................................................................46
Fieldbus: Configuring IP settings ............................................................................................................ 49
Fieldbus: Selecting the configuration mode ........................................................................................... 49
Fieldbus: Setting fail-safe values ............................................................................................................ 50
IO-Link ports: Setting the operating mode of pin 4 (US) ........................................................................ 50
IO-Link ports: Configuring device validation and data storage ............................................................... 50
IO-Link ports: Configuring data transfer to LR AGENT or LR SMARTOBSERVER .............................. 52
IO-Link ports: Reading / writing process data ........................................................................................ 52
IO-Link ports: Indicating port events ....................................................................................................... 55
IO-Link devices: Accessing parameters ................................................................................................. 55
IO-Link devices: Reading an writing device information ........................................................................ 57
IO-Link devices: Indicating IO-Link events ............................................................................................. 57
Gateway: Resetting, rebooting and localising the device ....................................................................... 57
Gateway: Reading device information .................................................................................................... 58
Gateway: Reading status and diagnostic information ............................................................................ 58
Gateway: Updating the firmware ............................................................................................................ 59
Gateway: Setting the application tag .................................................................................................... 60
Subscribing to notifications ..................................................................................................................... 61
Using Web Socket .................................................................................................................................. 64
MQTT support ........................................................................................................................................ 66
Using the IoT-Core Visualizer ................................................................................................................ 70
52244
General notes on the ifm IoT Core: ( ) → Programmers' notes → p. 37
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
37
9.2.1 Programmers' notes
Content
IoT Core: General information ................................................................................................................ 37
Access the ifm IoT Core ......................................................................................................................... 38
IoT Core: Diagnostic codes .................................................................................................................... 40
34229
>
IoT Core: General information
52256
The DataLine device family has an IoT Core. The IoT Core allows the user to address the AL1323
from IT networks via a REST API and to integrate it into Internet- -Things applications. of
A device description is stored on the AL1323. 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.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
38
>
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 →p. 40))
>
Example: GET request
54033
Request (via browser):
http://192.168.0.250/devicetag/applicationtag/getdata
Response:
{
"cid":-1,
"data":{"value":"AL1323"},
"code":200
}
>
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,
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
39
"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; ID freely assignable by the user
adr
data_point
Data point of the element tree which is to be accessed
service
Service to be performed ( ( → Overview: IoT services → p. 154))
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 → p. 40))
* = optional; only required for services, that receive data from the IoT core (e.g. getdata)
>
Example: POST request
54035
Request:
{
"code":"request",
"cid":4711,
"adr":"devicetag/applicationtag/getdata"
}
Response:
{
"cid":4711,
"data":{"value":"AL1323"},
"code":200
}
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
40
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 (Master cycle time)
233
IP settings (of IoT-Port) have been updated.
Application needs to reload device. Wait at least
1 second before reloading device.
IP settings have been successfully changed, IO-Link master will be
reloaded; wait for at least 1 second
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. -Link port in wrong operating g. IO
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 while setting data, because IO-Link master is still connected
to fieldbus PLC
>
9.2.2 First steps
52245
To read the device description of the AL1323:
► Send the following POST request to the AL1323:
{"code":"request","cid":-1,"adr":"gettree"}
> AL1323 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.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
41
>
9.2.3 General functions
61148
The AL1323 has the type device ( ( )). →Overview: IoT types →p. 153
The following services can be used on the root element of the type : device
Service
Description
../gettree
Provide the complete tree or subtree of the device description (JSON)
../getidentity
Reading device information
../getdatamulti
Reading several parameter values sequentially
../getelementinfo
Reading detailed information of an element
../getsubscriberlist
Print a list of all active notification subscriptions
../querytree
Search device description for specific elements
Depending on the read and write access rights, the following services can be applied to elements of
type : data
Service
Description
../getdata
Reading the value of the element
../setdata
Write the value of the element
>
Example: Reading properties of an element
59782
Task: Determine the data type and value range of the accessrights parameter.
Solution: Read the properties of the element of the getelementinfo service. iotsetup/accessrights
The fields type (data type) and valuation (range of values) contain the required information.
• Request:
{
"code":"request",
"cid":4711,
"adr":"getelementinfo",
"data":{"adr":"iotsetup/accessrights"}
}
• Response:
{
"cid":4711,
"data":{
"identifier":"accessrights",
"type":"data",
"uid":null,
"profiles":["parameter"],
"format":{
"type":"enum",
"namespace":"json",
"encoding":"integer",
"valuation":{
"valuelist":{
"0":"Fieldbus + IoT",
"1":"Fieldbus + IoT (read-only)",
"3":"IoT only"}}}},
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
42
"code":200
}
The accessrights parameter has the data type ENUM with the valid values "Fieldbus + IoT", "Fieldbus
+ IoT (read only)" and "IoT only".
>
Example: output subtree
61149
Task: Output all direct sub-elements of the node . firmware
Solution: Use the service gettree to output the required subtree (root node: rmware, sub-levels to be
shown: 1)
• Request:
{
"code":"request",
"cid":4711,
"adr":"gettree",
"data":{
"adr":"firmware",
"level":1}
}
• Response:
{
"cid":4711,
"data":{
"identifier":"firmware",
"type":"structure",
"profiles":[
"software","software/uploadablesoftware"],
"subs":[
{
"identifier":"version","type":"data","profiles":["parameter"],
"format":{"type":"string","namespace":"json","encoding":"UTF-8"}},
{
"identifier":"type","type":"data",
"format":{"type":"string","namespace":"json","encoding":"UTF-8"}},
{
"identifier":"install","type":"service"},
{
"identifier":"factoryreset","type":"service"},
{
"identifier":"signal","type":"service"},
{
"identifier":"container","type":"data",
"format":{"type":"binary","namespace":"json","encoding":"base64"}},
{
"identifier":"reboot","type":"service"}]
},
"code":200
}
>
Example: Read several parameter values of the IO-Link master simultaneously
33840
Task: The following current values are to be read by the IO- nk master: temperature, serial number Li
Solution: Read the current parameter values using the getdatamulti service (data point temperature:
/processdatamaster/temperature; data point serial number: /deviceinfo/serialnumber)
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
43
• 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
}
>
Example: Browsing device description
61150
Task: List all elements with the designation "status" and the prole "runcontrol".
Solution: Use the service querytree to browse the device description with the parameters "status"
(name) and "runcorntrol" (prole)
• Request:
{
"cid":4711,
"adr":"querytree",
"code": request","
"data":{
"profile":"runcontrol",
"name":"status"}
}
• Response:
{
"cid":4711,
"data":{
"adrList":[
"device/connections/mqttConnection/status",
"device/connections/mqttConnection/mqttCmdChannel/status"]},
"code":200
}
>
Setting the storage duration
61153
The IoT Core oers the possibility to set the storage duration of data and notications. The Services
Service: setdata ( ) and ( →p. 164 Service: subscribe →p. ) therefore have the parameter 166
"duration".
>
Example: Subscribing to notications
61154
Task: The current values of the following parameters are to be sent regularly to a network server with
IP address 192.168.0.4:
• Product name of the IO-Link Devices an IO-Link port X02
• Cyclic input data of the IO-Link Devices an IO-Link port X02
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
44
• Operating temperature of the IO-Link master.
The subscription is only to be active until the next restart 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.4:80/temp",
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/productname",
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/temperature"],
"duration":"uptime"}
}
• Response:
{
"cid":4711,
"code":200
}
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
45
>
9.2.4 IoT: Configuring access rights
59785
Substructure: iotsetup
Available data points:
Name
Description
Access
../accessrights
Access rights to the IO-Link master
rw
rw ... read and write
If in IoT and EtherNet/IP projection software the parameter [Access Rights] is = [EtherNet/IP +
IoT], the parameter values set in the EtherNet/IP projection software will always apply.
If in IoT the parameter [Access Rights] is = [IoT only], set the parameter [Access Rights] =
[Keep settings] in the EtherNet/IP projection software.
If in LR DEVICE the parameter [Access Rigts] is = [EtherCAT + IoT (read-only)], write access
to the device conguration via LR DEVICE and IoT core services is blocked. To enable write
access again, set the parameter to [EtherCAT + IoT] via eldbus conguration software.
Changes of the parameter [Access Rights] will only be eective after restarting the IO-Link
master ( →Firmware: Reboot the device ( )). →p. 34
>
9.2.5 IoT: Configuring IP settings
61155
Substructure: iotsetup
Available data points:
Name
Description
Access
../network/dhcp
Conguration 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 blockwise
Change the IP parameters in the substructure network only blockwise with the setblock
service!
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
46
>
9.2.6 IoT: Configuring the LR AGENT or LR SMARTOBSERVER interface
59786
Substructure: iotsetup
Avalable data points:
Name
Description
Access
../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
milliseconds)
rw
rw ... read and write
>
9.2.7 IoT: Configuring security mode
54683
The access to the IoT interface of the IO-Link master can be protected with a security mode:
Substructure: 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 ( →Servicet:
getidentity ( )). →p. 157
For the authentication, the user must additionally provide the POST requests with a valid user name
and password in the eld "auth". The user name and the password will be shown as Base64-coded
character strings ( →Example: Request with authentication ( →p. 47)).
The following requests can be done if the security mode is enabled, also without authentication:
• /getidentity
• /deviceinfo/vendor/getdata
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
47
• /deviceinfo/productcode/getda ta
>
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
}
>
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:
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
48
{
"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 elds "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
}
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
49
>
9.2.8 Fieldbus: Configuring IP settings
59783
Substructure: fieldbussetup
Available data points:
Name
Description
Access
../hostname
Name of the IO-Link master in the eldbus project
rw
../eldbusrmware
Firmware version of the IO-Link master
r
../network/macaddress
MAC address of the eldbus port
r
../network/ipaddress
IP address of the eldbus port
rw*
../network/subnetmask
Subnet mask of the network segment
rw*
../network/ipdefaultgateway
IP address of the network gateway
rw*
../network/dhcp
Conguration of the IP settings of the eldbus interface
rw
../connectionstatus
Status of the connection to the EtherNet/IP network
r
r ... read only
rw ... read and write
* ... only changeable, if the EtherNet/IP controller is not in RUNNING state
Applicable services:
Name
Description
../network/setblock
Write all values of the substructure at once
Change the IP parameters in the substructure only blockwise by using the service network
setblock!
>
9.2.9 Fieldbus: Selecting the configuration mode
52486
Substructure: fieldbussetup/configuration
Available data points:
Name
Description
Access
../in dependentmode
Set the conguration mode (Top-down, Independent)
r/w*
../explicitpdmode
Connection types
r/w*
../processdataconguration
Length of the process input data and process output data
rw*
../conguration/swap
Byte order of process data
r/w*
rw ... read and write
* ... only changeable, if the EtherNet/IP controller is not in RUNNING stated
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
50
>
9.2.10 Fieldbus: Setting fail-safe values
61120
Substructure: fieldbussetup/configuration/port[n] ( )n = 1...8
Available data points:
Name
Description
Access
../failsafedigitalout
Fail-safe value for the digital output - pin 4 (DO)
rw*
../failsafeiolink
Fail-safe value for IO-Link output data - pin 4 (IO-Link)
rw*
rw ... read and write
* ... can only be changed if EtherNet/IP PLC is not in RUNNING state
>
9.2.11 -Link ports: Setting the operating mode of pin 4 (US) IO
59793
Substructure: iolinkmaster/port[n] (n = 1...8).
Available data points:
Name
Description
Access
../mode
Operating mode of the IO-Link port
rw*
../mastercycletime_preset
Cycle time of the data transfer at the IO-Link port (value in ms)
rw*
../mastercycletime_actual
Current cycle time of the data transfer at the IO-Link port (value in ms)
r
../comspe ed
Data transfer rate of the IO-Link port
r
r ... read only
rw ... read and write
* ... only changeable, if the <Feldsbus> plc is not in RUNNING state
>
9.2.12 -Link ports: Configuring device validation and data storage IO
59792
Substructure: iolinkmaster/port[n] (n = 1...8).
Available data points:
Name
Description
Access
../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
Structure for port data storage
rw
../datastorage/maxsize
Maximum size of the data storage content (in bytes)
r
../datastorage/chunksize
Size of a data segment (in bytes)
r
../datastorage/size
Size of the data storage content (in bytes)
r
r ... read only
rw ... read and write
* ... can only be changed if the EtherNet/IP PLC is not in RUNNING state
Applicable services:
Service
Description
../validation_useconnecteddevice
Validate the IO-Link device connected to the IO-Link port*
../datastorage/getblobdata
Reading the content of the data storage area
../datastorage/stream_set
Transfer an individual data segment*
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
51
../datastorage/start_stream_set
Start sequential transmission of several data segments*
* ... can only be changed if the EtherNet/IP PLC is not in the RUNNING state
>
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 rst step, the Data Storage of the IO-Link
port of -Link master 1 is saved. In the second step, the saved data is restored at the Data Storage of IO
port IO-Link port of -Link master 2. IO
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..."}
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
52
>
9.2.13 -Link ports: Configuring data transfer to LR AGENT or LR IO
SMARTOBSERVER
59795
Substructure: iolinkmaster/port[n] (n = 1...8).
Available data points:
Name
Description
Access
../senddatatosmob
Process data to LR AGENT or LR SMARTOBSERVER
rw
rw ... read and write
>
9.2.14 -Link ports: Reading / writing process data IO
61156
Substructure: iolinkmaster/port[n] (n = 1...8)
Available data points:
Name
Description
Access
../pin2in
Value -Link port of the digital input on pin 2 of the IO
r
../iolinkdevice/pdin
Value of the -Link input on pin 4 of the IO-Link port IO
r
../iolinkdevice/pdout
Value of the IO-Link output on pin 4 of the IO-Link port
rw*
r ... read only
rw ... read and write
*... can only be changed if the eldbus PLC is not in RUNNING state
>
Example: Read IO-Link process data (operating mode "IO-Link")
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 service. getdata
• 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 = 0b 1111001001
Temperature value: 0b11110010 = 242
Therefore: The current temperature value is 24.2 °C.
>
Example: Writing IO-Link value (operating mode "IO-Link")
59804
Task: Switch on the buzzer of DV2500 at IO-Link Port X2. The DV2500 operates in On/O mode.
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
53
Solution: The IODD of the DV2500 shows the structure of the IO-Link process value ( e.g. LED →
activity). The buzzer will be switched using bit 40 of the process value (OFF = 0, ON = 1).
To switch the buzzer:
1. Read the current process value ( →Example: Read IO-Link process data (operating mode
"IO-Link") ( →p. 52)).
2. t bit 40 of the read value to 1. Se
3. Write the process value to the IO-Link device.
Example:
Read process value:
0x0000 0000 004D = 0b0000 0000 0000 0000 0000 0000 0 0000 1101 0000 000 0000 0100
New process value:
0b0000 000 0000 0000 0000 0000 0000 0000 0100 1101 = 0x0100 0000 004D 1 0000 0000
• Request:
{
"code":"request",
"cid":10,
"adr":"iolinkmaster/port[2]/iolinkdevice/pdout/setdata",
"data":{"newvalue":"01000000004D"}
}
• Response:
{
"cid":10,
"code":200
}
>
Example: Writing digital output (operating mode "DO")
59803
Task: Set the output value of the IO-Link devices at IO-Link Port X1 to "ON". The operating mode of
the IO-Link port is "Digital Output (DO)".
Solution: Write the value 1 to data point pdout. The value has to be written as hexadecimal value with
a length of 1 byte (OFF = "00", ON = "01").
• Request:
{
"code":"request",
"cid":10,
"adr":"iolinkmaster/port[1]/iolinkdevice/pdout/setdata",
"data":{"newvalue":"01"}
}
• Response:
{
"cid":10,
"code":200
}
>
Example: Reading digital input (operating mode "DI")
59802
Task: Read the current input value of the IO-Link device at IO-Link port X5. The operating mode of the
IO-Link port is "Digital Intput (DI)".
Solution: Read the value of data point pdin. The value will be returned as hexadecimal value with a
length of 1 byte (OFF = "00", ON = "01"').
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
54
• Request:
{
"code":"request",
"cid":10,
"adr":"iolinkmaster/port[5]/iolinkdevice/pdin/getdata"
}
• Response:
{
"cid":10,
"data":{"value":"00"},
"code":200
}
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
55
>
9.2.15 -Link ports: Indicating port events IO
59796
Substructure: iolinkmaster/port[n] (n = 1...8).
Available data points:
Name
Description
Access
../portevent
Indication of the following events at IO-Link port n:
▪ plugging -Link device IO
▪ pulling IO-Link device
▪ changing operating mode of IO-Link port
r
r ... read only
Subscribing events: → Subscribing to notifications ( ) → p. 61
>
9.2.16 -Link devices: Accessing parameters IO
59800
The ifm IoT Core supports the configuration of the connected IO-Link devices. A parameter is
accessed via -Link index and subindex ( IO Device Description (IODD) of the device). IO →
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 service from the IO-Link device (index: iolreadacyclic
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
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
56
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 ( -Link description of → IO
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
}
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
57
>
9.2.17 -Link devices: Reading an writing device information IO
59797
Substructure: iolinkmaster/port[n]/iolinkdevice (n = 1...8)
Available data point s:
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
>
9.2.18 -Link devices: Indicating IO-Link events IO
59798
Substructure: iolinkmaster/port[n]/iolinkdevice (n = 1...8).
Available data points:
Name
Description
Access
../iolinkevent
Indication of IO-Link events
r
r ... read only
Subscribing events: → Subscribing to notifications ( ) → p. 61
>
9.2.19 Gateway: Resetting, rebooting and localising the device
59790
Substructure: firmware
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
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
58
>
9.2.20 Gateway: Reading device information
52254
Substructure: deviceinfo
Available data points:
Name
Description
Access
../productcode
Article number
r
../vendor
Manufacturer
r
../devicefamily
Device family
r
../hwrevision
Hardware revision
r
../serialnumber
Serial number
r
../revision
Firmware version
r
../bootloaderrevision
Bootloader version
r
../extensionrevisions
Firmware and bootloader version
r
../fieldbustype
Fieldbus
r
r ... read only
Additional information about the AL1323 can be read with the service (getidentity → Servicet:
getidentity ( )). → p. 157
>
9.2.21 Gateway: Reading status and diagnostic information
61157
Substructure: processdatamaster
Available data points:
Name
Description
Access
../temperature
Temperature of the IO-Link master (value in °C)
r
../voltage
Present voltage value of the supply voltage US (value in mV)
r
../current
Present current value of the sensor supply US (value in mA)
r
../supervisionstatus
Status of the device supply US
r
r ... read only
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
59
>
9.2.22 Gateway: Updating the firmware
59789
Substructure: firmware
Available data points:
Name
Description
Access
../version
Software version
r
../type
Software type
r
../container
Structure for updating the firmware
w
../container/maxsize
Maximum size of the container structure (in bytes)
r
../container/chunksize
Size of a data segment (in bytes)
r
../container/size
Size of the container content (in bytes)
r
r = only read
w = write only
Applicable services:
Name
Description
../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
>
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.
> -Link master stores the segments received in the container area. IO
4 Install firmware
► Start the installation of the transmitted firmware.
{"code": "request", "cid": -1, "adr": "/firmware/install", "data": {}}
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
60
9.2.23 Gateway: Setting the application tag
59791
Substructure: devicetag
Available data points:
Name
Description
Access
../applicationtag
Name of the -Link master (application tag) IO
rw
rw ... read and write
For the storage of the applicationtag 32 bytes are available on the IO-Link master. If the
memory area is exceeded during writing with setdata, the IoT core aborts the write process
and returns the diagnostics code 400.
When writing the application tag, note the different memory requirements of the individual
UTF-8 characters:
• characters 0-127: 1 byte per character
• characters >127: more than 1 byte per character
>
Example: Change name of the IO-Link master
a33823
Task: Set the name of the IO-Link master to AL1323 for the representation in the
LR SMARTOBSERVER.
Solution: Change the parameter [Application Tag] with the setdata service to the value [AL1323].
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":"AL1323"}
}
• Response:
{"cid":4711,"code":200}
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
61
>
9.2.24 Subscribing to notifications
61159
If a data point has the sub-element datachanged, the user can subscribe to notifications on value and
condition changes. Notifications can be triggered by the expiration of a timer or an event. The IoT Core
supports the output of notifications in CSV or JSON format.
Available data points:
Name
Description
Access
timer[x]/counter
Timer for triggering a notification
rw
timer[x]/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:
▪ -Link device connected IO
▪ -Link device disconnected IO
▪ Operating mode of the IO-Link port changed
rw
iolinkmaster/port[n]/iolinkdevice/iolinkevent
Display of IO-Link events
rw
r ... read only
rw ... read and write
x = [1,2]
n = 1...8
Applicable services:
Name
Description
../datachanged/subscribe
Subsrscibe to notification
../datachanged/unsubsribe
Unsubscribe notification
../datachanged/getsubscriptioninfo
Show information about notifications
Additionally, the user can use ( ) show all active subscriptions. Service: getsubscriberlist → p. 158
>
Example: Subscribing to notifications
61160
Task: The current values of the following parameters are to be sent regularly to a network server with
IP address 192.168.0.4:
• cyclic input data of the IO-Link Devices an IO-Link port X02
• Operating temperature of the IO-Link master.
Solution: Subscribe to the required data using the subscribe service.
The following options are additionally available:
• via WebSockets (ws://): Example: Subscribing notifications via WebSocket ( → p. ) 64
• via MQTT (mqtt://): Example: Configuring the MQTT command channel ( → p. ) 67
• Request:
{
"code":"request",
"cid":4711,
"adr":"/timer[1]/counter/datachanged/subscribe",
"data":
{
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
62
"callback":"http://192.168.0.4:80/temp",
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/temperature"]
}
}
In addition, the time interval of the timer[1] must 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
}
• Notication (JSON)
{
"code":"event",
"cid":4711,
"adr":"",
"data":{
"eventno":"6317",
"srcurl":"/timer[1]/counter/datachanged",
"payload":{
"/timer[1]/counter":{"code":200,"data":1},
"/processdatamaster/temperature":{"code":200,"data":39},
"/iolinkmaster/port[2]/iolinkdevice/pdin":{"code":200,"data":"03B0"}}}
}
>
Example: Changing a subscription
61161
Task: The existing subscription (Example: Subscribing to notications ( )) is to be changed. →p. 61
Instead of the temperature of the IO-Link master, the operating voltage applied is to be transmitted.
Solution: Overwrite the existing subscription. For this purpose, the parameter values for "cid" and
"callback" in the request must be the same as those of the existing subscription.
• Request:
{
"code":"request",
"cid":4711,
"adr":"/timer[1]/counter/datachanged/subscribe",
"data":{
"callback":"http://192.168.0.4:80/temp",
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/voltage"]}
}
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
63
Example: Subscribing to notications in CSV format
61162
Task: Every 2 seconds, the current values of the following parameters are to be sent to a network
server with the IP address 192.168.0.4
• cyclic IO-Link input data of the IO-Link device at port X02
• Operating temperature of the IO-Link master.
The data should be transmitted in CSV format (comma separator).
Solution:
► Use the subscribe service to subscribe to the required data and set the output format to "csv0".
Data in CSV format can only be sent via TCP protocol.
• Request:
{
"cid": 1,
"adr":"/timer[1]/counter/datachanged/subscribe",
"code":"request",
"callback":"tcp://192.168.50.59:1883/topic",
"codec":"csv0",
"data":{
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/temperature"]}
}
► Set the interval of the timer to 2 seconds:
• Request:
{
"code":"request",
"cid":4712,
"adr":"/timer[1]/interval/setdata",
"data":{"newvalue":2000}
}
The cyclically sent notication has the following structure:
/timer[1]/counter/datachanged,6317,200,1,200,39,200,03B0
>
Example: Unsubscribing from notications
61163
Task: The existing subscription (Example: Subscribing to notications ( )) is to be deleted. →p. 61
Solution: Use the unsubscribe service to delete the subscription. For this purpose, the value of the
parameter "callback" in the request must be equal to the value of the existing subscription.
{
"code":"request",
"cid":4711,
"adr":"/timer[1]/counter/datachanged/unsubscribe",
"data":{
"callback":"http://192.168.0.4:80/temp"
}
>
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
64
Example: Checking subscriptions
61164
Task: Information about the existing subscription (Example: Subscribing to notications
( )Show →p. 61 Example: Subscribing to notications ( )). →p. 61
Solution: Use the service getsubscriptioninfo and the parameter values cid, "adr" and "callback" of the
existing subscription to retrieve the information.
• Request:
{
"code":"request",
"cid":4711,
"adr":"/timer[1]/counter/datachanged/getsubscriptioninfo",
"data":{
"callback":"http://192.168.0.4:80/temp"}
}
• Response:
{
"cid." 4711,
"data":{
"callback":"http://192.168.0.4:80/temp",
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/productname",
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/temperature"]},
"code":200
}
>
9.2.25 Using Web Socket
61165
The IoT Core supports communication via WebSocket protocol. With Web Sockets, the user can
establish a full-duplex communication channel via a TCP connection.
WebSockets can be used for the following services:
• subscribe / unsubscribe
Maximum number of WebSocket connections: 8
Fail-safe WebSocket connections (wss://) are not supported.
To transmit notications via a WebSockets connection:
► Establish the WebSocket connection (e.g. "ws://192.168.0.55:80/websocket")
• Option 1: without parameter "callback”
► make subscribe/unsubscribe request without parameter "callback".
> IoT-Core sends notications about existing WebSocket connections.
• Option 2. with parameter "callback”
► make subscribe/unsubscribe requests with parameter "callback" ( "ws:///myTopic").
> IoT-Core sends notications about existing WebSocket connections to the topic . myTopic
>
Example: Subscribing notications via WebSock et
61166
Task: The current values of the following parameters are to be sent regularly to the data sink myTopic
via an existing WebSocket connection:
IO-Link master with EtherNet/IPinterface DataLine 8 ports IP 65 / IP 66 / IP 67 / IP 69K
65
• Product name of the IO-Link Devices an IO-Link port X02
• cyclic input data of the IO-Link Devices an IO-Link port X02
• 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":"ws:///myTopic",
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/productname",
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/temperature"]}
}
If the notications are to be transmitted via the existing WebSocket connection, but without a special
data sink, the callback parameter is not required.
• Request:
{
"code":"request",
"cid":4711,
"adr":"/timer[1]/counter/datachanged/subscribe",
"data":{
"datatosend":[
"/iolinkmaster/port[2]/iolinkdevice/productname",
"/iolinkmaster/port[2]/iolinkdevice/pdin",
"/processdatamaster/temperature"]}
}

Termékspecifikációk

Márka: IFM
Kategória: nincs kategorizálva
Modell: AL1323

Szüksége van segítségre?

Ha segítségre van szüksége IFM AL1323, tegyen fel kérdést alább, és más felhasználók válaszolnak Önnek


Útmutatók nincs kategorizálva IFM

IFM

IFM E40581 Útmutató

9 Április 2025
IFM

IFM O3R252 Útmutató

9 Április 2025
IFM

IFM PG1704 Útmutató

9 Április 2025
IFM

IFM PE2599 Útmutató

23 Március 2025
IFM

IFM MK5312 Útmutató

23 Március 2025
IFM

IFM RU6035 Útmutató

18 Március 2025
IFM

IFM SF3210 Útmutató

18 Március 2025
IFM

IFM RU6045 Útmutató

18 Március 2025
IFM

IFM KI0200 Útmutató

18 Március 2025
IFM

IFM PT2400 Útmutató

16 Január 2025

Útmutatók nincs kategorizálva

Legújabb útmutatók nincs kategorizálva

MOZA

MOZA SR-P Útmutató

10 Április 2025
Soundstream

Soundstream VRN-64HBL Útmutató

10 Április 2025
Panasonic

Panasonic Lumix DMW-AC11 Útmutató

10 Április 2025
Planet

Planet PWR-240-48 Útmutató

9 Április 2025
CaterChef

CaterChef 445001 Útmutató

9 Április 2025
Livn

Livn Bolt Útmutató

9 Április 2025
Livn

Livn Beats Útmutató

9 Április 2025
Alpine

Alpine DP2-40C-BC Útmutató

9 Április 2025
Daikin

Daikin EKWCTRDI1V3 Útmutató

9 Április 2025
Simplified MFG

Simplified MFG SP18CAT120 Útmutató

9 Április 2025