Notes on the documentation
1 Foreword
1.1 Notes on the documentation
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 the 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®, Safety over EtherCAT®, 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.
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 symbols
In this documentation the following symbols are used with an accompanying safety instruction or note. The
safety instructions must be read carefully and followed without fail!
DANGER
Serious risk of injury!
Failure to follow the safety instructions associated with this symbol directly endangers the life and health of
persons.
WARNING
Risk of injury!
Failure to follow the safety instructions associated with this symbol endangers the life and health of persons.
CAUTION
Personal injuries!
Failure to follow the safety instructions associated with this symbol can lead to injuries to persons.
NOTE
Damage to the environment or devices
Failure to follow the instructions associated with this symbol can lead to damage to the environment or
equipment.
Tip or pointer
This symbol indicates information that contributes to better understanding.
2 Overview
2.1 Product description
TwinCAT HMI is a tool for creating HMIs (Human Machine Interfaces). Like TwinCAT, it is integrated directly
into Visual Studio. A graphical WYSIWYG editor is used for the configuration, i.e. no programming is
required.
Controls from the toolbox can be arranged on the user interface and linked with real-time variables, e.g. from
the PLC or from a C++ module. User Controls can be used to graphically create and configure specific
controls. JavaScript developers can develop their own controls. During development, the functionality can be
tested with live data from the real-time system. Modifications are also possible in this live mode.
The logic of the HMI can either be implemented on the client side in JavaScript or as a server extension. A
server extension allows you to develop extensions in C#.
Because the HMI is web-based and responsive - based on HTML5 and JavaScript - the resolution and
orientation adapt automatically. This allows the same page to be used for different display sizes, aspect
ratios and orientations.
2.2 Scenarios
The HMI can be integrated into a wide range of scenarios.
In a network, different controllers can exchange their data with one or more clients. The clients can run on
local PCs or Panel PCs, or on mobile devices such as tablets or smartphones.
Local-Client
Multi-client
An HMI can be configured for different resolutions and can be called up by several devices simultaneously.
Multi-runtime
The TwinCAT HMI can connect several real-time systems. TwinCAT runtimes can be programmed in PLC
languages, C/C++ or MATLAB®/Simulink®.
Multi-protocol
The TwinCAT HMI server can communicate with all TwinCAT runtimes via the ADS extension. Third-party
controllers can be connected via the OPC UA extension. Other protocols can be integrated via the Server
Extensions SDK.
2.3 Architecture
2.3.1 Engineering
The TwinCAT HMI integrates into the Visual Studio® development environment from Microsoft. TwinCAT3
provides the free Visual Shell, which can also be used with the TwinCAT HMI. This allows you to develop the
PLC and the HMI in one tool. TwinCAT HMI Creator is an editor for graphical development of the HMI. The
TwinCAT HMI framework comes with predefined controls. Communication with the TwinCAT HMI Server
takes place via secure network connections. The TwinCAT HMI Server has a modular structure. HMI Server
Extensions provide additional functions. Furthermore, you can develop your own customer extensions to
execute non-real-time-relevant business logics centrally in the server. The TwinCAT ADS protocol
(Automation Device Specification) is supported, which enables communication with all TwinCAT devices.
2.3.2 Client/Server
The TwinCAT HMI is essentially based on a client-server architecture. No additional software installation is
required for the TwinCAT HMI Client. It is an HTML5-capable web browser that does not require any
additional extensions. The browser connects to the TwinCAT HMI server, which provides the HMI in a virtual
directory (WWW root). The HMI is passed to the client via HTTP(S) protocol. The HMI project consists of
content such as pages and images and the TwinCAT HMI framework, which is based on JavaScript and
dynamizes the web-based HMI. Among other things, the framework provides the controls and establishes a
secure web socket connection (WS(S)) to the server in order to be able to communicate with it.
The TwinCAT HMI server has a modular structure. Additional functionalities can be provided via server
extensions, such as the messaging system or other protocols. The server supports the TwinCAT ADS
protocol and can therefore communicate with all TwinCAT devices. Third-party systems can be connected
via OPC UA extensions.
2.4 Business model
The business model of the TwinCAT HMI is based on that of TwinCAT 3 XAE. All products can be unlocked
via a 7-day trial license, which can be renewed at any time. Only the TwinCAT HMI server is licensed. No
data points are counted. Only the simultaneous client connections (e.g. browser) and the number of active
targets (controllers) are taken into account. The TwinCAT HMI Server includes a client and a target
connection as standard. Additional TF20x0 packages are available for further connections. Further TF2x00
server extensions can also be licensed optionally.
3 Installation
3.1 System requirements
Technical data TE2000 TC3 HMI Engineering
Min. TwinCAT version 3.1.4022.0
Min. TwinCAT level TC1000 TC3 | ADS
Supported Visual Studio versions 2013 Version >= 12.0.40629 with Update 5 (Shell,
Community, Pro)
2015 Version >= 14.0.25431 with Update 3
(Community, Pro)
2017 version >= 15.0 (Community, Pro) with
ASP.NET
Operating system Windows 7/8/10 (32-/64-bit)
.NET Framework version >= 4.7.2
.NET standard version >= 2.0
Technical data TwinCAT HMI Client
Supported browser versions >= Google Chrome 58
>= Mozilla Firefox 53
>= Microsoft Edge 40
Supported mobile browsers >= Google Chrome for Android 58
>= Apple Safari for iOS 9
3.2 Installation
The TwinCAT 3 function for Windows-based operating systems is installed step-by-step.
1. Close all running Visual Studio instances so that the setup can integrate into the installed Visual Studio
environments.
2. Double-click the downloaded file TE2000-HMI-Engineering.
Start the installation under Windows with "Run As Admin" by right-clicking the setup files and selecting
the corresponding option in the context menu.
3. Select the language to guide you through the installation.
4. Click on Next and then accept the end user agreement.
5. Enter your user data.
6. Start the installation and click Install.
7. If not all Visual Studio instances are closed, the setup will pause.
8. Please close all Visual Studio instances and click Retry.
9. Select Finish to exit the setup.
ð The installation is complete and the TE2000 HMI Engineering is integrated into the Visual Studio
environment with its own project templates.
3.3 Licensing
If no TF2000 HMI server license is available on the Engineering system when a TwinCAT HMI project is first
created, a 7-day test license can be generated. The suggested character string must be typed and confirmed
with OK.
The trial license can be renewed at any time after it has expired.
Licensing a full version
1. Start TwinCAT XAE
2. Open an existing TwinCAT 3 project or create a new project
3. In the Solution Explorer, navigate to the entry SYSTEM/License
4. Open the Manage Licenses tab and add a Runtime License for your product (in this screenshot
TF2000: TC3 HMI Server).
5. Optional: If you wish to add the license for a remote device, you must first connect to this device via the
TwinCAT XAE toolbar
6. Open the Order Information tab
The System ID and HW Platform fields cannot be changed. They describe the platform to be licensed.
In general, a TwinCAT 3 license is linked to two parameters:
The System ID identifies your device unambiguously.
The HW Platform is an indicator for the performance of the device.
7. Optionally you can enter your own order number and a comment
8. On the Order Information tab, click the Generate License Request File... button to generate a license
request file that is validated by a Beckhoff license server (if you do not know your Beckhoff License ID,
contact your Beckhoff sales representative).
9. After you have saved the License Request File, the system asks whether the file should be sent to the
Beckhoff license server by email:
10. If you confirm the dialog with Yes, your default email client opens and creates a new email for
tclicense@beckhoff.com containing the license request file.
11. Send this activation request to Beckhoff
The License Response File is sent to the same email address that sent the License Request File.
12. Shortly afterwards, you will receive a license file from the Beckhoff license server.
Import the file via the Activate License Response File... button to activate the product
13. Select the License Response File you received in your folder system
14. The License Response File is imported and all licenses contained in it are activated. All affected demo
licenses are removed
15. Restart TwinCAT to activate the license
The license file is automatically copied to your local hard disk under ...\TwinCAT\3.1\Target\License.