Communication
112/154
10.3.4
Device topics
Topic
Description
{prefix}/iolink/v1/devices
Address all devices of all masters: Device alias, master
number, port number
For an example, see Device List.
{prefix}/iolink/v1/devices/[DEVICE_ALIAS]/capabilities
Read capability information of the device: Minimum cycle
time, supported profiles
Example: {prefix}/iolink/v1/devices/master1port4/capabilities
For an example, see Device Capabilities.
{prefix}/iolink/v1/devices/[DEVICE_ALIAS]/identification
Read identification information of the device: Vendor ID,
device ID, IO-Link revision, vendor name, vendor text,
product name, product ID, product text, serial number, serial
number, hardware revision, firmware revision, application
specific tag, location tag, function tag
Example: {prefix}/iolink/v1/devices/master1port4/identification
For an example, see Device Identification.
{prefix}/iolink/v1/devices/[DEVICE_ALIAS]/processdata/
value
Read process data value from the device:
Get data (IO-Link, IQ value), set data (IO-Link, IQ value)
Example: {prefix}/iolink/v1/devices/master1port4/processdata/
value
For an example, see Device Process Data.
{prefix}/iolink/v1/devices/[DEVICE_ALIAS]/processdata/
getdata/value
Read process data input value from the device:
Get Data (IO-Link, IQ value)
Example: {prefix}/iolink/v1/devices/master1port4]/
processdata/getdata/value
For an example, see Device Process Data Input.
{prefix}/iolink/v1/devices/[DEVICE_ALIAS]/processdata/
setdata/value
Read process data output value from the device:
Set Data (IO-Link, IQ value)
Example: {prefix}/iolink/v1/devices/master1port4]/
processdata/setdata/value
For an example, see Device Process Data Output.
iolink/v1/devices/[DEVICE_ALIAS]/events
Read event log from the device: Time, severity, origin,
message
Example: {prefix}/iolink/v1/devices/master1port4/events
For an example, see Device Events.
{prefix}/iolink/v1/devices/[DEVICE_ALIAS]/parameters/
[INDEX]/subindices/[SUBINDEX]/value
Read IO-Link device parameter (request, elements):
Direction, index (IO-Link parameter index number), subindex
(O-Link parameter subindex number), object reference
(reference to NPX object holding operation result)
{prefix}/iolink/v1/devices/[DEVICE_ALIAS]/parameters/
[INDEX]/value
Read IO-Link device parameter:
This resource is also reachable via following URL with
[SUBINDEX] set to zero.
{prefix}/iolink/v1/devices/[DEVICE_ALIAS]/parameters/
[INDEX]/subindices/[SUBINDEX]/value
Table 72: Device topics
You find examples and details about the transferred JSON objects below.
NFD-3090-EIS-IOLM\W | Hardware, installation and commissioning
DOC200701UM02EN | Revision 2 | English | 2021-08 | Released | Public
© Hilscher 2020 - 2021