Page 1 LioN-X Digital-I/O Multiprotocol: 0980 XSL 3900-121-007D-01F (16 x Input/Output) 0980 XSL 3901-121-007D-01F (16 x Input) 0980 XSL 3903-121-007D-01F (8 x Input, 8 x Output isolated) 0980 XSL 3923-121-007D-01F (8 x Input, 8 x Output) Manual EtherCAT® Technical Support Version 1.0 03/2023 lumberg-automation-support.belden.com...
Page 2: Table Of Contents
Contents Contents 1 About this manual 1.1 General information 1.2 Explanation of symbols 1.2.1 Use of danger information 1.2.2 Use of general information ® 1.2.3 EtherCAT trademark information 1.3 Version information 2 Safety instructions 2.1 Intended use 2.2 Qualified personnel 3 Designations and synonyms 4 System description 4.1 Device variants...
Page 3: Configuration And Operation In Twincat
Contents 6 Assembly and wiring 6.1 General information 6.2 Outer dimensions 6.2.1 LioN-X Digital-I/O multiprotocol variants 6.2.2 Notifications 6.3 Port assignments 6.3.1 Ethernet ports, M12 socket, 4-pin, D-coded 6.3.2 Power supply with M12 power L-coded 6.3.3 I/O ports as M12 sockets 6.3.3.1 I/O ports 7 Starting operation 7.1 ESI file...
Page 4 Contents 8.2.8 Output current limit ® 8.3 Configuration example with TwinCAT 8.3.1 Configuration of 0980 XSL 3900-121-... devices 8.3.2 EoE IP address 8.3.3 Activate configuration 9 Diagnostics processing 9.1 Channel error 9.2 Voltage error at the M12 slots (sensor short-circuit) 9.2.1 Error of the actuator power supply U 9.2.2 Overload/short-circuit of the I/O port sensor supply outputs 9.2.3 Overload/short circuit of the I/O port Ch.
Page 5 Contents 10.3 REST API 10.3.1 Standard device information 10.3.2 Structure 10.3.3 Configuration and forcing 10.4 CoAP server 10.4.1 CoAP configuration 10.4.2 REST API access via CoAP 10.4.3 CoAP configuration - Quick start guide 10.4.3.1 CoAP configuration via JSON 10.5 Syslog 10.5.1 Syslog configuration 10.5.2 Syslog configuration - Quick start guide 10.5.2.1 Syslog configuration via JSON...
Page 6 Contents 12.5.2 Digital outputs 12.6 LEDs 12.7 Data transfer times 13 Accessories Manual EtherCAT® Version 1.0 03/2023...
Page 7: About This Manual
– Lumberg Automation™ – Im Gewerbepark 2 D-58579 Schalksmühle Germany lumberg-automation-support.belden.com www.lumberg-automation.com catalog.belden.com Belden Deutschland GmbH – Lumberg Automation™ – reserves the right to make technical changes or changes to this manual at any time without notice. Manual EtherCAT® Version 1.0 03/2023...
Page 8: Explanation Of Symbols
1.2 Explanation of symbols 1 About this manual 1.2 Explanation of symbols 1.2.1 Use of danger information Danger information is denoted as follows: Danger: Means that death, serious physical injury or substantial damage to property will occur if the required safety measures are not taken.
Page 9: Version Information
1 About this manual 1.3 Version information 1.3 Version information Version Created Changes 03/2023 Table 1: Overview of manual revisions Manual EtherCAT® Version 1.0 03/2023...
Page 10: Safety Instructions
2.1 Intended use 2 Safety instructions 2 Safety instructions 2.1 Intended use The products described in this manual are decentralized I/O Devices on an Industrial Ethernet Network. We adhere to all safety standards when developing, producing, testing, and documenting our products. When you adhere to the handling specifications and safety instructions described for the configuration, assembly, and correct operation, there should not normally be any risks for people or equipment.
Page 11: Qualified Personnel
Only Belden Deutschland GmbH – Lumberg Automation™ – is permitted to make changes to the hardware or software of the products that go beyond the scope of this manual.
Page 12: Designations And Synonyms
3 Designations and synonyms 3 Designations and synonyms Add-On Instruction Application Programming Interface Bus Fault LED Big Endian Data format with High-B on first place (PROFINET) Back-Up Inconsistency (EIP diagnostics) CC-Link IE Field Ch. A Channel A (Pin 4) of I/O port Ch.
Page 13 3 Designations and synonyms GSDML General Station Description Markup Language High-B High-Byte Invalid Cycle Time (EIP diagnostics) IIoT Industrial Internet of Things Input process data Length Error (EIP diagnostics) Internal Module Error (EIP diagnostics) Input / Output I/O port X1 .. X8 I/O port pin 2 Channel B of X1 ..
Page 14 3 Designations and synonyms Programmable Logic Controller PROFINET Power REST REpresentational State Transfer Request for Comments Requested Packet Interval Word data input as seen from the master station (CC-Link) Word data output as seen from the master station (CC-Link) Bit data input as seen from the master station (CC-Link) Bit data output as seen from the master station (CC-Link) Short Circuit Actuator/U (EIP diagnostics)
Page 15: System Description
4 System description 4 System description The LioN modules (Lumberg Automation™ Input/Output Network) function as the interface in an industrial Ethernet system: A central controller on the management level is able to communicate with the decentralized sensors and actuators on the field level. The line or ring topologies for which LioN modules can be used ensure not only reliable data communication but also significantly reduce the number of cables required and thus also the costs for installation and maintenance.
Page 16: Device Variants
4.1 Device variants 4 System description 4.1 Device variants The following Digital I/O device variants are available in the LioN-X family: Article Product designation Description I/O port functionality number 935705001 0980 XSL 3900-121-007D-01F LioN-X M12-60 mm, 16 x Input/Output I/O Device universal Multiprotocol (PN, EIP, EC, MB, CC)
Page 17: I/O Port Overview
4 System description 4.2 I/O port overview 4.2 I/O port overview The following tables show the main I/O port differences of the LioN-X family. Pin 4 and Pin 2 of the I/O ports can be configured partly to Digital Input or Digital Output.
Page 18 4.2 I/O port overview 4 System description LioN-X 16DI ports Device variant Port Pin 1 U Pin 4 / Ch. Pin 2 / Ch. B A (Input) (Input) Info: – Type 3 Type 3 (4 A) (4 A) (4 A) (4 A) 0980 XSL 3901...
Page 19 4 System description 4.2 I/O port overview LioN-X 8DI8DO ports with galvanic isolation of the outputs Device variant Port Pin 1 U Pin 4 / Ch. A (In/Out) Pin 2 / Ch. B (In/Out) Info: Type 3 Supply by U Type 3 Supply –...
Page 20 4.2 I/O port overview 4 System description LioN-X 8DI8DO ports without galvanic isolation of the outputs Device variant Port Pin 1 U Pin 4 / Ch. A (In/Out) Pin 2 / Ch. B (In/Out) Info: Type 3 Supply by U Type 3 Supply –...
Page 21: Overview Of Product Features
5 Overview of product features 5.1 EtherCAT product features ® 5 Overview of product features 5.1 EtherCAT product features ® Data connection The connection option provided by LioN-X is the widely-used M12 connector with D-coding for the EtherCAT network. ® The connectors are also color-coded to prevent the ports from being mixed Data transmission rates Support of 100Mbit/s with auto crossover and auto negotiation corresponding...
Page 22: Integrated Web Server
5.2 Integrated Web server 5 Overview of product features 5.2 Integrated Web server Network parameter display Get an overview of network parameters such as the IP address, subnet mask and gateway. Displaying diagnostics View diagnostics via the integrated Web server. User management Use the integrated Web server for convenient management of all users.
Page 23: Security Features
5 Overview of product features 5.3 Security features 5.3 Security features Firmware signature The official firmware update packages contain a signature which helps prevent the system against manipulated firmware updates. Syslog The LioN-X multiprotocol variants support the traceability of messages centrally managed and logged via Syslog.
Page 24: Other Features
5.4 Other features 5 Overview of product features 5.4 Other features Interface protection The devices have reverse polarity, short-circuit and overload protection for all interfaces. For more details, see section Port assignments on page 31. Failsafe The devices support a failsafe function. This allows you to define the behavior of every single channel configured as an output in the case of a loss of the PLC communication.
Page 25: Assembly And Wiring
6 Assembly and wiring 6.1 General information 6 Assembly and wiring 6.1 General information Mount the device on a flat surface using 2 screws (M4x 25/30). The torque required here is 1 Nm. Use washers for all fastening methods as per DIN 125. Attention: The devices have a ground connection with an M4 thread for the conduction of interference currents and the EMC immunity.
Page 26: Outer Dimensions
6.2 Outer dimensions 6 Assembly and wiring 6.2 Outer dimensions 6.2.1 LioN-X Digital-I/O multiprotocol variants Figure 1: 0980 XSL 3900-121-007D-01F Manual EtherCAT® Version 1.0 03/2023...
Page 27 6 Assembly and wiring 6.2 Outer dimensions Figure 2: 0980 XSL 3901-121-007D-01F Manual EtherCAT® Version 1.0 03/2023...
Page 28 6.2 Outer dimensions 6 Assembly and wiring Figure 3: 0980 XSL 3903-121-007D-01F Manual EtherCAT® Version 1.0 03/2023...
Page 29 6 Assembly and wiring 6.2 Outer dimensions Figure 4: 0980 XSL 3923-121-007D-01F Manual EtherCAT® Version 1.0 03/2023...
Page 30: Notifications
6.2 Outer dimensions 6 Assembly and wiring 6.2.2 Notifications Attention: For UL applications, be sure to use a UL-certified cable with a suitable evaluation to connect the devices (CYJV or PVVA). To program the control, please refer to the OEM information, and only use suitable accessories.
Page 31: Port Assignments
6 Assembly and wiring 6.3 Port assignments 6.3 Port assignments All the contact arrangements shown in this chapter show the frontal view of the connection area for the connectors. 6.3.1 Ethernet ports, M12 socket, 4-pin, D-coded Color coding: green Figure 5: Schematic drawing, ports X01, X02 Port Signal Function...
Page 32: Power Supply With M12 Power L-Coded
6.3 Port assignments 6 Assembly and wiring 6.3.2 Power supply with M12 power L-coded Color coding: gray Figure 6: Schematic diagram of the M12 L-coding (connector X03 for Power Figure 7: Schematic diagram of the M12 L-coding (socket X04 for Power Out) Power supply Signal...
Page 33: I/O Ports As M12 Sockets
6 Assembly and wiring 6.3 Port assignments Attention: For the input module 0980 XSL 3901-xxx, the two contacts 1 and 5 are not required for the voltage supply of the actuator. Nevertheless, these two contacts are bridged together on the plug and socket side to enable a 5-pole forwarding of the voltage supply to a subsequent module.
Page 34: I/O Ports
6.3 Port assignments 6 Assembly and wiring 6.3.3.1 I/O ports Signal Function 0980 XSL 3900-121... 16DIO +24 V power supply +24 V X1 .. X8 IN/OUT Ch. B: Digital input or digital output Ground/reference potential IN/OUT Ch. A: Digital input or digital output Functional ground 0980 XSL 3901-121...
Page 35: Starting Operation
All device variants are grouped in a single ESI file. The file can be downloaded from the product pages on our online catalog: catalog.belden.com On request, the ESI file is also sent by the support team. The ESI file is named LumbergAutomation-LioN-X-Digital.xml.
Page 36: Mac Addresses
7.2 MAC addresses 7 Starting operation 7.2 MAC addresses Every device has three unique assigned MAC addresses that cannot be changed by the user. The first assigned MAC address is printed onto the device. For EtherCAT , the MAC address has no function. For EoE (Ethernet over ®...
Page 37 7 Starting operation 7.3 Setting the rotary encoding switches With the other rotary encoding switches (x10 / x1), you set the last two digits of the IP address when you are using EtherNet/IP, Modbus TCP or CC-Link IE Field Basic. Protocol x100 EtherNet/IP...
Page 38 7.3 Setting the rotary encoding 7 Starting operation switches point. The device will always start using the stored protocol from that point on. The IP address can be changed depending on the selected protocol. To change the protocol, carry out a factory reset. In this way you restore the factory settings of the respective device.
Page 39: Factory Reset
7 Starting operation 7.3 Setting the rotary encoding switches 7.3.1 Factory reset A factory reset restores the original factory settings and thus resets the changes and settings you have made up to that point. It also resets the protocol selection. To perform a factory reset, set the first rotary encoding switch (x100) to 9, the second (x10) to 7, and the third (x1) also to 9.
Page 40: Pdo Assignments
8.1 PDO assignments 8 Configuration and operation in TwinCAT ® 8 Configuration and operation in TwinCAT ® 8.1 PDO assignments Only applicable for variant 0980 XSL 3900-121-007D-00F (16 x Input/Output). The device supports different PDO (Process Data Object) assignments for input and output data.
Page 41 8 Configuration and operation in 8.1 PDO assignments TwinCAT ® PDO 0x1A01 (TxPDO Mapping 16 Bits) PDO content Index Size Index Size Type Name 0x1A01 0x6020:1 UINT32 SubIndex 001 0x6020:2 UINT32 SubIndex 002 0x6020:3 UINT32 SubIndex 003 0x6020:4 UINT32 SubIndex 004 0x6020:5 UINT32 SubIndex 005...
Page 42 8.1 PDO assignments 8 Configuration and operation in TwinCAT ® PDO 0x1A11 (TxPDO Mapping 8 Bits) PDO content Index Size Index Size Type Name 0x1A11 0x6020:1 UINT32 SubIndex 001 0x6020:2 UINT32 SubIndex 002 0x6020:3 UINT32 SubIndex 003 0x6020:4 UINT32 SubIndex 004 0x6020:5 UINT32 SubIndex 005...
Page 43 8 Configuration and operation in 8.1 PDO assignments TwinCAT ® PDO 0x1A82 (TxPDO current measurements) PDO content Index Size Index Size Type Name 0x1A82 0x2003:1 UINT32 SubIndex 001 0x2003:2 UINT32 SubIndex 002 0x2003:3 UINT32 SubIndex 003 0x2003:4 UINT32 SubIndex 004 0x2003:5 UINT32 SubIndex 005...
Page 44: Output Data
8.1 PDO assignments 8 Configuration and operation in TwinCAT ® 8.1.2 Output data PDO 0x1600 (RxPDO Mapping 2 Byte) PDO content Index Size Index Size Type Name 0x1600 0x7000:1 UINT32 SubIndex 001 0x7000:2 UINT32 SubIndex 002 PDO 0x1601 (RxPDO Mapping 16 Bits) PDO content Index Size...
Page 45 8 Configuration and operation in 8.1 PDO assignments TwinCAT ® PDO 0x1610 (RxPDO Mapping 1 Byte) PDO content Index Size Index Size Type Name 0x1610 0x7000:1 UINT32 SubIndex 001 PDO 0x1611 (RxPDO Mapping 8 Bits) PDO content Index Size Index Size Type Name...
Page 46: Modular Slots
8.1 PDO assignments 8 Configuration and operation in TwinCAT ® 8.1.3 Modular slots Only applicable for variant 0980 XSL 3900-121-007D-00F (16 x Input/Output). The ESI file features a modular slot-based PDO configuration. The following slots are available for the I/O configuration: Slot name Description 16DI/DO (byte)
Page 47: Device Parameters
8 Configuration and operation in 8.2 Device parameters TwinCAT ® 8.2 Device parameters The device supports different parameters. The parameters must be transferred from the controller to the device during startup. The following blocks of parameters can be adjusted. Certain configuration parameters apply only to Digital Outputs or only to Digital Inputs.
Page 48 8.2 Device parameters 8 Configuration and operation in TwinCAT ® SDO content Index Size Index Size Type Name 0x2380 0x2380:1 UINT8 Port X1 A 0 = Set Low 1 = Set High 2 = Hold Last Others: reserved 0x238 :2 UINT8 Port X1 B 0 = Set Low...
Page 49 8 Configuration and operation in 8.2 Device parameters TwinCAT ® SDO content 0x2380:7 UINT8 Port X4 A 0 = Set Low 1 = Set High 2 = Hold Last Others: reserved 0x2380:8 UINT8 Port X4 B 0 = Set Low 1 = Set High 2 = Hold Last Others: reserved...
Page 50 8.2 Device parameters 8 Configuration and operation in TwinCAT ® SDO content 0x2380:14 UINT8 Port X7 B 0 = Set Low 1 = Set High 2 = Hold Last Others: reserved 0x2380:15 UINT8 Port X8 A 0 = Set Low 1 = Set High 2 = Hold Last Others: reserved...
Page 51: General Device Settings
8 Configuration and operation in 8.2 Device parameters TwinCAT ® 8.2.2 General device settings The device supports the setting of different parameters. The following blocks of parameters can be adjusted: SDO content Index Size Index Size Type Name 0x2381 0x2381:1 BOOL Web Interface Locked 0 = false, 1 = true...
Page 52: Surveillance Timeout
8.2 Device parameters 8 Configuration and operation in TwinCAT ® 8.2.3 Surveillance timeout The firmware of the devices allows you to define a delay time before the automatic monitoring of the output currents. This is known as the surveillance timeout. You can define the surveillance timeout for every individual output channel.
Page 53 8 Configuration and operation in 8.2 Device parameters TwinCAT ® SDO content 0x2382:9 UINT8 Surveillance Timeout Port 5 Channel 0x2382:10 UINT8 Surveillance Timeout Port 5 Channel 0x2382:11 UINT8 Surveillance TimeoutPort 6 Channel 0x2382:12 UINT8 Surveillance Timeout Port 6 Channel 0x2382:13 UINT8 Surveillance Timeout Port 7 Channel 0x2382:14...
Page 54: Digital Input Logic
8.2 Device parameters 8 Configuration and operation in TwinCAT ® 8.2.4 Digital input logic The device supports the configuration of digital input logic for Channel A (Pin 4) and Channel B (Pin 2) of the port. SDO content Index Size Index Size Type...
Page 55 8 Configuration and operation in 8.2 Device parameters TwinCAT ® SDO content 0x2384:8 UINT8 Digital Input logic Port 4 Channel B 0: NO 1: NC 0x2384:9 UINT8 Digital Input logic Port 5 Channel A 0: NO 1: NC 0x2384:10 1 UINT8 Digital Input logic Port 5 Channel B 0: NO...
Page 56: Digital Input Filter
8.2 Device parameters 8 Configuration and operation in TwinCAT ® 8.2.5 Digital input filter The device supports the configuration of a digital input filter (in ms) for Channel A (Pin 4) and Channel B (Pin 2) of the port. Example: Value "100" = 10 ms SDO content Index Size...
Page 57: Digital Output Restart
8 Configuration and operation in 8.2 Device parameters TwinCAT ® 8.2.6 Digital Output restart The device supports the option to enable or disable a digital output restart for a given Channel A (Pin 4) or Channel B (Pin 2) of the port. Timeout: ~1 s SDO content Index Size...
Page 58 8.2 Device parameters 8 Configuration and operation in TwinCAT ® SDO content 0x2386:12 BOOL Enable the Digital Output restart for Port X6 Channel B 0x2386:13 BOOL Enable the Digital Output restart for Port X7 Channel A 0x2386:14 BOOL Enable the Digital Output restart for Port X7 Channel B 0x2386:15 BOOL...
Page 59: I/O Mapping Configuration
8 Configuration and operation in 8.2 Device parameters TwinCAT ® 8.2.7 I/O mapping configuration The device supports the configuration of the I/O mapping of the port. SDO content Index Size Index Size Type Name 0x2387 0x2387:1 UINT8 I/O Mapping Configuration Port X1 A: 0 ..
Page 60 8.2 Device parameters 8 Configuration and operation in TwinCAT ® SDO content 0x2387:12 UINT8 I/O Mapping Configuration Port X6 B: 0 .. 15 = "Process Data Channel 0 .. 15", 255 = "Inactive" 0x2387:13 UINT8 I/O Mapping Configuration Port X7 A: 0 ..
Page 61: Output Current Limit
8 Configuration and operation in 8.2 Device parameters TwinCAT ® 8.2.8 Output current limit The device supports the configuration of a current limit for the output for Channel A (Pin 4) and Channel B (Pin 2) of the port. SDO content Index Size Index...
Page 62 8.2 Device parameters 8 Configuration and operation in TwinCAT ® SDO content 0x2388:12 UINT16 Current limit (in mA) to turn off X6 B: Default: 2000 0x2388:13 UINT16 Current limit (in mA) to turn off X7 A: Default: 2000 0x2388:14 UINT16 Current limit (in mA) to turn off X7 B: Default: 2000 0x2388:15 UINT16 Current limit (in mA) to turn off X8 A:...
Page 63 8 Configuration and operation in 8.3 Configuration example with TwinCAT TwinCAT ® ® 8.3 Configuration example with TwinCAT ® 3 The configuration and start-up of the devices described below refer to the TwinCAT 3 software by Beckhoff Automation GmbH & Co. KG. If ®...
Page 64 8.3 Configuration example with 8 Configuration and operation in TwinCAT TwinCAT ® ® 5. If not already done, choose the network adapter and install the driver for EtherCAT real time communication. ® Browse to Adapter in the right workspace window and click on Compatible Devices...
Page 65: Configuration Of 0980 Xsl 3900-121
8 Configuration and operation in 8.3 Configuration example with TwinCAT TwinCAT ® ® 8.3.1 Configuration of 0980 XSL 3900-121-... devices 1. Select the I/O device from the hardware catalog: Browse to Solution Explorer > I/O > Devices in the left workspace window. Right-click on Device 1 (EtherCAT) and choose the option Add New Item ….
Page 66 8.3 Configuration example with 8 Configuration and operation in TwinCAT TwinCAT ® ® 3. Configure the Process Data: Browse to Process Data in the right workspace window and choose the PDOs for Inputs and Outputs. Manual EtherCAT® Version 1.0 03/2023...
Page 67: Eoe Ip Address
8 Configuration and operation in 8.3 Configuration example with TwinCAT TwinCAT ® ® 8.3.2 EoE IP address 1. Set the IP address for the EoE (Ethernet over EtherCAT ) protocol: ® For using the Web interface of the device, the IP address must be set. Click on EtherCAT >...
Page 68 8.3 Configuration example with 8 Configuration and operation in TwinCAT TwinCAT ® ® 3. Activate IP Port and IP Address when using Web services. Enter your IP settings depending from your local network adapter settings. Manual EtherCAT® Version 1.0 03/2023...
Page 69: Activate Configuration
8 Configuration and operation in 8.3 Configuration example with TwinCAT TwinCAT ® ® 8.3.3 Activate configuration Warning: Risk of personal injury or damage of the equipment. Keep away from moveable machine parts during setting up the inputs or outputs of the device. 1.
Page 70: Diagnostics Processing
9.1 Channel error 9 Diagnostics processing 9 Diagnostics processing The devices provide advanced diagnosis behavior, in particular for the output channels. The firmware of the devices distinguishes between 5 different types of error. 9.1 Channel error A channel error is determined by comparing the target value set by a controller with the actual value of an output channel.
Page 71: Voltage Error At The M12 Slots (Sensor Short-Circuit)
9 Diagnostics processing 9.2 Voltage error at the M12 slots (sensor short-circuit) of the module. The value of this parameter can range from 0 to 255 ms; the factory setting is 80 ms. The filter is used to avoid premature error messages when a capacitive load is activated or an inductive load is deactivated, and during other voltage peaks when a status changes.
Page 72: Overload/Short-Circuit Of The I/O Port Sensor Supply Outputs
9.2 Voltage error at the M12 slots 9 Diagnostics processing (sensor short-circuit) For disabled U supply voltage fault alarms, the U indicator LED is "off" in case of voltage drops below approx. 18 V. For enabled U supply voltage fault alarms, the U indicator LED is "red"...
Page 73: Internal Module Error
9 Diagnostics processing 9.3 Emergency messages 9.2.4 Internal module error Internal module error states (e.g. internal abnormal states) will be reported by the following diagnostic message. 9.3 Emergency messages When parametrized, the Device sends emergency messages to the Master in case of a detected diagnosis on the Device.
Page 74: Iiot Functionality
10 IIoT functionality 10 IIoT functionality The LioN-X variants offer a number of new interfaces and functions for the optimal integration into existing or future IIoT (Industrial Internet of Things) networks. The devices continue to work as field bus devices which communicate with and are controlled by a PLC (Programmable Logic Controller).
Page 75: Mqtt
10 IIoT functionality 10.1 MQTT 10.1 MQTT The MQTT (Message Queueing Telemetry Transport) protocol is an open network protocol for machine-to-machine communication, which provides the transmission of telemetric data messages between devices. The integrated MQTT client allows the device to publish a specific set of information to an MQTT broker.
Page 76 10.1 MQTT 10 IIoT functionality The following configuration elements are available (default values in bold): Element Data Description Example data type mqtt-enable boolean Master switch for the MQTT client. true / false broker string IP address of the MQTT Broker "192.168.1.1"...
Page 77 10 IIoT functionality 10.1 MQTT Element Data Description Example data type number Selects the "Quality of Service" status 0 = At most once for all published messages. 1 = At least once 2 = Exactly once Table 15: MQTT configuration MQTT response: The resulting response is a JSON object with a "status"...
Page 78: Mqtt Topics
10.1 MQTT 10 IIoT functionality 10.1.2 MQTT topics MQTT mainly relates to topics. All messages are attached to a topic which adds context to the message itself. Topics may consist of a string and they are allowed to contain slashes (/). In topic filters, there also wildcard symbols like e.g.
Page 79 10 IIoT functionality 10.1 MQTT There are the following domains: Domain name Definition Example content identity All fixed data which is defined by the Device name, ordering number, MAC used hardware and which cannot be address, port types, port capabilites changed by configuration or at runtime.
Page 80 10.1 MQTT 10 IIoT functionality Topic Content examples Total Publish publish interval count [base-topic]/identity/ Name, ordering number, MAC, vendor, I&M Startup gateway etc. [base-topic]/identity/ Port name, port type Startup port/n [base-topic]/config/ Configuration parameters, ip address etc. Interval gateway [base-topic]/config/port/ Port mode, data storage, mapping, direction Interval [base-topic]/status/ Bus state, device diagnosis, master events...
Page 81: Publish Topic
10 IIoT functionality 10.1 MQTT 10.1.2.2 Publish topic Overview of all publish JSON data for the defined topics: Identity/gateway Data type product_name json_string ordering_number json_string device_type json_string serial_number json_string mac_address json_string production_date json_string fw_name json_string fw_date json_string fw_version json_string hw_version json_string family json_string...
Page 82 10.1 MQTT 10 IIoT functionality Config/gateway Data type Range Default Remarks value fieldbus_protocol json_string PROFINET EtherNet/IP EtherCAT® Modbus TCP CC-Link IE Field Basic network_configuration json_string PROFINET: Manual EtherNet/IP: Manual Rotary DHCP EtherCAT®: Manual Modbus TCP: Manual DHCP Rotary CC-Link IE Field Basic: Manual Rotary...
Page 83 10 IIoT functionality 10.1 MQTT Config/gateway Data type Range Default Remarks value fast_startup json_boolean true / false false PROFINET and EIP only Table 21: Config/gateway Manual EtherCAT® Version 1.0 03/2023...
Page 84 10.1 MQTT 10 IIoT functionality Status/gateway Data type Range Default Remarks value protocol json_string PROFINET: UNKNOWN OFFLINE STOP IDLE OPERATE EtherNet/IP: CONNECTED DISCONNECTED EtherCAT®: PREOP SAFEOP INIT UNKNOWN Modbus TCP: No Connections Connected CC-Link IE Feld Basic: STOP DISCONNECTED ERROR system_voltage_fault json_boolean true / false...
Page 85 10 IIoT functionality 10.1 MQTT Process/gateway Data type Range Default Remarks value Input_data json_integer[] output_data json_integer[] Table 23: Process/gateway Manual EtherCAT® Version 1.0 03/2023...
Page 86 10.1 MQTT 10 IIoT functionality Identity/port/1 .. 8 Data type Range Default Remarks value port json_integer 1 .. 8 type json_string Digital Input Digital Output DIO Pin 4 Only DI Pin 4 Only DO Pin 4 Only Not available Unknown max_output_power_cha json_string 2.0_mA...
Page 87 10 IIoT functionality 10.1 MQTT Config/port/1 .. 8 Data type Range Default Remarks value port json_integer 1 .. 8 direction_cha json_string Output Input Inactive Auxiliary Power Unknown direction_chb json_string Output Input Inactive Auxiliary Power Unknown restart_mode_cha json_string Manual Auto restart_mode_chb json_string Manual Auto...
Page 88 10.1 MQTT 10 IIoT functionality Config/port/1 .. 8 Data type Range Default Remarks value surveillance_timeout_chb json_integer 0 .. 255 io_mapping_cha json_integer 0 .. 15 channel 16DIO only number io_mapping_chb json_integer 0 .. 15 channel 16DIO only number Table 25: Config/port/1 .. 8 Status/port/1 ..
Page 89: Command Topic (Mqtt Subscribe)
10 IIoT functionality 10.1 MQTT 10.1.2.3 Command topic (MQTT Subscribe) The main purpose of MQTT is to publish data from the device to a broker. This data can then be received by any subscriber who is interested in this data. But also the other way round is possible. The device can subscribe to a topic on the broker and is then able to receive data.
Page 90 10.1 MQTT 10 IIoT functionality For the Force object properties digital and iol, there are several value specifications arrayed: Property Data type Example values Remarks port integer 1, 2, 5 channel string "a", "b" force_dir string "out", "in", "clear" force_value integer 0, 1 Table 28: Force object: Digital...
Page 91 10 IIoT functionality 10.1 MQTT For the Conig object property portmode, there are several value specifications arrayed: Property Data type Example values Remarks port integer channelA* string "dio", "di", "do", "iol", "off" channelB* string "dio", "di", "do", "iol", "off", "aux" inlogicA string "no", "nc"...
Page 92 10.1 MQTT 10 IIoT functionality […]/reset Use the Command topic [base-topic]/command/reset for Reset object data about restart and factory reset issues. The Reset object can contain any of the following properties: Property Data type Example values Remarks factory_reset boolean true / false system_reset boolean true / false...
Page 93: Mqtt Configuration - Quick Start Guide
10 IIoT functionality 10.1 MQTT 10.1.3 MQTT configuration - Quick start guide Attention: Lumberg Automation is not responsible for any content of the referenced Web pages and provides no warranty for any functionality of the named third party software. 10.1.3.1 MQTT configuration via JSON 1.
Page 94 10.1 MQTT 10 IIoT functionality 3. Read MQTT: GET: [IP-address]/r/config/mqtt.json Manual EtherCAT® Version 1.0 03/2023...
Page 95: Opc Ua
10 IIoT functionality 10.2 OPC UA 10.2 OPC UA OPC Unified Architecture (OPC UA) is a platform-independent standard with a service-oriented architecture for communication in and with industrial automation systems. The OPC UA standard is based on the client-server principle and lets machines and devices, regardless of any preferred field bus, communicate horizontally among each other as well as vertically to the ERP system or the cloud.
Page 96 10.2 OPC UA 10 IIoT functionality Tree overview of OPC UA objects: All configuration elements are optional and do not need a specific order. Not every element is required to be sent. This means that only configuration changes will be taken over. Manual EtherCAT®...
Page 97 10 IIoT functionality 10.2 OPC UA Optional: The configuration parameters of OPC UA can be set directly via the Web interface. It is possible to download the Web interface for sharing with other devices. Response: The resulting response is a JSON object with a status field. Status should be "0"...
Page 98: Gateway Objects
10.2 OPC UA 10 IIoT functionality 10.2.1.1 Gateway objects Identity Name Data type Example Device Name UA_STRING Device ID UA_STRING MAC address UA_STRING Ordering Number UA_STRING Serial Number UA_STRING Production Date UA_STRING Hardware Version UA_STRING App Firmware Version UA_STRING Fieldbus Firmware Version UA_STRING IO Firmware Version UA_STRING...
Page 99 10 IIoT functionality 10.2 OPC UA Name Data type Unit Example Forcemode diag UA_BOOLEAN US voltage UA_DOUBLE 23.2 UL voltage UA_DOUBLE 22.9 Rotary position UA_UINT16 Forcing (read) Name Data type Example Forcing active UA_BOOLEAN Forcing client UA_STRING if forcemode is not active, string is empty Own Forcing UA_BOOLEAN...
Page 100 10.2 OPC UA 10 IIoT functionality Process (read) Name Data type Example Input Data UA_UINT16 ioInput for all channels Output Data UA_UINT16 ioOutput for all channels Consuming Data UA_UINT16 Data from the PLC to the device Producing Data UA_UINT16 Data from the device to the PLC Commands (write) Name Arguments...
Page 101: Ports Objects
10 IIoT functionality 10.2 OPC UA 10.2.1.2 Ports objects Identity Name Data type Example Name UA_STRING "X1" Type UA_STRING "DIO" Channel m ("Pin 4" / "Pin 2") See details in Channel objects on page 102. Status (read) Name Data type Unit Example Sensor Diag...
Page 102: Channel Objects
10.2 OPC UA 10 IIoT functionality 10.2.1.3 Channel objects Identity (read) Name Data type Unit Example Name UA_STRING "X1A" Type UA_STRING "DIO" MaxOutputCurrent UA_INT16 1300 Status (read) Name Data type Unit Example Actuator Diag UA_BOOL Actuator Voltage UA_DOUBLE 23.5 Actuator Current UA_INT16 Channel Failsafe UA_BOOL...
Page 103 10 IIoT functionality 10.2 OPC UA Name Data type Unit Example / Remarks InputFilterTime UA_UINT8 InputLogic UA_ENUMERATION Process (read) Name Data type Example / Remarks Output UA_BOOLEAN Output type channels only. Input UA_BOOLEAN Input type channels only. Consuming UA_BOOLEAN Producing UA_BOOLEAN Forcing (read + write) Name...
Page 104: Opc Ua Address Space
10.2 OPC UA 10 IIoT functionality Name Data type Example / Remarks Simulate value UA_BOOLEAN When changed by the user it will start simulation with the new value if forcing is enabled for opcua. Input type channels only. 10.2.2 OPC UA address space OPC UA provides different services on the LioN-X devices with which a client can navigate through the hierarchy of the address space and read or write variables.
Page 105: Opc Ua Configuration - Quick Start Guide
10 IIoT functionality 10.2 OPC UA 10.2.3 OPC UA configuration - Quick start guide Attention: Lumberg Automation is not responsible for any content of the referenced Web pages and provides no warranty for any functionality of the named third party software. 10.2.3.1 OPC UA configuration via JSON 1.
Page 106 10.2 OPC UA 10 IIoT functionality 3. Read OPC UA: GET: [IP-address]/r/config/opcua.json Manual EtherCAT® Version 1.0 03/2023...
Page 107: Rest Api
For all LioN-X variants, the REST API can be used to read the device status. For the LioN-X multiprotocol variants, the REST API can also be used to write configuration and forcing data. The customized Belden REST API is described in the following chapters. 10.3.1 Standard device information Request method:...
Page 108: Structure
10.3 REST API 10 IIoT functionality 10.3.2 Structure Name Data type Description Example name string Device name "0980 XSL 3912- 121-007D-00F" order-id string Ordering number "935 700 001" fw-version string Firmware version "V.1.1.0.0 - 01.01.2021" hw-version string Hardware version "V.1.00" string MAC address of the device "3C B9 A6 F3 F6...
Page 109 10 IIoT functionality 10.3 REST API Name Data type Description Example consuming array of numbers (2) Cyclic data from PLC to device producing array of numbers (2) Cyclic data from device to PLC Element 0 = 1 Byte: diag array of numbers (4) Diagnostic information Bit 7: Internal module error (IME)
Page 110 10.3 REST API 10 IIoT functionality Name Data type Description Example CHANNEL Object name string Name of channel type number Hardware channel type as number: 0 = DIO 1 = Input 2 = Output 3 = Input/Output 4 = Channel not available 5 = Channel not available 6 = Channel not available 7 = Channel not available...
Page 111 10 IIoT functionality 10.3 REST API Name Data type Description Example maxOutputCurrent number Maximum output current of the output in mA current_mA number Measured current of the output in mA (if current measurement is available) voltage_mV number Measured voltage of this output in mV (if voltage measurement is available) PORT Object port_type...
Page 112: Configuration And Forcing
10.3 REST API 10 IIoT functionality Name Data type Description Example digitalOutForced array of numbers (2) The force values of all 16 digital output channels. digitalOutMask array of numbers (2) The forcing mask of all 16 digital output channels. digitalInForced array of numbers (2) The force values of all 16 digital input channels.
Page 113 10 IIoT functionality 10.3 REST API Property Data type Example values Remarks port integer 0..7 channel integer "a","b" optional default is "a" direction string "dio","di","do", "off", "aux" inlogica string "no","nc" inlogicb string "no","nc" Table 33: Port mode object Property Data type Example values Remarks port...
Page 114: Coap Server
10.4 CoAP server 10 IIoT functionality 10.4 CoAP server The Constrained Application Protocol (CoAP) is a specialized Internet application protocol for constrained networks such as lossy or low power networks. CoAP is useful especially in M2M (Machine to Machine) communication and can be used to translate simplified HTTP requests of low speed networks.
Page 115: Rest Api Access Via Coap
10 IIoT functionality 10.4 CoAP server The following configuration elements are available (default values in bold): Element Data type Description Example data true / false enable boolean Master switch for the CoAP server port integer Port of the CoAP server 5683 (0 to 65535) Table 35: CoAP configuration...
Page 116 10.4 CoAP server 10 IIoT functionality Type Note /r/status.lr /r/system.lr /info.json" /r/config/net.json /r/config/mqtt.json /r/config/opcua.json /r/config/coapd.json /r/config/syslog.json /contact.json /fwup_status Table 36: REST API access via CoAP Manual EtherCAT® Version 1.0 03/2023...
Page 117: Coap Configuration - Quick Start Guide
10 IIoT functionality 10.4 CoAP server 10.4.3 CoAP configuration - Quick start guide Attention: Lumberg Automation is not responsible for any content of the referenced Web pages and provides no warranty for any functionality of the named third party software. 10.4.3.1 CoAP configuration via JSON 1.
Page 118 10.4 CoAP server 10 IIoT functionality 3. Read CoAP configuration: GET: [IP-address]/r/config/coapd.json Manual EtherCAT® Version 1.0 03/2023...
Page 119: Syslog
10 IIoT functionality 10.5 Syslog 10.5 Syslog The LioN-X multiprotocol variants provide a Syslog client which can connect with a configured Syslog server and is able to log messages. Syslog is a platform-independent standard for logging messages. Each message contains a timestamp as well as information about the severity level and the subsystem.
Page 120 10.5 Syslog 10 IIoT functionality The following configuration elements are available (default values in bold): Element Data type Description Example data true / false syslog-enable boolean Master switch for the Syslog client global-severity integer Severity level of Syslog client 0/1/2/3/4/5/6/7 0 –...
Page 121 10 IIoT functionality 10.5 Syslog Syslog response: The resulting response is a JSON object with a "status" field. Status should be "0" if no error occurred, and "-1" if there is an error. In case of an error, the response contains an error array. The error array contains an error object for each error occurred.
Page 122: Syslog Configuration - Quick Start Guide
10.5 Syslog 10 IIoT functionality 10.5.2 Syslog configuration - Quick start guide Attention: Lumberg Automation is not responsible for any content of the referenced Web pages and provides no warranty for any functionality of the named third party software. 10.5.2.1 Syslog configuration via JSON 1.
Page 123 10 IIoT functionality 10.5 Syslog 3. Read Syslog configuration: GET: [IP-address]/r/config/syslog.json Manual EtherCAT® Version 1.0 03/2023...
Page 124: Network Time Protocol (Ntp)
10.6 Network Time Protocol (NTP) 10 IIoT functionality 10.6 Network Time Protocol (NTP) The LioN-X multiprotocol variants provide an NTP client (version 3) which can connect with a configured NTP server and is able to synchronize the network time at a configurable interval. NTP is a network protocol which uses UDP datagrams to send and receive timestamps in order to synchronize with a local clock.
Page 125 10 IIoT functionality 10.6 Network Time Protocol (NTP) The following configuration elements are available (default values in bold): Element Data type Description Example data true / false NTP client state boolean Master switch for the NTP client Server address string IP address of the NTP server 192.168.1.50 Server port...
Page 126: Ntp Configuration - Quick Start Guide
10.6 Network Time Protocol (NTP) 10 IIoT functionality 10.6.2 NTP configuration - Quick start guide Attention: Lumberg Automation is not responsible for any content of the referenced Web pages and provides no warranty for any functionality of the named third party software. 10.6.2.1 NTP configuration via JSON 1.
Page 127 10 IIoT functionality 10.6 Network Time Protocol (NTP) 3. Read NTP configuration: GET: [IP-address]/r/config/ntpc.json Manual EtherCAT® Version 1.0 03/2023...
Page 128: The Integrated Web Server
11 The integrated Web server 11 The integrated Web server All device variants are equipped with an integrated Web server which makes functions for the device configuration and the display of status and diagnostic information available via a Web interface. The Web interface provides an overview of the configuration and status of the device.
Page 129 11 The integrated Web server 11.1 LioN-X 0980 XSL... variants 11.1 LioN-X 0980 XSL... variants 11.1.1 The Status page The status page provides a quick overview of the current state of the device. The left side shows a graphical representation of the module with all its LEDs and the positions of the rotary encoding switches.
Page 130: The Ports Page
11.1 LioN-X 0980 XSL... variants 11 The integrated Web server 11.1.2 The Ports page The page shows detailed port information. In the field Port Diagnosis, incoming and outgoing diagnostics are displayed as clear text. Pin 2 and Pin 4 contain information about the configuration and state of the port. Manual EtherCAT®...
Page 131: The System Page
11 The integrated Web server 11.1 LioN-X 0980 XSL... variants 11.1.3 The System page The System page shows the basic information for the module like Firmware version, Device information, Ethernet, Network and Fieldbus information. Restart Device The module initializes a software reset. Manual EtherCAT®...
Page 132 11.1 LioN-X 0980 XSL... variants 11 The integrated Web server Reset to Factory Settings The module restores to the default factory settings. IP Settings Use this parameter to change the current IP address of the module. For PROFINET, this is only useful during commissioning. Normally, the PLC sets the IP address at start-up by detecting the PROFINET module via its device name.
Page 133: The User Page
11 The integrated Web server 11.1 LioN-X 0980 XSL... variants 11.1.4 The User page The User page provides the user management of the Web interface. New users with access rights "Admin" or "Write" can be added here. For security reasons please change the default admin password immediately after configuring the device.
Page 134: Technical Data
The following sections give an overview of the most important functional data needed to operate the device. For further information and detailed technical data, see the respective Data Sheet of your required product in the product specific download area on catalog.belden.com. Manual EtherCAT® Version 1.0 03/2023...
Page 135: General
12 Technical data 12.1 General 12.1 General Protection class IP65 (Only applies if the connectors IP67 are screwed together or if IP69K protective caps are used.) Ambient temperature (during 0980 XSL 3x00-121... -40 °C .. +70 °C operation and storage) 0980 XSL 3x01-121...
Page 136: Ethercat ® Protocol
12 Technical data 12.2 EtherCAT protocol ® 12.2 EtherCAT ® protocol Protocol EtherCAT ® (ETG.1000 V1.2) ESI file LumbergAutomation-LioN-X-Digital.xml Transmission rate 100 Mbit/s, full duplex Type of addressing Auto-increment addressing, Fixed addressing Min. cycle time 1 ms Vendor ID Device ID 0x0400 (same for all LioN-X devices) Mailbox protocols CanOpen over EtherCAT ®...
Page 137: Power Supply Of The Module Electronics/Sensors
12 Technical data 12.3 Power supply of the module electronics/sensors 12.3 Power supply of the module electronics/ sensors Port X03, X04 M12-L-coded Power, connector/socket, 5-pole Pin 1 / Pin 3 Nominal voltage U 24 V DC (SELV/PELV) Current U Max. 16 A Voltage range 21 ..
Page 138: Power Supply Of The Actuators
12.4 Power supply of the actuators 12 Technical data Max. 5.0 A for each port pair X1/X2, X3/X4, X5/X6, X7/X8 Max. 9.0 A in total for the whole port group X1 .. X8 Pay attention to the derating! 12.4 Power supply of the actuators Port X03, X04 M12_L-coded Power, connector/socket, 5-pole Pin 2 / Pin 4...
Page 139: Digital Inputs
12 Technical data 12.5 I/O ports 12.5.1 Digital inputs Input connection 0980 XSL 3900-121... Type 3 as per IEC 61131-2 0980 XSL 3901-121... 0980 XSL 39x3-121... Nominal input 24 V DC voltage Input current Typically 3 mA Channel type Normally open, p-switching Number of digital 0980 XSL 3900-121...
Page 140 12.5 I/O ports 12 Technical data Output type normally open, p-switching Nominal output voltage per channel Signal status “1” min. (U -1 V) Signal status “0” max. 2 V Max. output current per 0980 XSL 3900-121... device 0980 XSL 39x3-121... Max. output current per 0980 XSL 3900-121...
Page 141 12 Technical data 12.6 LEDs 12.6 LEDs Color Description Green Auxiliary sensor/actuator voltage OK 18 V (+/- 1 V) < U < 30 V (+/- 1 V) Auxiliary sensor/actuator voltage LOW < 18 V (+/- 1 V) or U > 30 V (+/- 1 V) if "Report U supply voltage fault" is enabled. None of the above conditions.
Page 142 12.6 LEDs 12 Technical data Color Description EtherCAT controller has established an active connection to ® the device. EtherCAT ® module diagnostic alarm active. Red flashing at Watchdog time-out; fail safe mode is active. 1 Hz Red double flash Firmware update None of the above conditions.
Page 143 12 Technical data 12.7 Data transfer times 12.7 Data transfer times The following tables give an overview of the internal data transfer times of LioN-X. There are three measured data direction values for each use case: PLC to DO: Transfer of a changed PLC output data to the digital output channel.
Page 144 12.7 Data transfer times 12 Technical data Use case 1: LioN-X Digital-I/O configuration with enabled Web interface and disabled IIoT protocols 16DIO variant (0980 XSL 3900-121-007D-01F): Data direction Data transfer time in ms Minimum Average Maximum PLC to DO DI to PLC 8DI/8DO variant without galvanic isolation (0980 XSL 3913-121-007D-01F): Data direction Data transfer time in ms...
Page 145 12 Technical data 12.7 Data transfer times Use case 2: LioN-X Digital-I/O configuration with enabled Web interface and enabled IIoT protocols 16DIO variant (0980 XSL 3900-121-007D-01F): Data direction Data transfer time in ms Minimum Average Maximum PLC to DO DI to PLC 10.0 11.5 14.0...
Page 146 13 Accessories 13 Accessories In order to get access to various types of accessories, please visit our Web page: http://www.beldensolutions.com Manual EtherCAT® Version 1.0 03/2023...

This manual is also suitable for:

Lumberg automation 0980 xsl 3901-121-007d-01f Lumberg automation 0980 xsl 3903-121-007d-01f Lumberg automation 0980 xsl 3923-121-007d-01f 935705001 935706002 935707001 ... Show all

Belden Lumberg Automation 0980 XSL 3900-121-007D-01F Manual

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Belden Lumberg Automation 0980 XSL 3900-121-007D-01F

Summary of Contents for Belden Lumberg Automation 0980 XSL 3900-121-007D-01F

This manual is also suitable for:

Table of Contents