0% found this document useful (0 votes)
26 views36 pages

IIoT Quick Start Guide for ICE2/ICE3

The IIoT Quick Start Guide for Pepperl+Fuchs' ICE2 and ICE3 IO-Link Masters provides an overview of integrating IIoT protocols like MQTT and OPC UA for data sharing in automation applications. It includes instructions for configuring network settings, utilizing MQTT for data publishing, and highlights the advantages of using these protocols for real-time and non-time-critical data communication. The guide also emphasizes the flexibility and innovation in data-sharing requirements for customers in automation projects.

Uploaded by

Nikola Krga
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
26 views36 pages

IIoT Quick Start Guide for ICE2/ICE3

The IIoT Quick Start Guide for Pepperl+Fuchs' ICE2 and ICE3 IO-Link Masters provides an overview of integrating IIoT protocols like MQTT and OPC UA for data sharing in automation applications. It includes instructions for configuring network settings, utilizing MQTT for data publishing, and highlights the advantages of using these protocols for real-time and non-time-critical data communication. The guide also emphasizes the flexibility and innovation in data-sharing requirements for customers in automation projects.

Uploaded by

Nikola Krga
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

IIoT Quick Start Guide

Pepperl+Fuchs IO-Link
Master, ICE2 and ICE3
MQTT, and OPC UA

Manual
With regard to the supply of products, the current issue of the following document is applicable:
The General Terms of Delivery for Products and Services of the Electrical Industry, published
by the Central Association of the Electrical Industry (Zentralverband Elektrotechnik und Elek-
troindustrie (ZVEI) e.V.) in its most recent version as well as the supplementary clause:
"Expanded reservation of proprietorship"

Worldwide
Pepperl+Fuchs Group
Lilienthalstr. 200
68307 Mannheim
Germany
Phone: +49 621 776 - 0
E-mail: info@[Link]
North American Headquarters
Pepperl+Fuchs Inc.
1600 Enterprise Parkway
Twinsburg, Ohio 44087
USA
Phone: +1 330 425-3555
E-mail: sales@[Link]
Asia Headquarters
Pepperl+Fuchs Pte. Ltd.
P+F Building
18 Ayer Rajah Crescent
Singapore 139942
Phone: +65 6779-9091
E-mail: sales@[Link]
[Link]
Contents

1 Introduction................................................................................................................ 4

2 MQTT Protocol Primer............................................................................................... 8

3 Configuring ICE2 / ICE3 Network Settings............................................................ 10


3.1 Configuring MQTT Protocol ........................................................................ 11
3.2 MQTT Settings.............................................................................................. 11
3.3 Port-Specific MQTT Settings ...................................................................... 12
3.4 MQTT Client Configuration Data ................................................................ 12

4 OPC UA Protocol Primer for Pepperl+Fuchs' ICE2/3 IO-Link Master ................. 15

5 Client and Server: OPC UA ..................................................................................... 20

6 Using an OPC UA Client to Connect to the IOLM Server ..................................... 21


6.1 IO-Link Master Tags ..................................................................................... 32
6.2 Additional Tips for UaExpert ...................................................................... 34
6.3 Contact Us .................................................................................................... 35
2022-02

3
IIoT Quick Start Guide
Introduction

1 Introduction
Pepperl+Fuchs has developed an innovative way to share IIoT and Industry 4.0 data from its
sensors and other sensor or actuator systems through communication solutions including its
IO-Link master, the ICE2 and ICE3 devices, or the ICRL Ethernet switch series. The ICE2 and
ICE3 solutions embed IIoT protocols such as OPC UA and MQTT along with various REST
APIs to enable automatic data sharing with or without PLC communication. The IIoT protocols
described below can communicate simultaneously along with the industrial Ethernet protocols
such as PROFINET, Ethernet/IP, or ModbusTCP.
Pepperl+Fuchs' ICE2 and ICE3 have the ability to communicate process-critical data with the
PLC for real-time control and send the non-time-critical data via MQTT or OPC UA for diagnos-
tics, predictive maintenance, trending, and reporting. This ability is called MultiLinkTM.
The graphic below illustrates how the protocols run concurrently and send process and sensor
health data to multiple software systems. The software systems can be a cloud-enabled dash-
board, on-premise SCADA or MES system, or a centralized Unified Name Space (UNS) soft-
ware system.

Figure 1.1
2022-02

4
IIoT Quick Start Guide
Introduction

The differences and capabilities of OPC UA and MQTT are described in the following table:

OPC UA MQTT
Communication Model Client/Server Publish/Subscribe
Publish/Subscribe
Communication Method Request/Response Publish/Subscribe
Publish/Subscribe (based on
MQTT/AMQP)
Participants Identified Unknown (Broker has no info
(Handshake during connec- about participants)
tion)
Relationship n:1 (Client/Server) n:m
n:m (Pub/Sub)
Data Update Cyclic and change-driven (for Change-driven
events and alarms)
Data Overhead High Low
Standardization High Low
Metadata Yes No
Security Integrated (Optional) Separate (On higher network
level)
Driving Industry Automation IT
Table 1.1

Depending on the project application needs and its SCADA or MES control software capabili-
ties, the customer can decide which protocol will work best. Flexibility and innovation are the
driving principles behind Pepperl+Fuchs' Sensorik 4.0 strategy, which gives the customer con-
trol of their sensing and data-sharing requirements for automation applications.
This guide will provide the necessary understanding to enable the MQTT and OPC UA proto-
cols within the embedded webserver on the ICE2 and ICE3 sensor edge gateway and its asso-
ciated connection software called PortVision DX.
Additionally, Pepperl+Fuchs' IIoT Starter Kits contain everything that you need to integrate IO-
Link technology into your system. The following diagrams illustrate the suggested connections
and layout of the products included in the kits, making setup quick and easy.
2022-02

5
IIoT Quick Start Guide
Introduction

Wiring Diagram for Kit with IP20 Master


Power Supply Female Cordset Distance Sensor
PS1000-A6-24.5 Black Wire (to Terminal 4) V11-G-0,8M-PVC OMT550-R200-2EP-IO-V1
Lead length as is from stock
Brown Wire (L+) Blue Wire (to Terminal 2)
Blue Wire (L-)
Brown Wire (to Terminal 1, Power Out L+ )
Blue Wire (L-)

16 Gauge Wire - 1 m Length


Brown Wire (L+)

OUTPUT DC 24V 5A Power Out

Female Cordset Inductive Sensor


Black Wire (to Terminal 4) V11-G-0,8M-PVC NRB4-12GS40-E2-IO-V1
Lead length as is from stock
Blue Wire (to Terminal 2)
Front View
Brown Wire (to Terminal 1, Power Out L+ )

Blue Wire (L-) Brown Wire (L+)


4 4 4
RFID Transponder
16 Gauge Wire - 1 m Length

INPUT
AC 100-240V 3 3 3
N L Power In 2 2 2
1 1 1 Front View IQC21-50
Side View 1 2 3 4 1 2 3 4

AC Input
White or Gray Wire (Neutral)

x3
Power In Port IO-Link Ports
Green Wire (Ground)
Black Wire (Positive)

1 = V- (24 V DC) 1 = L+ RFID Transponder


2 = V- (24 V DC) Ethernet Ports 2 = L- Power Out
3 = V+ (Primary +24 V DC) 3 = DI IQC21-F125
4 = V+ (Secondary +24 V DC) 4 = C/Q

x3
1 2 3 4 1 2 3 4

4
IO-Link Master (IP20) 3 Black Wire (to Terminal 4) Female Cordset
2 Read/Write Station
1 V11-G-0,8M-PVC
Blue Wire (to Terminal 2) IQT1-F61-IO-V1
Lead length as is from stock

3-Conductor Brown Wire (to Terminal 1, Power Out L+ )


Blue Wire (L-)
US Power Cable
Brown Wire (L+)
( ≶ 3 – 5 ft)
Side View Front View
Ethernet Ports
Ethernet Switch Unmanaged
ICRL-U-5RJ45-DIN-NT
V+ V- P5 P4 P3 P2 P1 Ethernet Connection Cable
V45-G-C5-GN1M-PUR-E1S-V45-G
Relay Power

2022-02

6
IIoT Quick Start Guide
Introduction

WIring Diagram for Kit with IP67 Master


Power Supply
PS1000-A6-24.5

Brown Wire (L+)


Connection Cable
Blue Wire (L-) V11-G-1M-PVC-V11-G Read/Write Station
IQT1-F61-IO-V1
Blue Wire (L-) IO-Link Master (IP67)

Brown Wire (L+) Power Out IO-Link Ports Top View

Power Out OUTPUT DC 24V 5A


x3
RFID Transponder
IQC21-F125

Ethernet Ports

16 Gauge Wire - 1 m Length


x3
Power In
RFID Transponder
Power In
INPUT
AC 100-240V IQC21-50
N L

Front View

AC Input
White or Gray Wire (Neutral)

Connection Cable
Green Wire (Ground)
Black Wire (Positive)

0.0
0.2
0.4

V11-G-1M-PVC-V11-G
0.6
0.8
1.0

Inductive Sensor
Female Cordset
NRB4-12GS40-E2-IO-V1
V15L-G-2M-PUR-U
(If too long to fit into the kit,
the V15L can shortened to 1 m)

Connection Cable
V11-G-1M-PVC-V11-G
3-Conductor
US Power Cable Distance Sensor
( ≶ 3 – 5 ft) OMT550-R200-2EP-IO-V1
Ethernet Connection Cable
Brown Wire (L+) Blue Wire (L-) V1SD-G-GN1M-PUR-E1S-V45-G

Ethernet Ports
Ethernet Switch Unmanaged
ICRL-U-5RJ45-DIN-NT V+ V- Ethernet Connection Cable
P5 P4 P3 P2 P1
Side View Front View V45-G-C5-GN1M-PUR-E1S-V45-G
Relay Power
2022-02

7
IIoT Quick Start Guide
MQTT Protocol Primer

2 MQTT Protocol Primer


The ICE2 and ICE3 MQTT package provides a way to publish various data to an MQTT broker.
MQTT is a simple publish-subscribe messaging protocol that is becoming popular for use
within Industrial Internet of Things (IIoT) applications:
• [Link]
• [Link]/wiki/MQTT

What makes MQTT different from industrial communication protocols?


It is a lightweight protocol that enables communication between devices and on-premise soft-
ware and cloud-based solutions. The devices do not need a lot of processing power, making
them small and inexpensive. These devices generate and send a limited amount of data and
can be operated on low-quality networks. While industrial communication protocols tend to
offer fast, real-time data transfer, MQTT does not.
The MQTT standard does not define any format for the published messages, but JSON has
been almost universally adopted by the MQTT implementation in the IIoT area, so JSON has
been implemented by Pepperl+Fuchs for the ICE2 and ICE3 IO-Link master MQTT implemen-
tation.
Currently, most data is published "on-change" with a minimum interval of two seconds between
updates. One exception to this publishing rule is that the ICE2 and ICE3 "uptime" message is
sent at a fixed ten-second interval.

How does the MQTT network architecture operate with the


Pepperl+Fuchs ICE2 and ICE3?
MQTT's network architecture involves clients and a broker instead. Here, the client establishes
a connection to the broker and transmits its internal data. The broker acts as a central clearing
house for data and can be in the cloud or on a private server. It uses topics to organize the data
sent by the client. For instance, ICE2 and ICE3 IO-Link masters have between eight to sixteen
IO ports. Any data for a sensor connected to port 1 has "port 1" in its topic name. One of the
topics Pepperl+Fuchs IO-Link masters publish, or send, is the IO-Link sensor's process data.
When the IO-Link master publishes updates on a topic, the broker updates that information.
One of the most important operations the broker performs is it allows clients to subscribe to this
data. An application that needs to use data from the distance sensor (think Pepperl+Fuchs'
R200 optical sensor) connected to port 1 on the IO-Link master will simply subscribe to the
"process data from port 1" topic. Data will then flow from the sensor to the customer's SCADA,
MES, or Cloud dashboard application.

2022-02

8
IIoT Quick Start Guide
MQTT Protocol Primer

Figure 2.1 An IO-Link distance measurement sensor published the "target distance" to the broker.
User application programs subscribe to this data (topic) and receive updates when they
are available.
2022-02

9
IIoT Quick Start Guide
Configuring ICE2 / ICE3 Network Settings

3 Configuring ICE2 / ICE3 Network Settings

Finding ICE2 / ICE3 in PortVision DX


1. Start PortVision DX and click Scan to scan the network for IO-Link masters.
2. Your master will populate under Scan Results. Once it has populated, double-click the device
name to open the device properties window.

Figure 3.1 Device Properties window

Network setup: DHCP


1. In the Network Settings section of the Device Properties window, the IP Mode must be set to
"dhcp." If yours is not, click the drop-down menu to change [Link] click the Apply Changes
button.
2. Now that the IO-Link master is running DHCP IP mode, your router will assign it an IP address.
Again, click Scan in PortVision DX to scan for the IO-Link master. Note its IP address, start a
web browser, and open a page at that IP address. In the example, the IP address is

[Link]. Alternatively, you can use the button in PortVision DX.


2022-02

10
IIoT Quick Start Guide
Configuring ICE2 / ICE3 Network Settings

Network setup: Static IP


1. In the Network Settings section of the Device Properties window, the IP Mode must be set to
"static." If yours is not, click the drop-down menu to change it. Then click the Apply Changes
button.
2. Now enter the static IP address, Subnet mask, and Gateway Address, and then click the Apply
Changes button.
3. You will also need to enter the DNS1 and DNS2 on the web interface if your MQTT broker is
using a server name (URL).
4. Click Scan in PortVision DX to scan for the IO-Link master. Note its IP address, start a web
browser, and open a page at that IP address. In the example, the IP address is [Link].

Alternatively, you can use the button in PortVision DX.

3.1 Configuring MQTT Protocol


To enable the MQTT publish and subscribe capability within Pepperl+Fuchs' ICE2 and ICE3
IO-Link masters, see the following configuration instructions.

3.2 MQTT Settings


You must also make sure that your IO-Link master has the right firmware to support MQTT. If
your home screen lists MQTT as one of the supported protocols, you are ready to configure
MQTT. If not, you will need to update a few internal files. Contact your Pepperl+Fuchs Sales
support to obtain the latest firmware version if the firmware does not show MQTT capability.

Figure 3.2 MQTT as supported protocol


With MQTT supported, we will now configure MQTT and "tell" the IO-Link master everything it
needs to know about the broker. In the web browser, click the Configuration menu, then select
MQTT.
2022-02

11
IIoT Quick Start Guide
Configuring ICE2 / ICE3 Network Settings

Figure 3.3 Configuring MQTT

3.3 Port-Specific MQTT Settings

Figure 3.4 MQTT settings


• Process Data Publish Interval Min (100–999999)specifies the rate the IO-Link master
will publish port data when the data is changing faster than this rate. If you set this param-
eter to 100 ms, the IO-Link master will publish the process data every 100 ms, even
though the data is changing at a faster rate.
• Process Data Publish Interval Max (0–999999) specifies the maximum time between
two updates (i.e., a heartbeat). A value of 0 s indicates that updates are only published
based on the process data changes. Any other number forces an update after this Max
Interval, even if the process data has not changed.
• PDO Write Enable specifies whether writing output data is allowed at this point. In appli-
cations where MQTT is only used to read port data, PDO Write Enable "disable" is the
right setting. If a PLC is used to write RFID tag data and a client application is only inter-
ested in logging the result of the read activity, this is the right setting. If the sensor configu-
rations are managed via MQTT while the PLC is only using the sensor data to run logic
and control, PDO Write Enable "enable" is likely the correct setting.

3.4 MQTT Client Configuration Data


Global Configuration Settings
Name Type Default Description
MqttClientEnable Enum Disable enable/disable the MQTT client (not imple-
mented)
MqttServerName String MQTT server hostname or IPv4 address
MqttServerPort Int 1883 MQTT server port (065535)
MqttUseTls Boolean False Use SSL/TLS encryption
MqttUsername String Username sent to server for authentication
MqttPassword String Password sent to server for authentication
MqttClientId String Client ID sent to server when connecting
MqttTopicBase String Path prefix used for all publish messages
MqttPubRetain Boolean False Request that broker retain published mes-
sages
MqttIsduWriteEnable String Disable Enable ISDU write
2022-02

Table 3.1

12
IIoT Quick Start Guide
Configuring ICE2 / ICE3 Network Settings

Per-Port Configuration Settings


Name Type Default Description
MqttPdoWriteEnable String Disable Enable PDO write

ISDU Read/Write
Since MQTT lacks intrinsic support for request/response semantics, ISDU read/write requests
and responses are handled via a pair of topics:
• MqttTopicBase/port/n/isdu/request/client_transaction_id and
• MqttTopicBase/port/n/isdu/response/client_transaction_id
Requests for ISDU read/write are published by other clients to the "request" topic shown above.
The client_transaction_id is an arbitrary string chosen by the requesting client and should be
chosen to be unique. After the ISDU operation is completed, the IOLM will publish the response
to the corresponding "response" topic (with the same client_transaction_id as the request).
ISDU Request Payload
Name Type Description
Op String Required—must be "read" or "write"
Index Integer Required
Subindex Integer Optional—defaults to 0 if not provided

Fields specific to read requests:

Name Type Description


Format String Optional—if present, it determines the format of the returned
read data in the response. Should be one of the following:
"str", "raw", or "unit." If not provided, read data will be in all for-
mats.

Fields specific to write requests (exactly one of uint, raw, or str must be present):

Name Type Description


Raw String Whitespace-delimited hex-byte data string
Uint Integer Integer data value (requires len field)
Str String UTF-8 data string (len field is optional)
Len Integer Required for uint data; optional for str data.
Controls number of data bytes written.

In a write request with str data and a len field, the string will be NULL-padded to the requested
length before being written to the device.
2022-02

13
IIoT Quick Start Guide
Configuring ICE2 / ICE3 Network Settings

ISDU Response Payload


The ISDU response payload is a JSON object with the fields described below:

Name Type Description


Op String "Op" value from request
Index Integer "Index" value from request
Subindex Integer "Subindex" value from request
Status String String "OK" if the request was successful, otherwise an error
message

Fields specific to read response (one or more of raw, str, uint may be present)

Name Type Description


Raw String Whitespace-delimited hex-byte data string
Uint Integer Unsigned integer value
Str String UFT-8 string data
Len Integer Number of bytes read

PDO Write
PDO values may be written by publishing to MQTTTopicBase/port/n/pdowr. The payload may
contain PDO data fields in one of two formats: raw or uint. Data in raw format must match the
PDO length exactly. Data in uint format is supported only for PDO lengths of no more than four
bytes. It may also contain a Boolean valid flag.

Implementation Notes
The Pepperl+Fuchs IO-Link master MQTT package is implemented using the Eclipse Paho C
client ([Link]/paho/clients/c) libraryversion 1.3.0
([Link]/eclipse/[Link].c/tree/v1.3.0).
This concludes the MQTT portion on the Pepperl+Fuchs IO-Link master. The next section will
provide connectivity guidance on OPC UA server and client information.

2022-02

14
IIoT Quick Start Guide
OPC UA Protocol Primer for Pepperl+Fuchs' ICE2/3 IO-Link Master

4 OPC UA Protocol Primer for Pepperl+Fuchs' ICE2/3 IO-


Link Master
How to Enable OPC UA on IO-Link Master

Ensure Compatibility
1. Check the IO-Link master to confirm it has the following application base images installed:
• EIP v1.5.0.1 or higher
• PNIO v1.5.0.1 or higher
2. Check your software version using one of the following methods:

Web Page Method


1. Ensure you are connected to the same network as your IOLM.
2. Type in the IP address of your IOLM.
3. The software version will display on the Home page of the IP address.
2022-02

Figure 4.1 Software version information

15
IIoT Quick Start Guide
OPC UA Protocol Primer for Pepperl+Fuchs' ICE2/3 IO-Link Master

PortVision DX Method
1. To check your software on PortVision DX, launch the application, left-click Scan once the IOLM
is connected to the network, check the box labeled IO-Link Master / ICE2 / ICE3, and left-
click Scan. Highlight the folder of the connected device. In the example below, the folder is
named Scan Results [1/1].

Figure 4.2 Scan results


2. The IO-Link master will appear on the bottom section of PortVision DX. Navigate to Software
Version and confirm its EIP / PNIO is v1.5.0.1 or higher. Keep note of the IP address, as it will
be used in the next step.

Figure 4.3 Software version information


2022-02

16
IIoT Quick Start Guide
OPC UA Protocol Primer for Pepperl+Fuchs' ICE2/3 IO-Link Master

Tip
Not the correct version?
Depending on when the IO-Link master was manufactured, you may need to send the IO-Link
master to Pepperl+Fuchs for image updates, if below v1.5.0.1
If you do NOT have PortVision DX, install it using this link:
Install PortVision DX

Configuring
1. After confirming your software version is correct, open a web browser and enter the IO-Link
master IP address.
2. Once loaded, click on Configuration, the OPC UA.
3. Click Edit for the OPC UA Configuration tab on the right side.

Figure 4.4 OPC UA settings


4. Open the drop-down menu and click enable for OPC UA Server Enable.

Figure 4.5 Enabling OPC UA server


2022-02

17
IIoT Quick Start Guide
OPC UA Protocol Primer for Pepperl+Fuchs' ICE2/3 IO-Link Master

Additional Parameter Settings


Depending on the software version, there will be different parameter settings for OPC UA.
Below are the available options for OPC UA configuration:

Figure 4.6 OPC UA configuration options


The following table provides information for OPC UA Configuration Settings:

Options OPC UA Configuration Descriptions


OPC UA PORT CONFIGURATION
Allow OPC UA clients to write PDO data Determines whether OPC UA clients are
(Default = disable) allowed to write PDO data to the IO-Link
devices
OPC UA CONFIGURATION
Allow OPC UA clients to write PDO data This option controls whether or not the OPC
(Default = disable) UA server runs on the IO-Link master.
Workaround for faulty OPC UA clients that Enables an alternative set of browsenames
require unique browsenames where each node's browsename is unique.
(Default = disable) Normally only browsepaths are required to be
unique.
Show only currently selected process data Some slaves have multiple possible layouts for
groups PDI/PDO data, and the user selects the active
(Default = disable) layout when configuring the slave device. If
this option is set to "enable", then only the cur-
rently active PDI/PDO layout will be present in
the OPC UA object tree. If this option is "dis-
able" (the default) the OPC UA object tree will
contain all possible PDI/PDO layouts, and the
OPC UA client must select the correct one.
Allow OPC UA clients to write ISDU data Determines whether OPC UA clients are
(Default = disable) allowed to write ISDU data to the IO-Link
devices.
2022-02

18
IIoT Quick Start Guide
OPC UA Protocol Primer for Pepperl+Fuchs' ICE2/3 IO-Link Master

To check the number of TCP connections, click on Diagnostics | OPC UA.

Figure 4.7 Diagnostics window


If you have a connection (after completion of next section), this page will display:
2022-02

Figure 4.8 Diagnostics window with TCP connection displayed

19
IIoT Quick Start Guide
Client and Server: OPC UA

5 Client and Server: OPC UA


Before you connect to the client, review the following summary of how our IO-Link master com-
municates with your OPC UA client of choice.

Overview
The IO-Link master acts as the OPC UA server. The OPC UA client can be your choice of either
HMI, SCADA, or a PC application. Once the client is ready for the server, you will be required to
enter an Endpoint to access the server, such as typing in the IP address of the server. Your cli-
ent connects to the OPC UA server’s endpoint to communicate. Pepperl+Fuchs does not use a
Discovery Server between the client and server.

Figure 5.1 OPC UA server connection


The design behind the connection isn’t important at this time; however, it helps explain how
your IO-Link master is working behind the scenes.
In order to start viewing tags and data from your IO-Link master, you'll need to choose your
OPC UA client. For this document, UaExpert will be the example program.

2022-02

20
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

6 Using an OPC UA Client to Connect to the IOLM Server


The material presented is solely for educational purposes to show the connection(s) between
the OPC UA client, OPC UA server, and sensors/actuators.
UaExpert will be the example application for the OPC UA client—it's free to download and
quick to use. To download UaExpert, use this link:
[Link]
You will need to create an account before downloading and you will be prompted to enter addi-
tional information when opening the application for the first time.
There are two method that can be used to connect to the server:
• Method One is for general OPC UA client connections;
• Method Two is designed specifically for UaExpert.

Method One: Connecting with OPC Clients


1. Once you have UaExpert (or your OPC UA client of choice) downloaded, your starting client
will appear like the image below. You may have to drag some windows around to get the same
exact appearance.

Figure 6.1 OPC UA client dashboard


2022-02

21
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

2. Next, find your "add server" option. In UA Expert, that will be located in the top left under
Server. Select Add.

3. This will be your endpoint to connect to the server. When working with OPC via TCP, choose
the [Link] option.

2022-02

22
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

4. Discover the server through the UA Client. Double-click on <Double click to Add Server...>
under the Custom Discovery tab.

5. Enter the URL of your IO-Link master and click OK.


2022-02

23
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

6. Double-click the IP address you just added. Then double-click the endpoint name. Since the
master has not yet been named within the OPCUA Configuration tab via the Web Server, it is
simply named ([Link]).

7. Replace the hostname of the connected endpoint with the IP address of the master. Click Yes
to continue.
2022-02

24
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

8. Double-click the lock symbol to connect.


2022-02

25
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

9. The server is now connected! A blank name for the connection is acceptable, but may be
renamed by right-clicking the connection icon, going into Properties, and changing the
Configuration Name field. In the example below, the connection was named "Test1."

Additional Steps:
1. If your server and client are not connected yet, please continue to the next page
2. If you have successfully connected, see "Viewing Tags and Data on the Client" on page
28 to view tags inside your OPC UA client.
3. If you want to find a specific tag, see "How to Read Tag Values: Practical Application" on
page 31 .

2022-02

26
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

Method Two: Connecting with UaExpert


If the server did not connect, try another strategy, such as inputting the Endpoint URL directly
for the server. In this case, [Link] is needed in front of the IO-Link master's IP address. You
can find this on the Advanced tab for "Add Server." This will directly connect you to the OPC
UA server for your IO-Link master. A configuration name is needed to connect using this
method.

Note
You may have to type "port:4840" after the IP address.
2022-02

27
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

Viewing Tags and Data on the Client


After successfully connecting your client and server, you can now start viewing your tags and
data in the client, using the following steps:
1. Look for IOLM in the Address Space on the left side. The Address Space will provide all the
IDs, Cycle Times, ISDU, POI information, and additional tags. Use the drop-down icon to view
an expanded look as shown below:

2022-02

28
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

2. Expand one of your Ports that a sensor is attached to. In this example, a Pepperl+Fuchs
Diffuse mode photoelectric sensor (OBD1400-R200-2EP-IO-V1) is attached to Port 3. To view
data, the IODD files for the device in use MUST be uploaded to the web server.
2022-02

29
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

3. Expand Attached Device. This will be the destination for all your tags you want to view on your
OPC UA client for that specific port.

2022-02

30
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

4. Now, you can explore the different tags and view any data you wish to select. To test if the IO-
Link master is properly working with its respective sensor(s), click on Vendor Name tag (left
side), then look over on the Attributes (right side). Under Value, the Vendor Name of our
device (Pepperl+Fuchs) for the port confirms that the client, server, and port are all
communicating—you can now freely view the data for any tag.

How to Read Tag Values: Practical Application


1. For the Pepperl+Fuchs OBD1400-R200-2EP-IO-V1 Photoelectric sensor, let’s find out the
value it is reading. Choose the tag PDI Data Unsigned32. The attributes will now change.
Under Values, you can see the static value is 1. This means the sensor is producing an output,
which you can confirm by checking the output status indicator on the sensor. If the static value
is 0, this means the sensor is not producing an output.

2. To view the data change in real time, you’ll need to use the Data Access View tab (the center
panel in the image below). This will give you live data while testing your sensor. To start using
the Data Access View tab, pick the tag you want to track data for. In this case, PDI Data
Unsigned32 will work—drag it to the Data Access View tab and it will now display in real time.
Watch the value change as you move the sensor. The value will correlate to the output light on
the sensor.
2022-02

31
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

6.1 IO-Link Master Tags


Tags are "Read-Only" unless noted as Read/Write (RW).

Tag Names:
Attached Devices IO-Link Tag Description
Actual Cycle Time When the master sends a packet and receives it. This is noted as a
period rather than a frequency (ex: 5ms). The Actual Cycle Time is a
negotiation between the IO-Link master and the IO-Link sensor / actu-
ator; this time will vary depending on the device and master. It will be
the greater of either the master or device min cycle time.
DS Capable Determines if the attached device is data storage capable; Boolean.
Data Storage allows saving and loading of multiple parameters as a
single object. This object can be uploaded or downloaded to facilitate
sensor cloning or effortless replacement of a bad sensor.
Device ID A numerical identifier set by the device manufacturer into the sensor
hardware that cannot be changed. Useful for basic identification and
criteria to allow certain automated options such as automatic data
storage download.
Device Min Cycle At the low level hardware IO-Link information exchange, the Device
Time Min Cycle Time is the minimum period of time at which the device can
run. It may not necessarily be used, but rather an "Actual Cycle Time"
is negotiated during IOL handshake which is acceptable to both mas-
ter and device.
FW Version Displayed under IOLM properties, this is the Firmware of the attached
device if displayed under "Port X/Attached device." It cannot be
changed.
HW Version Displayed under IOLM properties, this is the Hardware of the attached
device if displayed under "Port X/Attached device." It cannot be
changed.
IO-Link Version This is the version of the IO-Link spec that the device conforms [Link]-
sion 1.0 or 1.1 is reported.
ISDU Capable Implementation of the Index Service Data Unit; this tag is true when
the device supports ISDUs.
PDI Bytecount Size of the input process data payload
PDI Data Byte Array One of several different format options to read PDI; formatted in an
array.
PDI Data Byte String One of several different format options to display PDI; String
PDI Data Unsigned32: One of several different format options to read PDI; simple data type of
UInt32 (4 bytes).
PDI Files Collection of tags; only available if a valid IODD file has been loaded
for that particular device. Offers "smart automatic formatting" of the
PDI payload by parsing PDI. You may observe, for example, a raw 32
bit value sorted into a flow rate and a temperature complete with engi-
neering units, and the tags will be automatically labeled as "flow rate"
and "temperature."
PDI Valid This tag is true when the device is sending valid PDI data. The device
(sensor) determines if the data is valid.
PDO Bytecount Size of the output process data payload.
PDO Data Byte Array One of several different format options to read PDO; formatted in an
(RW) array.
2022-02

32
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

Tag Names:
Attached Devices IO-Link Tag Description
PDO Data Unsigned One of several different format options to read PDO; simple data type
with of UInt32 (4 bytes).
PDO Fields Collection of tags; only available if a valid IODD file has been loaded
for that particular device. Offers "smart automatic formatting" of the
PDO payload by parsing PDO.
Page 1 Data ISDU Index 0; Index that tells critical information on the device such as
Min Cycle Time, etc.
Page 2 Data Used for devices that are minimalistic and do not implement ISDU.
Used to store parameter data(16 bytes).
Product Name Often called "model" or "family of devices." This tag is any string of
alphanumeric characters. Ex: TD2807, Q4X.
Serial Numerical Identifier assigned by the device (sensor) manufacturer at
build time; unchangeable and unique for each device built.
Vendor ID Assigned to each vendor in the IO-Link community. The Vendor ID will
appear the same for every IO-Link compatible product made by that
OEM.
Vendor Name The common name of the vendor.(Ex: Pepperl-Fuchs)

Tag Names: ISDU Description


Data (RW) Data as ByteString. Multiple Bytes.
Data08 (RW) Data as one Byte.
Data16 (RW) Data as UInt16; Two Bytes.
Data32 (RW) Data as UInt32; Four Bytes.
Index (RW) Index of ISDU to read/write.
Request (RW) Set to 1 for read ISDU and 2 for write ISDU. Set to 0 to clear RW.
Status (RO) Indicates the status of the most recently executed request. 1 = Suc-
cess; 2 = Failed; 0 = cleared state.
SubIndex (RW) SubIndex of ISDU to read/write.

Tag Names: Port Description


Aux Inout Status of an auxiliary input; either Boolean or Binary (single bit). Pin 2
of the IOLM port.
Event Queue Queue of device and master events. Allows events to be read using
simple data types.
Event Read Method that allows events to be read.
ISDU Read Method for reading ISDU data.
ISDU Write Method for writing ISDU data.
Mode Displays the current status of the port (ex: IO-Link, digital input, digital
output, reset, idle).
Name Name of the port. Ex: IO-Link Port 3.
PDO Lock Enable Protocol can lock PDO, if true.
2022-02

PDO Locked Protocol has PDO locked.

33
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

Tag Names: Port Description


SIO Input Indicates the Boolean status of pin 4 on a port that is configured to
allow simple inputs (standard digital input); this would not be valid
while in IOL mode.
SIO Output Refer to SIO Input, but for simple outputs. Not valid for a port in IOL
mode.
Status Status of the port. Ex: pre-operate, operate, init.
Uptime Amount of time the port has been actively connected to an IO-Link
device.

6.2 Additional Tips for UaExpert


Rebrowsing
When changing sensors, viewing new data, or updating the environment/client/server, you can
use the Rebrowse option. To do this, select a node in the Address Space and click "Rebrowse."

2022-02

34
IIoT Quick Start Guide
Using an OPC UA Client to Connect to the IOLM Server

6.3 Contact Us
Still have questions?
This handy guide was designed to introduce you to IO-Link technology and to address many of
the common questions new users have. If you have any questions or concerns not addressed
in this document, a member of our staff will always be happy to help. Feel free to contact us by
telephone or email and we will be sure to get back to you as soon as possible.

How to reach us...


Phone
US: +1-330-425-3555
International: +49-621-776-0
Monday–Friday: 6:00 a.m. to 8:00 p.m.
Saturday & Sunday: 10:00 a.m. to 5:00 p.m.
Email
ask@[Link]
Online
[Link]
2022-02

35
Pepperl+Fuchs Quality
Download our latest policy here:

[Link]/quality

[Link]
© Pepperl+Fuchs · Subject to modifications
/ DOCT-8129

You might also like