Page 3
Document file: I:\Texte\Doku\MANUALS\ECX\ECX-EC\Englisch\ECX-EC-Manual_en_19.odt Date of print: 2020-01-14 Document type DOC0800 number: Firmware version: from Version 1.0.3 Document History The changes in the document listed below affect changes in the hardware as well as changes in the description of the facts, only. Revision Chapter Changes versus previous version...
Page 4
Classification of Warning Messages and Safety Instructions This manual contains noticeable descriptions, warning messages and safety instructions, which you must follow to avoid personal injuries or death and property damage. This is the safety alert symbol. It is used to alert you to potential personal injury hazards. Obey all safety messages and instructions that follow this symbol to avoid possible injury or death.
It is the responsibility of the device's user to take care that necessary safety precautions for the device's network interface are in place.
Page 6
Service Note The ECX-EC does not contain any parts that require maintenance by the user. The ECX-EC does not require any manual configuration of the hardware. Unauthorized intervention in the device voids warranty claims. Disposal Devices which have become defective in the long run have to be disposed in an appropriate way or have to be returned to the manufacturer for proper disposal.
InRailBus connector (TBUS-connector) integrated in the mounting-rail. Furthermore, an optional CAN interface can be realized, accessible via the InRailBus connector. The 100BASE-T-EtherCAT interfaces are designed according to IEEE 802.3. The ECX-EC can be configured by typical network configuration tools (e.g. esd Workbench, TwinCAT , etc.).
Hardware Installation 2. Hardware Installation 2.1 Connecting Diagram Fig. 2: Connections of the ECX-EC in ready-to-operate condition NOTICE Read chapter “Hardware Installation ” on page 14, before you start with the installation of the hardware! NOTICE Do not connect the USB interface! It is currently without function.
Hardware Installation 2.2 LED Display Fig. 3: Position of the LEDs The position of the LEDs of the secondary EtherCAT interface EC-B in the RJ45 sockets IN and OUT and its display functions is equal to those of interface EC-A. The position of the sockets of EC-B can be taken from the connecting diagram (page 11).
Page 13
Hardware Installation Name in Function Color Indicator state Description schematic diagram power supply voltage on Status green LED4 firmware update finished, device flickering has to be restarted write access to the internal flash Flash yellow on LED3 is active Init BootStrap flickering Pre-Operational...
Hardware Installation 3. Hardware Installation To put the ECX-EC into operation, please follow the installation notes. Step Procedure page NOTICE Read the safety instructions at the beginning of this document carefully, before you start with the hardware installation! WARNING Hazardous voltage - Risk of electric shock All current circuits which are connected to the device have to be sufficiently protected against hazardous voltage (SELV according to EN 60950-1) before you start with the installation.
Technical Data 4. Technical Data 4.1 General Technical Data Power supply voltage Nominal voltage: typical: 24 V/DC, (min.: 18 V, max.: 32 V) Current consumption: (24 V, 20 °C): 100 mA reverse voltage protection Connectors 24 V-power supply voltage (X1, 4-pol. Phoenix Contact connector with spring-cage connection) EC-A Primary EtherCAT I/F (EtherCAT0)
Technical Data 4.2 Microprocessor and Memory TI, AM3357, min. 600 MHz Main memory 64 MB DDR2, 16 bit Flash memory (NOR) Max. 8 MB (via SPI) Flash memory (NAND) EEPROM 24C32 Watchdog CPU internal Table 5: Microprocessor and memory 4.2.1 EtherCAT Slave EC-A (Primary) Number Controller PRUs of the CPU with Micrel KSZ8051 Ethernet Phys...
Table 9: Data of the USB interface 4.5 Software Support For the configuration of the ECX-EC common EtherCAT configuration tools, as e.g. esd Workbench or TwinCAT , can be used. (For examples see chapter “Software” , page 21 et seqq.) ®...
Connector Assignments 5. Connector Assignments 5.1 24 V-Power Supply Voltage Device socket: Phoenix Contact MSTBO 2,5/4-G1L-KMGY Line connector: Phoenix Contact FKCT 2,5/4-ST, 5.0 mm pitch, spring cage connection, Phoenix Contact order No.: 19 21 90 0 (included in the scope of delivery) For conductor connection and conductor cross section see page 20.
Permissible cable types: Cables of category 5e or higher have to be used to grant the function in networks with up to 100 Mbits/s. esd grants the EC conformity of the product if the wiring is carried out with shielded twisted pair cables of class SF/UTP or higher.
Connector Assignments 5.3 Conductor Connection/Conductor Cross Sections The following table contains an extract of the technical data of the line connectors. 24 V Power Supply Interface Voltage Connector type plug component FKCT 2,5/..-ST KMGY (Range of articles) Connection method spring-cage connection Stripping length 10 mm...
6.2.4. 6.1 Quick Start / First Steps INFORMATION The ECX-EC can be configured with the EtherCAT Workbench. The esd EtherCAT Workbench is contained on the supplied ECX-EC-CD. For quick configuration of the ECX-EC the esd software UDDC (“Universal Device Description Composer”) can be used to generate a complete EtherCAT ESI file that...
Start the EtherCAT Workbench and choose Copy ESI file(s) to slave library in the upper • Tools menu. In the following dialogue choose the file: ESD ECX-EC.xml • Copy the file ESD ECX-EC.xml into the subdirectory SlaveLibrary of the Workbench • installation. (For example: C:\Program Files\esd\EtherCAT\EtherCAT Workbench\SlaveLibrary\)
Software 6.1.2.2 Scan the EtherCAT Segment To establish a connection to the master click the button Online. A dialogue with a request opens. Confirm here to perform a scan. (In newer versions of the Workbench this step will be carried out automatically if the slaves were not yet assigned.) If the ECX-EC is successfully detected, the following dialogue is shown.
Software 6.1.2.3 Creating Variables For the ECX-EC special tabs are created under Device Specific in the EtherCAT Workbench, see Fig. 7 and Fig. 8. These tabs simplify the creation of variables and allow the transmission to the corresponding opposite side. (In principle this is also possible without this special configuration tab, see 6.2.3 for details.) Fig.
Page 25
Software Primary side Select the slave of the ECX-EC primary side: Slave 1 (ECX-EC Pri) (Fig. 6) and go to the corresponding Workbench configuration tab (Fig. 7). Right-click in the list of Inputs: to open a context menu and select Append item to append a new input variable: Fig.
Software 6.1.2.4 Test Data Transfer In the online mode the data transfer can be tested. If you are not already in this mode, change into the online mode by clicking the Online button. Then click the Free run button to switch into Free run mode. The states of the slaves and of the master should be Operational after a short time, as indicated by -symbols in Fig.
Page 27
Software Read and write variables Select tab Process Data/Image of the Workbench and choose tab Variables. All process variables are shown in this list. Output variables can be changed/written and input- variables can be updated/read. To make it easier to find the generated variables it is advisable to set a filter (e.g. “Vari “ as shown in Fig.
2.11. The figures might differ for other versions, but the basic procedure is the same and can be applied to other configurators. 6.1.3.1 ESI Installation Copy the file: ESD ECX-EC.xml into the subdirectory Io\EtherCAT of the TwinCAT installation. (For example C:\Program Files\TwinCAT\Io\EtherCAT\). Restart TwinCAT now.
Software 6.1.3.3 Create variables Because the ECX-EC can not be detected as EtherCAT bridge by TwinCAT currently, the variables have to be created via configuration of the PDOs (for details see chapter 6.2.3). Primary side Select the slave of the ECX-EC's primary side: Slave 1 (ECX-EC Pri) (Fig. 13, “Box 1”) and go to tab Process Data: Fig.
Page 30
Software Secondary side Select the slave of the ECX-EC's secondary side: Slave 2 (ECX-EC Sec) (Fig. 13, “Box 2”) and switch to tab Process data (Fig. 14). Because the input variables of one side must correspond to the output variables of the other side two input variables: 1.
Software 6.1.3.4 Test Data Transfer Click the Reload I/O Devices button to switch into Free Run state (see upper menu bar): Fig. 17: TwinCAT Reload I/O Devices button The dialogue Activate Free Run opens and has to be confirmed. Make sure that all slaves are in “OP”...
Page 32
Software Read and write variables Select the first output variable of the primary side and click Online Write.. in the context menu: Fig. 19: TwinCAT context menu output variable In the following dialogue the value of the variable can be entered. In this example “123” is written. Click on the corresponding input variable of the other side and choose the tab Online: Fig.
6.2 Start-Up NOTICE The enclosed ECX-EC-CD contains the EtherCAT Workbench as network configuration and diagnostic tool for EtherCAT networks (see chapter “esd EtherCAT Workbench”, on page 22). For quick configuration of the ECX-EC the esd software UDDC (“Universal Device Description Composer”) can be used to generate a complete EtherCAT ESI file that already includes the variables.
Software 6.2.3 Definition of the Bridge Variables The PDO 0x1A00 is specified for input data and PDO 0x1600 for output data. The definition of the corresponding variables, and thereby the size of the process data, result from the objects that are mapped into these PDOs. As input variables the entries of object 0x6000 and as output variables the entries of object 0x7000 are used.
Software 6.2.4 Distributed Clocks Basically each single side of the ECX-EC acts as an ordinary DC slave – its time can be distributed to the following slaves as a reference or if another reference is present, it can be simply adjusted. (The data transfer to/from the other side is thereby independent of the SYNC signal) The specific characteristic of the ECX-EC is, that the difference of the DC times on both of its sides can be determined with high-precision.
Page 36
Software Normal operation: (Pri.) Slave1 Slave2 Slave3 Slave4 Primary Master Redund. (Sec.) Slaven Slave6 Slave5 ECX-EC Redundancy: (Pri.) Slave1 Slave2 Slave3 Slave4 Primary Auto sync Master enabled Redund. (Sec.) Slaven Slave6 Slave5 Fig. 23: Automatic DC synchronisation in redundancy case Important notes about automatic DC synchronisation: Primary and secondary side can’t be exchanged, it’s always the primary side •...
Software 6.2.4.2 Standard Synchronisation In the standard DC synchronisation the ECX-EC only serves to measure the difference between the DC times of both EtherCAT segments, i.e. the adaptation is done from an EtherCAT master. 6.2.4.2.1 PDOs The required time stamps are contained in Object 0x10F4 – “External Synchronization Status” (see chapter 6.3.1.6), for that PDO 0x1A02 –...
Software Additionally the master of the ECX-EC secondary side adapts the time that is spread by this slave, so it matches the other side’s time (“Correction” in Fig. 24). This correction is done by writing the slave’s DC System Time (register 0x0910), which provides for the fact that the clock frequency is adapted accordingly, when the timestamps show the clock runs too slow, a higher value is written, and vice versa.
Software In normal operation in this example the time of the first slave is distributed to all following slaves, as this is would be possible with every other DC slave too. In case of redundancy there are only two segments and the last slave of the primary segment becomes the first slave of the new segment –...
Software 6.2.5 PDOs 6.2.5.1 0x1600 – “Outputs” Output variables. This PDO must be assigned (SM2) and is writeable, see 6.2.3 for details. Content: Length Index Description index (Type) 0x7000 1 0x7000 2 variable Process variable, see 6.2.3 0x7000 0x7000 n 6.2.5.2 0x1605 –...
Software 6.2.5.4 0x1A01 – “SYNC Slave (status only)” This PDO is optional, a synchronous usage of PDO 0x1A02/0x1A03/0x1A04 is excluded. Used for DC synchronisation, see 6.2.4.2.2. Content: Length Index Description index (Type) 0x10F4 0x01 2 (BIT2) SYNC mode, see 6.3.1.6 0x0000 0x00 Alignment 0x0000 0x00...
Software 6.2.5.6 0x1A03 – “SYNC Slave (32 bit)” As object 0x1A02, but with 32-bit time stamps. This PDO is optional, a synchronous usage of PDO 0x1A01/0x1A02/0x1A04 is excluded. Used for DC synchronisation, see 6.2.4.2.2. Content: Length Index Description index (Type) 0x10F4 0x01 2 (BIT2) SYNC mode, see 6.3.1.6...
Software 6.2.6 UDP Gateway This is a special mode of the ECX-EC in which the EtherCAT secondary (EC-B) is left unused. Instead of that the UDP remote station (ETH) acts as a primary, i.e. the input data of the primary (EC-A) are received by the ECX-EC by UDP and the output data are accordingly transmitted by UDP.
Software 6.2.6.2 Configuration with UDDC - Universal Device Description Composer For quick configuration the esd software UDDC (“Universal Device Description Composer”) can be used to generate a complete EtherCAT ESI file that already includes the variables. UDDC additionally generates a C header file that might be helpful for the configuration of the UDP remote station.
Software 6.2.6.3 Protocol Overview In both directions the communication is done via so called ”commands”, packed in UDP frames with a defined header. For more details see chapter 6.2.6.4. Each time new output data are received for the EtherCAT ECX-EC primary site a command with these output data is transmitted via UDP (if this does not contradict the configured minimum interval time).
Page 46
Software Command Structure 32 Bit Type Length 0..n command data bytes Type • See following table “Commands”. ◦ Unknown commands have to be ignored. Length • Data length of the commands in byte (without header, i.e. starting with 0). ◦ If the number of bytes is lower than specified, the command has to be skipped.
Page 47
Software Name Value Data Description (UDPGW_CMD_...) PONG 0x4f50 8 byte timestamp + Transmitted as answer to a PING – can 8 byte timestamp of be used to estimate the latency according PING SENDLOSTCNT 0x4c53 none Instructs the ECX-EC to send a LOSTCNT command LOSTCNT 0x434c 4 byte lost counter +...
Software 6.3 CoE Object Directory All subindices not listed do not exist, an access to them leads to the according error. 6.3.1 Standard Objects (0x1000..0x1FFF) 6.3.1.1 Object 0x1000 – “Device Type” Name Type Description index 0x00 Device Type UDINT Device type of the EtherCAT slave The LoWord contains the CoE profile used (5000: Modular device).
Software 6.3.1.6 Object 0x10F4 – “External Synchronization Status” Used at DC synchronisation, see also 6.2.4.2.2. Name Type Description index 0x00 SubIndex000 USINT Max. number of sub indices (0x13) 0x01 Sync mode BIT2 0: no synchronisation, 1: slave is SYNC master, 2: slave is SYNC slave defined via 0x10F5.01, see 6.3.1.7 0x0E...
If the configuration of the variables shall e.g. be done only on one side and be transferred to the other side, this object can be used to define a detailed configuration. (E.g. the esd EtherCAT Workbench uses this object on the primary side via Download variable Configuration and for the variables on the secondary side via Load from device –...
Software 6.3.1.9 Object 0x1400 – “RxPDO 0x1600 Parameter” See also Object 0x1800 – “TxPDO 0x1A00 Parameter”. Name Type Description index 0x00 SubIndex000 USINT Max. number of sub indices (0x09) 0x07 RxPDO State BOOL Is set by the slave if the output variables could not be copied to the opposite side.
Software 6.3.1.12 Object 0x1800 – “TxPDO 0x1A00 Parameter” See also Object 0x1400 – “RxPDO 0x1600 Parameter”. Name Type Description index 0x00 SubIndex000 USINT Max. number of sub indices (0x09) 0x07 TxPDO State BOOL Is set by the slave if the input data are invalid, i.e. the other side is not in “Operational”.
Software 6.3.1.16 Object 0x1804 – “TxPDO 0x1A04 Parameter” Name Type Description index 0x00 SubIndex000 USINT Max. number of sub indices (0x06) 0x06 Exclude TxPDOs OCTET_STRING PDOs, that must not be simultaneously assigned with this: 0x1A01/0x1A02/0x1A03 6.3.1.17 Object 0x1A00 – “Inputs” Name Type Description...
Software 6.3.1.24 Object 0x1C12 – “PDO Assignment” Name Type Description index 0x00 SubIndex000 USINT Max. number of sub indices 0x01..0xFF PDO Assignment UINT SM2 assigned PDOs, see also 6.2.4.2.1 6.3.1.25 Object 0x1C13 – “PDO Assignment” Name Type Description index 0x00 SubIndex000 USINT Max.
Software 6.3.2 Manufacturer-specific Objects (0x2000..0x5FFF) 6.3.2.1 Object 0x2000 – “Other Settings” All this settings affect both sides, no matter from which side accessed, and remain valid until the ECX-EC is rebooted or other values are written. Name Type Description index 0x00 SubIndex000 USINT Max.
Software 6.3.2.3 Object 0x2010 – “Statistics” This object contains several statistics, usually it is only used for troubleshooting. Sub- Name Type Description 0x00 SubIndex000 USINT Max. number of sub indices (0x16) 0x01 Reset UDINT Every write access resets the statistics (as far as possible).
Software Sub- Name Type Description 0x16 EoE Frames Local Tx UDINT No. of frames that could not be sent to Ethernet Overrun interface due to Tx buffer overrun 6.3.2.4 Object 0x2020 – “Ethernet” This object contains some data about the Ethernet interface, usually it is only used for troubleshooting.
Software 6.3.2.5 Object 0x2030 – “UDP Gateway” This objekt contains the data of the UDP gateway mode as described in chapter 6.2.6. It exists at the primary site only. Sub- Name Type Description 0x00 SubIndex000 USINT Max. used subindex (0x30) 0x01 Enabled UINT...
Page 61
Software Sub- Name Type Description 0x0c UDP not ready UDINT Transmission interval in µs for ECATSTATEINFO interval commands, if the ECX-EC is not in EtherCAT state “Op”. (values limited to ≥ 1000, default value: 100000) 0x0d Client timeout UINT If no valid frame is received from the UDP remote station within this time, the connection is assumed to be interrupted.
Software 6.3.3 Profile-specific Objects (0x6000..0xFFFF) 6.3.3.1 Object 0x6000 – “Inputs” The entries of this object correspond to the created input variables, i.e. they are only generated if the PDO 0x1A00 configuration is downloaded into the ECX-EC. Name Type Description index 0x00 SubIndex000 USINT...
INFORMATION Make sure the latest/correct EEPROM ESI is also installed and updated if necessary. 6.4.1 Firmware-Update with esd EtherCAT Workbench INFORMATION The EtherCAT Workbench is contained on the enclosed ECX-EC-CD. Connect the primary side of the ECX-EC with the Workbench system and choose the •...
Try to transfer the file again. If the transfer of the file fails again, the file might be ▪ defective. Contact the support (support@esd.eu) 6.4.2 Firmware-Update with Beckhoff TwinCAT/Configurator Connect the primary side of the ECX-EC with the TwinCAT system and choose Scan •...
Page 65
Software Activate the button Download in the range File access over EtherCAT • Select the file, e.g. firmwareUpdate_1_0_1.efw • Fig. 28: Select firmware Confirm your selection with the OK button • Wait until the file is transferred (see progress bar) •...
EEPROM (Category “General”, see [3]). If that is set to 0 (evaluated at first state change to “PreOp”) all EoE activities are stopped. Fig. 29 shows this exemplary for the EtherCAT Workbench: Fig. 29: EoE deactivation with the esd EtherCAT Workbench Page 66 of 74 Manual • Doc. No.: E.3022.21 / Rev. 1.9...
Appendix InRailBus (Option) 7. Appendix InRailBus (Option) 7.1 Connector Assignment 24V via InRailBus (Option) Connector type: Mounting-rail bus connector CAN-CBX-TBUS Phoenix Contact ME 22,5 TBUS 1,5/5-ST-3,81 KMGY Connector View: Pin Assignment: Signal (GND) (+24 V) Do not connect! Do not connect! Do not connect! (PE_GND) Signal Description:...
Appendix InRailBus (Option) 7.2 Using InRailBus Connector 7.2.1 Connection of the Power Supply Voltage The power supply voltage can be connected via the +24V connector for the power supply voltage or via InRailBus connector. NOTICE Please note the safety instructions to requirements on the supply current circuit (see page NOTICE The connections for the 24V power supply are internally connected and must not be supplied by two independent current sources at once!
Appendix InRailBus (Option) 7.2.2 Installation of the Module Using the InRailBus Connector If the power supply voltage shall be fed via the InRailBus, please proceed as follows: Fig. 31: Mounting rail with bus connector NOTICE The pins 1,2 and 3 of the mounting rail bus connector are reserved and must not be connected! Position the mounting rail bus connector of the InRailBus (CAN-CBX-TBUS, order no.: C.3000.01) on the mounting rail and snap it onto the mounting rail using slight pressure.
Page 70
Appendix InRailBus (Option) When mounting the CAN-CBX module the metal foot catch snaps on the bottom edge of the mounting rail. Now the module is mounted on the mounting rail and connected to the InRailBus via the bus connector. Connect the bus connectors and the InRailBus, if not already done.
Appendix InRailBus (Option) 7.2.2.1 Connecting Power Supply via CBX-InRailBus To connect the power supply and the CAN-signals via the InRailBus, a terminal plug (CAN-CBX- TBUS Connector, order no.: C.3000.02) is needed. The terminal plug is not included in delivery and must be ordered separately. Fig.
Page 72
References 8. References EtherCAT Technology Group, EtherCAT Specification – Part 5 (ETG.1000.5), Version 1.0.2 EtherCAT Technology Group, EtherCAT Protocol Enhancements (ETG.1020), Version 1.0.0 EtherCAT Technology Group, EtherCAT Specification – Part 6 (ETG.1000.6), Version 1.0.2 Beckhoff Automation GmbH, ET1100 Hardware Data Sheet, Version 1.8 Page 72 of 74 Manual •...
Page 73
Declaration of Conformity 9. Declaration of Conformity ECX-EC Manual • Doc. No.: E.3022.21 / Rev. 1.9 Page 73 of 74...
Page 74
Table 10: Order information PDF Manuals Manuals are available in English and usually in German as well. For availability of English manuals see table below. Please download the manuals as PDF documents from our esd website www.esd.eu for free. Manuals Order No.
Need help?
Do you have a question about the EtherCAT ECX-EC E.3022.02 and is the answer not in the manual?
Questions and answers