TwinSAFE Loader en PDF
TwinSAFE Loader en PDF
TwinSAFE Loader
Version: 2.3.0
Date: 2019-07-22
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 safety symbols ............................................................................................ 7
1.3 Documentation issue status .............................................................................................................. 8
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 ............................................................................. 16
3.3.8 Additional functions.......................................................................................................... 17
3.4 List of all available parameters ........................................................................................................ 18
3.5 Safety parameters ........................................................................................................................... 18
3.6 Error codes ...................................................................................................................................... 19
3.7 FMEDA ............................................................................................................................................ 19
5 Appendix .................................................................................................................................................. 27
5.1 Support and Service ........................................................................................................................ 27
5.2 Certificates....................................................................................................................................... 28
5.2.1 Letter of Confirmation ...................................................................................................... 28
1 Foreword
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.
This documentation was originally 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 [} 27].
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
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.
EtherCAT® and Safety over EtherCAT® are registered trademarks and patented technologies, licensed by
Beckhoff Automation GmbH, Germany.
Copyright
Delivery conditions
In addition, the general delivery conditions of the company Beckhoff Automation GmbH & Co. KG apply.
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.
Tip or pointer
This symbol indicates information that contributes to better understanding.
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.
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.
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.1.1 Windows
No additional components are required for the operating system Windows 7 (32 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
3.1.1.2 Linux
No additional components are required for the operating system Ubuntu 16.04.
The following table lists the different versions of the TwinSAFE Loader and the associated SHA checksums.
Filename Operating system Version SHA Checksum
TwinSAFE_Loader.bin Linux x86 64-Bit v1 SHA1:
c37f52a2fb8e3609346671feb2f60c9cba2bd2f9
v5 SHA256:
462a9f652eab4ad43fb0dbf487bb3db9fa71a596c
e339fb9fd5990f544d0a808
v6 SHA256:
972391f4aa88322dc8ffad415919ae814095ab73
49f059ffcb03e8a8c5d0f8a5
v7 SHA256:
b184816a9a17caeb1d7baca2395d30207cac463
b63638930de0dc4f20539bedf
TwinSAFE_Loader-i386.bin Linux x86 32-Bit v5 SHA256:
4b25dbd486cd56a3da411e7b1643be6834b7db5
1c3cb58bfb9caecdd36bdc9e1
v6 SHA256:
11ed882fd06dd28f19ec3a7c458fdebf87b8fdd26
9bec930a145056ece4dc835
v7 SHA256:
3af9a3a22fffa7a399c9aa5c1763ba588bc2680be
b8d3cadfd165739f4dca099
The components listed in the table above are directly supported in the current version of the TwinSAFE
loader.
NOTE
Integration of new TwinSAFE logic components
If a new TwinSAFE logic component is available which is not directly supported in the current version of the
TwinSAFE loader, it can be included by an additional configuration file.
To integrate a new TwinSAFE logic component, an additional file "custom_terminals.csv" must be created in
the directory of the TwinSAFE Loader execution file. This file can then be filled in the following syntax so that
new components can be supported (lines 1 and 2 are fixed). Using the example of a new logic component
ELxxxx, which is based on the TwinSAFE Logic EL6910, the file would have to be extended as shown in line
5.
File: custom_terminals.csv
1
class;type
EL6910;EL6910
EL6910;EP1957-0022
EL6910;ELxxxx
Furthermore, an updated version of this configuration file can always be found on the Beckhoff website when
new components are introduced without direct support from the TwinSAFE Loader.
For successful communication with the TwinSAFE logic component, the TwinSAFE Loader must be able to
establish a connection with the EtherCAT master existing in the system. The following system requirements
must be fulfilled for this:
CAUTION
Follow the machinery directive!
The TwinSAFE terminals may only be used in machines according to the machinery directive.
WARNING
Loading and adapting the project - workflow!
For loading and adapting a safety project, the user must specify a workflow in order to ensure that the cor-
rect safety project for the application is activated on the TwinSAFE logic component.
WARNING
Loading and adapting the project - authentication!
The user must ensure that only authorized persons are able to load or adapt the safety project.
3.3 Functioning
The task of the TwinSAFE Loader is to load a safety project to a TwinSAFE logic component independently
of the TwinCAT development environment or to adapt a safety project already existing on a TwinSAFE logic
component.
The data packets necessary for this are transmitted via the EtherCAT master existing in the system to the
corresponding component. The functions of the TwinSAFE Loader are controlled by command line
parameters.
3.3.1 Communication
The following parameters must be used to control communication.
3.3.2 Authentication
The following parameters must be used to authenticate a user on the TwinSAFE logic.
User management
Each TwinSAFE logic component has its own user administration. Only users registered in the
TwinSAFE logic component can perform certain functions.
WARNING
Loading a safety project
The loading of a safety project typically consists of a two-step process. The safety project must be activated
after loading it to the TwinSAFE logic component.
This division of the process enables measures to be taken to ensure that the correct safety project for the
respective application on the TwinSAFE logic component is switched to active. The user must define these
measures. The user shall bear full responsibility to provide proof for the accuracy and efficacy of these
measures. See also Chapter FMEDA [} 19].
In the TwinCAT development environment, for example, the checksum of the transferred safety project is
checked and a repeat login carried out before the safety project is really enabled (see chapter Intended use
[} 13]).
The loading of a safety project takes place, for example, as shown in the following call:
TwinSAFE_Loader --gw 192.168.1.254 --user Administrator --pass TwinSAFE --slave 1007 --proj ./
example.bin
The activation of a safety project takes place, for example, as shown in the following call:
TwinSAFE_Loader --gw 192.168.1.117 --ams 192.168.1.117.2.1 --user Administrator --pass TwinSAFE --
slave 1007 --proj ./example.bin --crc 0x4273
The deletion of a safety project takes place, for example, as shown in the following call:
TwinSAFE_Loader --gw 192.168.1.254 --user Administrator --pass TwinSAFE --slave 1007 --delete
The customizing of a safety project takes place, for example, as shown in the following call:
TwinSAFE_Loader --gw 192.168.1.254 --user Administrator --pass TwinSAFE --slave 1007 --customize ./
groupconfig.csv
The first line contains an unsigned integer, which is interpreted as the version number of the csv format:
"1"
"id;activate;passivate;temporarily;permanent"
The (2+n)th line contains the configuration of the nth TwinSAFE group in the format:
A: Active
D: cannot be activated
1
id; activate; passivate; temporarily; permanent
1; E; E; E; A
2; E; A; D; D
1. The first group can be activated, passivated, temporarily deactivated and permanently deactivated. Its
current state is permanently deactivated.
2. The second group can only be activated or passivated. Its current state is passivated.
The listing of the groups of a safety project takes place, for example, as shown in the following call:
TwinSAFE_Loader --gw 192.168.1.254 --user Administrator --pass TwinSAFE --slave 1007 --list ./
groupconfig.csv
The listing of the available slaves takes place, for example, as shown in the following call:
TwinSAFE_Loader --gw 192.168.1.254 --list ./safetyterminals.csv
The (1+n)th row contains the configuration of the nth EtherCAT slave in the format:
1. The first logic terminal is accessible via the EtherCAT address "1001", it has the FSoE address "1", it
is of the type "EL6900", no project is currently active on it ("0x0") and it is called "Term 2 (EL6900)"
2. The second logic terminal is accessible via the EtherCAT address "1003", it has the FSoE address "3",
it is of the type "EL6910", no project is currently active on it ("0x0") and it is called "Term 4 (EL6910)"
3. The third logic terminal is accessible via the EtherCAT address "1004", it has the FSoE address "50",
it is of the type "EL6930", the project with the CRC "0x4539" is currently active on it and it is called
"Term 5 (EL6930)"
3.7 FMEDA
The following table contains the FMEDA for the TwinSAFE loader. The errors are described in the
FailureMode column, in Effect the effect and in Diagnostics how the errors are detected or not detected.
CAUTION
FMEDA
The last column, User measures required of the following table indicates whether the user has to take ac-
tion to handle the errors described under FailureMode in a safe manner. These measures must be defined
and implemented by the user in the form of e.g. process descriptions or software specifications. The user
shall bear full responsibility to provide proof for the accuracy and efficacy of these measures.
11 A download and an acti- Download will be carried out completely Activation only occurs if the secure No
vation of the project are and validly by the tool, but it won’t be acti- address in the activation record
being carried out on a tar- vated yet. matches the secure address of the
get system which was not target system. A discrepancy leads to
intended from the point of cancellation of the activation.
view of the secure ad-
dress.
3 The download and the Download is carried out completely and Error is not detected by the tool. Yes
activation are being car- validly by the tool.
ried out with an unex-
pected project.
5 A user is attempting to Prior to start of the actual download Invalid access data is detected on the No
carry out a download with process a login is carried out with the in- target system during the login, the
false access data. valid access data on the target system. download is refused and a feedback
is given to the tool.
7 An unauthorized user is The download is successfully carried out. Error is not detected by the tool. Yes
attempting to carry out a
download with valid ac-
cess data.
13 Customizing is being car- The customizing is successfully carried Error is not detected by the tool. Yes
ried out by an unautho- out.
rized user with valid ac-
cess data.
14 Customizing is being car- Prior to starting the actual customizing Invalid access data is detected on the No
ried out by a user with process a login is carried out on the target target system during the login, cus-
false access data. system with the invalid access data. tomizing is refused and a feedback is
given to the tool.
8 Customizing record is be- The customizing is successfully carried Error is not detected by the tool. Yes
ing incorrectly transmit- out.
ted.
12 The wrong customizing Customizing action is carried out com- Error is not detected by the tool. Yes
record is being transmit- pletely and validly by the tool.
ted.
9 A communication connec- No action is executed on the target sys- An error code indicates a communi- No
tion cannot be estab- tem. cation error.
lished with the target sys-
tem.
15 While carrying out the Prior to the actual download the current An error code indicates the cancella- No
download the communi- safety project is deleted by the tool. The tion of the action.
cation connection to the download of a safety project only leads to
target system is can- a successful change of the active safety
celed. project if all steps of the download were
correctly carried out and the safety project
was activated. A cancellation of this
process leads to an empty target system.
16 While carrying out the The customizing is carried out by a single An error code indicates the cancella- No
customizing the commu- transaction. If this transaction is inter- tion of the action.
nication connection to the rupted, no action will be carried out on the
target system is can- target system. If the transaction is carried
celed. out, the correct action takes place on the
target system (provided there are no fur-
ther errors such as e.g. FMEDA ID 8).
The following description shows which settings must be made by way of example in order to be able to
communicate via the EtherCAT Mailbox Gateway.
The configuration for using the EtherCAT Mailbox Gateway consists of a TwinSAFE Loader PC on which the
TwinSAFE Loader is installed and a TwinCAT PC which serves as a gateway to route the requests from the
TwinSAFE Loader PC to the EtherCAT network and to the TwinSAFE logic components.
The settings for the EtherCAT Mailbox Gateway are summarized under the entry EoE Support. The Virtual
Ethernet Switch, Connect to TCP / IP Stack, and IP Enable Router must be enabled. In addition, the
EtherCAT Mailbox Gateway must be activated and an IP address outside the existing networks must be
selected. These settings require a restart of the TwinCAT PC.
Whether these settings are correct should be checked locally with the ping command on the TwinCAT
computer. In this case, the command would read as follows:
ping 192.198.67.254
To do this, open the network settings and select the Properties via the context menu of the Beckhoff Virtual
Ethernet Adapter.
Fig. 10: Network settings - context menu of the Beckhoff virtual Ethernet adapter
In the properties of this network adapter, you set a fixed IP address that is within the network area of the
EtherCAT Mailbox Gateway. In the example, this is the IP address 192.198.67.13 with the subnet mask
255.255.255.0.
Whether this setting is correct should be checked again with the ping command locally on the TwinCAT
computer. The command would again be as follows:
ping 192.198.67.254
The route is added by command route add from the command line.
The command returns an OK! when adding the route was successful.
The current routes can be displayed using the route print 192.198.* command.
To check the function, a ping command should now be sent from the TwinSAFE Loader PC to the EtherCAT
Mailbox Gateway.
ping 192.198.67.254
If the ping command returns a positive result, the EtherCAT Mailbox Gateway can also be used with the
TwinSAFE Loader.
5 Appendix
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
Huelshorstweg 20
33415 Verl
Germany
Phone: +49 5246 963 0
Fax: +49 5246 963 198
e-mail: [email protected]
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 5246 963 157
Fax: +49 5246 963 9157
e-mail: [email protected]
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 5246 963 460
Fax: +49 5246 963 479
e-mail: [email protected]
5.2 Certificates
Table of figures
Fig. 1 TwinSAFE Loader - Overview ..................................................................................................... 9
Fig. 2 Call to load a safety project ......................................................................................................... 14
Fig. 3 Call to activate a safety project.................................................................................................... 15
Fig. 4 Call to delete a safety project ...................................................................................................... 15
Fig. 5 Call to customize a safety project ................................................................................................ 15
Fig. 6 Call to list the groups of a safety project...................................................................................... 16
Fig. 7 EtherCAT Mailbox Gateway ........................................................................................................ 22
Fig. 8 EoE Support ................................................................................................................................ 23
Fig. 9 The command ping 192.198.67.254 ............................................................................................ 23
Fig. 10 Network settings - context menu of the Beckhoff virtual Ethernet adapter .................................. 24
Fig. 11 Properties of the Beckhoff virtual Ethernet adapter ..................................................................... 24
Fig. 12 Start the Windows command prompt as administrator ................................................................ 25
Fig. 13 Windows command prompt ......................................................................................................... 26
Fig. 14 Windows command prompt - command ping 192.198.67.254 .................................................... 26