IFM AL1330 Operating Instructions Manual

IFM AL1330 Operating Instructions Manual

Io-link master with ethercat interface dataline 4 ports ip 65 / ip 66 / ip 67
Table of Contents

Advertisement

Quick Links

>
>
Operating instructions
IO-Link master with EtherCAT interface
DataLine
4 ports
IP 65 / IP 66 / IP 67
AL1330
Firmware: 3.1.x
English

Advertisement

Table of Contents
loading

Summary of Contents for IFM AL1330

  • Page 1 > > Operating instructions IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 AL1330 Firmware: 3.1.x English...
  • Page 2 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Contents Preliminary note Legal and copyright information ................... 5 Purpose of the document ..................... 5 Explanation of Symbols ....................... 5 Change history ........................6 Safety instructions General ..........................
  • Page 3 9.1.11 Firmware: Reset device to factory settings ................. 32 9.1.12 Firmware: Reboot the device ...................... 32 9.1.13 Configure IO-Link devices ......................33 ifm IoT Core ........................34 9.2.1 Programmers' notes ........................35 9.2.2 First steps ........................... 39 9.2.3 General functions ........................39 9.2.4...
  • Page 4 Parameter data ........................... 93 14.2.2 Cyclic data ..........................94 14.2.3 Acyclic data ..........................95 14.2.4 Events ............................107 14.3 ifm IoT Core ........................111 14.3.1 Overview: IoT profile ........................ 112 14.3.2 Overview: IoT types ........................121 14.3.3 Overview: IoT services ......................122 Index...
  • Page 5 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: •...
  • Page 6 Correction: Technical data - current rating per output 09 / 2019 ▪ Added: New IoT core functions 10 / 2020 ▪ Added: IoT Core Visualizer ▪ Correction: Description of the IoT Core Service getsubscriptioninfo Deleted: ifm IoT Core – DNS support 10 / 2021...
  • Page 7 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Safety instructions Content General ..............................7 Required background knowledge ......................7 Safety symbols on the device ........................7 IT security ..............................8 28333 > General 58525 •...
  • Page 8 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 IT security 54678 NOTICE! If the device is operated in an unprotected network environment. > Unauthorised read or write access to data is possible. >...
  • Page 9 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Intended use 58283 The device may only be used for the following purposes: • as IO-Link master for configuration, administration and operation of IO-Link devices •...
  • Page 10 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Function Content Communication, parameter setting, evaluation ..................11 Digital inputs ............................12 IO-Link supply ............................12 33836...
  • Page 11 IO-Link master (IO-Link revision 1.0 and 1.1) • 4 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 EtherCAT 33676 The device offers the following EtherCAT functions: •...
  • Page 12 34210 The device provides the following configuration options: • Parameter setting of the IO-Link master of the AL1330 with LR DEVICE parameter setting software, EtherCAT projection software or ifm IoT-Core services. • Parameter setting of the connected IO-Link devices (sensors, actuators) with LR DEVICE parameter setting software, EtherCAT projection software or ifm IoT-Core services •...
  • Page 13 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Mounting Content Mount the device ............................ 13 34058 > Mount the device 34059 ► Disconnect the system from power before installation. ► For installation choose a flat mounting surface. ►...
  • Page 14: Table Of Contents

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Electrical connection Content Notes ..............................14 Connecting the EtherCAT ports ......................15 Connecting the IoT port .......................... 15 IO-Link ports ............................16 Connecting the device ..........................18 33805 >...
  • Page 15: Connecting The Ethercat Ports

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Connecting the EtherCAT ports 33671 ► Connect the device via the M12 socket X21 and/or X22 to the EtherCAT network (e.g. EtherCAT PLC, additional EtherCAT device) ►...
  • Page 16: Io-Link Ports

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 IO-Link ports 51958 The IO-Link ports of the AL1330 meet the requirements of the IO-Link specifications 1.0 to 1.1.2. ► Please note the information concerning IO-Link wiring! ► Cover unused sockets with M12 protective caps (art. no.: E73004).
  • Page 17 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 6.4.2 Connecting IO-Link devices for Class B operation 51960 Notes on wiring: • For Class B operation, the IO-Link device must be supplied with an additional auxiliary voltage UA using a Y connection cable.
  • Page 18: Connecting The Device

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Connecting the device 33882 ► Disconnect power. ► Connect the IO-Link Master via M12 socket X31 to 24 V DC (20...30 V SELV/PELV; according to EN61010-1, secondary circuit with maximum 30 V DC supplied by mains circuit up to 300 V of overvoltage category II).
  • Page 19 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Operating and display elements Content Overview ..............................19 LED indicators ............................20 34063 > Overview 34052 RDY, RUN and ERR status LEDs → Status LEDs (→...
  • Page 20 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > LED indicators 34047 The device only has the following LED indicators: > 7.2.1 Status LEDs 34198 The RDY LED indicates the status of the gateway. The RUN LED indicates the current state of the EtherCAT state machine.
  • Page 21 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 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 identification. Status LED Description green...
  • Page 22 (→ Operating and display elements (→ p. 19)). To enable parameter setting of the AL1330, the IoT interface and / or the fieldbus interface must be configured according to the network environment. ► Configure fieldbus interface (→...
  • Page 23 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Configuration Content LR DEVICE ............................. 24 ifm IoT Core ............................34 EtherCAT ..............................76 33858...
  • Page 24 Firmware: Reset device to factory settings .................... 32 Firmware: Reboot the device........................32 Configure IO-Link devices ........................33 33692 On delivery, the AL1330 is configured with the factory settings (→ Factory settings (→ p. 85)). Required software: LR DEVICE (1.5.0.x or higher) (art.-no.: QA0011/QA0012)
  • Page 25: Remarks

    IO-Link master and the connected IO-Link devices without being connected to the AL1330 (OFFLINE mode). The configuration created in this way can be stored as a file (*.lrp) and loaded to the AL1330 and activated at a later date.
  • Page 26: Iot: Configure Security Mode

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 9.1.3 IoT: Configure security mode 54680 The IoT interface of the IO-Link offers a security mode. It enables secure data transmission via transport encryption and restriction of the access to IO-Link masters and IO-Link devices via user authentication.
  • Page 27: Iot: Configuring Access Rights

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 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.
  • Page 28: Iot: Configure The Interface To Lr Agent Or Lr Smartobserver

    2147483647 2147483647 ms [Application Tag] Source identifier of the IO-Link master in the Factory setting: AL1330 structure of LR AGENT or LR SMARTOBSERVER (String32) After changing the parameter [Port LR Agent or SMARTOBSERVER] or [Application Tag], it may take 120 seconds before the device establishes a new TCP connection.
  • Page 29: Io-Link Ports: Activate Data Transfer To Lr Agent Or Lr Smartobserver

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 9.1.7 IO-Link ports: Activate data transfer to LR AGENT or LR SMARTOBSERVER 33690 The user can decide separately for each IO-Link port whether the process data of the connected IO-Link devices should be transferred to LR AGENT or LR SMARTOBSERVER.
  • Page 30: Io-Link Ports: Configure Operating Mode

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 9.1.8 IO-Link ports: Configure operating mode 33694 The IO-Link ports X01...X04 of the device support the following operating modes: • Disabled: no data transfer at pin 4 (C/Q) of the IO-Link port •...
  • Page 31: Io-Link Ports: Set The Device Validation And Data Storage

    Restore] [Vendor ID] ID of the manufacturer that is to be validated 0...65535 Factory setting: 0# ifm electronic: 310 [Device ID] ID of the IO-Link device that is to be validated 0...16777215 Factory setting: 0 ► Save changed values on the device.
  • Page 32: Info: Show Device Information

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 9.1.10 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.
  • Page 33: Configure Io-Link Devices

    ► Under [ONLINE]: Click on the required IO-Link master. > LR DEVICE automatically detects the IO-Link devices connected to the IO-Link master (e.g. ifm sensor KG5065). Configure IO-Link device ► Mouse click on the port to which the IO-Link device is connected.
  • Page 34 Gateway: Setting the application tag ....................59 Subscribing to notifications ........................60 Using Web Socket ..........................63 MQTT support ............................65 Using the IoT-Core Visualizer ........................ 69 52244 General notes on the ifm IoT Core: → Programmers' notes (→ p. 35)
  • Page 35: Programmers' Notes

    IoT Core: General information 52256 The DataLine device family has an IoT Core. The IoT Core allows the user to address the AL1330 from IT networks via a REST API and to integrate it into Internet-of-Things applications. A device description is stored on the AL1330. This device description is a structured, machine-readable data object in JSON format.
  • Page 36 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 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.
  • Page 37 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > POST request 54700 Using a POST request the user has read and write access to a data point. The syntax of the request to the IoT Core is: "code":"code_id", "cid":id, "adr":"data_point/service",...
  • Page 38 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Example: POST request 54035 Request: "code":"request", "cid":4711, "adr":"devicetag/applicationtag/getdata" Response: "cid":4711, "data":{"value":"AL1330"}, "code":200 > IoT Core: Diagnostic codes 54688 Code Text Description Request successfully processed OK but needs reboot Request successfully processed;...
  • Page 39: First Steps

    9.2.2 First steps 52245 To read the device description of the AL1330: ► Send the following POST request to the AL1330: {"code":"request","cid":-1,"adr":"gettree"} > AL1330 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.
  • Page 40 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 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 iotsetup/accessrights of the getelementinfo service. The fields type (data type) and valuation (range of values) contain the required information.
  • Page 41 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 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: firmware, sub-levels to be shown: 1) •...
  • Page 42 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Example: Read several parameter values of the IO-Link master simultaneously 33840 Task: The following current values are to be read by the IO-Link master: temperature, serial number Solution: Read the current parameter values using the getdatamulti service (data point temperature: /processdatamaster/temperature;...
  • Page 43: Iot: Configuring Access Rights

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Example: Using DNS support 61152 Example 1: gettree Synonymous requests: • http://192.168.23.70:8080/gettree • http://example.org:8080/gettree Example 2: subscribe Synonymous requests: • with IP address "cid": 11 "code": 10, "adr."...
  • Page 44: Iot: Configuring Ip Settings

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 9.2.5 IoT: Configuring IP settings 61155 Substructure: iotsetup Available data points: Name Description Access ../network/dhcp Configuration of the IP settings of the IoT port ../network/ipaddress IP address of the IoT port ../network/subnetmask...
  • Page 45: Iot: Configuring Security Mode

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 9.2.6 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...
  • Page 46 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 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: Activate security mode Use service setdata with datapoint iotsetup/security/securitymode to activate the security mode.
  • Page 47 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 "cid":-1, "data":{"value":37}, "code":200 > Example: reset password 54686 Task: The existing password is to be reset. Solution: To reset a password, disable the security mode. To disable it, enter the user name and the password (the fields "user"...
  • Page 48: Fieldbus: Configuring The Fieldbus Interface

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 9.2.7 Fieldbus: Configuring the fieldbus interface 33892 The AL1330 in das EtherCATnetwork can be integrated via the field bus interface (ports X21 / X22). Substructure: fieldbussetup Available data points: Name Description Access ../hostname...
  • Page 49: Io-Link Ports: Configuring Device Validation And Data Storage

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 9.2.9 IO-Link ports: Configuring device validation and data storage 59792 Substructure: iolinkmaster/port[n] (n = 1...4). Available data points: Name Description Access ../validation_datastorage_mode Response of the IO-Link port when a new IO-Link device is connected ../validation_vendorid IO-Link ID of the manufacturer that is to be validated ../validation_deviceid...
  • Page 50 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 {"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 >...
  • Page 51: Io-Link Ports: Configuring Data Transfer To Lr Agent Or Lr Smartobserver

    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 getdata service. •...
  • Page 52 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 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.
  • Page 53 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 • Request: "code":"request", "cid":10, "adr":"iolinkmaster/port[5]/iolinkdevice/pdin/getdata" • Response: "cid":10, "data":{"value":"00"}, "code":200...
  • Page 54: Io-Link Ports: Indicating Port Events

    9.2.13 IO-Link devices: Accessing parameters 59800 The ifm IoT Core supports the configuration of the connected IO-Link devices. A parameter is accessed via IO-Link index and subindex (→ IO Device Description (IODD) of the device). Substructure: iolinkmaster/port[n]/iolinkdevice (n = 1...4)
  • Page 55 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.
  • Page 56: Io-Link Devices: Reading An Writing Device Information

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 9.2.14 IO-Link devices: Reading an writing device information 59797 Substructure: iolinkmaster/port[n]/iolinkdevice (n = 1...4) Available data points: Name Description Access ../status Status of the connected IO-Link device ../vendorid IO-Link ID of the vendor ../deviceid...
  • Page 57: Gateway: Reading Device Information

    ../bootloaderrevision Bootloader version ../extensionrevisions Firmware and bootloader version ../fieldbustype Fieldbus r ... read only Additional information about the AL1330 can be read with the service getidentity (→ Servicet: getidentity (→ p. 125)). > 9.2.18 Gateway: Reading status and diagnostic information...
  • Page 58: Gateway: Updating The Firmware

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 9.2.19 Gateway: Updating the firmware 59789 Substructure: firmware Available data points: Name Description Access ../version Software version ../type Software type ../container Structure for updating the firmware ../container/maxsize Maximum size of the container structure (in bytes) ../container/chunksize...
  • Page 59: Gateway: Setting The Application Tag

    > Example: Change name of the IO-Link master a33823 Task: Set the name of the IO-Link master to AL1330 for the representation in the LR SMARTOBSERVER. Solution: Change the parameter [Application Tag] with the setdata service to the value [AL1330].
  • Page 60: Subscribing To Notifications

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 9.2.21 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.
  • Page 61 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 "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. •...
  • Page 62 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Example: Subscribing to notifications 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 •...
  • Page 63: Using Web Socket

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Example: Checking subscriptions 61164 Task: Information about the existing subscription (Example: Subscribing to notifications (→ p. 60)Show Example: Subscribing to notifications (→ p. 60)). Solution: Use the service getsubscriptioninfo and the parameter values cid, "adr"...
  • Page 64 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 • 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.
  • Page 65: Mqtt Support

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 9.2.23 MQTT support 61168 The IoT Core supports the MQTT protocol. The protocol allows an MQTT client to communicate with the IoT Core via an MQTT broker to request and receive data. The IoT Core can publish data via the MQTT connection.
  • Page 66 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Notes on the states of an MQTT connection: Note: Connection states (→ p. 66) To create an MQTT connection, perform the following steps in sequence: Ensure that the MQTT broker can be reached and that the selected port of the MQTT broker is enabled for data transmission.
  • Page 67 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Example: Configuring the MQTT command channel 61171 Task: Configuring and activating the MQTT command channel (IP address MQTT broker: 192.168.82.100, port: 1883, topic: abc). Solution: ►...
  • Page 68 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 "code":"request", "cid":4716, "adr":"/connections/mqttConnection/MQTTSetup/QoS/setdata", "data":{"QoS2"} > Example: Publish the temperature to an MQTT broker 54687 Task: Publish the temperature of the IO-Link master to an MQTT broker (IP address MQTT broker: 192.168.82.100, port: 1883, topic: abc Solution: •...
  • Page 69: Using The Iot-Core Visualizer

    Reading and writing process data ......................74 Updating the firmware ..........................75 61173 The ifm-IoT Core Visualizer of the IO-Link master provides a graphical user interface for accessing functions of the ifm-IoT Core. To start the IoT Core Visualizer: ► Start web browser.
  • Page 70: Managing Notifications

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Managing notifications 61174 The menu page allows you to perform the following functions • Creating notifications • Showing active notifications • Deleting notifications (single, all) Requirements: •...
  • Page 71 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 ► Use the wizard to enter the required notification parameters step by step. > Created notification subscription is displayed in the table. For cyclical notifications via timer[1] or timer[2], the user also needs to set the interval time of the timer in question.
  • Page 72: Searching For Elements In The Device Tree

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Searching for elements in the device tree 61177 The [Elements] menu page allows you to search the device description for elements with specific properties (status, profile, name) and to output the results.
  • Page 73: Configuring Io-Link The Master

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Configuring IO-Link the master 61178 The [Parameter] menu page allows you to configure the IO-Link master. Available options: • Reading and writing individual parameters •...
  • Page 74: Reading And Writing Process Data

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Reading and writing process data 61179 The menu page allows the process data of the IO-Link master and the connected IO-Link devices to be read and written.
  • Page 75: Updating The Firmware

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Updating the firmware 61180 The [Update] menu page allows you to update the firmware of the IO-Link master: Requirements: • Iot-Core Visualizer has been started. ►...
  • Page 76: Install Esi File

    9.3.1 Install ESI file 34067 To represent the AL1330 in a field bus projection software ifm electronic provides an ESI file (→ www.ifm.com)). In the ESI file, all parameters, process data and their valid value ranges are defined. To integrate the ESI file into EtherCAT projection software TwinCAT 3.1: ►...
  • Page 77: Integrate The Io-Link Master Into The Twincat Project

    Manufacturer-specific settings of the IO-Link ports Port Configuration (0x8000) (→ p. 101) Settings X01...X04 The AL1330 has no failsafe function for the outputs of the IO-Link ports. If the fieldbus connection is interrupted, the last used output values are written and marked as invalid. >...
  • Page 78: Configure Cyclic Process Data

    Integrate the IO-Link master into the TwinCAT project "Example: Reading properties of an element" → p. 40)). Open the device editor ► In the Solution Explorer: Double-click on the node of the AL1330. > The window shows the available configuration options. ► Select the tab [Slots].
  • Page 79: Read Diagnostic And Status Information

    Diagnosis History (0x10F3) (→ p. 107)). The IO-Link Master stores a maxiumum of 32 events. The single events will be stored in a ring buffer. The AL1330 supports the following operation modes for writing the ring buffer: • Overwrite Mode: If the buffer memory is full, the oldest event will be overwritten by new incoming...
  • Page 80: Configure Io-Link Devices

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 • Acknowledge Mode: Events will only be overwritten, when they are read and acknowledged. The configuration is done via sub-index 0x05. The eventsare stored in sub-indexes 0x06...0x26. >...
  • Page 81: Ethercat: Programmers' Notes

    Content Use acyclic services ..........................81 33665 > Use acyclic services 34187 The AL1330 supports following services for acyclic read and write processes: • AoE - ADS over EtherCAT (→ Use ADS over EtherCAT (→ p. 81) • CoE - CANopen over EtherCAT (→...
  • Page 82 The request channel is unlocked. > Next command processing can be initiated. The AL1330 can only process one CoE request at a time. If during an active request another CoE request is started, the device answers with an error (SDO abort code: 0x06090030).
  • Page 83 The device has an integrated web server The web server generates a website with the following data: • Status information of the ports • Access to product page of connected IO-Link devices (only ifm devices) • Diagnostic information of the device •...
  • Page 84 ► Save changes. Replace IO-Link device ► Disconnect old IO-Link device from IO-Link master. ► Connect new IO-Link device with the same IO-Link port of the AL1330. > IO-Link master copies parameter values from the data memory to the new IO-Link device.
  • Page 85 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Factory settings 33849 In the factory settings, the device has the following parameter settings: Parameter Factory setting [IP address] (IoT interface) 169.254.X.X [Subnet mask] (IoT interface) 255.255.0.0 [IP gateway address] (IoT interface) 0.0.0.0...
  • Page 86 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Accessories 33870 List of accessories of AL1330: → www.ifm.com > Product page > Accessories...
  • Page 87 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Appendix Content Technical data ............................88 EtherCAT ..............................92 ifm IoT Core ............................111 33879...
  • Page 88: Application

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.1 Technical data Content Application .............................. 88 Electrical data ............................88 Inputs / outputs ............................88 Inputs ..............................89 Outputs ..............................89 Interfaces ..............................89 Operating conditions ..........................
  • Page 89: Inputs

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 14.1.4 Inputs 34069 Inputs Number of digital inputs 8; (IO-Link port Class A: 4 x 2) Switching level high [V] 11...30 Switching level low [V] 0...5 Digital inputs protected against short circuits >...
  • Page 90: Operating Conditions

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.1.7 Operating conditions 34062 Operating conditions Applications Indoor use Ambient temperature [°C] -25...60 Storage temperature [°C] -25...85 Max. perm. relative air humidity [%] Max. height above sea level [m] 2000 Protection rating IP 65;...
  • Page 91: 14.1.10 Electrical Connection

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > 14.1.10 Electrical connection 33806 Voltage supply IN X31 Plug and socket connection Wiring + 24 V DC (US) GND (US) Ethernet IN / OUT X21, X22 Plug and socket connection Wiring TX +...
  • Page 92 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.2 EtherCAT Content Parameter data ............................93 Cyclic data .............................. 94 Acyclic data ............................95 Events ..............................107 33674...
  • Page 93: Ethercat

    ESI file 33810 To represent the AL1330 in a field bus projection software ifm electronic provides an ESI file. The EDS file can be downloaded from ifm's website. In the ESI file, all parameters, process data and their valid value ranges are defined.
  • Page 94: Cyclic Data

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.2.2 Cyclic data Content Process Data Objects (PDO)........................94 33814 > Process Data Objects (PDO) 34204 Selection of IO-Link Port via n (n = 0: Port X01, n = 1: Port X02,...) Index Name Description...
  • Page 95: Acyclic Data

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.2.3 Acyclic data Content Note ................................ 95 MDP Standard Information (0x1000) ...................... 96 Manufacturer Specific Index (0x2000) ....................97 IO-Link Acyclic Command (0x3100) ....................... 98 IO-Link Inputs (0x6000) ..........................
  • Page 96: Mdp Standard Information (0X1000)

    Manufacturer Software Version STRING/ r 0x1018 Identity Object ▪ Vendor ID 0x622 UINT32 / r ▪ Product Code "AL1330" UINT32 / r ▪ Revision Number: UINT32 / r ▪ Serial Number UINT32 / r 0x10F8 Timestamp (value in ns) UINT64 / r r ...
  • Page 97: Manufacturer Specific Index (0X2000)

    Description Possible values Data type / index Access 0x2001 Component Name "EtherCAT IO-Link Gateway" STRING / r 0x2002 Vendor Name "ifm electronic" STRING / r 0x2003 Vendor URL "www.ifm.com" STRING / r 0x2004 Order Number "AL1330" STRING / r 0x2005...
  • Page 98: Io-Link Acyclic Command (0X3100)

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > IO-Link Acyclic Command (0x3100) 33664 Selection of the IO-Link port via n (n = 0: port X01, n = 1: port X02,...) Index Sub- Description Possible values...
  • Page 99: Io-Link Inputs (0X6000)

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > IO-Link Inputs (0x6000) 33669 Input data of the IO-Link ports X01...X04 Selection of the IO-Link port via n (n = 0: port X01, n = 1: port X02,...) Index Sub- Description...
  • Page 100: Io-Link Outputs (0X7000)

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > IO-Link Outputs (0x7000) 33667 Output data of the IO-Link ports X01...X04 Selection of the IO-Link port via n (n = 0: port X01, n = 1: port X02,...) Index Sub- Description...
  • Page 101: Port Configuration (0X8000)

    0x04 Device ID 0x000000 UINT32 / rw 0xFFFFFF ▪ 0x05 Vendor ID 0x0000 UINT32 / rw 0xFFFF 0x136: ifm electronic ▪ 0x20 IO-Link Revision 0x10: IO-Link Revision 1.0 UINT8 / rw 0x11: IO-Link Revision 1.1 ▪ 0x22 Cycle Time UINT32 / rw ▪...
  • Page 102: Port Mode (0X9000)

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Port Mode (0x9000) 34213 Current value of the connected IO-Link devices Selection of the IO-Link port via n (n = 0: port X01, n = 1: port X02,...) Index Sub- Description...
  • Page 103: Diagnostics Data (0Xa000)

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Diagnostics Data (0xA000) 33821 The device provides the following diagnostic data for each port: Selection of the IO-Link port via n (n = 0: port X01, n = 1: port X02,...) Index Sub- Description...
  • Page 104: Device Status / Port Status (0Xf000)

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Device Status / Port Status (0xF000) 33812 Status of the IO-Link device at the port X01...X04 Selection of the IO-Link port via n (n = 0: port X01, n = 1: port X02,...) Index Sub- Description...
  • Page 105 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Mapping: Device Status (0xF100) 34039 Error Code Port State Legend: ▪ [Error Code] Error code of the IO-Link Device No error Note If more than one error occure at the same time. Invalid Device ID only one error will be shown.
  • Page 106 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Mapping: Port Qualifier (0xF101) 34041 Port Qualifier Information (PQI) contains diagnostic information about the IO-Link port. In addition to the process data, the IO-Link master sends the PQI to the EtherCAT controller. DACT Legend: ▪...
  • Page 107: Events

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.2.4 Events Content Diagnosis History (0x10F3) ........................107 33809 > Diagnosis History (0x10F3) 33815 Index Sub- Description Possible values Datentyp / index Zugriff 0x10F3 Diagnosis History 0x01 Maximum Messages 0x00...0x0x20...
  • Page 108 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Index Sub- Description Possible values Datentyp / index Zugriff default if device does not support Emergency sending new diagnosis messages shall be sent as Emergency message Bit 1: Disable info messages Info messages are stored in the...
  • Page 109 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Mapping: Diagnosis Message SYS_OBJECTID> Parameter Content Possible values Data type / Access Diag Code Diagnostic code Bit 0...15: 0x0000 - not used UINT32 / r 0xDFFF 0xE000 - Bit 16...31: Manufacturer...
  • Page 110 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Parameter Content Possible values Data type / Access 0x04 Port X04 Flags Parameter 2 Data type Parameter 2 0x0006 UINT16 UINT16 / r Parameter 2 Event Code geräteabhängig (→...
  • Page 111 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.3 ifm IoT Core Content Overview: IoT profile ..........................112 Overview: IoT types ..........................121 Overview: IoT services .........................122 33803...
  • Page 112 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.3.1 Overview: IoT profile Content Profile: blob ............................113 Profile: deviceinfo ..........................114 Profile: devicetag ..........................115 Profile: iolinkdevice_full ........................115 Profile: iolinkmaster ..........................116 Profile: mqttCmdChannel ........................117 Profile: mqttCmdChannelSetup ......................117 Profile: mqttConnection ........................117 Profile: mqttSetup ..........................118 Profile: network .............................118...
  • Page 113: Profile: Blob

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Profile: blob 52264 Element (identifier) Properties Mandatory Comment ▪ blobname type = data labels element as device information ▪ profiles = blob ../size type = data mandatory ../chunksize...
  • Page 114: Profile: Deviceinfo

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Profile: deviceinfo 34207 Element (identifier) Properties mandatory Comments ▪ deviceinfo type = structure characterises the element as device information ▪ profile = deviceinfo ../devicename type = data optional...
  • Page 115: Profile: Devicetag

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Profile: devicetag 34206 Element (identifier) Properties mandatory Comments ▪ devicetag type = structure ▪ profile = devicetag ../applicationtag type = data mandatory ../applicationgroup type = data optional ../machinecode...
  • Page 116: Profile: Iolinkmaster

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Profile: iolinkmaster 34205 Element (identifier) Properties Mandatory Comments ▪ masterport type = structure Executable service ▪ profile = iolinkmaster ▪ ../mode type = data mandatory ▪...
  • Page 117: Profile: Mqttcmdchannel

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Profile: mqttCmdChannel 61186 Element (identifier) Properties Mandatory Comment ▪ mqttCmdChannel type = structure Profile of the MQTT command channel ▪ profile = commChannel ▪...
  • Page 118: Profile: Mqttsetup

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Profile: mqttSetup 61189 Element (identifier) Properties Mandatory Comment ▪ mqttSetup type = structure Settings of the MQTT command channel ▪ profile = mqttSetup ▪ ../QoS type = data mandatory...
  • Page 119: Profile: Parameter

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Profile: parameter 34215 The profile is used to mark the elements of type data as parameters (acyclic data). The profile defines no substructure. >...
  • Page 120: Profile: Software/Uploadedablesoftware

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Profile: software/uploadedablesoftware 52267 Element (identifier) Characteristics Mandatory Comments ▪ software type = structure Software that can be loaded to the device via the IoT Core ▪...
  • Page 121 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.3.2 Overview: IoT types 34055 The ifm IoT Core uses the following element types: Name Description structure Element is a structure element (like a folder in a file system)
  • Page 122: Service: Factoryreset

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 14.3.3 Overview: IoT services Content Service: factoryreset ..........................122 Service: getblobdata ..........................123 Service: getdata ............................123 Service: getdatamulti ..........................124 Service: getelementinfo ........................124 Servicet: getidentity ..........................125 Service: getsubscriberlist ........................126 Service: getsubscriptioninfo........................127 Service: gettree ............................128 Service: install ............................129...
  • Page 123: Service: Getblobdata

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: getblobdata 52345 Name: getblobdata Description: The service reads a binary large object (blob). Applicable to: datastorage Request data (field "data"): Data field Required Data type Default...
  • Page 124: Service: Getdatamulti

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: getdatamulti 34174 Name: getdatamulti Description: The service sequentially reads the values of several data points and provides them. The value and the diagnostic code are provided for each data point. Request data (field "data"): Data field Required field...
  • Page 125: Servicet: Getidentity

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Servicet: getidentity 54690 Name: getidentity Description: The service reads the device information of the AL1330 and issues it. Request data ("data" field): none Return data ("data" field): Data field Required...
  • Page 126: Service: Getsubscriberlist

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: getsubscriberlist 61191 Name: getsubscriberlist Description: The service provides a list of all active subscriptions. Request data ("data" field): none Return data ("data" field): Array with the following data Data field Mandatory Data type...
  • Page 127: Service: Getsubscriptioninfo

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: getsubscriptioninfo 61192 Name: getsubscriptioninfo Description: The service provides information about an existing subscription (subscribe). The following parameters of the existing subscription are to be used for the query: •...
  • Page 128: Service: Gettree

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Service: gettree 61193 Name: gettree Description: The service reads the device description of the IO-Link master and outputs it as a JSON object. The output can be limited to a subtree of the device description. Request data ("data"...
  • Page 129: Service: Install

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: install 52343 Name: install Description: The service installs the firmware stored in the container area of the device. Applicable to: container Request data (data): none Return data (data): none >...
  • Page 130: Service: Querytree

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: querytree 61194 Name: querytree Description: The service searches a device tree for the criteria profile, type and name and outputs a list with the URLs of the elements found. At least one of the search criteria must be specified. The service can only be executed on the root node of the machine.
  • Page 131: Service: Setblock

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: setblock 34186 Name: setblock Description: The service simultaneously sets the values of several data points of a structure. Request data (field "data"): Data field Required field Data type...
  • Page 132: Service: Setdata

    "data":{ "newvalue": "ifm IO-Link master "duration": "lifetime"} > Service: signal 33819 Name: signal Description: The service starts the flashing of the status LEDs of the AL1330. Request data (field "data"): none Return data (field "data"): none Example: "code":"request", "cid":4711, "adr":"firmware/signal"...
  • Page 133: Service: Start

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: start 61196 Name: start Description: The service starts a connection. Request data ("data" field): none Return data ("data" field): none Example: "code":"request", "cid":4711, "adr":"/connections/mqttConnection/MQTTSetup/mqttCmdChannel/status/start"...
  • Page 134: Service: Stream_Set

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 > Service: stream_set 52341 Name: stream_set Description: The service transfers a data segment. Applicable to: Objects of type data Request data (data): Data field Required Data type Default...
  • Page 135: Service: Unsubscribe

    IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 "eventno":"EventNo", "srcurl":"SrcURL", "payload":{ "eventurl":{"code":EventStatus,"data":EventData}, "datapointurl_1":{"code":DataStatus_1,"data":DataValue_1}, "datapointurl_2":{"code":DataStatus_2,"data":DataValue_2}, ...}} Notification: CSV SrcURL,EventNo,EventStatus,EventData,DataStatus_1,DataValue_1,DataStatus_2,DataVal ue_2,... • SrcURL: Source of the event (data point on which subscribe command was listed) •...
  • Page 136 Read the parameter value of an IO-Link device ......... 53 Reading digital input (operating mode ............52 Reading properties of an element .............. 40 Request with authentication ............... 45 Access the ifm IoT Core ................ 36 reset password ................... 46 Accessories ................... 85 Subscribing notifications via WebSocket ............ 62 Subscribing to notifications .................
  • Page 137 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Configuring device validation and data storage .......... 48 Preliminary note ..................5 Indicating port events ................. 53 Principle of the acacylic command processing ........81 Reading / writing process data ..............
  • Page 138 IO-Link master with EtherCAT interface DataLine 4 ports IP 65 / IP 66 / IP 67 Set-up ....................22 Status LEDs ................... 20 Subscribing to notifications ..............59 Technical data ..................87 Updating the firmware ..............74, 83 Use acyclic services ................80 Use ADS over EtherCAT ...............

Table of Contents