Beckhoff TF3550 User Manual

Manual | EN
TF3550
TwinCAT 3 Analytics Runtime
8/12/2020 | Version: 1.0

Table of contents

Table of contents
1 Foreword ....................................................................................................................................................5
2 Overview.....................................................................................................................................................7
3 Installation..................................................................................................................................................8
3.3 Licensing .........................................................................................................................................11
4 Analytics Workflow - First Steps............................................................................................................14
4.1 Recording data from the machine ...................................................................................................14
4.2 Communication................................................................................................................................17
4.3 Historicize data ................................................................................................................................18
4.4 Analyse data....................................................................................................................................23
4.5 24h Analytics application .................................................................................................................27
5 Technical introduction ............................................................................................................................37
6 Configuration ...........................................................................................................................................39
6.1 Runtime deployment........................................................................................................................39
6.1.1 Algorithm properties......................................................................................................... 44
6.1.2 PLC Code ........................................................................................................................ 45
7 Appendix ..................................................................................................................................................58
7.1 FAQ - frequently asked questions and answers..............................................................................58
TF3550 3Version: 1.0
Table of contents
TF35504 Version: 1.0
Foreword

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 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®, EtherCAT G®, EtherCAT G10®, EtherCAT P®, Safety over EtherCAT®, 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.
EtherCAT® is a 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.
TF3550 5Version: 1.0
Foreword

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 per­sons.
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.
TF35506 Version: 1.0
Overview

2 Overview

The TwinCAT Analytics Runtime ensures that a continuous data analysis runs parallel to the actual machine applications. The PLC code that is downloaded to the Analytics Runtime can be automatically generated with the help of the engineering product TE3500 Analytics Workbench. Based on this code, the user can design their own HTML5 dashboard with the TwinCAT 3 HMI. The HMI Server integrated in the Analytics Runtime then displays the dashboard for different clients like tablet, smart phone or PC.
Components
• PLC Runtime (TC1200)
• Analytics PLC library (TF3510)
• IoT Connectivity
• 4 Control Devices (to analyze 4 different controller at the same time – add more with TF356x)
• Analytics Storage Provider (TF3520)
• HMI Server (TF2000)
• HMI Client Pack 3 (TF2020)

2.1 TF356x TC3 Analytics Controller Pack x

For a 24h monitoring application with the TwinCAT Analytics Runtime it is limited how many control devices can be analyzed at the same time. With TF3550 Analytics Runtime it is already possible to analyze four control devices. If this is not enough you are able to get packages to realize more connections and to have
more devices in your analysis. See also the Technical introduction [}37].
The following packages can optionally be added via a license.
• TF3560 TC3 Analytics Controller Pack 4
• TF3561 TC3 Analytics Controller Pack 8
• TF3562 TC3 Analytics Controller Pack 16
• TF3563 TC3 Analytics Controller Pack 32
• TF3564 TC3 Analytics Controller Pack 64
• TF3565 TC3 Analytics Controller Pack 128
TF3550 7Version: 1.0
Installation

3 Installation

3.1 System requirements

The Analytics Runtime setup is an all-around setup. It includes a current version of TwinCAT 3.1 XAR and of the TwinCAT HMI Server.
Technical data TF3550 TwinCAT 3 Analytics Runtime
Target System Windows 7/8/10

3.2 Installation

The following section describes how to install the TwinCAT3Function for Windows-based operating systems.
ü The TwinCAT3Function setup file was downloaded from the Beckhoff website.
1. Run the setup file as administrator. To do this, select the command Run as administrator in the context menu of the file.
ð The installation dialog opens.
2. Accept the end user licensing agreement and click Next.
TF35508 Version: 1.0
3. Enter your user data.
Installation
4. If you want to install the full version of the TwinCAT3Function, select Complete as installation type. If you want to install the TwinCAT3Function components separately, select Custom.
TF3550 9Version: 1.0
Installation
5. Select Next, then Install to start the installation.
ð A dialog box informs you that the TwinCAT system must be stopped to proceed with the installation.
6. Confirm the dialog with Yes.
TF355010 Version: 1.0
7. Select Finish to exit the setup.
Installation
ð The TwinCAT3Function has been successfully installed and can be licensed (see Licensing [}11]).

3.3 Licensing

The TwinCAT3function can be activated as a full version or as a 7-day test version. Both license types can be activated via the TwinCAT 3 development environment (XAE).
Licensing the full version of a TwinCAT3Function
A description of the procedure to license a full version can be found in the Beckhoff Information System in the documentation "TwinCAT3Licensing".
Licensing the 7-day test version of a TwinCAT3Function
Note: A 7-day test version cannot be enabled for a TwinCAT 3 license dongle.
1. Start the TwinCAT 3 development environment (XAE).
2. Open an existing TwinCAT 3 project or create a new project.
3. If you want to activate the license for a remote device, set the desired target system. To do this, select the target system from the Choose Target System drop-down list in the toolbar.
ð The licensing settings always refer to the selected target system. When the project is activated on
the target system, the corresponding TwinCAT 3 licenses are automatically copied to this system.
TF3550 11Version: 1.0
Installation
4. In the Solution Explorer, double-click License in the SYSTEM subtree.
ð The TwinCAT 3 license manager opens.
5. Open the Manage Licenses tab. In the AddLicense column, check the check box for the license you want to add to your project (e.g."TF6420:TC3DatabaseServer").
6. Open the Order Information (Runtime) tab.
ð In the tabular overview of licenses, the previously selected license is displayed with the status
“missing”.
TF355012 Version: 1.0
Installation
7. Click7-DayTrialLicense... to activate the 7-day trial license.
ð A dialog box opens, prompting you to enter the security code displayed in the dialog.
8. Enter the code exactly as it appears, confirm it and acknowledge the subsequent dialog indicating successful activation.
ð In the tabular overview of licenses, the license status now indicates the expiry date of the license.
9. Restart the TwinCAT system.
ð The 7-day trial version is enabled.
TF3550 13Version: 1.0
Analytics Workflow - First Steps

4 Analytics Workflow - First Steps

This step by step documentation presents the complete TwinCAT Analytics workflow. From the data acquisition over the communication and historizing up to the evaluation and analysis of the data and to the presentation of the data in web-based dashboard.

4.1 Recording data from the machine

On the machine side is the Analytics Logger the recorder of process data from the machine image, PLC, NC and so on. The Logger is working in the real-time context of TwinCAT.
The TwinCAT Analytics Logger is installed with TwinCAT XAE and XAR. The Logger can act as MQTT Client to communicate the recorded data to a native MQTT Message Broker or store the data in the same data format in a local binary file. By the usage as MQTT Client the Logger is able to bypass short disconnects to the Message Broker with a ring buffer functionality. You can configure a ring buffer as well for the local binary file storage.
• To configure the Analytics Logger you have to navigate in your existing TwinCAT Project to the Analytics tree node
TF355014 Version: 1.0
Analytics Workflow - First Steps
• Right click on this node and click on “Add Data Logger” to add one new instance to your configuration
• For configuring the base settings, please double click on the new tree item
You can make your specific Analytics Logger settings
-Data Format: Binary file or MQTT stream
-FILE format: Analytics Logger stores the data in local binary files and all other settings are not necessary anymore. The files will be stored in C:\TwinCAT\3.1\Boot\Analytics.
-BINARY: Data will be sent to the configured MQTT Message Broker. You can have multiple Logger in one TwinCAT project to communicate data to different MQTT Message Broker.
-Data Compression: on (default) or off
TF3550 15Version: 1.0
Analytics Workflow - First Steps
-Max Compression: mode of the compression
-MQTT host name
-MQTT Tcp port
-MQTT main topic for own hierarchical levels to keep the identification easy
-MQTT Client ID should be unique in the network
-MQTT username
-MQTT password to make authentication at the message broker
-At the TLS (Transport Layer Security) tab, security settings can be configured. TLS is a secure communication channel between client and server. By the usage of certificates, the TCP port 8883 is exclusively reserved for MQTT over TLS. Analytics Logger is supporting the modes CA Certificates, CA Certificates & Client Certificate and Preshared Key (PSK) mode.
• If variables in your PLC application are marked in the declaration with the attribute {attribute 'TcAnalytics'} they will be shown automatically as a stream below the Data Logger tree node.
An additional device stream will be shown if your configuration provides an EtherCAT Process Image.
TF355016 Version: 1.0
Analytics Workflow - First Steps
• In the stream a Selection tab is available to choose the variables that should be recorded
• Finally it is possible to change the package size for the frames or to configure the ring buffer for disconnects and file in the Data Handling tab.

4.2 Communication

Currently, the Analytics workflow is fully mappable via MQTT. The engineering tools can also access the data of the machines via ADS and carry out analyzes.
TF3550 17Version: 1.0
Analytics Workflow - First Steps
If you choose for the IoT communication protocol MQTT you have to setup a native MQTT Message Broker somewhere in the network (VM in a cloud system is also possible). This Message Broker provides a decoupling of the different applications in the Analytics Workflow.

4.3 Historicize data

After installation of the TwinCAT Analytics Storage Provider you are able to configure the service running in the background. You will find therefore the TcAnalyticsStorageProvider_Config application in the folder C: \TwinCAT\Functions\TF3520-Analytics-StorageProvider\WinService.
TF355018 Version: 1.0
Loading...
+ 42 hidden pages