Beckhoff TwinSAFE Loader User manual
Documentation | EN
TwinSAFE Loader
Tool to load and adapt a TwinSAFE project
2020-08-10 | Version: 2.4.0
Table of contents
Table of contents
1 Foreword ....................................................................................................................................................5
1.1 Notes on the documentation..............................................................................................................5
1.2 Safety instructions .............................................................................................................................6
1.2.1 Delivery state ..................................................................................................................... 6
1.2.2 Operator's obligation to exercise diligence ........................................................................ 6
1.2.3 Description of instructions.................................................................................................. 7
1.3 Documentation issue status ..............................................................................................................8
2 System description ...................................................................................................................................9
2.1 General..............................................................................................................................................9
2.2 System limits......................................................................................................................................9
3 Product description.................................................................................................................................10
3.1 System requirements.......................................................................................................................10
3.1.1 Operating System ............................................................................................................ 10
3.1.2 Target system .................................................................................................................. 11
3.1.3 Communication with the TwinSAFE logic component ..................................................... 12
3.2 Intended use....................................................................................................................................13
3.3 Functioning ......................................................................................................................................13
3.3.1 Communication................................................................................................................ 13
3.3.2 Authentication .................................................................................................................. 13
3.3.3 Loading a safety project................................................................................................... 14
3.3.4 Activation of a safety project............................................................................................ 14
3.3.5 Deleting a safety project .................................................................................................. 15
3.3.6 Customizing a safety project............................................................................................ 15
3.3.7 List of the current group configuration ............................................................................. 17
3.3.8 Additional functions.......................................................................................................... 17
3.4 List of all available parameters ........................................................................................................18
3.5 Safety parameters ...........................................................................................................................19
3.6 Error codes ......................................................................................................................................20
3.7 FMEDA ............................................................................................................................................20
4 EtherCAT Mailbox Gateway....................................................................................................................23
4.1 Settings EtherCAT Mailbox Gateway ..............................................................................................23
4.2 Beckhoff Virtual Ethernet Adapter ...................................................................................................24
4.3 Adding a route .................................................................................................................................26
5 Appendix ..................................................................................................................................................28
5.1 Support and Service ........................................................................................................................28
5.2 Certificates.......................................................................................................................................29
5.2.1 Letter of Confirmation ...................................................................................................... 29
TwinSAFE Loader 3Version: 2.4.0
Table of contents
TwinSAFE Loader4 Version: 2.4.0
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 following notes and explanations are followed when installing and commissioning
these components.
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.
Origin of the document
This original documentation is written in German. All other languages are derived from the German original.
Currentness
Please check whether you are using the current and valid version of this document. The current version can
be downloaded from the Beckhoff homepage at http://www.beckhoff.com/english/download/twinsafe.htm.
In case of doubt, please contact Technical Support [}28].
Product features
Only the product features specified in the current user documentation are valid. Further information given on
the product pages of the Beckhoff homepage, in emails or in other publications is not authoritative.
Disclaimer
The documentation has been prepared with care. The products described are subject to cyclical revision. For
that reason the documentation is not in every case checked for consistency with performance data,
standards or other characteristics. 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®, EtherCATG®, EtherCATG10®, EtherCATP®, SafetyoverEtherCAT®,
TwinSAFE®, XFC®, XTS® and XPlanar® 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, EP1456722, EP2137893, DE102015105702 with corresponding
applications or registrations in various other countries.
TwinSAFE Loader 5Version: 2.4.0
Foreword
EtherCAT® and Safety over EtherCAT® are registered trademarks and patented technologies, 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.
Delivery conditions
In addition, the general delivery conditions of the company Beckhoff Automation GmbH & Co. KG apply.
1.2 Safety instructions
1.2.1 Delivery state
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.
1.2.2 Operator's obligation to exercise diligence
The operator must ensure that
• the TwinSAFE products are only used as intended (see chapter Product description);
• the TwinSAFE products are only operated in sound condition and in working order.
• the TwinSAFE products are operated only by suitably qualified and authorized personnel.
• the personnel is instructed regularly about relevant occupational safety and environmental protection
aspects, and is familiar with the operating instructions and in particular the safety instructions contained
herein.
• the operating instructions are in good condition and complete, and always available for reference at the
location where the TwinSAFE products are used.
• none of the safety and warning notes attached to the TwinSAFE products are removed, and all notes
remain legible.
TwinSAFE Loader6 Version: 2.4.0
1.2.3 Description of instructions
In these operating instructions 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 the environment/equipment or data loss
Failure to follow this instruction can lead to environmental damage, equipment damage or data loss.
Foreword
Tip or pointer
This symbol indicates information that contributes to better understanding.
TwinSAFE Loader 7Version: 2.4.0
Foreword
1.3 Documentation issue status
Version Comment
2.4.0 • Semicolons removed from the csv tables
• Note on the different indexing in the Loader compared to the Safety Editor with regards to
the groups
• Added another example for the customizing
• Description of operating system extended
2.3.0 • Description of target system extended
• Added TwinSAFE Loader Version v7
2.2.0 • Added TwinSAFE Loader Version v6
2.1.1 • Note to Virtual Ethernet Adpater added
• Parameter --localams added
2.1.0 • Added extensions for TwinSAFE Loader, version v5
2.0.0 • Migration
• List of supported hardware updated
1.2.0 • Setting up EtherCAT Mailbox Gateway added
1.1.0 • Expanding system requirements
• Foreword updated
1.0.0 • First released version
0.0.7 • Functions Delete and Customize added
0.0.6 • Note added to FMEDA chapter
• Graphic added to Chapter 2.1
0.0.5 • Addition of the FMEDA
• Exchange of Chapters 3.2 and 3.3
0.0.4 • Resorting of chapters
0.0.3 • Chapter 3.7, CSV format added
0.0.2 • Revision of call parameters
0.0.1 • First draft
TwinSAFE Loader8 Version: 2.4.0
System description
2 System description
2.1 General
The TwinSAFE Loader is a software for loading a safety project to an EL69xx or EK19x0 safety controller
independently of the TwinCAT development environment. The starting point of a loading procedure is a
binary file that is exported in advance from the TwinCAT development environment.
Following the actual loading procedure, it is possible to adapt the safety project. To perform an adaptation,
the safety project must be configured accordingly in the TwinCAT development environment. The TwinSAFE
groups that are to be activated, deactivated or be passivated must be parametrized accordingly and the safe
substitute values for the outputs of the groups must be defined during the development by the programmer.
These substitute values are also part of the binary file that the programmer created after completion of the
safety program.
Fig.1: TwinSAFE Loader - Overview
2.2 System limits
The TwinSAFE Loader software is delivered as an executable program library and is available for the
Windows and Linux operating systems. This library can be integrated into applications. The various functions
of the program library are controlled by corresponding command line parameters.
The safety project can only be loaded for the EL6900 TwinSAFE logic terminal. It is not possible to adapt the
safety project here.
The safety project can be loaded and adapted for the EL6910 TwinSAFE logic terminal, the EK1960
TwinSAFE controller and any future TwinSAFE products.
A TwinCAT version 3.1 or higher is required to create a corresponding safety project.
TwinSAFE Loader 9Version: 2.4.0
Product description
3 Product description
The TwinSAFE Loader is a program library for the loading and adaptation of a safety project for TwinSAFE
logic components. Before describing the functional mode of the product in detail, the system requirements
for the successful use of the TwinSAFE Loader are dealt with in the following section.
3.1 System requirements
3.1.1 Operating System
To run the TwinSAFE Loader, the following system requirements must be met depending on the operating
system.
3.1.1.1 Windows
No additional components are required for the operating systems Windows7 (32/64bit) and Windows 10
(32/64 bit).
The following table lists the different versions of the TwinSAFE Loader and the associated SHA checksums.
File name Operating system Version SHA Checksum
TwinSAFE_Loader.exe Win32 v1 SHA1:
3dfc76aca223f04a0e91677f2c6452df8a39a8f9
v5 SHA256:
970a4ee096e181d20cea42d700c6ded1253a61a
34c9ea00a5db6cc9ee99693f6
v6 SHA256:
177f74ae6ce036ecc0f747f1f1324cfd890c627be9
1c111429a4bf124a3a1a1d
v7 SHA256:
e8287a0c23229cedb821e3a5b56459101ca45aa
badaa185e4313bd7ad3a92d47
TwinSAFE Loader10 Version: 2.4.0
Loading...