Manual | EN
TF1800
TwinCAT 3 | PLC HMI
2020-11-17 | Version: 1.3
Table of contents
Table of contents
1 Foreword ....................................................................................................................................................5
1.1 Notes on the documentation..............................................................................................................5
1.2 Safety instructions .............................................................................................................................6
2 PLC HMI......................................................................................................................................................7
TF1800 3Version: 1.3
Table of contents
TF18004 Version: 1.3
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.
TF1800 5Version: 1.3
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 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.
TF18006 Version: 1.3
PLC HMI
2 PLC HMI
The PLCHMI is an extension of the runtime system and enables the visualization to be executed on the
control computer or a third computer without a development environment. The visualization code is created
based on the existing visualization objects and downloaded to the control computer. Avoiding the use of the
development environment results in significant memory savings. This can be useful for small computers.
The following topics are described below:
• Commissioning the PLC HMI [}7]
• Remote operation of a PLCHMIClient [}9]
• Editor of the TargetVisualization object [}10]
Commissioning the PLC HMI
Step 1: Enable the PLCHMI
The object "TargetVisualization" ( ) enables the PLCHMI. It can be added to the "VisualizationManager"
object in the PLC project tree via the context menu command Add>TargetVisualization (see also PLC
documentation: Creating a visualization>Visualization object).
With the TargetVisualization object a visualization task "VISU_TASK" is created in the Solution and a
reference to this task in the PLC project. The reference is used to call the visualization code. Therefore, you
have to reactivate the configuration after adding the object.
Deleting a TargetVisualization object
If you delete a TargetVisualization object and have not added an additional WebVisualization object, you have to delete the task "VISU_TASK" under System>Tasks in the TwinCAT project tree.
This task is not required in the integrated visualization. (See also Editor of the WebVisualization object and Integrated visualization)
Step 2: Configure the PLCHMIClient
Step 2 is necessary only if you are using a build older than 4022.0 or if you wish to start a
PLCHMIClient with a remote connection to the runtime device. From build 4022.0 or higher, the .ini
file is automatically generated and updated in the folder C:\TwinCAT\3.1\Boot\Plc.
In order to establish the connection between the client and the device on which the corresponding
visualization code is executed, you must adapt the Tc3PlcHmi.ini file.
The ini. file is located in the folder C:\TwinCAT\3.1\Components\Plc\Tc3PlcHmi for builds older than 4022.0
and in the folder C:\TwinCAT\3.1\Boot\Plc for build 4022.0 and newer.
Example of a .ini file:
TF1800 7Version: 1.3
PLC HMI
AmsNetID AmsNetID of the device, on which the visualization code is executed.
Preset: 127.0.0.1.1.1
AmsPort AmsPort of PLC project, to which the visualization belongs.
Preset: 851
StartVisualization Name of the visualization object to be opened as start page.
Preset: Visualization
CommBufferSize Memory size in bytes that the visualization allocates for this PLCHMIClient and
uses for the communication.
Preset: 50000
PaintBufferSize Memory size in bytes that the visualization allocates for this PLCHMIClient and
uses for the drawing actions.
Preset: 50000
UpdateRate(ms) Update rate in milliseconds, at which the client data are queried again.
Preset: 200
HideCursor Setting through which the cursor can be hidden.
Preset: false
KeyboardActivate Setting through which input via a hardware keyboard is enabled. A software
keyboard is used automatically if this setting is inactive.
Preset: false
TouchActivate Setting through which touch-based input is enabled.
Preset: true
Step 3: Set PLCHMI to be the startup application
Step 3 is necessary only if you are using a build older than 4024.0 or if you wish to start a
PLCHMIClient with a remote connection to the runtime device. From build 4024 or higher, the PLC
HMI client is automatically started locally on the runtime device.
If PLCHMI is to start automatically when the computer is booted up, there must be a link to the
Tc3PlcHmi.exe application in the StartUp folder.
Execute the following steps to do this:
1. Open the directory C:\TwinCAT\3.1\Target\StartUp.
2. Add a new link via the context menu command New.
TF18008 Version: 1.3
3. Enter C:\TwinCAT\3.1\Components\Plc\Tc3PlcHmi\Tc3PlcHmi.exe as storage location.
4. Confirm this dialog and the following dialog.
Execute the following steps for Beckhoff CE devices:
1. Start the Beckhoff Startup Manager under Start>StartMan.
2. Add a new item via the New button.
3. Give the item the name "Tc3PlcHmi" and select the type "ShellCommand".
4. Confirm the dialog.
5. Under the Startup Options, select "Autostart" and enter a time next to Delay in order to open the
client only when the PLC project has already been started.
6. Switch to the Shell Command tab.
7. In the field Enter Shell command, enter "\HardDisk\TwinCAT\3.1\Components\Plc\Tc3PlcHmi
\X.exe". Replace the "X" with the name of the Client Exe that is stored under the specified path. This
may differ between ARM and ATOM devices, for example.
8. Confirm the dialog.
Step 4: Start the PLCHMIClient
Step 4 is necessary only if you are using a build older than 4024.0 or if you wish to start a
PLCHMIClient with a remote connection to the runtime device. From build 4024 or higher, the PLC
HMI client is automatically started locally on the runtime device.
PLC HMI
A PLCHMIClient is started with the aid of the Tc3PlcHmi.exe application. This is located in the directory C:
\TwinCAT\3.1\Components\Plc\Tc3PlcHmi, but can also be linked to any desired location. If you create a link
in the directory C:\TwinCAT\3.1\Target\StartMenuAdmin\Tools you can start the application via the
TwinCATicon in the context menu under Tools.
If the development PC is connected, the visualization can also be displayed in the development environment.
However, it is not equivalent to an integrated visualization, but is also based on a PLCHMIClient.
For Beckhoff CE devices you have to activate a setting in the visualization manager before starting the client;
this setting enables all image files in the svg format to be automatically converted to the bmp format. This
step is required, because under CE only image files in bmp format are supported in the PLCHMIClient.
Both image file formats are nevertheless loaded on the target system, since a PLCHMIWebClient
continues to use the svg format. The PLCHMIClient for CE can be found in directory \HardDisk\TwinCAT
\3.1\Components\Plc\Tc3PlcHmi .
See also:
• PLCdocumentation:Creating a visualization>Visualization Manager>Settings
• PLCdocumentation:Creating a visualization>Visualization variants>Integrated Visualization
• Documentation for TC3 PLC HMI Web
Remote operation of a PLCHMIClient
A PLCHMIClient can also be operated remotely on a third computer, which is neither the development
computer nor the control computer. To do this, the following requirements must be met:
• A TwinCAT 3 Build 4018.0 ADS or later is installed on the system.
• ADS communication is established with the control computer on which the visualization code is
executed (TwinCATIcon>Router>Edit Routes>Add…).
TF1800 9Version: 1.3
PLC HMI
• The Tc3PlcHmi folder has been copied from the development or control computer to the third system.
The path for the folder must be added manually.
• The Tc3PlcHmi.ini file was adjusted on the system, on which the client is to run.
Editor of the TargetVisualization object
The "TargetVisualization" object ( ), which you can add in the PLC project tree below the
"VisualizationManager" object, enables the PLCHMI and contains its settings. Double-click on the object in
order to edit the settings in an editor window.
The settings in the object "TargetVisualization" are adopted automatically into the .ini file from build
4022.0 onwards. If you wish to use an older build or start a PLCHMIClient with a remote connection to the runtime device, you have to make the changes to the settings in the .ini file manually.
Start visualization Name of the visualization object that is to be opened as the first page
when starting the PLCHMI. A visualization object is already entered here
by default. The input assistant can be used to select a different
visualization object. If the PLC project contains only one visualization
object, this is automatically used as start visualization.
Update rate (ms) The update rate in milliseconds, with which the data in the PLCHMI is
updated.
Show used Visualizations Button for opening the standard dialog of the Visualization Manager: Here
you can select the visualizations that are to be used for the PLCHMI. (See
also PLCdocumentation:Creating a visualization>Visualization
Manager>Visualizations)
Scaling options
TF180010 Version: 1.3
PLC HMI
Fixed The size of the visualization is retained, irrespective of the screen size.
Isotropic The size of the visualization depends on the size of the screen. The
visualization retains its proportions.
Anisotropic The size of the visualization depends on the size of the screen. The
visualization does not retain its proportions.
Using scaling options for dialogs The dialogs, also keypad and numpad, are scaled with the same scaling
factor as the visualization. This is advantageous if a dialog was created to
match the visualization.
Use automatically determined
client size
Use specified client size The PLCHMI fills the screen area determined by the following dimensions.
Presentation options
Characters with antialiasing Activate this option, if antialiasing is to be used when the visualizations are
Standard text input
The PLCHMI fills the client screen.
• Client height: height in pixels
• Client width: width in pixels
drawn in the visualization editor window of the programming system.
(Offline or online)
This setting is only then active if the input type “Standard” is selected in the input configuration of the
visualization element. In this case, the default text entries defined in the Visualization Manager are used.
Touchscreen Select this option if the target device is operated with a touch screen by
default.
Keyboard Select this option if the target device is operated with a keyboard by
default.
Advanced Settings
Hide mouse pointer Setting through which the cursor can be hidden.
Size of the command buffer Memory size in bytes that the visualization allocates for this
PLCHMIClient and uses for the communication.
Start client on startup The PLC HMI client is automatically started locally on the runtime system.
TF1800 11Version: 1.3
More Information:
www.beckhoff.com/tf1800
Beckhoff Automation GmbH & Co. KG
Hülshorstweg 20
33415 Verl
Germany
Phone: +49 5246 9630
info@beckhoff.com
www.beckhoff.com
Loading...