Documentation
EL1052, EL1054
Digital input terminals for NAMUR sensors
Version:
Date:
1.1
2018-11-29
Table of contents
Table of contents
1 Foreword ....................................................................................................................................................5
1.1 Notes on the documentation..............................................................................................................5
1.2 Safety instructions .............................................................................................................................6
1.3 Documentation Issue Status..............................................................................................................7
1.4 Version identification of EtherCAT devices .......................................................................................7
2 Product overview.....................................................................................................................................11
2.1 EL1052, EL1054 - Introduction........................................................................................................11
2.2 Technical data .................................................................................................................................12
2.3 Start .................................................................................................................................................13
3 Basics communication ...........................................................................................................................14
3.1 EtherCAT basics..............................................................................................................................14
3.2 EtherCAT cabling – wire-bound.......................................................................................................14
3.3 General notes for setting the watchdog...........................................................................................15
3.4 EtherCAT State Machine.................................................................................................................17
3.5 CoE Interface...................................................................................................................................19
3.6 Distributed Clock .............................................................................................................................24
4 Mounting and wiring................................................................................................................................25
4.1 Instructions for ESD protection........................................................................................................25
4.2 Installation on mounting rails ...........................................................................................................25
4.3 Installation instructions for enhanced mechanical load capacity .....................................................28
4.4 Connection ......................................................................................................................................29
4.4.1 Connection system .......................................................................................................... 29
4.4.2 Wiring............................................................................................................................... 31
4.4.3 Shielding .......................................................................................................................... 32
4.5 Positioning of passive Terminals .....................................................................................................33
4.6 UL notice .........................................................................................................................................33
4.7 ATEX - Special conditions (standard temperature range) ...............................................................35
4.8 ATEX Documentation ......................................................................................................................36
4.9 Installation positions ........................................................................................................................36
4.10 LEDs and connection ......................................................................................................................38
5 Commissioning........................................................................................................................................39
5.1 TwinCAT Development Environment ..............................................................................................39
5.1.1 Installation of the TwinCAT real-time driver..................................................................... 39
5.1.2 Notes regarding ESI device description........................................................................... 45
5.1.3 TwinCAT ESI Updater ..................................................................................................... 49
5.1.4 Distinction between Online and Offline............................................................................ 49
5.1.5 OFFLINE configuration creation ...................................................................................... 50
5.1.6 ONLINE configuration creation ........................................................................................ 55
5.1.7 EtherCAT subscriber configuration.................................................................................. 63
5.2 General Notes - EtherCAT Slave Application..................................................................................72
5.3 Notes to the NAMUR switching amplifier of the terminal.................................................................80
6 Appendix ..................................................................................................................................................82
6.1 EtherCAT AL Status Codes.............................................................................................................82
EL1052, EL1054 3Version: 1.1
Table of contents
6.2 Firmware compatibility.....................................................................................................................82
6.3 Firmware Update EL/ES/EM/EPxxxx ..............................................................................................82
6.3.1 Device description ESI file/XML....................................................................................... 83
6.3.2 Firmware explanation ...................................................................................................... 86
6.3.3 Updating controller firmware *.efw................................................................................... 87
6.3.4 FPGA firmware *.rbf......................................................................................................... 88
6.3.5 Simultaneous updating of several EtherCAT devices...................................................... 92
6.4 Restoring the delivery state .............................................................................................................93
6.5 Support and Service ........................................................................................................................94
EL1052, EL10544 Version: 1.1
Foreword
1 Foreword
1.1 Notes on the documentation
Intended audience
This description is only intended for the use of trained specialists in control and automation engineering who
are familiar with the applicable national standards.
It is essential that the documentation and the following notes and explanations are followed when installing
and commissioning these components.
It is the duty of the technical personnel to use the documentation published at the respective time of each
installation and commissioning.
The responsible staff must ensure that the application or use of the products described satisfy all the
requirements for safety, including all the relevant laws, regulations, guidelines and standards.
Disclaimer
The documentation has been prepared with care. The products described are, however, constantly under
development.
We reserve the right to revise and change the documentation at any time and without prior announcement.
No claims for the modification of products that have already been supplied may be made on the basis of the
data, diagrams and descriptions in this documentation.
Trademarks
Beckhoff®, TwinCAT®, EtherCAT®, EtherCATP®, SafetyoverEtherCAT®, TwinSAFE®, XFC® and XTS® are
registered trademarks of and licensed by Beckhoff Automation GmbH.
Other designations used in this publication may be trademarks whose use by third parties for their own
purposes could violate the rights of the owners.
Patent Pending
The EtherCAT Technology is covered, including but not limited to the following patent applications and
patents: EP1590927, EP1789857, DE102004044764, DE102007017835 with corresponding applications or
registrations in various other countries.
The TwinCAT Technology is covered, including but not limited to the following patent applications and
patents: EP0851348, US6167425 with corresponding applications or registrations in various other countries.
EtherCAT® is registered trademark and patented technology, licensed by Beckhoff Automation GmbH,
Germany.
Copyright
© Beckhoff Automation GmbH & Co. KG, Germany.
The reproduction, distribution and utilization of this document as well as the communication of its contents to
others without express authorization are prohibited.
Offenders will be held liable for the payment of damages. All rights reserved in the event of the grant of a
patent, utility model or design.
EL1052, EL1054 5Version: 1.1
Foreword
1.2 Safety instructions
Safety regulations
Please note the following safety instructions and explanations!
Product-specific safety instructions can be found on following pages or in the areas mounting, wiring,
commissioning etc.
Exclusion of liability
All the components are supplied in particular hardware and software configurations appropriate for the
application. Modifications to hardware or software configurations other than those described in the
documentation are not permitted, and nullify the liability of Beckhoff Automation GmbH & Co. KG.
Personnel qualification
This description is only intended for trained specialists in control, automation and drive engineering who are
familiar with the applicable national standards.
Description of instructions
In this documentation the following instructions are used.
These instructions must be read carefully and followed without fail!
DANGER
Serious risk of injury!
Failure to follow this safety instruction directly endangers the life and health of persons.
WARNING
Risk of injury!
Failure to follow this safety instruction endangers the life and health of persons.
CAUTION
Personal injuries!
Failure to follow this safety instruction can lead to injuries to persons.
NOTE
Damage to environment/equipment or data loss
Failure to follow this instruction can lead to environmental damage, equipment damage or data loss.
Tip or pointer
This symbol indicates information that contributes to better understanding.
EL1052, EL10546 Version: 1.1
1.3 Documentation Issue Status
Version Comment
1.1 • Update technical data
• Update chapter "Connection technology" -> "connection"
• Update structure
1.0 • 1st public issue
0.1 • Documentation for EL1052 and EL1054 (first version)
1.4 Version identification of EtherCAT devices
Designation
A Beckhoff EtherCAT device has a 14-digit designation, made up of
• family key
• type
• version
• revision
Foreword
Example Family Type Version Revision
EL3314-0000-0016 EL terminal
(12 mm, nonpluggable connection
level)
ES3602-0010-0017 ES terminal
(12 mm, pluggable
connection level)
CU2008-0000-0000 CU device 2008 (8-port fast ethernet switch) 0000 (basic type) 0000
Notes
• The elements mentioned above result in the technical designation. EL3314-0000-0016 is used in the
example below.
• EL3314-0000 is the order identifier, in the case of “-0000” usually abbreviated to EL3314. “-0016” is the
EtherCAT revision.
• The order identifier is made up of
- family key (EL, EP, CU, ES, KL, CX, etc.)
- type (3314)
- version (-0000)
• The revision -0016 shows the technical progress, such as the extension of features with regard to the
EtherCAT communication, and is managed by Beckhoff.
In principle, a device with a higher revision can replace a device with a lower revision, unless specified
otherwise, e.g. in the documentation.
Associated and synonymous with each revision there is usually a description (ESI, EtherCAT Slave
Information) in the form of an XML file, which is available for download from the Beckhoff web site.
From 2014/01 the revision is shown on the outside of the IP20 terminals, see Fig. “EL5021 EL terminal,
standard IP20 IO device with batch number and revision ID (since 2014/01)”.
• The type, version and revision are read as decimal numbers, even if they are technically saved in
hexadecimal.
3314 (4-channel thermocouple
terminal)
3602 (2-channel voltage
measurement)
0000 (basic type) 0016
0010 (highprecision version)
0017
Identification number
Beckhoff EtherCAT devices from the different lines have different kinds of identification numbers:
EL1052, EL1054 7Version: 1.1
Foreword
Production lot/batch number/serial number/date code/D number
The serial number for Beckhoff IO devices is usually the 8-digit number printed on the device or on a sticker.
The serial number indicates the configuration in delivery state and therefore refers to a whole production
batch, without distinguishing the individual modules of a batch.
Structure of the serial number: KKYYFFHH
KK - week of production (CW, calendar week)
YY - year of production
FF - firmware version
HH - hardware version
Example with
Ser. no.: 12063A02: 12 - production week 12 06 - production year 2006 3A - firmware version 3A 02 hardware version 02
Exceptions can occur in the IP67 area, where the following syntax can be used (see respective device
documentation):
Syntax: D ww yy x y z u
D - prefix designation
ww - calendar week
yy - year
x - firmware version of the bus PCB
y - hardware version of the bus PCB
z - firmware version of the I/O PCB
u - hardware version of the I/O PCB
Example: D.22081501 calendar week 22 of the year 2008 firmware version of bus PCB: 1 hardware version
of bus PCB: 5 firmware version of I/O PCB: 0 (no firmware necessary for this PCB) hardware version of I/O
PCB: 1
Unique serial number/ID, ID number
In addition, in some series each individual module has its own unique serial number.
See also the further documentation in the area
• IP67: EtherCAT Box
• Safety: TwinSafe
• Terminals with factory calibration certificate and other measuring terminals
Examples of markings
Fig.1: EL5021 EL terminal, standard IP20 IO device with serial/ batch number and revision ID (since
2014/01)
EL1052, EL10548 Version: 1.1
Fig.2: EK1100 EtherCAT coupler, standard IP20 IO device with serial/ batch number
Foreword
Fig.3: CU2016 switch with serial/ batch number
Fig.4: EL3202-0020 with serial/ batch number 26131006 and unique ID-number 204418
EL1052, EL1054 9Version: 1.1
Foreword
Fig.5: EP1258-00001 IP67 EtherCAT Box with batch number/ date code 22090101 and unique serial
number 158102
Fig.6: EP1908-0002 IP67 EtherCAT Safety Box with batch number/ date code 071201FF and unique serial
number 00346070
Fig.7: EL2904 IP20 safety terminal with batch number/ date code 50110302 and unique serial number
00331701
Fig.8: ELM3604-0002 terminal with unique ID number (QR code) 100001051 and serial/ batch number
44160201
EL1052, EL105410 Version: 1.1
2 Product overview
2.1 EL1052, EL1054 - Introduction
Product overview
Fig.9: EL1052, EL1054
Digital input terminals for NAMUR sensors
The EL1052 and EL1054 digital input terminal acquires signals from NAMUR field devices according to
IEC60947‑5‑6. The sensors are supplied with a voltage of 8.2 VDC and return a diagnosable current signal.
In this way, a wire breakage or short-circuit can be detected in addition to the switching state. The LEDs
indicate signal or any error states, channel by channel.
EL1052, EL1054 11Version: 1.1
Product overview
2.2 Technical data
Technical data EL1052 EL1054
Number of inputs 2 4
Technology NAMUR
Signal type binary, current input for NAMUR sensors
Specification NAMUR DC current switching amplifier (IEC60947‑5‑6)
Connection technology 2-wire
“0“ signal current ≤ 1.2mA
“1“ signal current ≥ 2.1mA
Switching hysteresis 350µA typ.
Shortcut current 7.8mA typ.
Error detection I ≤ 200µA (wire break), I ≥ 7.0mA (shortcut)
Switching frequency max. 5kHz (duty cycle 50%)
Open circuit voltage 8.2VDC typ.
Reverse voltage protection 35VDC max. (I1 or I2 in “no current state” against 0V)
Internal resistance according I/U‑diagram in IEC 60947‑5‑6, par.9‑1
Distributed Clocks -
Voltage power supply for electronics 24VDC via power contacts
Current consumption E-bus 40mA typ. 50mA typ.
Current consumption power contacts 20mA typ. + load 40mA typ. + load
Electrical isolation 500V (E-bus/field potential)
Bit width in the process image 4 state bits 8 state bits
Configuration no address or configuration setting
Special features integrated reverse voltage protection
Max. sensor wire length The wire length from the EtherCAT terminal to the sensor/encoder
must have max. 30 m without any action of protection. For larger wire
lengths a proper over voltage protection (surge protection) is
required.
Weight approx. 60 g
Permissible ambient temperature
range during operation
Permissible ambient temperature
range during storage
Relative humidity 95 %, no condensation
Dimensions (W x H x D) ca. 15mm x 100mm x 70mm (width aligned: 12mm)
Mounting [}25]
Vibration/shock resistance conforms to EN60068-2-6/
-25°C ... + 60°C 0°C ... + 55°C
-40°C ... + 85°C -25°C ... + 85°C
on 35 mm mounting rail conforms to EN 60715
according to EN 60068-2-6/EN
EN60068-2-27,
60068-2-27
see also Installation instructions
[}28] for terminals with
increased mechanical load
capacity
EMC immunity/emission conforms to EN61000-6-2/ EN61000-6-4
Protect. class IP20
Installation pos. variable
Pluggable wiring for all ESxxxx terminals
Approvals CE
IECEx
EL1052, EL105412 Version: 1.1
2.3 Start
For commissioning:
• mount the terminal as described in the chapter Mounting and wiring [}25]
• configure the terminal in TwinCAT as described in chapter Commissioning [}39]
Product overview
EL1052, EL1054 13Version: 1.1
Basics communication
3 Basics communication
3.1 EtherCAT basics
Please refer to the EtherCAT System Documentation for the EtherCAT fieldbus basics.
3.2 EtherCAT cabling – wire-bound
The cable length between two EtherCAT devices must not exceed 100 m. This results from the FastEthernet
technology, which, above all for reasons of signal attenuation over the length of the cable, allows a maximum
link length of 5 + 90 + 5 m if cables with appropriate properties are used. See also the Design
recommendations for the infrastructure for EtherCAT/Ethernet.
Cables and connectors
For connecting EtherCAT devices only Ethernet connections (cables + plugs) that meet the requirements of
at least category 5 (CAt5) according to EN 50173 or ISO/IEC 11801 should be used. EtherCAT uses 4 wires
for signal transfer.
EtherCAT uses RJ45 plug connectors, for example. The pin assignment is compatible with the Ethernet
standard (ISO/IEC 8802-3).
Pin Color of conductor Signal Description
1 yellow TD + Transmission Data +
2 orange TD - Transmission Data -
3 white RD + Receiver Data +
6 blue RD - Receiver Data -
Due to automatic cable detection (auto-crossing) symmetric (1:1) or cross-over cables can be used between
EtherCAT devices from Beckhoff.
Recommended cables
Suitable cables for the connection of EtherCAT devices can be found on the Beckhoff website!
E-Bus supply
A bus coupler can supply the EL terminals added to it with the E-bus system voltage of 5V; a coupler is
thereby loadable up to 2A as a rule (see details in respective device documentation).
Information on how much current each EL terminal requires from the E-bus supply is available online and in
the catalogue. If the added terminals require more current than the coupler can supply, then power feed
terminals (e.g. EL9410) must be inserted at appropriate places in the terminal strand.
The pre-calculated theoretical maximum E-Bus current is displayed in the TwinCAT System Manager. A
shortfall is marked by a negative total amount and an exclamation mark; a power feed terminal is to be
placed before such a position.
EL1052, EL105414 Version: 1.1
Basics communication
Fig.10: System manager current calculation
NOTE
Malfunction possible!
The same ground potential must be used for the E-Bus supply of all EtherCAT terminals in a terminal block!
3.3 General notes for setting the watchdog
ELxxxx terminals are equipped with a safety feature (watchdog) that switches off the outputs after a
specifiable time e.g. in the event of an interruption of the process data traffic, depending on the device and
settings, e.g. in OFF state.
The EtherCAT slave controller (ESC) in the EL2xxx terminals features 2 watchdogs:
• SM watchdog (default: 100 ms)
• PDI watchdog (default: 100 ms)
SM watchdog (SyncManager Watchdog)
The SyncManager watchdog is reset after each successful EtherCAT process data communication with the
terminal. If no EtherCAT process data communication takes place with the terminal for longer than the set
and activated SM watchdog time, e.g. in the event of a line interruption, the watchdog is triggered and the
outputs are set to FALSE. The OP state of the terminal is unaffected. The watchdog is only reset after a
successful EtherCAT process data access. Set the monitoring time as described below.
The SyncManager watchdog monitors correct and timely process data communication with the ESC from the
EtherCAT side.
PDI watchdog (Process Data Watchdog)
If no PDI communication with the EtherCAT slave controller (ESC) takes place for longer than the set and
activated PDI watchdog time, this watchdog is triggered.
PDI (Process Data Interface) is the internal interface between the ESC and local processors in the EtherCAT
slave, for example. The PDI watchdog can be used to monitor this communication for failure.
The PDI watchdog monitors correct and timely process data communication with the ESC from the
application side.
The settings of the SM- and PDI-watchdog must be done for each slave separately in the TwinCAT System
Manager.
EL1052, EL1054 15Version: 1.1
Basics communication
Fig.11: EtherCAT tab -> Advanced Settings -> Behavior -> Watchdog
Notes:
• the multiplier is valid for both watchdogs.
• each watchdog has its own timer setting, the outcome of this in summary with the multiplier is a
resulting time.
• Important: the multiplier/timer setting is only loaded into the slave at the start up, if the checkbox is
activated.
If the checkbox is not activated, nothing is downloaded and the ESC settings remain unchanged.
Multiplier
Multiplier
Both watchdogs receive their pulses from the local terminal cycle, divided by the watchdog multiplier:
1/25 MHz * (watchdog multiplier + 2) = 100 µs (for default setting of 2498 for the multiplier)
The standard setting of 1000 for the SM watchdog corresponds to a release time of 100 ms.
The value in multiplier + 2 corresponds to the number of basic 40 ns ticks representing a watchdog tick.
The multiplier can be modified in order to adjust the watchdog time over a larger range.
EL1052, EL105416 Version: 1.1
Basics communication
Example "Set SM watchdog"
This checkbox enables manual setting of the watchdog times. If the outputs are set and the EtherCAT
communication is interrupted, the SM watchdog is triggered after the set time and the outputs are erased.
This setting can be used for adapting a terminal to a slower EtherCAT master or long cycle times. The
default SM watchdog setting is 100 ms. The setting range is 0..65535. Together with a multiplier with a range
of 1..65535 this covers a watchdog period between 0..~170 seconds.
Calculation
Multiplier = 2498 → watchdog base time = 1 / 25MHz * (2498 + 2) = 0.0001seconds = 100µs
SM watchdog = 10000 → 10000 * 100µs = 1second watchdog monitoring time
CAUTION
Undefined state possible!
The function for switching off of the SM watchdog via SM watchdog = 0 is only implemented in terminals
from version -0016. In previous versions this operating mode should not be used.
CAUTION
Damage of devices and undefined state possible!
If the SM watchdog is activated and a value of 0 is entered the watchdog switches off completely. This is
the deactivation of the watchdog! Set outputs are NOT set in a safe state, if the communication is interrupted.
3.4 EtherCAT State Machine
The state of the EtherCAT slave is controlled via the EtherCAT State Machine (ESM). Depending upon the
state, different functions are accessible or executable in the EtherCAT slave. Specific commands must be
sent by the EtherCAT master to the device in each state, particularly during the bootup of the slave.
A distinction is made between the following states:
• Init
• Pre-Operational
• Safe-Operational and
• Operational
• Boot
The regular state of each EtherCAT slave after bootup is the OP state.
EL1052, EL1054 17Version: 1.1
Basics communication
Fig.12: States of the EtherCAT State Machine
Init
After switch-on the EtherCAT slave in the Init state. No mailbox or process data communication is possible.
The EtherCAT master initializes sync manager channels 0 and 1 for mailbox communication.
Pre-Operational (Pre-Op)
During the transition between Init and Pre-Op the EtherCAT slave checks whether the mailbox was initialized
correctly.
In Pre-Op state mailbox communication is possible, but not process data communication. The EtherCAT
master initializes the sync manager channels for process data (from sync manager channel 2), the FMMU
channels and, if the slave supports configurable mapping, PDO mapping or the sync manager PDO
assignment. In this state the settings for the process data transfer and perhaps terminal-specific parameters
that may differ from the default settings are also transferred.
Safe-Operational (Safe-Op)
During transition between Pre-Op and Safe-Op the EtherCAT slave checks whether the sync manager
channels for process data communication and, if required, the distributed clocks settings are correct. Before
it acknowledges the change of state, the EtherCAT slave copies current input data into the associated DPRAM areas of the EtherCAT slave controller (ECSC).
In Safe-Op state mailbox and process data communication is possible, although the slave keeps its outputs
in a safe state, while the input data are updated cyclically.
Outputs in SAFEOP state
The default set watchdog [}15] monitoring sets the outputs of the module in a safe state - depending on the settings in SAFEOP and OP - e.g. in OFF state. If this is prevented by deactivation of the
watchdog monitoring in the module, the outputs can be switched or set also in the SAFEOP state.
Operational (Op)
Before the EtherCAT master switches the EtherCAT slave from Safe-Op to Op it must transfer valid output
data.
In the Op state the slave copies the output data of the masters to its outputs. Process data and mailbox
communication is possible.
EL1052, EL105418 Version: 1.1
Basics communication
Boot
In the Boot state the slave firmware can be updated. The Boot state can only be reached via the Init state.
In the Boot state mailbox communication via the file access over EtherCAT (FoE) protocol is possible, but no
other mailbox communication and no process data communication.
3.5 CoE Interface
General description
The CoE interface (CANopen over EtherCAT) is used for parameter management of EtherCAT devices.
EtherCAT slaves or the EtherCAT master manage fixed (read only) or variable parameters which they
require for operation, diagnostics or commissioning.
CoE parameters are arranged in a table hierarchy. In principle, the user has read access via the fieldbus.
The EtherCAT master (TwinCAT System Manager) can access the local CoE lists of the slaves via
EtherCAT in read or write mode, depending on the attributes.
Different CoE parameter types are possible, including string (text), integer numbers, Boolean values or larger
byte fields. They can be used to describe a wide range of features. Examples of such parameters include
manufacturer ID, serial number, process data settings, device name, calibration values for analog
measurement or passwords.
The order is specified in 2 levels via hexadecimal numbering: (main)index, followed by subindex. The value
ranges are
• Index: 0x0000 …0xFFFF (0...65535
• SubIndex: 0x00…0xFF (0...255
dez
)
dez
)
A parameter localized in this way is normally written as 0x8010:07, with preceding "x" to identify the
hexadecimal numerical range and a colon between index and subindex.
The relevant ranges for EtherCAT fieldbus users are:
• 0x1000: This is where fixed identity information for the device is stored, including name, manufacturer,
serial number etc., plus information about the current and available process data configurations.
• 0x8000: This is where the operational and functional parameters for all channels are stored, such as
filter settings or output frequency.
Other important ranges are:
• 0x4000: In some EtherCAT devices the channel parameters are stored here (as an alternative to the
0x8000 range).
• 0x6000: Input PDOs ("input" from the perspective of the EtherCAT master)
• 0x7000: Output PDOs ("output" from the perspective of the EtherCAT master)
Availability
Not every EtherCAT device must have a CoE list. Simple I/O modules without dedicated processor
usually have no variable parameters and therefore no CoE list.
If a device has a CoE list, it is shown in the TwinCAT System Manager as a separate tab with a listing of the
elements:
EL1052, EL1054 19Version: 1.1
Basics communication
Fig.13: "CoE Online " tab
The figure above shows the CoE objects available in device "EL2502", ranging from 0x1000 to 0x1600. The
subindices for 0x1018 are expanded.
Data management and function "NoCoeStorage"
Some parameters, particularly the setting parameters of the slave, are configurable and writeable. This can
be done in write or read mode
• via the System Manager (Fig. "CoE Online " tab) by clicking
This is useful for commissioning of the system/slaves. Click on the row of the index to be
parameterised and enter a value in the "SetValue" dialog.
• from the control system/PLC via ADS, e.g. through blocks from the TcEtherCAT.lib library
This is recommended for modifications while the system is running or if no System Manager or
operating staff are available.
Data management
If slave CoE parameters are modified online, Beckhoff devices store any changes in a fail-safe
manner in the EEPROM, i.e. the modified CoE parameters are still available after a restart.
The situation may be different with other manufacturers.
An EEPROM is subject to a limited lifetime with respect to write operations. From typically 100,000
write operations onwards it can no longer be guaranteed that new (changed) data are reliably saved
or are still readable. This is irrelevant for normal commissioning. However, if CoE parameters are
continuously changed via ADS at machine runtime, it is quite possible for the lifetime limit to be
reached. Support for the NoCoeStorage function, which suppresses the saving of changed CoE values, depends on the firmware version.
Please refer to the technical data in this documentation as to whether this applies to the respective
device.
• If the function is supported: the function is activated by entering the code word 0x12345678 once
in CoE 0xF008 and remains active as long as the code word is not changed. After switching the
device on it is then inactive. Changed CoE values are not saved in the EEPROM and can thus
be changed any number of times.
• Function is not supported: continuous changing of CoE values is not permissible in view of the
lifetime limit.
EL1052, EL105420 Version: 1.1
Startup list
Changes in the local CoE list of the terminal are lost if the terminal is replaced. If a terminal is replaced with a new Beckhoff terminal, it will have the default settings. It is therefore advisable to link
all changes in the CoE list of an EtherCAT slave with the Startup list of the slave, which is processed whenever the EtherCAT fieldbus is started. In this way a replacement EtherCAT slave can
automatically be parameterized with the specifications of the user.
If EtherCAT slaves are used which are unable to store local CoE values permanently, the Startup
list must be used.
Recommended approach for manual modification of CoE parameters
• Make the required change in the System Manager
The values are stored locally in the EtherCAT slave
• If the value is to be stored permanently, enter it in the Startup list.
The order of the Startup entries is usually irrelevant.
Basics communication
Fig.14: Startup list in the TwinCAT System Manager
The Startup list may already contain values that were configured by the System Manager based on the ESI
specifications. Additional application-specific entries can be created.
Online/offline list
While working with the TwinCAT System Manager, a distinction has to be made whether the EtherCAT
device is "available", i.e. switched on and linked via EtherCAT and therefore online, or whether a
configuration is created offline without connected slaves.
In both cases a CoE list as shown in Fig. “’CoE online’ tab” is displayed. The connectivity is shown as offline/
online.
• If the slave is offline
◦ The offline list from the ESI file is displayed. In this case modifications are not meaningful or
possible.
◦ The configured status is shown under Identity.
◦ No firmware or hardware version is displayed, since these are features of the physical device.
◦ Offline is shown in red.
EL1052, EL1054 21Version: 1.1
Basics communication
Fig.15: Offline list
• If the slave is online
◦ The actual current slave list is read. This may take several seconds, depending on the size and
cycle time.
◦ The actual identity is displayed
◦ The firmware and hardware version of the equipment according to the electronic information is
displayed
◦ Online is shown in green.
Fig.16: Online list
EL1052, EL105422 Version: 1.1
Basics communication
Channel-based order
The CoE list is available in EtherCAT devices that usually feature several functionally equivalent channels.
For example, a 4-channel analog 0..10 V input terminal also has 4 logical channels and therefore 4 identical
sets of parameter data for the channels. In order to avoid having to list each channel in the documentation,
the placeholder "n" tends to be used for the individual channel numbers.
In the CoE system 16 indices, each with 255 subindices, are generally sufficient for representing all channel
parameters. The channel-based order is therefore arranged in 16
dec
/10
steps. The parameter range
hex
0x8000 exemplifies this:
• Channel 0: parameter range 0x8000:00 ... 0x800F:255
• Channel 1: parameter range 0x8010:00 ... 0x801F:255
• Channel 2: parameter range 0x8020:00 ... 0x802F:255
• ...
This is generally written as 0x80n0.
Detailed information on the CoE interface can be found in the EtherCAT system documentation on the
Beckhoff website.
EL1052, EL1054 23Version: 1.1
Basics communication
3.6 Distributed Clock
The distributed clock represents a local clock in the EtherCAT slave controller (ESC) with the following
characteristics:
• Unit 1 ns
• Zero point 1.1.2000 00:00
• Size 64 bit (sufficient for the next 584 years; however, some EtherCAT slaves only offer 32-bit support,
i.e. the variable overflows after approx. 4.2 seconds)
• The EtherCAT master automatically synchronizes the local clock with the master clock in the EtherCAT
bus with a precision of < 100 ns.
For detailed information please refer to the EtherCAT system description.
EL1052, EL105424 Version: 1.1
Mounting and wiring
4 Mounting and wiring
4.1 Instructions for ESD protection
NOTE
Destruction of the devices by electrostatic discharge possible!
The devices contain components at risk from electrostatic discharge caused by improper handling.
• Please ensure you are electrostatically discharged and avoid touching the contacts of the device directly.
• Avoid contact with highly insulating materials (synthetic fibers, plastic film etc.).
• Surroundings (working place, packaging and personnel) should by grounded probably, when handling
with the devices.
• Each assembly must be terminated at the right hand end with an EL9011 or EL9012 bus end cap, to ensure the protection class and ESD protection.
Fig.17: Spring contacts of the Beckhoff I/O components
4.2 Installation on mounting rails
WARNING
Risk of electric shock and damage of device!
Bring the bus terminal system into a safe, powered down state before starting installation, disassembly or
wiring of the bus terminals!
EL1052, EL1054 25Version: 1.1
Mounting and wiring
Assembly
Fig.18: Attaching on mounting rail
The bus coupler and bus terminals are attached to commercially available 35mm mounting rails (DIN rails
according to EN60715) by applying slight pressure:
1. First attach the fieldbus coupler to the mounting rail.
2. The bus terminals are now attached on the right-hand side of the fieldbus coupler. Join the components with tongue and groove and push the terminals against the mounting rail, until the lock clicks
onto the mounting rail.
If the terminals are clipped onto the mounting rail first and then pushed together without tongue and
groove, the connection will not be operational! When correctly assembled, no significant gap should
be visible between the housings.
Fixing of mounting rails
The locking mechanism of the terminals and couplers extends to the profile of the mounting rail. At
the installation, the locking mechanism of the components must not come into conflict with the fixing
bolts of the mounting rail. To mount the mounting rails with a height of 7.5mm under the terminals
and couplers, you should use flat mounting connections (e.g. countersunk screws or blind rivets).
EL1052, EL105426 Version: 1.1
Mounting and wiring
Disassembly
Fig.19: Disassembling of terminal
Each terminal is secured by a lock on the mounting rail, which must be released for disassembly:
1. Pull the terminal by its orange-colored lugs approximately 1cm away from the mounting rail. In doing
so for this terminal the mounting rail lock is released automatically and you can pull the terminal out of
the bus terminal block easily without excessive force.
2. Grasp the released terminal with thumb and index finger simultaneous at the upper and lower grooved
housing surfaces and pull the terminal out of the bus terminal block.
Connections within a bus terminal block
The electric connections between the Bus Coupler and the Bus Terminals are automatically realized by
joining the components:
• The six spring contacts of the K-Bus/E-Bus deal with the transfer of the data and the supply of the Bus
Terminal electronics.
• The power contacts deal with the supply for the field electronics and thus represent a supply rail within
the bus terminal block. The power contacts are supplied via terminals on the Bus Coupler (up to 24V)
or for higher voltages via power feed terminals.
Power Contacts
During the design of a bus terminal block, the pin assignment of the individual Bus Terminals must
be taken account of, since some types (e.g. analog Bus Terminals or digital 4-channel Bus Terminals) do not or not fully loop through the power contacts. Power Feed Terminals (KL91xx, KL92xx
or EL91xx, EL92xx) interrupt the power contacts and thus represent the start of a new supply rail.
PE power contact
The power contact labeled PE can be used as a protective earth. For safety reasons this contact mates first
when plugging together, and can ground short-circuit currents of up to 125A.
EL1052, EL1054 27Version: 1.1
Mounting and wiring
Fig.20: Power contact on left side
NOTE
Possible damage of the device
Note that, for reasons of electromagnetic compatibility, the PE contacts are capacitatively coupled to the
mounting rail. This may lead to incorrect results during insulation testing or to damage on the terminal (e.g.
disruptive discharge to the PE line during insulation testing of a consumer with a nominal voltage of 230V).
For insulation testing, disconnect the PE supply line at the Bus Coupler or the Power Feed Terminal! In order to decouple further feed points for testing, these Power Feed Terminals can be released and pulled at
least 10mm from the group of terminals.
WARNING
Risk of electric shock!
The PE power contact must not be used for other potentials!
4.3 Installation instructions for enhanced mechanical load capacity
WARNING
Risk of injury through electric shock and damage to the device!
Bring the Bus Terminal system into a safe, de-energized state before starting mounting, disassembly or
wiring of the Bus Terminals!
Additional checks
The terminals have undergone the following additional tests:
Verification Explanation
Vibration 10 frequency runs in 3 axes
6 Hz < f < 60 Hz displacement 0.35 mm, constant amplitude
60.1Hz<f<500Hz acceleration 5g, constant amplitude
Shocks 1000 shocks in each direction, in 3 axes
25 g, 6 ms
EL1052, EL105428 Version: 1.1
Mounting and wiring
Additional installation instructions
For terminals with enhanced mechanical load capacity, the following additional installation instructions apply:
• The enhanced mechanical load capacity is valid for all permissible installation positions
• Use a mounting rail according to EN 60715 TH35-15
• Fix the terminal segment on both sides of the mounting rail with a mechanical fixture, e.g. an earth
terminal or reinforced end clamp
• The maximum total extension of the terminal segment (without coupler) is:
64 terminals (12 mm mounting with) or 32 terminals (24 mm mounting with)
• Avoid deformation, twisting, crushing and bending of the mounting rail during edging and installation of
the rail
• The mounting points of the mounting rail must be set at 5 cm intervals
• Use countersunk head screws to fasten the mounting rail
• The free length between the strain relief and the wire connection should be kept as short as possible. A
distance of approx. 10 cm should be maintained to the cable duct.
4.4 Connection
4.4.1 Connection system
WARNING
Risk of electric shock and damage of device!
Bring the bus terminal system into a safe, powered down state before starting installation, disassembly or
wiring of the bus terminals!
Overview
The Bus Terminal system offers different connection options for optimum adaptation to the respective
application:
• The terminals of ELxxxx and KLxxxx series with standard wiring include electronics and connection
level in a single enclosure.
• The terminals of ESxxxx and KSxxxx series feature a pluggable connection level and enable steady
wiring while replacing.
• The High Density Terminals (HD Terminals) include electronics and connection level in a single
enclosure and have advanced packaging density.
Standard wiring (ELxxxx / KLxxxx)
Fig.21: Standard wiring
The terminals of ELxxxx and KLxxxx series have been tried and tested for years.
They feature integrated screwless spring force technology for fast and simple assembly.
EL1052, EL1054 29Version: 1.1
Mounting and wiring
Pluggable wiring (ESxxxx / KSxxxx)
Fig.22: Pluggable wiring
The terminals of ESxxxx and KSxxxx series feature a pluggable connection level.
The assembly and wiring procedure is the same as for the ELxxxx and KLxxxx series.
The pluggable connection level enables the complete wiring to be removed as a plug connector from the top
of the housing for servicing.
The lower section can be removed from the terminal block by pulling the unlocking tab.
Insert the new component and plug in the connector with the wiring. This reduces the installation time and
eliminates the risk of wires being mixed up.
The familiar dimensions of the terminal only had to be changed slightly. The new connector adds about 3
mm. The maximum height of the terminal remains unchanged.
A tab for strain relief of the cable simplifies assembly in many applications and prevents tangling of individual
connection wires when the connector is removed.
Conductor cross sections between 0.08mm2 and 2.5mm2 can continue to be used with the proven spring
force technology.
The overview and nomenclature of the product names for ESxxxx and KSxxxx series has been retained as
known from ELxxxx and KLxxxx series.
High Density Terminals (HD Terminals)
Fig.23: High Density Terminals
The Bus Terminals from these series with 16 terminal points are distinguished by a particularly compact
design, as the packaging density is twice as large as that of the standard 12mm Bus Terminals. Massive
conductors and conductors with a wire end sleeve can be inserted directly into the spring loaded terminal
point without tools.
Wiring HD Terminals
The High Density (HD) Terminals of the ELx8xx and KLx8xx series doesn't support pluggable
wiring.
Ultrasonically "bonded" (ultrasonically welded) conductors
Ultrasonically “bonded" conductors
It is also possible to connect the Standard and High Density Terminals with ultrasonically
"bonded" (ultrasonically welded) conductors. In this case, please note the tables concerning the
wire-size width below!
EL1052, EL105430 Version: 1.1
Mounting and wiring
4.4.2 Wiring
WARNING
Risk of electric shock and damage of device!
Bring the bus terminal system into a safe, powered down state before starting installation, disassembly or
wiring of the Bus Terminals!
Terminals for standard wiring ELxxxx/KLxxxx and for pluggable wiring ESxxxx/KSxxxx
Fig.24: Connecting a cable on a terminal point
Up to eight terminal points enable the connection of solid or finely stranded cables to the Bus Terminal. The
terminal points are implemented in spring force technology. Connect the cables as follows:
1. Open a terminal point by pushing a screwdriver straight against the stop into the square opening
above the terminal point. Do not turn the screwdriver or move it alternately (don't toggle).
2. The wire can now be inserted into the round terminal opening without any force.
3. The terminal point closes automatically when the pressure is released, holding the wire securely and
permanently.
See the following table for the suitable wire size width.
Terminal housing ELxxxx, KLxxxx ESxxxx, KSxxxx
Wire size width (single core wires) 0.08 ... 2.5mm
Wire size width (fine-wire conductors) 0.08 ... 2.5mm
Wire size width (conductors with a wire end sleeve) 0.14 ... 1.5mm
2
2
2
0.08 ... 2.5mm
0,08 ... 2.5mm
0.14 ... 1.5mm
2
2
2
Wire stripping length 8 ... 9mm 9 ... 10mm
High Density Terminals (HD Terminals [}30]) with 16 terminal points
The conductors of the HD Terminals are connected without tools for single-wire conductors using the direct
plug-in technique, i.e. after stripping the wire is simply plugged into the terminal point. The cables are
released, as usual, using the contact release with the aid of a screwdriver. See the following table for the
suitable wire size width.
EL1052, EL1054 31Version: 1.1
Mounting and wiring
Terminal housing High Density Housing
Wire size width (single core wires) 0.08 ... 1.5mm
Wire size width (fine-wire conductors) 0.25 ... 1.5mm
Wire size width (conductors with a wire end sleeve) 0.14 ... 0.75mm
Wire size width (ultrasonically “bonded" conductors) only 1.5mm
2
2
2
2
Wire stripping length 8 ... 9mm
4.4.3 Shielding
Shielding
Encoder, analog sensors and actors should always be connected with shielded, twisted paired
wires.
EL1052, EL105432 Version: 1.1
4.5 Positioning of passive Terminals
Hint for positioning of passive terminals in the bus terminal block
EtherCAT Terminals (ELxxxx / ESxxxx), which do not take an active part in data transfer within the
bus terminal block are so called passive terminals. The passive terminals have no current consumption out of the E-Bus.
To ensure an optimal data transfer, you must not directly string together more than 2 passive terminals!
Examples for positioning of passive terminals (highlighted)
Mounting and wiring
Fig.25: Correct positioning
Fig.26: Incorrect positioning
4.6 UL notice
Application
Beckhoff EtherCAT modules are intended for use with Beckhoff’s UL Listed EtherCAT System only.
Examination
For cULus examination, the Beckhoff I/O System has only been investigated for risk of fire
and electrical shock (in accordance with UL508 and CSAC22.2 No.142).
EL1052, EL1054 33Version: 1.1
Mounting and wiring
For devices with Ethernet connectors
Not for connection to telecommunication circuits.
Basic principles
Two UL certificates are met in the Beckhoff EtherCAT product range, depending upon the components:
1. UL certification according to UL508. Devices with this kind of certification are marked by this sign:
2. UL certification according to UL508 with limited power consumption. The current consumed by the device is limited to a max. possible current consumption of 4A. Devices with this kind of certification are
marked by this sign:
Almost all current EtherCAT products (as at 2010/05) are UL certified without restrictions.
Application
If terminals certified with restrictions are used, then the current consumption at 24VDC must be limited
accordingly by means of supply
• from an isolated source protected by a fuse of max. 4A (according to UL248) or
• from a voltage supply complying with NECclass2.
A voltage source complying with NECclass2 may not be connected in series or parallel with another
NECclass2compliant voltage supply!
These requirements apply to the supply of all EtherCAT bus couplers, power adaptor terminals, Bus
Terminals and their power contacts.
EL1052, EL105434 Version: 1.1
Mounting and wiring
4.7 ATEX - Special conditions (standard temperature range)
WARNING
Observe the special conditions for the intended use of Beckhoff fieldbus components with
standard temperature range in potentially explosive areas (directive 94/9/EU)!
• The certified components are to be installed in a suitable housing that guarantees a protection class of at
least IP54 in accordance with EN 60529! The environmental conditions during use are thereby to be
taken into account!
• If the temperatures during rated operation are higher than 70°C at the feed-in points of cables, lines or
pipes, or higher than 80°C at the wire branching points, then cables must be selected whose temperature data correspond to the actual measured temperature values!
• Observe the permissible ambient temperature range of 0 to 55°C for the use of Beckhoff fieldbus components standard temperature range in potentially explosive areas!
• Measures must be taken to protect against the rated operating voltage being exceeded by more than
40% due to short-term interference voltages!
• The individual terminals may only be unplugged or removed from the Bus Terminal system if the supply
voltage has been switched off or if a non-explosive atmosphere is ensured!
• The connections of the certified components may only be connected or disconnected if the supply voltage has been switched off or if a non-explosive atmosphere is ensured!
• The fuses of the KL92xx/EL92xx power feed terminals may only be exchanged if the supply voltage has
been switched off or if a non-explosive atmosphere is ensured!
• Address selectors and ID switches may only be adjusted if the supply voltage has been switched off or if
a non-explosive atmosphere is ensured!
Standards
The fundamental health and safety requirements are fulfilled by compliance with the following standards:
• EN 60079-0:2012+A11:2013
• EN 60079-15:2010
Marking
The Beckhoff fieldbus components with standard temperature range certified for potentially explosive areas
bear one of the following markings:
II 3GKEMA 10ATEX0075 X Ex nA IIC T4 GcTa: 0…55°C
or
II 3GKEMA 10ATEX0075 X Ex nC IIC T4 GcTa: 0…55°C
EL1052, EL1054 35Version: 1.1
Mounting and wiring
4.8 ATEX Documentation
Notes about operation of the Beckhoff terminal systems in potentially explosive areas (ATEX)
Pay also attention to the continuative documentation
Notes about operation of the Beckhoff terminal systems in potentially explosive areas (ATEX)
that is available in the download area of the Beckhoff homepage http:\\www.beckhoff.com!
4.9 Installation positions
NOTE
Constraints regarding installation position and operating temperature range
Please refer to the technical data for a terminal to ascertain whether any restrictions regarding the installation position and/or the operating temperature range have been specified. When installing high power dissipation terminals ensure that an adequate spacing is maintained between other components above and below the terminal in order to guarantee adequate ventilation!
Optimum installation position (standard)
The optimum installation position requires the mounting rail to be installed horizontally and the connection
surfaces of the EL/KL terminals to face forward (see Fig. “Recommended distances for standard installation
position”). The terminals are ventilated from below, which enables optimum cooling of the electronics through
convection. "From below" is relative to the acceleration of gravity.
Fig.27: Recommended distances for standard installation position
EL1052, EL105436 Version: 1.1
Mounting and wiring
Compliance with the distances shown in Fig. “Recommended distances for standard installation position” is
recommended.
Other installation positions
All other installation positions are characterized by different spatial arrangement of the mounting rail - see
Fig “Other installation positions”.
The minimum distances to ambient specified above also apply to these installation positions.
Fig.28: Other installation positions
EL1052, EL1054 37Version: 1.1
Mounting and wiring
4.10 LEDs and connection
Fig.29: LEDs and connection EL1052, EL1054
LEDs
The following table is assigned to the respective LED number of a channel:
Signal LED Error LED Meaning
off on Error detection: open-loop on channel (I<200µA typ.)
off off Usual operation: NAMUR sensor on channel in closed state
on on Error detection: shortcut on channel (I>7mA typ.)
on off Usual operation: NAMUR sensor on channel in conducting state
("0"; according to IEC 60947-5-6)
("1"; according to IEC 60947-5-6)
Connection EL1052
Terminal point Description
Designation No.
I1 1 Input Channel 1
Uv1 2 Sensor supply Channel 1
n.c. 3 Not connected
PE 4 PE (internally connected to terminal point 8)
I2 5 Input Channel 2
Uv2 6 Sensor supply Channel 2
n.c. 7 Not connected
PE 8 PE (internally connected to terminal point 4)
Connection EL1054
Terminal point Description
Designation No.
I1 1 Input Channel 1
Uv1 2 Sensor supply Channel 1
Uv3 3 Sensor supply Channel 3
I3 4 Input Channel 3
I2 5 Input Channel 2
Uv2 6 Sensor supply Channel 2
Uv4 7 Sensor supply Channel 4
I4 8 Input Channel 4
EL1052, EL105438 Version: 1.1
Commissioning
5 Commissioning
5.1 TwinCAT Development Environment
The Software for automation TwinCAT (The Windows Control and Automation Technology) will be
distinguished into:
• TwinCAT2: System Manager (Configuration) & PLC Control (Programming)
• TwinCAT3: Enhancement of TwinCAT2 (Programming and Configuration takes place via a common
Development Environment)
Details:
• TwinCAT2:
◦ Connects I/O devices to tasks in a variable-oriented manner
◦ Connects tasks to tasks in a variable-oriented manner
◦ Supports units at the bit level
◦ Supports synchronous or asynchronous relationships
◦ Exchange of consistent data areas and process images
◦ Datalink on NT - Programs by open Microsoft Standards (OLE, OCX, ActiveX, DCOM+, etc.)
◦ Integration of IEC 61131-3-Software-SPS, Software- NC and Software-CNC within Windows
NT/2000/XP/Vista, Windows 7, NT/XP Embedded, CE
◦ Interconnection to all common fieldbusses
◦ More…
Additional features:
• TwinCAT3 (eXtended Automation):
◦ Visual-Studio®-Integration
◦ Choice of the programming language
◦ Supports object orientated extension of IEC 61131-3
◦ Usage of C/C++ as programming language for real time applications
◦ Connection to MATLAB®/Simulink®
◦ Open interface for expandability
◦ Flexible run-time environment
◦ Active support of Multi-Core- und 64-Bit-Operatingsystem
◦ Automatic code generation and project creation with the TwinCAT Automation Interface
◦ More…
Within the following sections commissioning of the TwinCAT Development Environment on a PC System for
the control and also the basically functions of unique control elements will be explained.
Please see further information to TwinCAT2 and TwinCAT3 at http://infosys.beckhoff.com.
5.1.1 Installation of the TwinCAT real-time driver
In order to assign real-time capability to a standard Ethernet port of an IPC controller, the Beckhoff real-time
driver has to be installed on this port under Windows.
This can be done in several ways. One option is described here.
In the System Manager call up the TwinCAT overview of the local network interfaces via Options → Show
Real Time Ethernet Compatible Devices.
EL1052, EL1054 39Version: 1.1
Commissioning
Fig.30: System Manager “Options” (TwinCAT2)
This have to be called up by the Menü “TwinCAT” within the TwinCAT3 environment:
Fig.31: Call up under VS Shell (TwinCAT3)
The following dialog appears:
Fig.32: Overview of network interfaces
Interfaces listed under “Compatible devices” can be assigned a driver via the “Install” button. A driver should
only be installed on compatible devices.
A Windows warning regarding the unsigned driver can be ignored.
Alternatively an EtherCAT-device can be inserted first of all as described in chapter Offline configuration
creation, section “Creating the EtherCAT device” [}50] in order to view the compatible ethernet ports via its
EtherCAT properties (tab „Adapter“, button „Compatible Devices…“):
EL1052, EL105440 Version: 1.1
Commissioning
Fig.33: EtherCAT device properties(TwinCAT2): click on „Compatible Devices…“ of tab “Adapter”
TwinCAT 3: the properties of the EtherCAT device can be opened by double click on “Device .. (EtherCAT)”
within the Solution Explorer under “I/O”:
After the installation the driver appears activated in the Windows overview for the network interface
(Windows Start → System Properties → Network)
Fig.34: Windows properties of the network interface
A correct setting of the driver could be:
EL1052, EL1054 41Version: 1.1
Commissioning
Fig.35: Exemplary correct driver setting for the Ethernet port
Other possible settings have to be avoided:
EL1052, EL105442 Version: 1.1
Commissioning
Fig.36: Incorrect driver settings for the Ethernet port
EL1052, EL1054 43Version: 1.1
Commissioning
IP address of the port used
IP address/DHCP
In most cases an Ethernet port that is configured as an EtherCAT device will not transport general
IP packets. For this reason and in cases where an EL6601 or similar devices are used it is useful to
specify a fixed IP address for this port via the “Internet Protocol TCP/IP” driver setting and to disable
DHCP. In this way the delay associated with the DHCP client for the Ethernet port assigning itself a
default IP address in the absence of a DHCP server is avoided. A suitable address space is
192.168.x.x, for example.
Fig.37: TCP/IP setting for the Ethernet port
EL1052, EL105444 Version: 1.1
Commissioning
5.1.2 Notes regarding ESI device description
Installation of the latest ESI device description
The TwinCAT EtherCAT master/System Manager needs the device description files for the devices to be
used in order to generate the configuration in online or offline mode. The device descriptions are contained
in the so-called ESI files (EtherCAT Slave Information) in XML format. These files can be requested from the
respective manufacturer and are made available for download. An *.xml file may contain several device
descriptions.
The ESI files for Beckhoff EtherCAT devices are available on the Beckhoff website.
The ESI files should be stored in the TwinCAT installation directory.
Default settings:
• TwinCAT2: C:\TwinCAT\IO\EtherCAT
• TwinCAT3: C:\TwinCAT\3.1\Config\Io\EtherCAT
The files are read (once) when a new System Manager window is opened, if they have changed since the
last time the System Manager window was opened.
A TwinCAT installation includes the set of Beckhoff ESI files that was current at the time when the TwinCAT
build was created.
For TwinCAT2.11/TwinCAT3 and higher, the ESI directory can be updated from the System Manager, if the
programming PC is connected to the Internet; by
• TwinCAT2: Option → “Update EtherCAT Device Descriptions”
• TwinCAT3: TwinCAT → EtherCAT Devices → “Update Device Descriptions (via ETG Website)…”
The TwinCAT ESI Updater [}49] is available for this purpose.
ESI
The *.xml files are associated with *.xsd files, which describe the structure of the ESI XML files. To
update the ESI device descriptions, both file types should therefore be updated.
Device differentiation
EtherCAT devices/slaves are distinguished by four properties, which determine the full device identifier. For
example, the device identifier EL2521-0025-1018 consists of:
• family key “EL”
• name “2521”
• type “0025”
• and revision “1018”
Fig.38: Identifier structure
The order identifier consisting of name + type (here: EL2521-0010) describes the device function. The
revision indicates the technical progress and is managed by Beckhoff. In principle, a device with a higher
revision can replace a device with a lower revision, unless specified otherwise, e.g. in the documentation.
Each revision has its own ESI description. See further notes [}7].
EL1052, EL1054 45Version: 1.1
Commissioning
Online description
If the EtherCAT configuration is created online through scanning of real devices (see section Online setup)
and no ESI descriptions are available for a slave (specified by name and revision) that was found, the
System Manager asks whether the description stored in the device should be used. In any case, the System
Manager needs this information for setting up the cyclic and acyclic communication with the slave correctly.
Fig.39: OnlineDescription information window (TwinCAT2)
In TwinCAT3 a similar window appears, which also offers the Web update:
Fig.40: Information window OnlineDescription (TwinCAT3)
If possible, the Yes is to be rejected and the required ESI is to be requested from the device manufacturer.
After installation of the XML/XSD file the configuration process should be repeated.
NOTE
Changing the ‘usual’ configuration through a scan
ü If a scan discovers a device that is not yet known to TwinCAT, distinction has to be made between two
cases. Taking the example here of the EL2521-0000 in the revision 1019
a) no ESI is present for the EL2521-0000 device at all, either for the revision 1019 or for an older revision.
The ESI must then be requested from the manufacturer (in this case Beckhoff).
b) an ESI is present for the EL2521-0000 device, but only in an older revision, e.g. 1018 or 1017.
In this case an in-house check should first be performed to determine whether the spare parts stock allows the integration of the increased revision into the configuration at all. A new/higher revision usually
also brings along new features. If these are not to be used, work can continue without reservations with
the previous revision 1018 in the configuration. This is also stated by the Beckhoff compatibility rule.
Refer in particular to the chapter ‘General notes on the use of Beckhoff EtherCAT IO components’ and for
manual configuration to the chapter ‘Offline configuration creation’ [}50].
If the OnlineDescription is used regardless, the System Manager reads a copy of the device description from
the EEPROM in the EtherCAT slave. In complex slaves the size of the EEPROM may not be sufficient for the
complete ESI, in which case the ESI would be incomplete in the configurator. Therefore it’s recommended
using an offline ESI file with priority in such a case.
The System Manager creates for online recorded device descriptions a new file
“OnlineDescription0000...xml” in its ESI directory, which contains all ESI descriptions that were read online.
EL1052, EL105446 Version: 1.1
Commissioning
Fig.41: File OnlineDescription.xml created by the System Manager
Is a slave desired to be added manually to the configuration at a later stage, online created slaves are
indicated by a prepended symbol “>” in the selection list (see Figure “Indication of an online recorded ESI of
EL2521 as an example”).
Fig.42: Indication of an online recorded ESI of EL2521 as an example
If such ESI files are used and the manufacturer's files become available later, the file OnlineDescription.xml
should be deleted as follows:
• close all System Manager windows
• restart TwinCAT in Config mode
• delete "OnlineDescription0000...xml"
• restart TwinCAT System Manager
This file should not be visible after this procedure, if necessary press <F5> to update
OnlineDescription for TwinCAT3.x
In addition to the file described above "OnlineDescription0000...xml" , a so called EtherCAT cache
with new discovered devices is created by TwinCAT3.x, e.g. under Windows 7:
(Please note the language settings of the OS!)
You have to delete this file, too.
Faulty ESI file
If an ESI file is faulty and the System Manager is unable to read it, the System Manager brings up an
information window.
Fig.43: Information window for faulty ESI file (left: TwinCAT2; right: TwinCAT3)
EL1052, EL1054 47Version: 1.1
Commissioning
Reasons may include:
• Structure of the *.xml does not correspond to the associated *.xsd file → check your schematics
• Contents cannot be translated into a device description → contact the file manufacturer
EL1052, EL105448 Version: 1.1
Commissioning
5.1.3 TwinCAT ESI Updater
For TwinCAT2.11 and higher, the System Manager can search for current Beckhoff ESI files automatically, if
an online connection is available:
Fig.44: Using the ESI Updater (>= TwinCAT2.11)
The call up takes place under:
“Options” → "Update EtherCAT Device Descriptions"
Selection under TwinCAT3:
Fig.45: Using the ESI Updater (TwinCAT3)
The ESI Updater (TwinCAT3) is a convenient option for automatic downloading of ESI data provided by
EtherCAT manufacturers via the Internet into the TwinCAT directory (ESI = EtherCAT slave information).
TwinCAT accesses the central ESI ULR directory list stored at ETG; the entries can then be viewed in the
Updater dialog, although they cannot be changed there.
The call up takes place under:
“TwinCAT“ → „EtherCAT Devices“ → “Update Device Description (via ETG Website)…“.
5.1.4 Distinction between Online and Offline
The distinction between online and offline refers to the presence of the actual I/O environment (drives,
terminals, EJ-modules). If the configuration is to be prepared in advance of the system configuration as a
programming system, e.g. on a laptop, this is only possible in “Offline configuration” mode. In this case all
components have to be entered manually in the configuration, e.g. based on the electrical design.
If the designed control system is already connected to the EtherCAT system and all components are
energised and the infrastructure is ready for operation, the TwinCAT configuration can simply be generated
through “scanning” from the runtime system. This is referred to as online configuration.
In any case, during each startup the EtherCAT master checks whether the slaves it finds match the
configuration. This test can be parameterised in the extended slave settings. Refer to note “Installation of
the latest ESI-XML device description” [}45].
For preparation of a configuration:
• the real EtherCAT hardware (devices, couplers, drives) must be present and installed
• the devices/modules must be connected via EtherCAT cables or in the terminal/ module strand in the
same way as they are intended to be used later
EL1052, EL1054 49Version: 1.1
Commissioning
• the devices/modules be connected to the power supply and ready for communication
• TwinCAT must be in CONFIG mode on the target system.
The online scan process consists of:
• detecting the EtherCAT device [}55] (Ethernet port at the IPC)
• detecting the connected EtherCAT devices [}56]. This step can be carried out independent of the
preceding step
• troubleshooting [}59]
The scan with existing configuration [}60] can also be carried out for comparison.
5.1.5 OFFLINE configuration creation
Creating the EtherCAT device
Create an EtherCAT device in an empty System Manager window.
Fig.46: Append EtherCAT device (left: TwinCAT2; right: TwinCAT3)
Select type ‘EtherCAT’ for an EtherCAT I/O application with EtherCAT slaves. For the present publisher/
subscriber service in combination with an EL6601/EL6614 terminal select “EtherCAT Automation Protocol
via EL6601”.
Fig.47: Selecting the EtherCAT connection (TwinCAT2.11, TwinCAT3)
Then assign a real Ethernet port to this virtual device in the runtime system.
Fig.48: Selecting the Ethernet port
EL1052, EL105450 Version: 1.1
Commissioning
This query may appear automatically when the EtherCAT device is created, or the assignment can be set/
modified later in the properties dialog; see Fig. “EtherCAT device properties (TwinCAT2)”.
Fig.49: EtherCAT device properties (TwinCAT2)
TwinCAT 3: the properties of the EtherCAT device can be opened by double click on “Device .. (EtherCAT)”
within the Solution Explorer under “I/O”:
Selecting the Ethernet port
Ethernet ports can only be selected for EtherCAT devices for which the TwinCAT real-time driver is
installed. This has to be done separately for each port. Please refer to the respective installation
page [}39].
Defining EtherCAT slaves
Further devices can be appended by right-clicking on a device in the configuration tree.
Fig.50: Appending EtherCAT devices (left: TwinCAT2; right: TwinCAT3)
The dialog for selecting a new device opens. Only devices for which ESI files are available are displayed.
Only devices are offered for selection that can be appended to the previously selected device. Therefore the
physical layer available for this port is also displayed (Fig. “Selection dialog for new EtherCAT device”, A). In
the case of cable-based Fast-Ethernet physical layer with PHY transfer, then also only cable-based devices
are available, as shown in Fig. “Selection dialog for new EtherCAT device”. If the preceding device has
several free ports (e.g. EK1122 or EK1100), the required port can be selected on the right-hand side (A).
Overview of physical layer
• “Ethernet”: cable-based 100BASE-TX: EK couplers, EP boxes, devices with RJ45/M8/M12 connector
EL1052, EL1054 51Version: 1.1
Commissioning
• “E-Bus”: LVDS “terminal bus”, “EJ-module”: EL/ES terminals, various modular modules
The search field facilitates finding specific devices (since TwinCAT2.11 or TwinCAT3).
Fig.51: Selection dialog for new EtherCAT device
By default only the name/device type is used as selection criterion. For selecting a specific revision of the
device the revision can be displayed as “Extended Information”.
Fig.52: Display of device revision
In many cases several device revisions were created for historic or functional reasons, e.g. through
technological advancement. For simplification purposes (see Fig. “Selection dialog for new EtherCAT
device”) only the last (i.e. highest) revision and therefore the latest state of production is displayed in the
selection dialog for Beckhoff devices. To show all device revisions available in the system as ESI
descriptions tick the “Show Hidden Devices” check box, see Fig. “Display of previous revisions”.
EL1052, EL105452 Version: 1.1
Fig.53: Display of previous revisions
Device selection based on revision, compatibility
The ESI description also defines the process image, the communication type between master and
slave/device and the device functions, if applicable. The physical device (firmware, if available) has
to support the communication queries/settings of the master. This is backward compatible, i.e.
newer devices (higher revision) should be supported if the EtherCAT master addresses them as an
older revision. The following compatibility rule of thumb is to be assumed for Beckhoff EtherCAT
Terminals/ Boxes/ EJ-modules:
device revision in the system >= device revision in the configuration
This also enables subsequent replacement of devices without changing the configuration (different
specifications are possible for drives).
Commissioning
Example:
If an EL2521-0025-1018 is specified in the configuration, an EL2521-0025-1018 or higher (-1019, -1020) can
be used in practice.
Fig.54: Name/revision of the terminal
If current ESI descriptions are available in the TwinCAT system, the last revision offered in the selection
dialog matches the Beckhoff state of production. It is recommended to use the last device revision when
creating a new configuration, if current Beckhoff devices are used in the real application. Older revisions
should only be used if older devices from stock are to be used in the application.
In this case the process image of the device is shown in the configuration tree and can be parameterised as
follows: linking with the task, CoE/DC settings, plug-in definition, startup settings, ...
EL1052, EL1054 53Version: 1.1
Commissioning
Fig.55: EtherCAT terminal in the TwinCAT tree (left: TwinCAT2; right: TwinCAT3)
EL1052, EL105454 Version: 1.1
Commissioning
5.1.6 ONLINE configuration creation
Detecting/scanning of the EtherCAT device
The online device search can be used if the TwinCAT system is in CONFIG mode. This can be indicated by
a symbol right below in the information bar:
• on TwinCAT2 by a blue display “Config Mode” within the System Manager window: .
• on TwinCAT3 within the user interface of the development environment by a symbol .
TwinCAT can be set into this mode:
• TwinCAT2: by selection of in the Menubar or by “Actions” → “Set/Reset TwinCATtoConfig
Mode…”
• TwinCAT3: by selection of in the Menubar or by „TwinCAT“ → “RestartTwinCAT(ConfigMode)“
Online scanning in Config mode
The online search is not available in RUN mode (production operation). Note the differentiation between TwinCAT programming system and TwinCAT target system.
The TwinCAT2 icon ( ) or TwinCAT3 icon ( ) within the Windows-Taskbar always shows the
TwinCAT mode of the local IPC. Compared to that, the System Manager window of TwinCAT2 or the user
interface of TwinCAT3 indicates the state of the target system.
Fig.56: Differentiation local/target system (left: TwinCAT2; right: TwinCAT3)
Right-clicking on “I/O Devices” in the configuration tree opens the search dialog.
Fig.57: Scan Devices (left: TwinCAT2; right: TwinCAT3)
This scan mode attempts to find not only EtherCAT devices (or Ethernet ports that are usable as such), but
also NOVRAM, fieldbus cards, SMB etc. However, not all devices can be found automatically.
Fig.58: Note for automatic device scan (left: TwinCAT2; right: TwinCAT3)
EL1052, EL1054 55Version: 1.1
Commissioning
Ethernet ports with installed TwinCAT real-time driver are shown as “RT Ethernet” devices. An EtherCAT
frame is sent to these ports for testing purposes. If the scan agent detects from the response that an
EtherCAT slave is connected, the port is immediately shown as an “EtherCAT Device” .
Fig.59: Detected Ethernet devices
Via respective checkboxes devices can be selected (as illustrated in Fig. “Detected Ethernet devices” e.g.
Device 3 and Device 4 were chosen). After confirmation with “OK” a device scan is suggested for all selected
devices, see Fig.: “Scan query after automatic creation of an EtherCAT device”.
Selecting the Ethernet port
Ethernet ports can only be selected for EtherCAT devices for which the TwinCAT real-time driver is
installed. This has to be done separately for each port. Please refer to the respective installation
page [}39].
Detecting/Scanning the EtherCAT devices
Online scan functionality
During a scan the master queries the identity information of the EtherCAT slaves from the slave
EEPROM. The name and revision are used for determining the type. The respective devices are located in the stored ESI data and integrated in the configuration tree in the default state defined
there.
Fig.60: Example default state
NOTE
Slave scanning in practice in series machine production
The scanning function should be used with care. It is a practical and fast tool for creating an initial configuration as a basis for commissioning. In series machine production or reproduction of the plant, however, the
function should no longer be used for the creation of the configuration, but if necessary for comparison
[}60] with the defined initial configuration.Background: since Beckhoff occasionally increases the revision
version of the delivered products for product maintenance reasons, a configuration can be created by such
a scan which (with an identical machine construction) is identical according to the device list; however, the
respective device revision may differ from the initial configuration.
Example:
Company A builds the prototype of a machine B, which is to be produced in series later on. To do this the
prototype is built, a scan of the IO devices is performed in TwinCAT and the initial configuration ‘B.tsm’ is
created. The EL2521-0025 EtherCAT terminal with the revision 1018 is located somewhere. It is thus built
into the TwinCAT configuration in this way:
EL1052, EL105456 Version: 1.1
Commissioning
Fig.61: Installing EthetCAT terminal with revision -1018
Likewise, during the prototype test phase, the functions and properties of this terminal are tested by the
programmers/commissioning engineers and used if necessary, i.e. addressed from the PLC ‘B.pro’ or the
NC. (the same applies correspondingly to the TwinCAT3 solution files).
The prototype development is now completed and series production of machine B starts, for which Beckhoff
continues to supply the EL2521-0025-0018. If the commissioning engineers of the series machine production
department always carry out a scan, a B configuration with the identical contents results again for each
machine. Likewise, A might create spare parts stores worldwide for the coming series-produced machines
with EL2521-0025-1018 terminals.
After some time Beckhoff extends the EL2521-0025 by a new feature C. Therefore the FW is changed,
outwardly recognizable by a higher FW version and a new revision -1019. Nevertheless the new device
naturally supports functions and interfaces of the predecessor version(s); an adaptation of ‘B.tsm’ or even
‘B.pro’ is therefore unnecessary. The series-produced machines can continue to be built with ‘B.tsm’ and
‘B.pro’; it makes sense to perform a comparative scan [}60] against the initial configuration ‘B.tsm’ in order
to check the built machine.
However, if the series machine production department now doesn’t use ‘B.tsm’, but instead carries out a
scan to create the productive configuration, the revision -1019 is automatically detected and built into the
configuration:
Fig.62: Detection of EtherCAT terminal with revision -1019
This is usually not noticed by the commissioning engineers. TwinCAT cannot signal anything either, since
virtually a new configuration is created. According to the compatibility rule, however, this means that no
EL2521-0025-1018 should be built into this machine as a spare part (even if this nevertheless works in the
vast majority of cases).
In addition, it could be the case that, due to the development accompanying production in company A, the
new feature C of the EL2521-0025-1019 (for example, an improved analog filter or an additional process
data for the diagnosis) is discovered and used without in-house consultation. The previous stock of spare
part devices are then no longer to be used for the new configuration ‘B2.tsm’ created in this way.Þ if series
machine production is established, the scan should only be performed for informative purposes for
comparison with a defined initial configuration. Changes are to be made with care!
If an EtherCAT device was created in the configuration (manually or through a scan), the I/O field can be
scanned for devices/slaves.
Fig.63: Scan query after automatic creation of an EtherCAT device (left: TwinCAT2; right: TwinCAT3)
EL1052, EL1054 57Version: 1.1
Commissioning
Fig.64: Manual triggering of a device scan on a specified EtherCAT device (left: TwinCAT2; right:
TwinCAT3)
In the System Manager (TwinCAT2) or the User Interface (TwinCAT3) the scan process can be monitored
via the progress bar at the bottom in the status bar.
Fig.65: Scan progressexemplary by TwinCAT2
The configuration is established and can then be switched to online state (OPERATIONAL).
Fig.66: Config/FreeRun query (left: TwinCAT2; right: TwinCAT3)
In Config/FreeRun mode the System Manager display alternates between blue and red, and the EtherCAT
device continues to operate with the idling cycle time of 4 ms (default setting), even without active task (NC,
PLC).
Fig.67: Displaying of “Free Run” and “Config Mode” toggling right below in the status bar
Fig.68: TwinCAT can also be switched to this state by using a button (left: TwinCAT2; right: TwinCAT3)
The EtherCAT system should then be in a functional cyclic state, as shown in Fig. “Online display example”.
EL1052, EL105458 Version: 1.1
Commissioning
Fig.69: Online display example
Please note:
• all slaves should be in OP state
• the EtherCAT master should be in “Actual State” OP
• “frames/sec” should match the cycle time taking into account the sent number of frames
• no excessive “LostFrames” or CRC errors should occur
The configuration is now complete. It can be modified as described under manual procedure [}50].
Troubleshooting
Various effects may occur during scanning.
• An unknown device is detected, i.e. an EtherCAT slave for which no ESI XML description is available.
In this case the System Manager offers to read any ESI that may be stored in the device. This case is
described in the chapter "Notes regarding ESI device description".
• Device are not detected properly
Possible reasons include:
- faulty data links, resulting in data loss during the scan
- slave has invalid device description
The connections and devices should be checked in a targeted manner, e.g. via the emergency scan.
Then re-run the scan.
Fig.70: Faulty identification
In the System Manager such devices may be set up as EK0000 or unknown devices. Operation is not
possible or meaningful.
EL1052, EL1054 59Version: 1.1
Commissioning
Scan over existing Configuration
NOTE
Change of the configuration after comparison
With this scan (TwinCAT2.11 or 3.1) only the device properties vendor (manufacturer), device name and
revision are compared at present! A ‘ChangeTo’ or ‘Copy’ should only be carried out with care, taking into
consideration the Beckhoff IO compatibility rule (see above). The device configuration is then replaced by
the revision found; this can affect the supported process data and functions.
If a scan is initiated for an existing configuration, the actual I/O environment may match the configuration
exactly or it may differ. This enables the configuration to be compared.
Fig.71: Identical configuration (left: TwinCAT2; right: TwinCAT3)
If differences are detected, they are shown in the correction dialog, so that the user can modify the
configuration as required.
Fig.72: Correction dialog
It is advisable to tick the “Extended Information” check box to reveal differences in the revision.
EL1052, EL105460 Version: 1.1
Commissioning
Colour Explanation
green This EtherCAT slave matches the entry on the other side. Both type and revision match.
blue This EtherCAT slave is present on the other side, but in a different revision. This other
revision can have other default values for the process data as well as other/additional
functions.
If the found revision is higher than the configured revision, the slave may be used provided
compatibility issues are taken into account.
If the found revision is lower than the configured revision, it is likely that the slave cannot be
used. The found device may not support all functions that the master expects based on the
higher revision number.
light blue This EtherCAT slave is ignored (“Ignore” button)
red • This EtherCAT slave is not present on the other side.
• It is present, but in a different revision, which also differs in its properties from the one
specified.
The compatibility principle then also applies here: if the found revision is higher than the
configured revision, use is possible provided compatibility issues are taken into account,
since the successor devices should support the functions of the predecessor devices.
If the found revision is lower than the configured revision, it is likely that the slave cannot
be used. The found device may not support all functions that the master expects based on
the higher revision number.
Device selection based on revision, compatibility
The ESI description also defines the process image, the communication type between master and
slave/device and the device functions, if applicable. The physical device (firmware, if available) has
to support the communication queries/settings of the master. This is backward compatible, i.e.
newer devices (higher revision) should be supported if the EtherCAT master addresses them as an
older revision. The following compatibility rule of thumb is to be assumed for Beckhoff EtherCAT
Terminals/ Boxes/ EJ-modules:
device revision in the system >= device revision in the configuration
This also enables subsequent replacement of devices without changing the configuration (different
specifications are possible for drives).
Example:
If an EL2521-0025-1018 is specified in the configuration, an EL2521-0025-1018 or higher (-1019, -1020) can
be used in practice.
Fig.73: Name/revision of the terminal
If current ESI descriptions are available in the TwinCAT system, the last revision offered in the selection
dialog matches the Beckhoff state of production. It is recommended to use the last device revision when
creating a new configuration, if current Beckhoff devices are used in the real application. Older revisions
should only be used if older devices from stock are to be used in the application.
In this case the process image of the device is shown in the configuration tree and can be parameterised as
follows: linking with the task, CoE/DC settings, plug-in definition, startup settings, ...
EL1052, EL1054 61Version: 1.1
Commissioning
Fig.74: Correction dialog with modifications
Once all modifications have been saved or accepted, click “OK” to transfer them to the real *.tsm
configuration.
Change to Compatible Type
TwinCAT offers a function “Change to Compatible Type…” for the exchange of a device whilst retaining the
links in the task.
Fig.75: Dialog “Change to Compatible Type…” (left: TwinCAT2; right: TwinCAT3)
This function is preferably to be used on AX5000 devices.
Change to Alternative Type
The TwinCAT System Manager offers a function for the exchange of a device: Change to Alternative Type
Fig.76: TwinCAT2 Dialog Change to Alternative Type
EL1052, EL105462 Version: 1.1
Commissioning
If called, the System Manager searches in the procured device ESI (in this example: EL1202-0000) for
details of compatible devices contained there. The configuration is changed and the ESI-EEPROM is
overwritten at the same time – therefore this process is possible only in the online state (ConfigMode).
5.1.7 EtherCAT subscriber configuration
In the left-hand window of the TwinCAT2 System Manager or the Solution Explorer of the TwinCAT3
Development Environment respectively, click on the element of the terminal within the tree you wish to
configure (in the example: EL3751 Terminal 3).
Fig.77: Branch element as terminal EL3751
In the right-hand window of the TwinCAT System manager (TwinCAT2) or the Development Environment
(TwinCAT3), various tabs are now available for configuring the terminal. And yet the dimension of
complexity of a subscriber determines which tabs are provided. Thus as illustrated in the example above the
terminal EL3751 provides many setup options and also a respective number of tabs are available. On the
contrary by the terminal EL1004 for example the tabs "General", "EtherCAT", "Process Data" and “Online“
are available only. Several terminals, as for instance the EL6695 provide special functions by a tab with its
own terminal name, so “EL6695” in this case. A specific tab “Settings” by terminals with a wide range of
setup options will be provided also (e.g. EL3751).
„General“ tab
Fig.78: “General” tab
Name Name of the EtherCAT device
Id Number of the EtherCAT device
Type EtherCAT device type
Comment Here you can add a comment (e.g. regarding the
system).
Disabled Here you can deactivate the EtherCAT device.
Create symbols Access to this EtherCAT slave via ADS is only
available if this control box is activated.
EL1052, EL1054 63Version: 1.1
Commissioning
„EtherCAT“ tab
Fig.79: „EtherCAT“ tab
Type EtherCAT device type
Product/Revision Product and revision number of the EtherCAT device
Auto Inc Addr. Auto increment address of the EtherCAT device. The
auto increment address can be used for addressing
each EtherCAT device in the communication ring
through its physical position. Auto increment
addressing is used during the start-up phase when
the EtherCAT master allocates addresses to the
EtherCAT devices. With auto increment addressing
the first EtherCAT slave in the ring has the address
0000
decremented by 1 (FFFF
. For each further slave the address is
hex
, FFFE
hex
hex
etc.).
EtherCAT Addr. Fixed address of an EtherCAT slave. This address is
allocated by the EtherCAT master during the start-up
phase. Tick the control box to the left of the input field
in order to modify the default value.
Previous Port Name and port of the EtherCAT device to which this
device is connected. If it is possible to connect this
device with another one without changing the order of
the EtherCAT devices in the communication ring,
then this combination field is activated and the
EtherCAT device to which this device is to be
connected can be selected.
Advanced Settings This button opens the dialogs for advanced settings.
The link at the bottom of the tab points to the product page for this EtherCAT device on the web.
“Process Data” tab
Indicates the configuration of the process data. The input and output data of the EtherCAT slave are
represented as CANopen process data objects (Process Data Objects, PDOs). The user can select a PDO
via PDO assignment and modify the content of the individual PDO via this dialog, if the EtherCAT slave
supports this function.
EL1052, EL105464 Version: 1.1
Fig.80: “Process Data” tab
Commissioning
The process data (PDOs) transferred by an EtherCAT slave during each cycle are user data which the
application expects to be updated cyclically or which are sent to the slave. To this end the EtherCAT master
(Beckhoff TwinCAT) parameterizes each EtherCAT slave during the start-up phase to define which process
data (size in bits/bytes, source location, transmission type) it wants to transfer to or from this slave. Incorrect
configuration can prevent successful start-up of the slave.
For Beckhoff EtherCAT EL, ES, EM, EJ and EP slaves the following applies in general:
• The input/output process data supported by the device are defined by the manufacturer in the ESI/XML
description. The TwinCAT EtherCAT Master uses the ESI description to configure the slave correctly.
• The process data can be modified in the system manager. See the device documentation.
Examples of modifications include: mask out a channel, displaying additional cyclic information, 16-bit
display instead of 8-bit data size, etc.
• In so-called “intelligent” EtherCAT devices the process data information is also stored in the CoE
directory. Any changes in the CoE directory that lead to different PDO settings prevent successful
startup of the slave. It is not advisable to deviate from the designated process data, because the
device firmware (if available) is adapted to these PDO combinations.
If the device documentation allows modification of process data, proceed as follows (see Figure “Configuring
the process data”).
• A: select the device to configure
• B: in the “Process Data” tab select Input or Output under SyncManager (C)
• D: the PDOs can be selected or deselected
• H: the new process data are visible as linkable variables in the system manager
The new process data are active once the configuration has been activated and TwinCAT has been
restarted (or the EtherCAT master has been restarted)
• E: if a slave supports this, Input and Output PDO can be modified simultaneously by selecting a socalled PDO record (“predefined PDO settings”).
EL1052, EL1054 65Version: 1.1
Commissioning
Fig.81: Configuring the process data
Manual modification of the process data
According to the ESI description, a PDO can be identified as “fixed” with the flag “F” in the PDO
overview (Fig. “Configuring the process data”, J). The configuration of such PDOs cannot be
changed, even if TwinCAT offers the associated dialog (“Edit”). In particular, CoE content cannot be
displayed as cyclic process data. This generally also applies in cases where a device supports
download of the PDO configuration, “G”. In case of incorrect configuration the EtherCAT slave usually refuses to start and change to OP state. The System Manager displays an “invalid SM cfg” logger message: This error message (“invalid SM IN cfg” or “invalid SM OUT cfg”) also indicates the
reason for the failed start.
A detailed description [}71] can be found at the end of this section.
„Startup“ tab
The Startup tab is displayed if the EtherCAT slave has a mailbox and supports the CANopen over EtherCAT
(CoE) or Servo drive over EtherCAT protocol. This tab indicates which download requests are sent to the
mailbox during startup. It is also possible to add new mailbox requests to the list display. The download
requests are sent to the slave in the same order as they are shown in the list.
EL1052, EL105466 Version: 1.1
Fig.82: „Startup“ tab
Column Description
Transition Transition to which the request is sent. This can either be
• the transition from pre-operational to safe-operational (PS), or
• the transition from safe-operational to operational (SO).
If the transition is enclosed in "<>" (e.g. <PS>), the mailbox request is fixed and cannot be
modified or deleted by the user.
Protocol Type of mailbox protocol
Index Index of the object
Data Date on which this object is to be downloaded.
Comment Description of the request to be sent to the mailbox
Commissioning
Move Up This button moves the selected request up by one
position in the list.
Move Down This button moves the selected request down by one
position in the list.
New This button adds a new mailbox download request to
be sent during startup.
Delete This button deletes the selected entry.
Edit This button edits an existing request.
“CoE – Online” tab
The additional CoE - Online tab is displayed if the EtherCAT slave supports the CANopen over EtherCAT
(CoE) protocol. This dialog lists the content of the object list of the slave (SDO upload) and enables the user
to modify the content of an object from this list. Details for the objects of the individual EtherCAT devices can
be found in the device-specific object descriptions.
EL1052, EL1054 67Version: 1.1
Commissioning
Fig.83: “CoE – Online” tab
Object list display
Column Description
Index Index and sub-index of the object
Name Name of the object
Flags RW The object can be read, and data can be written to the object (read/write)
RO The object can be read, but no data can be written to the object (read only)
P An additional P identifies the object as a process data object.
Value Value of the object
Update List The Update list button updates all objects in the displayed list
Auto Update If this check box is selected, the content of the objects is updated automatically.
Advanced The Advanced button opens the Advanced Settings dialog. Here you can specify
which objects are displayed in the list.
EL1052, EL105468 Version: 1.1
Commissioning
Fig.84: Dialog “Advanced settings”
Online - via SDO Information If this option button is selected, the list of the objects included in the object
list of the slave is uploaded from the slave via SDO information. The list
below can be used to specify which object types are to be uploaded.
Offline - via EDS File If this option button is selected, the list of the objects included in the object
list is read from an EDS file provided by the user.
„Online“ tab
Fig.85: „Online“ tab
EL1052, EL1054 69Version: 1.1
Commissioning
State Machine
Init This button attempts to set the EtherCAT device to the Init state.
Pre-Op This button attempts to set the EtherCAT device to the pre-operational state.
Op This button attempts to set the EtherCAT device to the operational state.
Bootstrap This button attempts to set the EtherCAT device to the Bootstrap state.
Safe-Op This button attempts to set the EtherCAT device to the safe-operational state.
Clear Error This button attempts to delete the fault display. If an EtherCAT slave fails during
change of state it sets an error flag.
Example: An EtherCAT slave is in PREOP state (pre-operational). The master now
requests the SAFEOP state (safe-operational). If the slave fails during change of state
it sets the error flag. The current state is now displayed as ERR PREOP. When the
Clear Error button is pressed the error flag is cleared, and the current state is
displayed as PREOP again.
Current State Indicates the current state of the EtherCAT device.
Requested State Indicates the state requested for the EtherCAT device.
DLL Status
Indicates the DLL status (data link layer status) of the individual ports of the EtherCAT slave. The DLL status
can have four different states:
Status Description
No Carrier / Open No carrier signal is available at the port, but the port is open.
No Carrier / Closed No carrier signal is available at the port, and the port is closed.
Carrier / Open A carrier signal is available at the port, and the port is open.
Carrier / Closed A carrier signal is available at the port, but the port is closed.
File Access over EtherCAT
Download With this button a file can be written to the EtherCAT device.
Upload With this button a file can be read from the EtherCAT device.
"DC" tab (Distributed Clocks)
Fig.86: "DC" tab (Distributed Clocks)
Operation Mode Options (optional):
• FreeRun
• SM-Synchron
• DC-Synchron (Input based)
• DC-Synchron
Advanced Settings… Advanced settings for readjustment of the real time determinant TwinCAT-
clock
Detailed information to Distributed Clocks are specified on http://infosys.beckhoff.com:
Fieldbus Components → EtherCAT Terminals → EtherCAT System documentation → EtherCAT basics →
Distributed Clocks
EL1052, EL105470 Version: 1.1
Commissioning
5.1.7.1 Detailed description of Process Data tab
Sync Manager
Lists the configuration of the Sync Manager (SM).
If the EtherCAT device has a mailbox, SM0 is used for the mailbox output (MbxOut) and SM1 for the mailbox
input (MbxIn).
SM2 is used for the output process data (outputs) and SM3 (inputs) for the input process data.
If an input is selected, the corresponding PDO assignment is displayed in the PDO Assignment list below.
PDO Assignment
PDO assignment of the selected Sync Manager. All PDOs defined for this Sync Manager type are listed
here:
• If the output Sync Manager (outputs) is selected in the Sync Manager list, all RxPDOs are displayed.
• If the input Sync Manager (inputs) is selected in the Sync Manager list, all TxPDOs are displayed.
The selected entries are the PDOs involved in the process data transfer. In the tree diagram of the System
Manager these PDOs are displayed as variables of the EtherCAT device. The name of the variable is
identical to the Name parameter of the PDO, as displayed in the PDO list. If an entry in the PDO assignment
list is deactivated (not selected and greyed out), this indicates that the input is excluded from the PDO
assignment. In order to be able to select a greyed out PDO, the currently selected PDO has to be deselected
first.
Activation of PDO assignment
ü If you have changed the PDO assignment, in order to activate the new PDO assignment,
a) the EtherCAT slave has to run through the PS status transition cycle (from pre-operational to
safe-operational) once (see Online tab [}69]),
b) and the System Manager has to reload the EtherCAT slaves
( button for TwinCAT2 or button for TwinCAT3)
PDO list
List of all PDOs supported by this EtherCAT device. The content of the selected PDOs is displayed in the
PDO Content list. The PDO configuration can be modified by double-clicking on an entry.
Column Description
Index PDO index.
Size Size of the PDO in bytes.
Name Name of the PDO.
If this PDO is assigned to a Sync Manager, it appears as a variable of the slave with this
parameter as the name.
Flags F Fixed content: The content of this PDO is fixed and cannot be changed by the
System Manager.
M Mandatory PDO. This PDO is mandatory and must therefore be assigned to a
Sync Manager! Consequently, this PDO cannot be deleted from the PDO
Assignment list
SM Sync Manager to which this PDO is assigned. If this entry is empty, this PDO does not take
part in the process data traffic.
SU Sync unit to which this PDO is assigned.
PDO Content
Indicates the content of the PDO. If flag F (fixed content) of the PDO is not set the content can be modified.
EL1052, EL1054 71Version: 1.1
Commissioning
Download
If the device is intelligent and has a mailbox, the configuration of the PDO and the PDO assignments can be
downloaded to the device. This is an optional feature that is not supported by all EtherCAT slaves.
PDO Assignment
If this check box is selected, the PDO assignment that is configured in the PDO Assignment list is
downloaded to the device on startup. The required commands to be sent to the device can be viewed in the
Startup [}66] tab.
PDO Configuration
If this check box is selected, the configuration of the respective PDOs (as shown in the PDO list and the
PDO Content display) is downloaded to the EtherCAT slave.
5.2 General Notes - EtherCAT Slave Application
This summary briefly deals with a number of aspects of EtherCAT Slave operation under TwinCAT. More
detailed information on this may be found in the corresponding sections of, for instance, the EtherCAT
System Documentation.
Diagnosis in real time: WorkingCounter, EtherCAT State and Status
Generally speaking an EtherCAT Slave provides a variety of diagnostic information that can be used by the
controlling task.
This diagnostic information relates to differing levels of communication. It therefore has a variety of sources,
and is also updated at various times.
Any application that relies on I/O data from a fieldbus being correct and up to date must make diagnostic
access to the corresponding underlying layers. EtherCAT and the TwinCAT System Manager offer
comprehensive diagnostic elements of this kind. Those diagnostic elements that are helpful to the controlling
task for diagnosis that is accurate for the current cycle when in operation (not during commissioning) are
discussed below.
Fig.87: Selection of the diagnostic information of an EtherCAT Slave
In general, an EtherCAT Slave offers
EL1052, EL105472 Version: 1.1
Commissioning
• communication diagnosis typical for a slave (diagnosis of successful participation in the exchange of
process data, and correct operating mode)
This diagnosis is the same for all slaves.
as well as
• function diagnosis typical for a channel (device-dependent)
See the corresponding device documentation
The colors in Fig. “Selection of the diagnostic information of an EtherCAT Slave” also correspond to the
variable colors in the System Manager, see Fig. “Basic EtherCAT Slave Diagnosis in the PLC”.
Colour Meaning
yellow Input variables from the Slave to the EtherCAT Master, updated in every cycle
red Output variables from the Slave to the EtherCAT Master, updated in every cycle
green Information variables for the EtherCAT Master that are updated acyclically. This means that
it is possible that in any particular cycle they do not represent the latest possible status. It is
therefore useful to read such variables through ADS.
Fig. “Basic EtherCAT Slave Diagnosis in the PLC” shows an example of an implementation of basic
EtherCAT Slave Diagnosis. A Beckhoff EL3102 (2-channel analogue input terminal) is used here, as it offers
both the communication diagnosis typical of a slave and the functional diagnosis that is specific to a channel.
Structures are created as input variables in the PLC, each corresponding to the process image.
Fig.88: Basic EtherCAT Slave Diagnosis in the PLC
The following aspects are covered here:
EL1052, EL1054 73Version: 1.1
Commissioning
Code Function Implementation Application/evaluation
A The EtherCAT Master's diagnostic infor-
mation
updated acyclically (yellow) or provided
acyclically (green).
B In the example chosen (EL3102) the
EL3102 comprises two analogue input
channels that transmit a single function
status for the most recent cycle.
C For every EtherCAT Slave that has cyclic
process data, the Master displays, using
what is known as a WorkingCounter,
whether the slave is participating successfully and without error in the cyclic exchange of process data. This important, elementary information is therefore provided
for the most recent cycle in the System
Manager
1. at the EtherCAT Slave, and, with
identical contents
2. as a collective variable at the
EtherCAT Master (see Point A)
for linking.
D Diagnostic information of the EtherCAT
Master which, while it is represented at the
slave for linking, is actually determined by
the Master for the Slave concerned and
represented there. This information cannot
be characterized as real-time, because it
• is only rarely/never changed,
except when the system starts up
• is itself determined acyclically (e.g.
EtherCAT Status)
Status
• the bit significations may be
found in the device
documentation
• other devices may supply
more information, or none
that is typical of a slave
WcState (Working Counter)
0: valid real-time communication in
the last cycle
1: invalid real-time communication
This may possibly have effects on
the process data of other Slaves
that are located in the same SyncUnit
State
current Status (INIT..OP) of the
Slave. The Slave must be in OP
(=8) when operating normally.
AdsAddr
The ADS address is useful for
communicating from the PLC/task
via ADS with the EtherCAT Slave,
e.g. for reading/writing to the CoE.
The AMS-NetID of a slave corresponds to the AMS-NetID of the
EtherCAT Master; communication
with the individual Slave is possible
via the port (= EtherCAT address).
At least the DevState is to be evaluated for
the most recent cycle in the PLC.
The EtherCAT Master's diagnostic information offers many more possibilities than are
treated in the EtherCAT System Documentation. A few keywords:
• CoE in the Master for communication
with/through the Slaves
• Functions from TcEtherCAT.lib
• Perform an OnlineScan
In order for the higher-level PLC task (or corresponding control applications) to be able to
rely on correct data, the function status must
be evaluated there. Such information is
therefore provided with the process data for
the most recent cycle.
In order for the higher-level PLC task (or corresponding control applications) to be able to
rely on correct data, the communication status of the EtherCAT Slave must be evaluated
there. Such information is therefore provided
with the process data for the most recent cycle.
Information variables for the EtherCAT Master that are updated acyclically. This means
that it is possible that in any particular cycle
they do not represent the latest possible status. It is therefore possible to read such variables through ADS.
NOTE
Diagnostic information
It is strongly recommended that the diagnostic information made available is evaluated so that the application can react accordingly.
CoE Parameter Directory
The CoE parameter directory (CanOpen-over-EtherCAT) is used to manage the set values for the slave
concerned. Changes may, in some circumstances, have to be made here when commissioning a relatively
complex EtherCAT Slave. It can be accessed through the TwinCAT System Manager, see Fig. “EL3102,
CoE directory”:
EL1052, EL105474 Version: 1.1
Commissioning
Fig.89: EL3102, CoE directory
EtherCAT System Documentation
The comprehensive description in the EtherCAT System Documentation (EtherCAT Basics --> CoE
Interface) must be observed!
A few brief extracts:
• Whether changes in the online directory are saved locally in the slave depends on the device. EL
terminals (except the EL66xx) are able to save in this way.
• The user must manage the changes to the StartUp list.
Commissioning aid in the TwinCAT System Manager
Commissioning interfaces are being introduced as part of an ongoing process for EL/EP EtherCAT devices.
These are available in TwinCAT System Managers from TwinCAT 2.11R2 and above. They are integrated
into the System Manager through appropriately extended ESI configuration files.
EL1052, EL1054 75Version: 1.1
Commissioning
Fig.90: Example of commissioning aid for a EL3204
This commissioning process simultaneously manages
• CoE Parameter Directory
• DC/FreeRun mode
• the available process data records (PDO)
Although the "Process Data", "DC", "Startup" and "CoE-Online" that used to be necessary for this are still
displayed, it is recommended that, if the commissioning aid is used, the automatically generated settings are
not changed by it.
The commissioning tool does not cover every possible application of an EL/EP device. If the available setting
options are not adequate, the user can make the DC, PDO and CoE settings manually, as in the past.
EtherCAT State: automatic default behaviour of the TwinCAT System Manager and manual operation
After the operating power is switched on, an EtherCAT Slave must go through the following statuses
• INIT
• PREOP
• SAFEOP
• OP
to ensure sound operation. The EtherCAT Master directs these statuses in accordance with the initialization
routines that are defined for commissioning the device by the ES/XML and user settings (Distributed Clocks
(DC), PDO, CoE). See also the section on "Principles of Communication, EtherCAT State Machine [}17]" in
this connection. Depending how much configuration has to be done, and on the overall communication,
booting can take up to a few seconds.
The EtherCAT Master itself must go through these routines when starting, until it has reached at least the
OP target state.
The target state wanted by the user, and which is brought about automatically at start-up by TwinCAT, can
be set in the System Manager. As soon as TwinCAT reaches the status RUN, the TwinCAT EtherCAT
Master will approach the target states.
EL1052, EL105476 Version: 1.1
Standard setting
The advanced settings of the EtherCAT Master are set as standard:
• EtherCAT Master: OP
• Slaves: OP
This setting applies equally to all Slaves.
Commissioning
Fig.91: Default behaviour of the System Manager
In addition, the target state of any particular Slave can be set in the "Advanced Settings" dialogue; the
standard setting is again OP.
Fig.92: Default target state in the Slave
EL1052, EL1054 77Version: 1.1
Commissioning
Manual Control
There are particular reasons why it may be appropriate to control the states from the application/task/PLC.
For instance:
• for diagnostic reasons
• to induce a controlled restart of axes
• because a change in the times involved in starting is desirable
In that case it is appropriate in the PLC application to use the PLC function blocks from the TcEtherCAT.lib,
which is available as standard, and to work through the states in a controlled manner using, for instance,
FB_EcSetMasterState.
It is then useful to put the settings in the EtherCAT Master to INIT for master and slave.
Fig.93: PLC function blocks
Note regarding E-Bus current
EL/ES terminals are placed on the DIN rail at a coupler on the terminal strand. A Bus Coupler can supply the
EL terminals added to it with the E-bus system voltage of 5 V; a coupler is thereby loadable up to 2 A as a
rule. Information on how much current each EL terminal requires from the E-bus supply is available online
and in the catalogue. If the added terminals require more current than the coupler can supply, then power
feed terminals (e.g. EL9410) must be inserted at appropriate places in the terminal strand.
The pre-calculated theoretical maximum E-Bus current is displayed in the TwinCAT System Manager as a
column value. A shortfall is marked by a negative total amount and an exclamation mark; a power feed
terminal is to be placed before such a position.
EL1052, EL105478 Version: 1.1
Commissioning
Fig.94: Illegally exceeding the E-Bus current
From TwinCAT 2.11 and above, a warning message "E-Bus Power of Terminal..." is output in the logger
window when such a configuration is activated:
Fig.95: Warning message for exceeding E-Bus current
NOTE
Caution! Malfunction possible!
The same ground potential must be used for the E-Bus supply of all EtherCAT terminals in a terminal block!
EL1052, EL1054 79Version: 1.1
Commissioning
5.3 Notes to the NAMUR switching amplifier of the terminal
The EL105x terminal is developed with regard to its input sided, functional voltage‑to‑current characteristic in
compliance with the definitions of IEC60947‑5‑6.
Fig.96: Representation of a typical U/I diagram on channel 1 of the EL105x incl. standard limits
(*Source of the standard limits: IEC60947‑5‑6, edition 1999)
Status bit, Status LED, Error bit, Error LED and switching hysteresis of the terminal together with
NAMUR‑limits is represented by the image as follows:
Fig.97: NAMUR switching potentials of the EL105x
A program of a control can evaluate the "Status bit" for the binary state and the "Error bit" of the terminal for
error detection. Accordingly, in addition to the active wire break or short circuit detection of the sensor, e.g.
switching paths differences of a sensor by a continuous sensor characteristic can be unique distinguished as
follows:
EL1052, EL105480 Version: 1.1
Commissioning
Fig.98: Exemplary trend of a proximity sensor with NAMUR limits for save decision of the switching state
EL1052, EL1054 81Version: 1.1
Appendix
6 Appendix
6.1 EtherCAT AL Status Codes
For detailed information please refer to the EtherCAT system description.
6.2 Firmware compatibility
The terminals of the EL10xx and EL11xx series have no firmware.
6.3 Firmware Update EL/ES/EM/EPxxxx
This section describes the device update for Beckhoff EtherCAT slaves from the EL/ES, EM, EK and EP
series. A firmware update should only be carried out after consultation with Beckhoff support.
Storage locations
An EtherCAT slave stores operating data in up to 3 locations:
• Depending on functionality and performance EtherCAT slaves have one or several local controllers for
processing I/O data. The corresponding program is the so-called firmware in *.efw format.
• In some EtherCAT slaves the EtherCAT communication may also be integrated in these controllers. In
this case the controller is usually a so-called FPGA chip with *.rbf firmware.
• In addition, each EtherCAT slave has a memory chip, a so-called ESI-EEPROM, for storing its own
device description (ESI: EtherCAT Slave Information). On power-up this description is loaded and the
EtherCAT communication is set up accordingly. The device description is available from the download
area of the Beckhoff website at (https://www.beckhoff.de). All ESI files are accessible there as zip files.
Customers can access the data via the EtherCAT fieldbus and its communication mechanisms. Acyclic
mailbox communication or register access to the ESC is used for updating or reading of these data.
The TwinCAT System Manager offers mechanisms for programming all 3 parts with new data, if the slave is
set up for this purpose. Generally the slave does not check whether the new data are suitable, i.e. it may no
longer be able to operate if the data are unsuitable.
Simplified update by bundle firmware
The update using so-called bundle firmware is more convenient: in this case the controller firmware and the
ESI description are combined in a *.efw file; during the update both the firmware and the ESI are changed in
the terminal. For this to happen it is necessary
• for the firmware to be in a packed format: recognizable by the file name, which also contains the
revision number, e.g. ELxxxx-xxxx_REV0016_SW01.efw
• for password=1 to be entered in the download dialog. If password=0 (default setting) only the firmware
update is carried out, without an ESI update.
• for the device to support this function. The function usually cannot be retrofitted; it is a component of
many new developments from year of manufacture 2016.
Following the update, its success should be verified
• ESI/Revision: e.g. by means of an online scan in TwinCAT ConfigMode/FreeRun – this is a convenient
way to determine the revision
• Firmware: e.g. by looking in the online CoE of the device
EL1052, EL105482 Version: 1.1
Appendix
NOTE
Risk of damage to the device!
Note the following when downloading new device files
• Firmware downloads to an EtherCAT device must not be interrupted
• Flawless EtherCAT communication must be ensured. CRC errors or LostFrames must be avoided.
• The power supply must adequately dimensioned. The signal level must meet the specification.
In the event of malfunctions during the update process the EtherCAT device may become unusable and require re-commissioning by the manufacturer.
6.3.1 Device description ESI file/XML
NOTE
Attention regarding update of the ESI description/EEPROM
Some slaves have stored calibration and configuration data from the production in the EEPROM. These are
irretrievably overwritten during an update.
The ESI device description is stored locally on the slave and loaded on start-up. Each device description has
a unique identifier consisting of slave name (9 characters/digits) and a revision number (4 digits). Each slave
configured in the System Manager shows its identifier in the EtherCAT tab:
Fig.99: Device identifier consisting of name EL3204-0000 and revision -0016
The configured identifier must be compatible with the actual device description used as hardware, i.e. the
description which the slave has loaded on start-up (in this case EL3204). Normally the configured revision
must be the same or lower than that actually present in the terminal network.
For further information on this, please refer to the EtherCAT system documentation.
Update of XML/ESI description
The device revision is closely linked to the firmware and hardware used. Incompatible combinations
lead to malfunctions or even final shutdown of the device. Corresponding updates should only be
carried out in consultation with Beckhoff support.
Display of ESI slave identifier
The simplest way to ascertain compliance of configured and actual device description is to scan the
EtherCAT boxes in TwinCAT mode Config/FreeRun:
EL1052, EL1054 83Version: 1.1
Appendix
Fig.100: Scan the subordinate field by right-clicking on the EtherCAT device
If the found field matches the configured field, the display shows
Fig.101: Configuration is identical
otherwise a change dialog appears for entering the actual data in the configuration.
Fig.102: Change dialog
In this example in Fig. Change dialog, an EL3201-0000-0017 was found, while an EL3201-0000-0016 was
configured. In this case the configuration can be adapted with the Copy Before button. The Extended
Information checkbox must be set in order to display the revision.
EL1052, EL105484 Version: 1.1
Changing the ESI slave identifier
The ESI/EEPROM identifier can be updated as follows under TwinCAT:
• Trouble-free EtherCAT communication must be established with the slave.
• The state of the slave is irrelevant.
• Right-clicking on the slave in the online display opens the EEPROM Update dialog, Fig. EEPROM
Update
Appendix
Fig.103: EEPROM Update
The new ESI description is selected in the following dialog, see Fig. Selecting the new ESI. The checkbox
Show Hidden Devices also displays older, normally hidden versions of a slave.
Fig.104: Selecting the new ESI
A progress bar in the System Manager shows the progress. Data are first written, then verified.
The change only takes effect after a restart.
Most EtherCAT devices read a modified ESI description immediately or after startup from the INIT.
Some communication settings such as distributed clocks are only read during power-on. The EtherCAT slave therefore has to be switched off briefly in order for the change to take effect.
EL1052, EL1054 85Version: 1.1
Appendix
6.3.2 Firmware explanation
Determining the firmware version
Determining the version on laser inscription
Beckhoff EtherCAT slaves feature serial numbers applied by laser. The serial number has the following
structure: KK YY FF HH
KK - week of production (CW, calendar week)
YY - year of production
FF - firmware version
HH - hardware version
Example with ser. no.: 12 10 03 02:
12 - week of production 12
10 - year of production 2010
03 - firmware version 03
02 - hardware version 02
Determining the version via the System Manager
The TwinCAT System Manager shows the version of the controller firmware if the master can access the
slave online. Click on the E-Bus Terminal whose controller firmware you want to check (in the example
terminal 2 (EL3204)) and select the tab CoE Online (CAN over EtherCAT).
CoE Online and Offline CoE
Two CoE directories are available:
• online: This is offered in the EtherCAT slave by the controller, if the EtherCAT slave supports this.
This CoE directory can only be displayed if a slave is connected and operational.
• offline: The EtherCAT Slave Information ESI/XML may contain the default content of the CoE.
This CoE directory can only be displayed if it is included in the ESI (e.g. "Beckhoff EL5xxx.xml").
The Advanced button must be used for switching between the two views.
In Fig. Display of EL3204 firmware version the firmware version of the selected EL3204 is shown as 03 in
CoE entry 0x100A.
Fig.105: Display of EL3204 firmware version
In (A) TwinCAT 2.11 shows that the Online CoE directory is currently displayed. If this is not the case, the
Online directory can be loaded via the Online option in Advanced Settings (B) and double-clicking on
AllObjects.
EL1052, EL105486 Version: 1.1
6.3.3 Updating controller firmware *.efw
CoE directory
The Online CoE directory is managed by the controller and stored in a dedicated EEPROM, which
is generally not changed during a firmware update.
Switch to the Online tab to update the controller firmware of a slave, see Fig. Firmware Update.
Appendix
Fig.106: Firmware Update
Proceed as follows, unless instructed otherwise by Beckhoff support. Valid for TwinCAT2 and 3 as
EtherCAT master.
• Switch TwinCAT system to ConfigMode/FreeRun with cycle time >= 1 ms (default in ConfigMode is 4
ms). A FW-Update during real time operation is not recommended.
EL1052, EL1054 87Version: 1.1
Appendix
• Switch EtherCAT Master to PreOP
• Switch slave to INIT (A)
• Switch slave to BOOTSTRAP
• Check the current status (B, C)
• Download the new *efw file (wait until it ends). A pass word will not be neccessary usually.
• After the download switch to INIT, then PreOP
• Switch off the slave briefly (don't pull under voltage!)
• Check within CoE 0x100A, if the FW status was correctly overtaken.
6.3.4 FPGA firmware *.rbf
If an FPGA chip deals with the EtherCAT communication an update may be accomplished via an *.rbf file.
• Controller firmware for processing I/O signals
• FPGA firmware for EtherCAT communication (only for terminals with FPGA)
The firmware version number included in the terminal serial number contains both firmware components. If
one of these firmware components is modified this version number is updated.
Determining the version via the System Manager
The TwinCAT System Manager indicates the FPGA firmware version. Click on the Ethernet card of your
EtherCAT strand (Device 2 in the example) and select the Online tab.
The Reg:0002 column indicates the firmware version of the individual EtherCAT devices in hexadecimal and
decimal representation.
EL1052, EL105488 Version: 1.1
Appendix
Fig.107: FPGA firmware version definition
If the column Reg:0002 is not displayed, right-click the table header and select Properties in the context
menu.
Fig.108: Context menu Properties
The Advanced Settings dialog appears where the columns to be displayed can be selected. Under
Diagnosis/Online View select the '0002 ETxxxx Build' check box in order to activate the FPGA firmware
version display.
EL1052, EL1054 89Version: 1.1
Appendix
Fig.109: Dialog Advanced Settings
Update
For updating the FPGA firmware
• of an EtherCAT coupler the coupler must have FPGA firmware version 11 or higher;
• of an E-Bus Terminal the terminal must have FPGA firmware version 10 or higher.
Older firmware versions can only be updated by the manufacturer!
Updating an EtherCAT device
The following sequence order have to be met if no other specifications are given (e.g. by the Beckhoff
support):
• Switch TwinCAT system to ConfigMode/FreeRun with cycle time >= 1ms (default in ConfigMode is
4ms). A FW-Update during real time operation is not recommended.
EL1052, EL105490 Version: 1.1
Appendix
• In the TwinCAT System Manager select the terminal for which the FPGA firmware is to be updated (in
the example: Terminal 5: EL5001) and
click the Advanced Settings button in the EtherCAT tab:
• The Advanced Settings dialog appears. Under ESC Access/E²PROM/FPGA click on Write FPGA
button:
EL1052, EL1054 91Version: 1.1
Appendix
• Select the file (*.rbf) with the new FPGA firmware, and transfer it to the EtherCAT device:
• Wait until download ends
• Switch slave current less for a short time (don't pull under voltage!). In order to activate the new FPGA
firmware a restart (switching the power supply off and on again) of the EtherCAT device is required.
• Check the new FPGA status
NOTE
Risk of damage to the device!
A download of firmware to an EtherCAT device must not be interrupted in any case! If you interrupt this
process by switching off power supply or disconnecting the Ethernet link, the EtherCAT device can only be
recommissioned by the manufacturer!
6.3.5 Simultaneous updating of several EtherCAT devices
The firmware and ESI descriptions of several devices can be updated simultaneously, provided the devices
have the same firmware file/ESI.
Fig.110: Multiple selection and firmware update
Select the required slaves and carry out the firmware update in BOOTSTRAP mode as described above.
EL1052, EL105492 Version: 1.1
Appendix
6.4 Restoring the delivery state
To restore the delivery state for backup objects in ELxxxx terminals, the CoE object Restore default
parameters, SubIndex 001 can be selected in the TwinCAT System Manager (Config mode) (see Fig.
Selecting the Restore default parameters PDO)
Fig.111: Selecting the "Restore default parameters" PDO
Double-click on SubIndex 001 to enter the Set Value dialog. Enter the value 1684107116 in field Dec or the
value 0x64616F6C in field Hex and confirm with OK (Fig. Entering a restore value in the Set Value dialog).
All backup objects are reset to the delivery state.
Fig.112: Entering a restore value in the Set Value dialog
Alternative restore value
In some older terminals the backup objects can be switched with an alternative restore value: Decimal value: 1819238756, Hexadecimal value: 0x6C6F6164An incorrect entry for the restore value
has no effect.
EL1052, EL1054 93Version: 1.1
Appendix
6.5 Support and Service
Beckhoff and their partners around the world offer comprehensive support and service, making available fast
and competent assistance with all questions related to Beckhoff products and system solutions.
Beckhoff's branch offices and representatives
Please contact your Beckhoff branch office or representative for local support and service on Beckhoff
products!
The addresses of Beckhoff's branch offices and representatives round the world can be found on her internet
pages:
http://www.beckhoff.com
You will also find further documentation for Beckhoff components there.
Beckhoff Headquarters
Beckhoff Automation GmbH & Co. KG
Huelshorstweg 20
33415 Verl
Germany
Phone: +49(0)5246/963-0
Fax: +49(0)5246/963-198
e-mail: info@beckhoff.com
Beckhoff Support
Support offers you comprehensive technical assistance, helping you not only with the application of
individual Beckhoff products, but also with other, wide-ranging services:
• support
• design, programming and commissioning of complex automation systems
• and extensive training program for Beckhoff system components
Hotline: +49(0)5246/963-157
Fax: +49(0)5246/963-9157
e-mail: support@beckhoff.com
Beckhoff Service
The Beckhoff Service Center supports you in all matters of after-sales service:
• on-site service
• repair service
• spare parts service
• hotline service
Hotline: +49(0)5246/963-460
Fax: +49(0)5246/963-479
e-mail: service@beckhoff.com
EL1052, EL105494 Version: 1.1
List of illustrations
List of illustrations
Fig. 1 EL5021 EL terminal, standard IP20 IO device with serial/ batch number and revision ID (since
2014/01)....................................................................................................................................... 8
Fig. 2 EK1100 EtherCAT coupler, standard IP20 IO device with serial/ batch number......................... 9
Fig. 3 CU2016 switch with serial/ batch number.................................................................................... 9
Fig. 4 EL3202-0020 with serial/ batch number 26131006 and unique ID-number 204418 ................... 9
Fig. 5 EP1258-00001 IP67 EtherCAT Box with batch number/ date code 22090101 and unique se-
rial number 158102...................................................................................................................... 10
Fig. 6 EP1908-0002 IP67 EtherCAT Safety Box with batch number/ date code 071201FF and
unique serial number 00346070 .................................................................................................. 10
Fig. 7 EL2904 IP20 safety terminal with batch number/ date code 50110302 and unique serial num-
ber 00331701............................................................................................................................... 10
Fig. 8 ELM3604-0002 terminal with unique ID number (QR code) 100001051 and serial/ batch num-
ber 44160201............................................................................................................................... 10
Fig. 9 EL1052, EL1054 .......................................................................................................................... 11
Fig. 10 System manager current calculation .......................................................................................... 15
Fig. 11 EtherCAT tab -> Advanced Settings -> Behavior -> Watchdog .................................................. 16
Fig. 12 States of the EtherCAT State Machine........................................................................................ 18
Fig. 13 "CoE Online " tab ........................................................................................................................ 20
Fig. 14 Startup list in the TwinCAT System Manager ............................................................................. 21
Fig. 15 Offline list ..................................................................................................................................... 22
Fig. 16 Online list .................................................................................................................................... 22
Fig. 17 Spring contacts of the Beckhoff I/O components......................................................................... 25
Fig. 18 Attaching on mounting rail ........................................................................................................... 26
Fig. 19 Disassembling of terminal............................................................................................................ 27
Fig. 20 Power contact on left side............................................................................................................ 28
Fig. 21 Standard wiring............................................................................................................................ 29
Fig. 22 Pluggable wiring .......................................................................................................................... 30
Fig. 23 High Density Terminals................................................................................................................ 30
Fig. 24 Connecting a cable on a terminal point ....................................................................................... 31
Fig. 25 Correct positioning....................................................................................................................... 33
Fig. 26 Incorrect positioning..................................................................................................................... 33
Fig. 27 Recommended distances for standard installation position ........................................................ 36
Fig. 28 Other installation positions .......................................................................................................... 37
Fig. 29 LEDs and connection EL1052, EL1054....................................................................................... 38
Fig. 30 System Manager “Options” (TwinCAT2)..................................................................................... 40
Fig. 31 Call up under VS Shell (TwinCAT3) ........................................................................................... 40
Fig. 32 Overview of network interfaces ................................................................................................... 40
Fig. 33 EtherCAT device properties(TwinCAT2): click on „Compatible Devices…“ of tab “Adapter” ..... 41
Fig. 34 Windows properties of the network interface............................................................................... 41
Fig. 35 Exemplary correct driver setting for the Ethernet port ................................................................. 42
Fig. 36 Incorrect driver settings for the Ethernet port ............................................................................. 43
Fig. 37 TCP/IP setting for the Ethernet port ............................................................................................ 44
Fig. 38 Identifier structure ....................................................................................................................... 45
Fig. 39 OnlineDescription information window (TwinCAT2) ................................................................... 46
Fig. 40 Information window OnlineDescription (TwinCAT3) ................................................................... 46
Fig. 41 File OnlineDescription.xml created by the System Manager ...................................................... 47
EL1052, EL1054 95Version: 1.1
List of illustrations
Fig. 42 Indication of an online recorded ESI of EL2521 as an example .................................................. 47
Fig. 43 Information window for faulty ESI file (left: TwinCAT2; right: TwinCAT3).................................. 47
Fig. 44 Using the ESI Updater (>= TwinCAT2.11).................................................................................. 49
Fig. 45 Using the ESI Updater (TwinCAT3)............................................................................................ 49
Fig. 46 Append EtherCAT device (left: TwinCAT2; right: TwinCAT3) ................................................... 50
Fig. 47 Selecting the EtherCAT connection (TwinCAT2.11, TwinCAT3)............................................... 50
Fig. 48 Selecting the Ethernet port ......................................................................................................... 50
Fig. 49 EtherCAT device properties (TwinCAT2) ................................................................................... 51
Fig. 50 Appending EtherCAT devices (left: TwinCAT2; right: TwinCAT3)............................................. 51
Fig. 51 Selection dialog for new EtherCAT device ................................................................................. 52
Fig. 52 Display of device revision ........................................................................................................... 52
Fig. 53 Display of previous revisions ...................................................................................................... 53
Fig. 54 Name/revision of the terminal ...................................................................................................... 53
Fig. 55 EtherCAT terminal in the TwinCAT tree (left: TwinCAT2; right: TwinCAT3).............................. 54
Fig. 56 Differentiation local/target system (left: TwinCAT2; right: TwinCAT3)....................................... 55
Fig. 57 Scan Devices (left: TwinCAT2; right: TwinCAT3) ...................................................................... 55
Fig. 58 Note for automatic device scan (left: TwinCAT2; right: TwinCAT3)........................................... 55
Fig. 59 Detected Ethernet devices .......................................................................................................... 56
Fig. 60 Example default state .................................................................................................................. 56
Fig. 61 Installing EthetCAT terminal with revision -1018 ......................................................................... 57
Fig. 62 Detection of EtherCAT terminal with revision -1019 .................................................................... 57
Fig. 63 Scan query after automatic creation of an EtherCAT device (left: TwinCAT2; right: Twin-
CAT3) ......................................................................................................................................... 57
Fig. 64 Manual triggering of a device scan on a specified EtherCAT device (left: TwinCAT2; right:
TwinCAT3).................................................................................................................................. 58
Fig. 65 Scan progressexemplary by TwinCAT2 ..................................................................................... 58
Fig. 66 Config/FreeRun query (left: TwinCAT2; right: TwinCAT3)......................................................... 58
Fig. 67 Displaying of “Free Run” and “Config Mode” toggling right below in the status bar .................... 58
Fig. 68 TwinCAT can also be switched to this state by using a button (left: TwinCAT2; right: Twin-
CAT3) ......................................................................................................................................... 58
Fig. 69 Online display example ............................................................................................................... 59
Fig. 70 Faulty identification ...................................................................................................................... 59
Fig. 71 Identical configuration (left: TwinCAT2; right: TwinCAT3) ......................................................... 60
Fig. 72 Correction dialog ......................................................................................................................... 60
Fig. 73 Name/revision of the terminal ...................................................................................................... 61
Fig. 74 Correction dialog with modifications ........................................................................................... 62
Fig. 75 Dialog “Change to Compatible Type…” (left: TwinCAT2; right: TwinCAT3) .............................. 62
Fig. 76 TwinCAT2 Dialog Change to Alternative Type ........................................................................... 62
Fig. 77 Branch element as terminal EL3751............................................................................................ 63
Fig. 78 “General” tab................................................................................................................................ 63
Fig. 79 „EtherCAT“ tab............................................................................................................................. 64
Fig. 80 “Process Data” tab....................................................................................................................... 65
Fig. 81 Configuring the process data....................................................................................................... 66
Fig. 82 „Startup“ tab................................................................................................................................. 67
Fig. 83 “CoE – Online” tab ....................................................................................................................... 68
Fig. 84 Dialog “Advanced settings”.......................................................................................................... 69
Fig. 85 „Online“ tab .................................................................................................................................. 69
EL1052, EL105496 Version: 1.1
List of illustrations
Fig. 86 "DC" tab (Distributed Clocks)....................................................................................................... 70
Fig. 87 Selection of the diagnostic information of an EtherCAT Slave ................................................... 72
Fig. 88 Basic EtherCAT Slave Diagnosis in the PLC............................................................................... 73
Fig. 89 EL3102, CoE directory ................................................................................................................ 75
Fig. 90 Example of commissioning aid for a EL3204 .............................................................................. 76
Fig. 91 Default behaviour of the System Manager .................................................................................. 77
Fig. 92 Default target state in the Slave .................................................................................................. 77
Fig. 93 PLC function blocks .................................................................................................................... 78
Fig. 94 Illegally exceeding the E-Bus current ......................................................................................... 79
Fig. 95 Warning message for exceeding E-Bus current ......................................................................... 79
Fig. 96 Representation of a typical U/I diagram on channel 1 of the EL105x incl. standard lim-
its(*Source of the standard limits: IEC60947‑5‑6, edition 1999)................................................. 80
Fig. 97 NAMUR switching potentials of the EL105x ................................................................................ 80
Fig. 98 Exemplary trend of a proximity sensor with NAMUR limits for save decision of the switching
state ............................................................................................................................................. 81
Fig. 99 Device identifier consisting of name EL3204-0000 and revision -0016 ...................................... 83
Fig. 100 Scan the subordinate field by right-clicking on the EtherCAT device .......................................... 84
Fig. 101 Configuration is identical ............................................................................................................. 84
Fig. 102 Change dialog ............................................................................................................................. 84
Fig. 103 EEPROM Update ........................................................................................................................ 85
Fig. 104 Selecting the new ESI.................................................................................................................. 85
Fig. 105 Display of EL3204 firmware version ............................................................................................ 86
Fig. 106 Firmware Update ......................................................................................................................... 87
Fig. 107 FPGA firmware version definition ............................................................................................... 89
Fig. 108 Context menu Properties ............................................................................................................ 89
Fig. 109 Dialog Advanced Settings ........................................................................................................... 90
Fig. 110 Multiple selection and firmware update ...................................................................................... 92
Fig. 111 Selecting the "Restore default parameters" PDO ........................................................................ 93
Fig. 112 Entering a restore value in the Set Value dialog.......................................................................... 93
EL1052, EL1054 97Version: 1.1
Loading...