EtherCAT® Configuration and Diagnosis Tool

Technical Presentation

EtherCAT System Architecture

.xml

EtherCAT Network Information (ENI) File

EtherCAT Slave

Information (ESI) Files.xml.xml.xml

Real-Time Kernel/OS

EtherCAT Application

RAS Server (TCP)

RAS Client (TCP)

TCP/IP

Online Functions

V2.7 2

Operating Modes

Offline Configuration:(In the Office)

Online Configuration:Slaves connected toEngineering System

Remote Configuration:Slaves connected toTarget System

Remote Diagnosis:Slaves connected toTarget System

V2.7 3

Start Page

V2.7 4

Configuration ModeMain View

V2.7 5

Configuration ModeSlaves using MDP

V2.7 6

Configuration ModeUpdate existing project with newly scanned slaves

V2.7 7

Configuration ModeMaster Sync Units

• Useful for grouping specific data

Process Image: Variables are stored together within one memory block

Error checking: Own datagram(s) allows individual WKC state check

• API ecatGetMasterSyncUnitInfo(), ecatGetMasterSyncUnitInfoNumOf()

V2.7 8

Configuration ModeMaster Sync Units and Multiple Tasks

V2.7 9

After setting any EC-Engineer project as template, newly added or scanned slaves are copied from the template instead from ESI cache. Using a template with preconfigured slaves (PDO mapping, Names, Init Commands etc.) will save time and prevents mistakes.

Project templates

V2.7 10

Slave to Slave communication in one cycle

V2.7 11

• Copy input data from one slave to output data in second slave Only enable valid slaves in the GUI

FMMU configuration adjusted appropriatelyo data will be copied automatically within the same (single) EtherCAT cycle

o No change in the master stack or application required

enable singlecycle copy

Beckhoff EL6224 IO-Link terminal

V2.7 12

Beckhoff EL6731-0010 PROFIBUS slave terminal

V2.7 13

Support for EtherCAT pPower Sourcing Device

V2.7 14

Support for EtherCAT pPowered Device

Define Load

V2.7 15

Support for EtherCAT pCheck whole configuration

Valid Configuration

V2.7 16

Support for EtherCAT pCheck whole configuration

Invalid Configuration

V2.7 17

Diagnosis ModeSlave state

V2.7 18

Diagnosis ModeFile access functions

V2.7 19

Diagnosis ModeView and force variables

V2.7 20

Diagnosis ModeAccess to CANOpen object dictionary

V2.7 21

Diagnosis ModePowerful “Line crossed” detection

V2.7 22

Snapshot and Offline Diagnosis

New

V2.7 23

• Takes a snapshot from the current diagnosis state and saves it into a capture file

• Automatic snapshot mode to take snapshots based on the configured rules, e. g. periodically and/or triggered by a notification

• Offline diagnosis mode to analyze previously captured data

Snapshot and Offline DiagnosisFeature Overview

V2.7 24

• Capture data from control system

Define capture settings and features, e.g., select captured data, slaves, …

Switch into Diagnosis Mode go online to control system

Take snapshot: Manually or periodically

Switch back to Configuration Mode

• Evaluate captured data

Select capture file

Switch into Diagnosis Mode captured data displayed

Select another snapshot

Snapshot and Offline DiagnosisStep by Step

V2.7 25

Snapshot and Offline DiagnosisCapture settings

Set folder and filename

Define content• Process data and master object dictionary

always• EEPROM and ESC optional• Slave object dictionary optional

Trigger conditions

V2.7 26

Snapshot and Offline DiagnosisTake Snapshot

Start Snapshot

Uploading and saving data

V2.7 27

Snapshot and Offline DiagnosisSelect Capture File

V2.7 28

Snapshot and Offline DiagnosisEvaluate data

Process Data

V2.7 29

• EMI (EtherCAT Master Information) file to specify the master features Unit Name Possible cycle times, e. g., 250, 500, 1000, 2000 usec Maximum Slave Count Distributed Clocks supported: yes/no. Define DCM mode Hot Connect supported: yes/no OEM features ….

• Features are enabling/disabling dialogs, controls and settings

• EMI files (XML format) located in C:\Program Files (x86)\acontis_technologies\EC-Engineer\EMI

V2.7

Definition of Master Features (EMI file)

30

• Unicode enabled: English, German, Japanese, Korean, …

Multiple Language Support

V2.7 31

• Language files located in C:\Program Files (x86)\acontis_technologies\EC-Engineer\Languages

Multiple Language Support

V2.7 32

• Scanning slave devices Slaves connected to the local (engineering) system Slaves connected to the control system

• Support of multiple, different Master Devices

• Master Device Settings Cycle Time, Verbosity Level Used network interface Activation of feature packs (e. g. cable redundancy)

• Plant Layout Adding, Removing and Moving of Slave Devices

• Update or synchronize an existing project with newly scanned slaves

• Slave Device Settings Display and edit EtherCAT address PDO Selection and configuration Display and edit start offset of slave inside process data image Display of slave variables Distributed Clocks (DC) parameters

• Configuration of slaves based on the Modular Device Profile (MDP)

Summary: Configuration Features (I)

V2.7 33

• Display and edit CoE and SoE Startup Commands using offline object dictionary

• Distributed Clocks Parameters Display and edit Reference Clock Setup DC Master Synchronization mode

• Defining and editing of Hot Connect (HC) Groups

• Station Alias Address: Display and program

• Slave to Slave copy, important for safety slaves

• Master Sync Units and Multiple Cyclic Tasks

• Advanced Settings Bus-Scan Parameters Timeouts for State Change FMMU Programing (LRD/LWR instead of LRW) Watchdog configuration (Sync Manager and PDI)

• Export ENI-File ETG.2100

• Import ENI-File

V2.7

Summary: Configuration Features (II)

34

• Compare actually connected slaves with configured slaves

• Line Crossed Analyzer: Figure out swapped cables

• Display and modify master state and slave states

• Display process data (inputs and outputs). Create watch list for favorites

All

Slave specific

• Display Master and Slave Object Dictionary

• Read and write CANOpen objects (SDO Up- and Download)

• Display Slave Error Register 0x300 ff.

• Display EtherCAT Slave Controller (ESC) Registers

• File up- and download via FoE

• Programming EEPROM based on ESI file content

• … and many more

Summary: Diagnosis Features

V2.7 35

• Runtime License: Protected with USB dongle 180-100-1-0 EC-Engineer, Runtime License, Windows

182-100-1-0 EC-Lyser, Runtime License, Windows

• Maintenance 180-101-1-0 EC-Engineer, Maintenance, Runtime License

182-101-1-0 EC-Lyser, Maintenance, Runtime License, 12 months

V2.7 36

EC-Engineer and EC-LyserLicensing

Plus Edition for Beckhoff Fieldbus Gatewaysand Slave-to-Slave communication in one cycle

EC-Engineer PlusBeckhoff PROFIBUS Master and Slave gateway EL6731

V2.7 38

EC-Engineer PlusBeckhoff CANopen Master and Slave gateway EL6751

V2.7 39

• Base license: One-time upgrade fee 180-152-1-0 EC-Engineer Plus, Base License

• Runtime License: Protected with USB dongle 180-150-1-0 EC-Engineer Plus, Runtime License, Windows

• Maintenance 180-151-1-0 EC-Engineer Plus, Maintenance, Runtime License

V2.7 40

EC-Engineer Plus Licensing

Software Development Kit

Customize EC-Engineer

Enhance EC-Engineer

Simplify EC-Engineer

Integrate EC-Engineer

Software Development Kit (SDK)

SDK

Software Development Kit to build

your own EtherCAT Tool

for configuration and diagnosis

V2.7 42

Use Case: Integration into existing toolsPhoenix Contact Multiprog

Separate dialog opens from within Multiprog to configure EtherCAT slaves

V2.7 43

V2.7

Use Case: Integration into existing tools YASKAWA SPEED7 Studio

44

Use Case: Slave specific configuration and diagnosis dialog

V2.7 45

V2.7

Use Case: Brand LabelingPower Automation ETC-Engineer

Product Name

Window Title

Company Logo

46

Software Architecture Overview

V2.7 47

Five layers for integration

1. Rebranding, theme, own slave plug-in

2. Integration in existing engineering software by showing reduced information in a sub window

3. Integration with a completely different graphical user interface (GUI)

4. Integration without GUI, but the internal EC-Master functionality will be used

5. Integration without GUI and EC-Master functionality. Library for creating ENI file based on ESI files and input list

Layer 1 to 3: Microsoft WindowsLayer 4 to 5: Microsoft Windows and Linux

Software layers

Layer 1

Layer 2

Layer 3

Layer 4

Layer 5

V2.7 48

• Create customized, different looking version of EC-Engineer without programming

• Change icons, colors, application name etc. just by editing text files and copying PNG files

• Hide tabs and menus

• Create custom installer

V2.7

Brand Labeling KitLayer 1

49

• ENI Builder Command line tool for creating ENI file based

on a simple input file (EBI) EBI file can be generated by customer´s

application, e.g., existing configuration tool All slave and master parameters, e.g., PDO,

cycle time, variable names, bus topology, etc. defined by specific tags

• ENI Engine Integrate business logic to create ENI file into

customer´s application Full-feature API (Classes) for specifying all

slave and master parameters Fast execution time, typically below two

seconds

• Available on Windows and Linux

• EtherCAT Slave Information (ESI) according to ETG.2000 required for slaves

V2.7

ENI Builder and ENI EngineLayer 5

50

• EC-Engineer SDK: Includes all layers 180-110-1-0 EC-Engineer OEM SDK with training

180-113-1-0 EC-Engineer OEM SDK without training

180-111-1-0 EC-Engineer OEM SDK, Maintenance, 12 months

“100-833-0-0 EC-Master, FP EC-Engineer OEM Runtime License” required

• EC-Engineer, Brand Labeling Kit: Layer 1 180-130-1-0 EC-Engineer, Brand Labeling Kit

• EC-ENI-Builder OEM: Layer 5 195-000-1-0 EC-ENI-Builder OEM, SDK, Windows

195-002-1-0 EC-ENI-Builder OEM, Yearly License, Windows, 12 months

V2.7 51

EC-Engineer SDKLicensing

OEM Edition

• Provide an alternative way for software protection By default EC-Engineer is protected via a USB dongle

Some customers, e. g. controller makers, have to provide the tool to their customers and therefore a USB dongle or any other software activation can´t be handled

• Restrict EC-Engineer features, e. g., no “Online Configuration”

• Simplify EC-Engineer user interface, e. g. exclude unsupported mailbox protocol tabs

• Link OEM EC-Engineer version to OEM controllers Avoid other OEMs being able to use the same OEM EC-Engineer with their

controllers

This restriction should work in configuration and diagnosis mode

• All requirements also apply to EC-Lyser

Purpose of EC-Engineer OEM

V2.7 53

System Architecture with OEM Version

Real-Time Kernel/OS

OEM Version

OEM Version

EtherCAT Application

RAS Server (TCP)

RAS Client (TCP)

TCP/IP

Login only with

valid key

ESI

Files

.XML

License File

EcOem

.DAT

Encrypted ENI

File

ENI

.XML

OEM Customer Key

V2.7 54

Implementation

• Each customer will get an unique “OEM Customer Key” for his controller

• This key is used by EC-Engineer to create an encrypted ENI file

• This key has to provided to EC-Master API ecatSetOemLicenseKey()

• EC-Master is able to decrypt the ENI file based on the key

• In diagnosis mode the EC-Engineer login procedure has to provide the matching key to EC-Master RAS-Server

How it works

V2.7 55

• EC-Engineer (Standard) can always be used to configure and diagnose all masters

• EC-Engineer-OEM creates encrypted network configuration (ENI file)

• EC-Master-OEM can read standard ENI file and can use encrypted ENI file

• EC-Engineer-OEM online functions (network scan and diagnosis) are only working together with the associated EC-Master-OEM version

Protection matrix

EC-Engineer EC-Engineer-OEM

EC-Master USB Dongle Invalid combination

EC-Master-OEM USB DongleProtection with matching

key

V2.7 56

• SDK is optional

• Runtime license: Equal volume as EC-Master runtimes 100-833-0-0 EC-Master, FP EC-Engineer OEM Runtime License

100-843-0-0 EC-Master, FP EC-Lyser OEM Runtime License

• Maintenance 100-835-0-0 EC-Master, FP EC-Engineer OEM Maintenance, 12 months

100-845-0-0 EC-Master, FP EC-Lyser OEM Maintenance, 12 months

V2.7 57

EC-Engineer and EC-Lyser OEM EditionLicensing