ABB PB610-manual PDF

—
M A N UA L
PB610 Panel Builder 600

Programming Software for
CP600 Control Panels
Contents
1 Getting started 1 Managing overlapping widgets 58
Assumptions 2 Grouping widgets 59
What´s new 2 Changing multiple widgets properties 66
Installing the application 4 Changing fill color property according to tag

values 67
2 Runtime 7
6 Project properties 69
HMI device basic settings 8
Runtime 70
Context menu options 8
Plug-in 75
Built-in SNTP service 11
Project 76
3 Runtime on PC 13
Web 80
Typical installation problems 15
Events 81
4 My first project 19
7 The HMI simulator 83
The workspace 20
Data simulation methods 84
Creating a project 20
Simulator settings 84
Communication protocols 22
Launching and stopping the simulator 85
Designing a page 23
8 Transferring the project to HMI device 87
The Widget Gallery 25
Download to HMI device 88
Data field widget 27
Update package 91
Adding tags 30
The Runtime loader 93
Attaching widget to tags 32
Upload projects 94
Dialog pages 34
9 System Variables (Attach To) 95
Exporting tags 35
Alarms variables 97
Importing tags 35
Buzzer variables 97
Tag find and rename 38
Communication variables 98
Tag find and replace 40
Daylight Saving Time variables 98
5 Programming concepts 43
Device variables 99
Data types 44
Dump information variables 101
"Attach to" parameters 44
FTP client variables 101
Formula 50
Keypad variables 102
Events 54
Network variables 102
Widgets positioning 57
Copyright © 2011-2019 ABB. All rights reserved. Documentation Revision 2.08 - Date of issue: 2019-02-27 I
Printing variables 103 Widget actions 180
Remote Client variables 104 12 The HMI Client 183
Version variables 105 Client application on PC 184
Screen variables 105 Client application on HMI 185
SD card variables 105 Settings and time zone options 186
Server variables 105 13 Using the integrated FTP server 191
Time variables 106 FTP settings 191
Touch screen variables 106 14 Using VNC for remote access 193
USB drive variables 107 Starting VNC server on WinCE devices 194
User management variables 108 Starting VNC server on Linux devices 195
10 System Variables (Protocol) 109 Starting VNC viewer 195
Protocol Editor Settings 110 15 Alarms 197
Tag Import 110 Alarms Editor 198
Default variables 112 Remote alarms acknowledge 200
Retentive Memory variables 126 Alarm state machine 201
Services variables 132 Setting events 202
11 Actions 135 Active Alarms widget 204
Alarm actions 136 Alarms History widget 209
Database actions 137 Managing alarms at runtime 209
Event actions 140 Enable/disable alarms at runtime 210
MultiLanguage actions 140 Displaying live alarm data 210
Keyboard actions 141 Exporting alarm buffers to .csv files 211
Media Player actions 143 Exporting alarm configuration 211
FTP actions 143 16 Recipes 215
Page actions 146 Managing recipes 215
Print actions 153 Configuring a recipe widget 218
Recipe actions 154 Recipe status 219
Remote Client actions 158 Uploading/downloading a recipe 220
System actions 159 Backup and restore recipes data 221
Tag actions 170 17 Trends 223
Trend actions 173 Data logging 224
Text Editor actions 177 Exporting trend buffer data 226
User management actions 177 Trend widgets 227
II Copyright © 2011-2019 ABB. All rights reserved. Documentation Revision 2.08 - Date of issue: 2019-02-27
History trends 229 23 User management and passwords 281
Trend widget properties 231 Enable/disable security management 282
Trend widget gestures 232 Configuring groups and authorizations 282
Values outside range or invalid 233 Modifying access permissions 283
Showing trend values 234 Assigning widget permissions from page

view 288
Scatter diagram widget 235
Configuring users 289
Table trend widget 236
Default user 290
18 Data transfer 241
Managing users at runtime 290
Data transfer editor 242
Force remote login 291
Exporting data to .csv files 244
24 Audit trails 293
Data transfer limitations and suggestions 244
Enable/disable audit trail 294
19 Offline node management 247
Electronic Signature 295
Offline node management process 248
Table audit widget 298
Manual offline node management process 248
Exporting audit trail as .csv files 299
Manual offline configuration 248
Configure audit events 300
Automatic offline node detection 249
25 Reports 303
20 Multi-language 251
Adding a report 304
The Multi-language editor 253
Configuring text reports 304
Changing language 254
Configuring graphic reports 305
Multi-language widgets 254
Print triggering events 306
Exporting/importing multi-language strings 256
Default printer 307
Changing language at runtime 258
26 Screen saver 311
Limitations in Unicode support 258
27 Backup/restore of Runtime and project 313
21 Scheduler 261
28 Keypads 315
Creating a schedule 262
Creating and using custom keypads 317
HighResolution schedule 262
Deleting or renaming custom keypads 319
Recurring schedule 262
Keypad type 319
Configuring location for schedules 264
Keypad position 320
Configuring the Scheduler widget 265
29 External keyboards 321
Scheduling events at runtime 266
Search and filter 323
22 21 CFR Part 11 Compliance 269
Displayed keys 323
x.509 Certificate 274
Removing action associations 323
21 CFR Part 11 - Tips 278
Copyright © 2011-2019 ABB. All rights reserved. Documentation Revision 2.08 - Date of issue: 2019-02-27 III
Keyboard layout 324 Gesture area widget 374
Enable/disable keyboard 324 IP Camera widgets 379
Associating actions to keys 324 JavaScript function block widget 382
30 Tag cross reference 327 Media Player widgets 384
Updating data in the Tag Cross Reference Multistate Image widget 386
pane 331
Multistate Image Multilayer widget 387
31 Indexed addressing 333
Network Adapters widget 389
Creating an indexed addressing set 334
RSS Feed widget 389
Using indexed tag set in pages 337
Scrolling RSS Feed widget 390
32 Storing data to external databases 339
Table widget 391
Installing SQL4Automation 341
TextEditor widget 404
Configuring SQL4Automation 341
Variables widget 406
Configuring the HMI project 343
35 Custom widgets 409
Transfer data with JavaScript 344
Creating a custom widget 410
Database tables 345
Adding properties to a custom widget 412
Custom tables 346
Using structured tags 415
Connection Limits 346
JavaScript in custom widgets 417
33 OPC UA Server 349
User's Gallery 420
Features 349
36 Sending an email message 423
Network 349
Configuring the email server 424
Authentication 349
Configure emails 424
Using x.509 Certificates 350
37 JavaScript 427
Using self-signed certificates 353
JavaScript editor 429
Using external certificates 357
Execution of JavaScript functions 429
Alarm map 358
Events 431
34 Special widgets 359
Widget events 432
BACnet widget 360
Page events 434
Browser widget 360
System events 435
Canvas Widget 361
Objects 437
Combo Box widget 364
Widget class objects 437
Consumption Meter widget 368
Widget properties 438
Control list widgets 369
Widget methods 441
DateTime widget 373
Page object 442
IV Copyright © 2011-2019 ABB. All rights reserved. Documentation Revision 2.08 - Date of issue: 2019-02-27
Page object properties 442 Static Optimization 490
Page object methods 443 FAQ on Static Optimization 493
Group object 445 Page caching 494
Group object methods 445 Image DB 494
Project object 447 Precaching 494
Project object properties 447 FAQ on precaching 494
Project object methods 447 42 Functional specifications and

compatibility 497
Project object widgets 456
Table of functions and limits 498
Print reports object 457
HMI devices capabilities 499
State object 460
Compatibility 500
State object methods 460
Converting projects between different HMI
Keywords 461
devices 500
Global functions 462
43 System Settings 503
Handling read/write files 462
Linux Devices 504
Sign in from JavaScript 465
WinCE Devices 524
Limitations in working with widgets in
44 Updating system components in HMI
JavaScript 467
devices 535
Debugging of JavaScript 468
Update of system components from the
38 Handling Gestures 471 application 536
39 Web access 473 Settings 537
Supported platforms and browsers 474 45 Communication protocols 539
Generating page for Web access 474 ABB CODESYS Ethernet 540
Platform specific Home pages 476 ABB CODESYS Serial 550
Testing the Web project 476 ABB IRC5 556
Downloading the Web project 477 ABB IRC5 Linux 561
Web connectivity issues 478 ABB Mint Controller HCP 571
Web supported features 479 ABB Modbus RTU 580
Troubleshooting and FAQ 483 ABB Modbus TCP 587
Privacy 483 ABB Pluto 593
40 Protecting access to HMI devices 485 BACnet 599
Changing password on HMI device 486 CODESYS V2 ETH 629
Ports and firewalls 486 CODESYS V3 ETH 643
41 Tips and tricks to improve performance 489 Ethernet/IP CIP 656
Copyright © 2011-2019 ABB. All rights reserved. Documentation Revision 2.08 - Date of issue: 2019-02-27 V
Modbus RTU 682
Modbus RTU Server 698
Modbus TCP 713
Modbus TCP Server 730
OPC UA Client 742
Simatic S7 ETH 755
System Variables 795
Variables 797
VI Copyright © 2011-2019 ABB. All rights reserved. Documentation Revision 2.08 - Date of issue: 2019-02-27
1 Getting started
PB610 Panel Builder 600 is a software application designed to create graphical HMI pages. PB610 Panel Builder 600 has a
drag-and-drop interface that makes it easy to create complex pages. Many of the features found in common Windows
applications are also available in PB610 Panel Builder 600.
This document is divided into chapters that describe the key functions of PB610 Panel Builder 600 and explain how to use
them. Each chapter is presented in a standalone manner, allowing you to jump from chapter to chapter, depending on the
task at hand.
Assumptions 2
What´s new 2
Installing the application 4
Copyright © 2011-2019 ABB. All rights reserved. Documentation Revision 2.08 - Date of issue: 2019-02-27 1
Assumptions
Assumptions
We assume that readers have a basic understanding of computers, Microsoft Windows, and the specific network
environment where the application will run.
What´s new
What´s new on v2.8
l Custom widgets and inheritance of widget properties
l Enhanced PB4Web function coverage including user management, custom widgets, canvas widget. Improved
responsive design based on grid layout.
l Support for application compliance with 21 CFR part 11 including electronic signatures and security with certificates
l Calculation of expressions with tag values
l New alarm and trend widgets based on table widget
l Audit trail widget
l Enhanced support for multitouch and gestures
l Tag find with rename and replace functions
l Remove unused tags from project
l Source timestamps in tag data acquisition for OPC UA sources
l Video player for Linux-based HMI devices
l Trend dump when full
l Direct Serial protocol for creating custom communication protocols
l Direct Socket protocol for creating custom communication protocols
l Extended project limits for high-end HMI devices
l Runtime performance enhancement with faster boot time
l Remote HMI Client software for Linux-based HMI devices
l Complete BACnet support with BACnet alarms and trends
2 Copyright © 2011-2019 ABB. All rights reserved. Documentation Revision 2.08 - Date of issue: 2019-02-27
1 Getting started
What´s new on v2.6

l Grid layout
l Table widget
l Canvas widget
l JavaScript Function Block Widget
l Structured tags support for custom widgets
l "Show all" option for Alarm History widget (Enhanced the Alarm History widget to be able to show all alarms)
l "Attach to ..." support for properties in e-mail server configuration
l Support for writing to network devices for CP600-eCo (BSP 1.0.25 or greater is required)
l Backup/Restore for CP600-eCo
l PB4Web support for trends
l PB4Web support for recipes
l BACnet protocol support for Calendar/Scheduler
l Revision of target limits
l Extend OPC-UA server to support Alarms and Trends
l FTP Client
l Enhanced Combo Box to work in full screen with pictures support
l Added support for manually edit and change data links
l Enhanced the Data Transfer to support alias (indexed tags)
l When required, the “Download to target” invoke the “update runtime” while downloading project.
l New System Variable to check the status of dumped files
Installing the application
What´s new on v2.4

l Unify PB600 Basic and Standard version with limits HMIs based on license (Basic/Standard)
l Project Limits check when converting a project (not just on download as before)
l Disable unavailable protocols based on device selected
l Disable SD card selection in devices where it is not available
l IP Widget for setting networks parameters.
l Introduced "WebPageRequest" to control page shown from a PLC
l New project property to set the runtime background color
l OPC-UA Server support
l SQL4Automation support
l JS support on PB4Web
l Multilanguage support on PB4Web
l Alarm state strings can be customized and translated
l PDF viewer support for CP600-eCo products
l Support for embedded custom JS in Widget gallery
l Gestures support
l Introduce push engine for data sent/received. Now PB4Web can refresh data and widget up to 10 times a second
l Redesign of Manage Target to update multiple HMI device
l New option to enable alarms from PLCs
l New option to execute a user macro action on alarm
l Possibility to group and filter alarms
What´s new in comparison to v2.0.0

l Support of Windows 10 32-/64-bit
l User´s gallery for customized widgets
l Maximum number of tags for PB610 PC Runtime: 10000
l German online-help / manual

PB610 Panel Builder 600 installation contains:
l PB610 Panel Builder 600: an application for designing custom HMI projects in a user-friendly manner, along with a
variety of objects in its built-in library, the Widget Gallery.
l HMI Client: a light-weight application that can be used on Windows computers to remotely view and manage a
project running on an HMI device.
l HMI Runtime: a standalone application that runs on the HMI devices. The HMI Runtime is installed via PB610
Panel Builder 600.
l PB610 PC Runtime: a standalone application that runs on Win32/Win64 platforms (computers instead of HMI
devices).
1 Getting started
PB610 Panel Builder 600 system requirements

PB610 Panel Builder 600 has the following system requirements:
Operating System Windows Embedded Standard (WES 2009)

Windows Server 2003
Windows Vista Business/Ultimate
Windows 7 Professional
Windows Embedded Standard 7
Windows 8
Windows 10
Storage 500 MB Minimum
RAM 512 MB
Other One Ethernet connection
Installing multiple versions of PB610 Panel Builder 600

You may install different instances of PB610 Panel Builder 600 on the same computer. Each installation has its own
settings and can be uninstalled individually.
Three installation scenarios are possible:
Installation scenario Results
First installation of PB610 Panel Builder 600 in the system Software is installed in the specified
destination folder
System with only one instance of PB610 Panel Builder 600 Current version can be replaced or
already installed maintained.
System with multiple instances of PB610 Panel Builder 600 Last version installed can be replaced or
already installed maintained.
If you try to install a second instance of an already installed version of PB610 Panel Builder 600, a warning message is
displayed.
Multiple PB610 Panel Builder 600 installations share a common workspace folder, each sub-folder includes the version
number, for example C:\Program Files\ABB\Panel Builder 600 Suite 2.5. Each installed version has its ID and can
therefore be removed individually.
Each installation is listed separately in the Windows Start menu.
Opening older projects

When opening a PB610 Panel Builder 600 project (.jpr file) created with an older version of the software PB610 Panel
Builder 600 asks to convert the project to the current version:
Option Description
Convert and overwrite current project The project is converted without a backup copy of the original
version
Select a new location before converting the The project is copied inside the specified folder and then
project converted.
WARNING: Do not edit projects with a version of PB610 Panel Builder 600 older than the version used
to create them. This will damage the project and may cause runtime instability.
Multilanguage for PB610 Panel Builder 600

PB610 Panel Builder 600 is available in multiple languages. All languages are installed by default as part of PB610 Panel
Builder 600.
The default language is English. To change it go to Help > Change Language.
Crash reports
A crash report dialog appears whenever PB610 Panel Builder 600 freezes or crashs.
Important: Always save crash report files since they may contain useful information for technical
support.
Note: Crash reports are unavailable in Windows XP.
2 Runtime
HMI Runtime is designed to support different platforms and different operating systems.
HMI device basic settings 8
Context menu options 8
Built-in SNTP service 11
HMI device basic settings
HMI device basic settings

HMI devices are delivered from factory without Runtime. If no Runtime is installed on the device, see "The Runtime loader"
on page 93 for details.
Runtime modes
The HMI Runtime is composed of two logic units:
l Server: runs communication protocols, collects data, monitors alarms, drives trend buffer sampling.
l Client: displays data collected by server.
The server unit is responsible for handling the HMI services such as the communication protocols, performing data
acquisition, driving trend buffer sampling activities, monitoring alarms, and so on.
The client unit is the part which is responsible for the visualization process: use the data collected by the server to render it
on the display as graphical information.
The server unit works in two operating modes:
l Configuration mode: server is idle (for example when no project is loaded on the device or some system files are
missing).
l Operation mode: server is operating according to the settings defined by the system files and by the loaded
application project.
Note: Data on client may be displayed even if no activity is running on the server.
Context menu options

On the HMI device press and hold on an empty area of the screen for a few seconds to display the context menu.
Zoom In/Out
Select view size at runtime
Pan Mode
Enables/disables pan mode after a zoom in
2 Runtime
Settings
Main parameters Description
Context Menu Delay Context menu activation delay. Range: 1–60 seconds.
(s)
Show Busy Cursor Display an hourglass when the system is busy
Use keypads Display keypads when user touches a data entry field.
Set to disable when an external USB keyboard is connected to the device.
Keep retentive data Preserve the content of the retentive data at project download or update.
on project update
Fit to screen size Adapts the view to the screen size
Password Define password protected operations amongst the following:
l Download Project/Runtime
l Upload project
l Board management (BSP Update)
See "Protecting access to HMI devices" on page 485 for details.
Context menu options
Project Manager
This tool allows you to:
l unload the current project

l load another project
l delete a project.
When you load a new project, the current project is automatically unloaded. You must unload a project before you can
delete it.
Update
This function loads update packages from an external USB drive. See "Update package" on page 91for details.
Backup
You can create a backup copy of the Runtime and of the project.
Logging
This function displays a log of system operations.
Click Log to file to save data: a logger.txt file is saved to the ...\var\log folder.
This file can be retrieved using an FTP Client and forwarded to technical support.
Note: Once enabled, logging is maintained after power cycles and must be manually disabled.
2 Runtime
Show log at boot

This function enables the logger at start up. If the Log to file option has been enabled, log files are saved from startup.
Logout
Logs off the current user.
Show system settings

Allow the HMI settings and the management of system components. See "System Settings" on page 503 for details.
Developer tools
Utility functions for debugging at runtime. It is visible only if enabled in the Project Properties (see "Developer tools" on
page 72 for details)
About
This function shows information about the Runtime version.
WARNING: Context Menu action has no effect if executed from a dialog page.
Built-in SNTP service

The HMI device features an integrated SNTP that synchronizes the internal real-time clock panel whenever the predefined
server is available. The system searches the SNTP server when turned on, or once a week if the HMI device is not turned
off.
Use HMI device "System Settings" on page 503to configure the service.
Availability: BSP v1.76 ARM / 2.79 MIPS or higher
Built-in SNTP service
3 Runtime on PC
PB610 PC Runtime for Windows is an HMI platform that combines advanced HMI features and vector graphics with
powerful web technologies. You can choose this platform to monitor and control your equipment with tags, alarms,
schedulers, recipes, trends, JavaScript logic and events.
PB610 PC Runtime provides connectivity with factory and building automation protocols, based on Ethernet and serial
interfaces.
PB610 PC Runtime system requirements

PB610 PC Runtime as the following minimum system requirements:
Operating System Windows Embedded Standard (WES 2009)

Windows Server 2003
Windows Vista Business/Ultimate
Windows 7 Professional
Windows Embedded Standard 7
Windows 8
Windows 10
Storage 256 MB Min
RAM 512 MB
CPU min. 300 MHz Pentium III or similar processors with 500 MHz.
Graphic min. SVGA
Other One Ethernet connection
Multiple instances of PB610 PC Runtime

PB610 PC Runtime can run in multiple instances. Copy the installation folder to a writable location and double-click on the
HMI application in each folder to start it.
The port used by PB610 PC Runtime can be changed from the Settings dialog. Restart the application to apply the port
change.
Limitations
The following features are not supported in PB610 PC Runtime:
Function Feature NOT supported
Manage Target Board section
System Mode/ User Mode Tap sequence and rotating menu
VNC/PDF readers Non-standard computer software
Backup/Restore Backup and restore functions. Standard computer software can be used for the purpose.
Protocols Serial protocols requiring special hardware.
See "Functional specifications and compatibility" on page 497 for more details.
Fullscreen mode
PB610 PC Runtime can start in fullscreen mode or in a window.
To switch to full screen:
1. Right click in the PB610 PC Runtime main window to display the context menu.
2. Choose Full Screen.
The workspace folder

When using PB610 PC Runtime, project files are stored in a workspace folder in:
%appdata%\ABB\[build number]\server\workspace
where [build number] is a folder named as build number (for example, 01.90.00.608).
3 Runtime on PC
Typical installation problems

Important: Make sure that ports 80/HTTP and 21/FTP are not blocked by the firewall.
If a port is in use and a conflict is detected a dialog is displayed to allow the user to change the default ports.
See "Protecting access to HMI devices" on page 485 for details.
In some conditions PB610 PC Runtime cannot detect all services running in ports like 80/HTTP and 21/FTP, this forces
PB610 PC Runtime to be closed automatically. This happens, for example, when IIS or MS SQL Server or other windows
services are running on these ports. In these cases, disable window services
If the project download to PB610 PC Runtime fails, try one of the following procedures.
Issues with port numbers

PB610 PC Runtime uses ports 80 and 21 by default. If at least one is occupied a warning message is displayed:
Make sure that when you change this port you also change the port used for download to HMI device in PB610 Panel
Builder 600.
1. From the Download to Target dialog select Advanced.
2. Modify the port number to match that set on PB610 PC Runtime.
3. Click OK to confirm: you can now download you project to the PB610 PC Runtime.
Restoring port information

If information about changes made on PB610 PC Runtime listening ports has been lost, the following error message is
returned:
Impossible to establish communication with Runtime. Please check connection settings and verify the Runtime is properly
running on HMI device.
The port used by PB610 PC Runtime can be changed from the Settings dialog. Restart the application to apply the port
change.
3 Runtime on PC
Bypassing firewall or antivirus blocks

If PB610 Panel Builder 600 is running on the same machine as the PB610 PC Runtime, your firewall or antivirus may block
the connection from PB610 Panel Builder 600 to PB610 PC Runtime.
1. From the Download to Target dialog manually type-in the localhost IP address 127.0.0.1.
2. Click Download.
4 My first project
This section describes how to create a simple PB610 Panel Builder 600 project.
The workspace 20
Creating a project 20
Communication protocols 22
Designing a page 23
The Widget Gallery 25
Data field widget 27
Adding tags 30
Attaching widget to tags 32
Dialog pages 34
Exporting tags 35
Importing tags 35
Tag find and rename 38
Tag find and replace 40
The workspace
The workspace
Workspace areas
PB610 Panel Builder 600 workspace is divided into the following main areas:
Area Description
Project View Project elements in hierarchical project tree.
Object View Tree view of widgets organized by page.
Working Area Space where pages are edited. Tabs at the top of the area show all open pages.
Properties Properties of selected object.
Widget Gallery Library of graphic objects and symbols.
Tag cross reference List of locations where a given tag is referenced.
Note: The workspace layout can be changed at any time, changes are saved and maintained through working
sessions.
Resetting the workspace layout

To restore the default layout, use the File > Reset and Restart function.
Creating a project
Path: File> New Project
4 My first project
1. In the Project Wizard dialog enter a name for the project and the storage location.
2. Click Next: the HMI device selection dialog is displayed.
3. Choose one device from the list of the available models.
4. Choose device orientation.
5. Click Finish to complete the Wizard.
Portrait rotation exceptions

The following elements are not rotated in portrait mode.
Element Description
Operating system dialogs System settings and system dialog
ContextMenu and related dialogs Project Manager, About, Settings, Logging, Backup
Video IPCamera, MediaPlayer
JavaScript Alert and Print function
Dialog pages “Title” of dialog pages
Scheduler Dialogs for data entry
Macro ShowMessage, LunchApplication, LunchBrowser
External applications PDF Reader, VNC
HMI devices based on Linux platform can be rotated from the BSP (see "Displays" tab from the "System
Settings" on page 503"Linux Devices" on page 504page) without these limitations.
Changing the device model

Once you have developed your project you can still change the device model, from the Project Properties pane. This will
not resize the widgets, but will relocate them on the screen. A warning will be displayed if some objects cannot be
relocated.
Communication protocols
Copying, moving, renaming a project

PB610 Panel Builder 600 projects folder contain all the files of the project: to move, copy or backup a project, move or copy
the project folder to the desired location.
To rename a project use the File > Save Project As function: this operation might take a few minutes.
WARNING: Do not rename the project folders manually.
Communication protocols
Path: ProjectView> Config > Protocols
Device communication drivers are configured in the Protocol Editor.You can add up to the maximum number of protocols
as specified in Table of functions and limits. Variable and System Variables are not counted as protocols.
See "Communication protocols" on page 539 for more details.
Note: you can run different Ethernet protocols over the same physical Ethernet port, but you cannot run different
serial protocols using the same serial port. Some serial protocols support access to multiple controllers, but this
option is set within the protocol itself which is still counted as one protocol.
Adding a protocol
Note: Refer to CP600 operating instructions manual in case you need cables information.
4 My first project
1. Click +.
2. Select the protocol from the PLC list and enter the required values.
Changing protocol settings

To change configuration parameters, click the browse button in the Configuration column.
Protocol parameters
Click Show Advanced Properties icon to see all parameters.
Parameter Description
Dictionaries Tags imported for the protocol.
See "Importing tags" on page 35 for details.
Enable Offline AlgorithmOffline Retry See "Automatic offline node detection" on page 249 for details.
Timeout
Version Protocol version available in PB610 Panel Builder 600 for selected HMI
device.
Designing a page
Path: ProjectView > Pages
Designing a page
When a project is created, the first page is automatically added and shown in the Page Editor.
Adding objects to a page

Drag and drop objects from Widget Gallery to the page.
Adding a page
1. Right click the Pages node from the project tree and select Insert new page.
2. Type a name for the new page.
Importing a page
When importing a page PB610 Panel Builder 600 will import the page layout and the page widgets without importing the
actions and data links attached to widgets. You can choose between two different behavior:
l importing only the pages and the widgets: in this case all actions and data link have to be defined
l importing pages with references to actions and data links: used tags must be present in the project for these
elements to work properly
Note: Page import can only be performed between projects made using the same software version. Save the
older project as the newer version, then try again.
1. Right click the Pages node from the project tree and select Import page.
2. Choose the page to be imported from the desired project then click OK: a warning message is displayed.
3. Click Yes to remove all the links to data and actions. Click No to maintain the reference to data links and actions.
Tags need to be available in the new project.
Group of pages
You can group similar pages for easier maintenance. Grouping pages does not affect how pages appears at runtime. To
create a group of pages:
1. In ProjectView right click Pages node and select Create Group: a new folder is added
2. To move a page to a group, right click a page and select Groups > groupName.
4 My first project
The Widget Gallery

Path: View> Toolbars and Docking Windows> Widget Gallery
HMI objects required to build an application are available in the Widget Gallery. The gallery is divided into several
categories, each containing a collection of widgets.
Adding a widget to a page

1. Select the widget from the Widget Gallery.
2. Drag and drop it on the page.
Changing the appearance of a widget

All widgets have properties (Properties pane) that can be changed, Some widgets are presented in various styles. You can
click the buttons in each category to see available styles.
Example
To set the widget style for round gauges:
The Widget Gallery
1. Click the style button to display the available styles for the widget.
2. Select one of the available styles from the toolbar: depending on the selected widget, different options are available.
Complex widgets
Some widgets are composed of many sub widgets. For example, a button is a complex widget composed by a button
widget and a label. The structure of widgets can be seen in the ObjectView when the widget is selected.
You can select a sub-widget, such as the label in a button, from the ObjectView and modify it without ungrouping the whole
widget.
4 My first project
Data field widget

The most common widget is the data field widget that give the possibility to display value of tags.
Path: View> Toolbars and Docking Windows> Widget Gallery
Data field widget
Field properties
Property Description
Value Tag that contain the information to display
Number Format Display format
l None
No restrictions (system decide the format to use)
l Numeric
Numerical format. Decimal digits and Leading digits can be used to better define the
number format
l hex
Hexadecimal format. Leading digits can be used to better define the number format
l HEX
The same of "hex" format but using uppercase
l scientific
Scientific format. Decimal digits can be used to better define the number format
l SCIENTIFIC
The same of "scientific" format but using uppercase
l Custom
Use the additional "Custom" parameter to better define the format to use (see the
below table)
4 My first project
Decimal Digits Number of decimal digits to show (not available on all format types)
Leading Digits Number of leading digits to show (not available on all format types)
Custom String that define the number format to use (available only when selected Number Format is
CUSTOM)
Keypad Keypad type to pop up to edit the tab value
l None
l Alphabetic, Numeric, Etc.
Pop up a predefined keypad or a user keypad (see "Keypads" on page 315)
l Wheel
Keypad will not be displayed . Wheel can be used to increment/decrement the
numeric value
l Macro
Keypad will not be displayed . Keyboard macro can be used to enter keys (see
"Keyboard actions" on page 141)
Events
OnDataUpdate Action Commands list to execute any time the tag value changes (See "Actions" on page 135 for
the available commands)
Some properties have a couple of buttons:
Enter edit mode:

you can directly type the tag name to use
Attach to tag:
the dialog where select the tag to use will be opened
Custom Formats
In custom property, the allowed chars are “#” “.” “0” “h” “H” “e” “E”
Use the place holder characters to control the display of digits before and after the decimal place. Use the number sign (#) if
you want to display only the significant digits in a number. This sign does not allow the display non-significant zeros. Use
the numerical character for zero (0) if you want to display non-significant zeros when a number might have fewer digits than
have been specified in the format code.
If a number has more digits to the left of the decimal point than there are placeholders in the format code, the extra digits are
displayed. However, if a number has more digits to the right of the decimal point than there are placeholders in the format
code, the number is rounded off to the same number of decimal places as there are placeholders.
Examples
To display As Place Holder
123 0123 000#
Adding tags
To display As Place Holder
1500 5DC #H
1500 5dc #h
1500 05DC 000#H
123.456 123.46 #.##
123.456 000123.456000 00000#.000000
12,200,000 1.22E+07 #0.00E+00
12,200,000 12.2E+6 #0.0E+0
Adding tags
PB610 Panel Builder 600 uses tag names to access all device data. All fields and reference locations in the device need to
be assigned a tag name to be used in the HMI project.
Tag Editor can be used to create and manage tags. After the tags have been defined, they can be used in the project by
attaching them to widgets' properties.
See ""Attach to" parameters" on page 44 for details.
Tag editor
Path: ProjectView > Tags
Adding a tag
1. Click + and enter the required data.
2. Select the Address from the communication protocol address dialog: new tags are named Tag1, Tag2, ....
3. Click on the tag name to rename it.
4 My first project
Tag properties
See specific protocol documentation for details.
Name Unique tag name at project level. Primary key to identify information in the runtime tag database.
WARNING: Duplicate tag names are not allowed.
Groups Group names associated to a tag
Driver Communication protocol
Address Controller memory address.
To edit click on the right side of the column to get the dialog box where you can enter the address
information.
Encoding Encoding type for string data type (UTF-8, Latin1, UTF-2 and UTF-16)
Comment Tag description
Simulator Tag behavior during simulation. Several profiles are available.
Scaling Conversion applied to tag before database storage.
By formula = defined as a linear transformation.
By range = defined as a range conversion.
The below properties will be visible only after select the “Show Advance Columns” mode from the tag editor tollbar..
PLC Original PLC tag name, used to match tags used by HMI application (Tag Name) and tags exported from PLC
Tag
R/W only in advanced view to allow for adjustments in case tag import errors.
Name
Rate Tag refresh time. Default: 500ms.

(ms)
When the refresh rate is set to “Manual”, the HMI device will not read the tag from the remote device
automatically in background. Tag is read and refreshed into the database only by explicitly required from the
“ForceReadTag” action or using the forceRefresh option into the JavaScript getTag().
WARNING: Tags refresh rate is the maximum refresh rate. Actual refresh rate depends on:
communication type (serial, fieldbus, Ethernet), protocol, amount of data exchanged.
Attaching widget to tags
R/W R/W tag attribute (R/W, R or W).
Note: The content of Write Only tags is always written and never read. When communication is not
active, the content of these tags may not be available in widgets.
Active Update mode.
false = tags are read from controller only when required by the HMI device.
true = tags are continuously read even if not required by the displayed page.
Important: Leave this value set to false for higher communication performance.
Managing tag names

Tag names must be unique at project level. If the same tags, from the same symbol file have to be used for two different
controllers, use the “Alias” feature to add a prefix to the imported tags and make them unique at project level.
Note: Not all protocols support the “Alias” feature.
See "Communication protocols" on page 539 for details.
Managing tag groups

Tags used in each page are identified as part of a group, so that requests made by the communication protocol to the
connected controller(s) can be processed faster: only the tags included in the displayed page are polled from the controller.
Attaching widget to tags

To control a widget and animate it through live data it is possible to bind a specific property to different data sources. For
example it is possible to bind the gauge Value property to a probe temperature tag, or the Display property to a recipe data
Data sources
Elements to which an object property can be attached:
Data source Description
Tag Tag defined in the Tag Editor
Alias Indexed tag address
System Predefined system tags (see "System Variables (Attach To)" on page 95)
Widget Connect to a widget property (for example, value of a slider widget)
Recipe Data from the Recipe Manager (see "Recipes" on page 215)
4 My first project
Attaching a property to a tag

1. Click + in the Properties pane.
2. In Source choose the data source, in the list choose a protocol and the tag. Use the Search box to filter tags.
3. Set the access type (for example Read Only). The Array Index field appears when the selected tag is an array to
identify the element of the array to use. The indirect index mode, through an additional tag, is supported.
4. Click OK to confirm.
The icons adjacent to the tag name highlight when a definition does not match the tag definition in the dictionary, or when
missing. If the Show all tags is selected, all the dictionary tags are shown also if not imported within the application. A
double-click will import the tags from the dictionary.
See ""Attach to" parameters" on page 44 for details.
Communication Error
Two icons may appear close to widgets that have an attached tag.
Dialog pages
l : communication error
l : data not yet available (slow communication protocol)
Dialog pages
Path: ProjectView> Dialogs
Dialog pages are opened at runtime on top of the current page on project request. They are used to notify alarms, errors or
to require user action.
Main dialog properties

Dialog Type modal = user cannot return to main project window/page until dialog is closed.
non-modal = user can continue to use main project window (or other non- modal dialogs ) while a
dialog is shown on top of it.
Title Bar true = dialog title displayed
false = no dialog title displayed
Title Name Dialog title. Only if Title Bar=true.
Runtime Dialog fixed position

Position
false = Dialog will be placed centered on the screen
true = Dialog will be placed with upper-left corner at position X and Y
Maximum number of dialogs

Maximum number of open dialogs is defined in "Functional specifications and compatibility" on page 497.
When the maximum number of open dialogs is reached, the oldest dialog is closed to open the new one.
4 My first project
Exporting tags
Path: ProjectView > Tags
1. Select the protocol for the tags you want to export.

2. Click the Export Tags button: all the tags configurations for the selected protocols are exported into an .xml file.
You can edit the resulting .xml file using third part tools (for example, Microsoft Excel) and then re-import the modified file
(see "Importing tags" below for details).
Importing tags
Introduction
Some protocols allow you to import tags stored in a comma separated file (.csv or other formats). Refer to the Tag Import
section of each protocol for details (see "Communication protocols" on page 539).
Importing is a two step process:
1. Import of the tag definition into a dictionary

2. Import tags from the dictionary to the project
WARNING: Special characters in tag names such as “&” character cause communication errors. See
"Limitations in Unicode support" on page 258
Note: When importing tags, character "." in tag names is replaced with "/" . The protocol will use the correct
syntax when communicating to the PLC.
Dictionaries
Path: ProjectView > Dictionaries
A dictionary is a list of tags imported in the Tag Editor for a specific protocol. Depending on the protocol type, tags are
shown in linear view or in hierarchical view.
Importing tags
Linear view
Hierarchical view
Importing tags
To import tags from an external file:
4 My first project
1. In ProjectView, Tags select the protocol from the filter list.
2. Click the Import Tags button: the select file dialog appears. A dialog to choose the importer type appears.
3. Select the file: a list of tags is shown in a linear or hierarchical view.
4. To import tags, select one or more tags or a node (hierarchical view only) and click the Import tag button: tags
are copied to the project and listed in the upper window section.
Recursive All elements of the structure are imported into separate tags.
Note: When the project is configured to use a protocol network you must also select the protocol node where
tags are to be imported. You can import the same tags on multiple protocols. When the tags file contains the
node information, you can choose to use the information to filter the tags and import only those matching with the
selected nodes.
Updating the imported tags

Using the Update Tag(s) command you can re-import tags. A dialog allows you to select the tags to be reimported:
Tag find and rename
These tags need to be updated. A list of differences between project and dictionary is displayed.
These tags are no longer available in the dictionary. If updated, these tags will be removed from the project.
Tag find and rename

Tag find and rename feature will rename a tag reference inside the entire project.
Note this feature can be used not only to rename tags, but even to change values from each columns of the tags editor
4 My first project
Parameters
Column Select the column to modify with the find and rename operation
Rename The tags’ names rename will be extend to rename even to the internal dictionary tags’ names.
Names in This parameter is useful when you have to substitute the dictionary with another dictionary
Dictionary that contains renamed tags
This parameter is available only when the selected column is “Name”
Find what String to search
Rename String to replace

with
Case Takes account of upper and lower case letters

sensitive
Use regular Enable regular expression in search/replace pattern

expression
See https://en.wikipedia.org/wiki/Regular_expression for additional details regarding regular
expressions.
When regular expression is enabled, the “Find what” parameter will not offer
predefined values but only free text handling.
RENAME SELECTED
Execute the rename only for the selected tags
RENAME ALL
Execute the rename for the entire tags database
References used in Java script and within custom widgets will not update.
Undo is not supported for this command
Regular expression example
Using the tags list of the above picture.
If you want add a prefix to all tags you don’t need to use regular expression:
Find what: MRTU
Rename with PLC01_MRTU
But if you want add a postfix, you need to use a regular expression:
Find what: MRTU(.*)
Rename with MRTU\1_PLC01
Tag find and replace
Where
(.*) is meaning any sequence of characters
\1 is a copy of the first sequence of characters enclosed by (...) found inside the search string

Using this feature you can search all occurrence of a tag inside the project and replace it with another tag.
Tag replace is only applicable for Protocol tags which are shown in black color and not for System Variable, Alias
and Recipe tags. (See "Opening the Tag Cross Reference pane" on page 328 for the different colors meaning)
From the Tag Cross Reference view, click the tag that you want replace
4 My first project
Using the check boxes select where you want apply the replace,
then click the “Select new tag” button to replace the data links of the selected objects or press “Cancel” to abort the
operation.
References used in the Java script and within custom widgets may not be listed.
Undo is not supported for this command
5 Programming concepts
Programming for PB610 Panel Builder 600 is based on a few basic concepts and behaviors.
Data types 44
"Attach to" parameters 44
Formula 50
Events 54
Widgets positioning 57
Managing overlapping widgets 58
Grouping widgets 59
Changing multiple widgets properties 66
Changing fill color property according to tag values 67
Data types
Data types
When creating a tag you have to specify its properties. Data type are specific to PB610 Panel Builder 600, memory type are
specific to the selected protocol. Choose the value according to the internal representation you need for the selected
controller address.
Note: arrays type use the same data type followed by "[ ]" (i.e.: boolean [ ])
Data Type Description
boolean One bit data (0..1)
byte Signed 8 bit data (-128..127)
double IEEE double-precision 64-bit floating point type (±2.2e-308 ... ±1.79e308)
float IEEE single-precision 32-bit floating point type (±1.17e-38 ... ±3.40e38)
int Signed 32 bit data (-2.1e9 ... 2.1e9)
short Signed 16 bits data (-32768..32767)
string Characters coded according to selected format
time Time data
unsignedByte Unsigned 8 bit data (0..255)
unsignedInt Unsigned 32 bit data (0 ... 4.2e9)
unsignedShort Unsigned 16 bit data (0..65535)
uint64 Unsigned 64 bit data (0...264 − 1)
"Attach to" parameters

Object properties
In PB610 Panel Builder 600 the properties of an object placed on a page can be set at programming time or configured to be
dynamic. To change a property at programming time use the page toolbar or the property pane. Select the object first to see
its properties displayed.
The page toolbar shows only the most common object properties, while the property pane show all the properties in a basic
or advanced view.
To change a property value dynamically you can attach it to tags or variables.
Attaching a property to a tag

1. Click + in the Properties pane.
2. In Source choose the data source, in the list choose a protocol and the tag. Use the Search box to filter tags.
3. Set the access type (for example Read Only). The Array Index field appears when the selected tag is an array to
identify the element of the array to use. The indirect index mode, through an additional tag, is supported.
The icons adjacent to the tag name highlight when a definition does not match the tag definition in the dictionary, or when
missing. If the Show all tags is selected, all the dictionary tags are shown also if not imported within the application. A
double-click will import the tags from the dictionary.
Data sources
Elements to which an object property can be attached:
Data source Description
Tag Tag defined in the Tag Editor
Alias Indexed tag address
System Predefined system tags (see "System Variables (Attach To)" on page 95)
Widget Connect to a widget property (for example, value of a slider widget)
Recipe Data from the Recipe Manager (see "Recipes" on page 215)
Advanced search
Various syntax options can be applied to search box:
Main
Function
options
Wildcards Search using simple wildcards matching . Character '?': matches any single character. Character ' *':
matches zero or more of any characters." […]": sets of characters can be represented in square brackets.
Regular Describes character pattern.

Expression
See https://en.wikipedia.org/wiki/Regular_expression for additional details regarding regular expressions.
Filtering tags
Choose various tag filter criteria:
Showing dictionary tags

When Show all tags is checked, tags that belong to one dictionary but have not been imported yet, appear in blue color.
You can select and double-click a tag to import it into the project.
Converting tag value
Scaling tab converts the tag value. In By Range section set the input and output range: the system will automatically
calculate the scaling factors.
Extract tag bit/byte based on index

Allows extracting a single bit or byte content from a word depending on the specified bit or byte number
Use a formula to calculate the value to use

Allow to use a formula to calculate the value to use. See "Formula" on page 50 chapter for additional details.
Note that using a formula the datalink will be ReadOnly
Mapping tag values to color

Allows to mapping numeric or string tag values to colors. For example, this option can be used to change the color of a
button.
Section Function
From the toolbar add/remove or move up/down the colors lines. The
tag value is editable and you can modify the sequence values.
Last defined color combination is saved automatically and can be

retrieved from the color toolbar.
Tag value could be a range of values separate by a comma, examples:
l 5, 10-15, 20
l A, AB, C
It is responsibility of the application's developer define all items correctly to cover all possible application’s
values, we could have unexpected color when the value is not defined inside the defined colors palette.
Note that the mapping tag value to color will return a string data type (e.g. “#FF0000”)
Datalink Serialization
Instead of use the above “Attach to…” dialog box, datalinks can be entered, or modified, manually.
Click a button in the Properties pane and enter the text that describe the datalink
The data link format is:
Tagname [index] | [Atribute] | [XForm] | [XForm] | ...
on in case of formula:
= <formula>
Example:
Formula
l arrayTag[2]
l Tag[0|index]
l Alarm triggered:_SysPropMgr
l Tag|R/W|ScaleXForm(1,10,0)
l Tag|R/W|ScaleXForm(1,10,0)|ByteIndexXForm(1)|ColorPaletteCustomXForm(0#00aa7f,1#ff0000)
l =$('Tag1')>$('Tag2')?$('Tag1'):$('Tag2')
l =$Contains($('Tag4'),$('Tag3'))
l =$Pow(2,$('Tag2'))
Formula
A formula is an expression made of:
l Operators: can be the basic mathematics operations, logic operators, compare operators or basic string operators.
l Operands: can be literals (numbers and strings used as constants) and references to tags.
Round brackets are supported as priority operators. The operator $ will be used to call functions and, in particular, to
referring to a tag (see below for examples).
The attach to dialog allow to use a formula to calculate the value to return.
Commands
Enter edit mode
Save the entered formula inside the formulas' library to have the possibility to reuse the same formula inside
other places of the project.
Open the formulas' library to select an already defined formula.
Removing the entered formula
Confirming the entered formula
When you are in edit mode you can simple edit the formula and double click tags or functions from the library to add them
inside the formula.
Example of formulas are:
l $('Tag1')+$('Tag2')
l $('Tag1')&$('Tag2')
l $('Tag1')>$('Tag2')?$('Tag1'):$('Tag2')
l $Pow(2,$('Tag2'))
l $Contains($('Tag1'),$('Tag2'))
Syntax for formula

Basic Operations
'Text' String literal
NUMBER Number literal, e.g. 169857 or 13.547
String( … ) Cast to string (note there is not $)
Number( … ) Cast to number (note there is not $)
$FuncName( param1, param2, … ) General function call. (Both default and user ones)
$(‘TagName’) Tag, or widget property, or recipe, etc.
Note that tag name must be string literal
$(‘TagName’)[index] Element of a array tag.
Note that tag name must be string literal
exp1 ? exp2 : exp3 Ternary expression. If exp1 is true, then is taken exp2, otherwise is taken
exp3. This is like using if/then/else statement
Math Operators
+ Addition
- Subtraction
* Multiplication
/ Division
% Module
Formula
Bitwise Operators
& Sets each bit to 1 if both bits are 1
| Sets each bit to 1 if one of two bits is 1
~ Inverts all the bits
^ Sets each bit to 1 if only one of two bits is 1
<< Shifts left by pushing zeros in from the right and let the leftmost bits fall off
>> Shifts right by pushing copies of the leftmost bit in from the left, and let the rightmost bits fall off
>>> Shifts right by pushing zeros in from the left, and let the rightmost bits fall off
Logical Operators
&& AND
|| OR
! NOT
Compare Operators
< Greater than
<= Less than or equal to
> Less than
>= Greater than or equal to
== Equal to
!= Not equal to
Use predefined formula from the library

To insert a project or a predefined formula:
1. Open the formulas' library

2. Select the formula to use
3. Confirm the selected formula
4. Enter the arguments required from the selected formula
Add user formulas into the library

After entering a new formula, using SAVE button is possible to store the new formula inside the project folder to make it
available from the formulas’ library.
Events
A user formula could be retrieved from the formulas’ library as for the other predefined formulas.
Events
Events are used to trigger actions at project level and can be associated to:
l buttons / touch (click, press, release)

l mouse wheel
l external input devices like keyboards and mouse (click, press, hold, release, wheel)
l data changes (OnDataUpdate)
l switch of pages (OnActivate, OnDeactivate)
l alarms
l scheduler
You can attach one or more actions to an event, so that they will be executed whenever the event occurs.
This example shows a JavaScript action activated by pressing a button.
OnClick / OnMouseClick
Triggers the event when the button/key is pressed and released quickly.
Events
OnHold/OnMouseHold
Triggers the event when the button/key is pressed and held pressed for a certain time set as Hold Time in the widget
properties. Actions programmed for this event will be executed only after the hold time has expired.
The default Hold Time is configured in Project properties but can be redefined for each button/key. See "Project
properties" on page 69.
Note: If Hold Time is set to -1 for the widget, the project Hold Time value will be used.
Autorepeat
Enables auto repeat for a press or hold event of button or key. Autorepeat Time is specified in the Project properties but
can also be redefined for each button or key
OnWheel
Triggers the event when a wheel (for example a USB mouse wheel) value changes. A wheel usually is used to
increase/decrease values in a text box or attached to a tag.
OnActivate
Triggers the event when a page is loaded. The event starts before widgets in the page are initialized.
OnDataUpdate
Triggers the event when the tag value changes. The update moment depend on the time needed by the protocol to finish the
update process. For example the OnDataUpdate event can be triggered or not, depending on whether data becomes
available from protocol respectively after or before widgets being initialized for the first time. In particular, page change
notifications are more likely to happen with slow protocols and remote clients.
Note: The value read during OnActivate can be the same obtained from a subsequent OnDataUpdate event,
since OnDataUpdate notifications are sent asynchronously.
Widgets positioning
You can position widgets in the page using two methods:
l Snap to Grid
l Snap to Object
To display the grid, on the View menu, click Show Grid.
Snap to Grid
Path: View> Snap to Grid
When you move or re-size an object, its top left corner will align with the nearest intersection of lines in the grid, even if the
grid is not visible.
Setting grid properties

Path: View> Properties
Managing overlapping widgets
Spacing X Space in pixel between two lines/dots on the X axis
Spacing Y Space in pixel between two lines/dots on the Y axis
Type Grid type (dot or line)
Color Grid color
Snap to Object
Path: View> Snap to Object
When you move an object, it will align with other objects on the page.
When you select an object, one of the following hot points is selected as the source of the snap point, depending on the
area you pressed: top, top left, top right, bottom, bottom left, bottom right, left, right, center:
An algorithm finds a matching hot point among the near widgets hot points matching either the x or the y coordinates of the
source snap point. For line widgets, the source snap points are the terminal points of the line.
Managing overlapping widgets

When one or more widgets on the page overlap, you can manage their order so that one is displayed on top of the other.
The order of the widget on the page is shown in the combo box. A widget with greater z-order number is in front of an
element with a lower z-order number. A picture icon identifies static objects, a movie frame icon identifies dynamic objects.
Important: Correct ordering of widgets is essential for runtime performance since overlapping
dynamic widgets can invalidate static optimization and reduce performance of HMI applications.
Hiding/showing widget on z-order

To hide widgets above a selected widget:
l On the toolbar click and select a widget: all widgets above this one are hidden
To hide widgets below a selected widget:
l On the toolbar click and select a widget: all widgets below this one are hidden
The toolbar allows to:
l hide widgets stacked above and/or below selected widgets

l work on different widgets using the combo box which lists all the widgets in their z-order.
Grouping widgets
To group widgets:
1. Select all the widgets to group.

2. Right-click and then click Group.
Tip: Double click to enter the group editing mode. In group mode only the group widgets are editable and
selectable. All other widgets are partially hidden
Resizing grouped widgets

You can define how object reacts when re-sized. Use the Scaling property in General section:
l Scale: object and text are not re-sized proportionally

l Stretch: object and text are re-sized proportionally
Grouping widgets
Grid Layout Group

The grid layout add the possibility to configure the spatial relationships among the widgets of the group.
To create a grid layout:
l Enable the "Grid Layout" parameter of the group of widgets.
or
l Select the widgets that will be inside the table and click the “Grid Layout” button on page toolbar. The selected
widgets will be aligned and collected inside a group with the grid layout property enabled.
There are several elements associated with the grid layout that can be configured:
l Grid properties
l Rows, Columns Properties
l Cells Properties
Grid Properties
Enable Enable the grid layout.
A grid will be generate around the widgets of the group
Num rows Number of rows and columns of the grids.

Num columns
Rows and columns can be removed only if their cells are
empty .
Horizontal overflow This parameter define the behavior of the grid when it is too small
Vertical overflow to contain all rows and columns.
l Hidden
Rows and columns that do not fit into the grid are not
displayed
l Visible
The grid can not be made smaller than the minimum size
required to contain all defined rows and columns
l Scroll
When the grid is too small to hold all the defined rows and
columns, the scroll bars can be used to shift the content of
the grid.
Grouping widgets
Horizontal underflow This parameter defines the behavior of the grid when it is larger
Vertical underflow than the size defined for the rows and columns
l Blocked
The grid can not be made larger than the maximum size of
rows and columns
l Left, Center, Right - Top, Middle, Bottom

Defines the position of the widgets when cells are bigger
than the maximum defined sizes
Scrollbar color Parameters to define look and position of the scroll bars
Scrollbar image
Scrollbar offset
Scrollbat size
Scrollbar autohide
Margin collapsed Collapse all left-right and top-botton margin using the parameters
of the stroke with greater width.
External margin width External margin parameters

External margin color
Add or remove rows or columns
To add or remove rows or columns, double click over the grid to enter in edit mode and right click over column or row
selector to open the context menu.
Merge or split rows or columns
To merge or split rows or columns, double click over the grid to enter in edit mode and move the cursor over the ribbons:
l Double click the black triangle to merge the two adjacent rows or columns (1)
Note that merge is possible only with an empty row or column.
l Double click on ribbon to split the selected row or column (2)
Rows, Columns Properties

Row and columns properties are available inside a pop up dialog after clicking on the row and column selectors, that are
visible after double clicking the group of widgets.
Grouping widgets
Geometry parameters
Left margin Distance of the widget from the border of the cell
Right margin
Min width Min/Max width that widget can assume when the cell is stretched
Max width
Stretch Defines the relationship between the widths of the columns that
will be maintained if the grid is stretched
Top margin Distance of the widget from the border of the cell
Bottom margin
Min height Min/Max height that widget can assume when the cell is stretched
Max heighty
Stretch Defines the relationship between the heights of the rows that will
be maintained if the grid is stretched
Style parameters
Left stroke width Strokes width

Right stroke width
Top stroke width
Bottom stroke width
Left stroke color Strokes color

Right stroke color
Top stroke color
Bottom stroke color
Background color Row background color
The list of values that are separated by a comma, are related to rows and columns. Example, the first value is for
row 0, the second value for row 1, and so on.
Color format could be #rrggbb or #rrggbbaa, where "aa" is the alpha value which defines the opacity of the color.
Selection parameters
The selection parameters is available only when the grid is used inside a Table Widget (see "Table widget" on page 391 for
details)
Forground color Colors that the row assume when it is selected

Background color
The list of colors is related with row templates. First color is for row
Stroke color
template 0, second color is for row template 1, and so on.
Cells Properties
Properties of a single cell are available inside the properties panel when a cell is selected. To select a cell: first double click
the widget group, then click the cell to select.
Changing multiple widgets properties
Horizontal underflow This parameter defines the behavior of the widget when the cell is
Vertical underflow larger than the size defined for widget.
l Inherited
Inherits the value used for the row or column
l Left, Center, Right - Top, Middle, Bottom
Defines the position of the widgets when cells are bigger
than the maximum defined sizes
Max width Overwrite global grid parameters

Max height
Left margin Overwrite global grid parameters

Right margin
Additional pixels that are added to the total margin.
Top margin
Bottom margin
Preserve aspect ratio Preserve aspect ration of the widget
Aspect ratio Available only when "Preserve aspect ratio" is true
Background Background color of cell
Changing multiple widgets properties

You can set the properties of more widgets of the same type all at once.
To change properties:
1. Select widgets.
2. Set common properties from Properties pane.
3. When multiple widgets are selected, the Properties pane title changes to <MultipleObjects>: all changes will be
applied to all selected widgets.
Note: Not all properties can be modified for multiple widgets simultaneously and must therefore be modified
individually.
Changing fill color property according to tag values

PB610 Panel Builder 600 allows to change the color property of a widget dynamically, based on tag values in two ways:
l Using ColorPalette
l Connecting the Color property to a String type tag
Changing color property using ColorPalette

1. Create the tag (internal or PLC) that you want to refer to for color management. The tag can be of any data type. On
the basis of the value of this tag, the color will change.
2. Attach this tag to the Fill Color property of an object (for example, a button).
3. In the same dialog select the ColorPalette tab and add the colors that will be used for the object according to the tag
value.
Note: The last used colors’ tables are saved and can be reused selecting them from the colors list box on the
toolbar.
Changing color property connecting Color property to a String type tag

1. Create the tag (internal or PLC) that you want to refer to for color management. On the basis of the value of this tag,
the color will change. The tag must be of String type and the Arraysize property of the tag must be big enough to
contain the string formatted as explained here.
2. Attach this tag to the Fill Color property of an object (for example, a button).
3. Write in the String tag the RGB color code of the required color. Use one of these formats:
l #XXYYZZ, Where XX, YY and ZZ are the RGB components of the needed color expressed in Hexadecimal format
(range 00–FF).
l rgb(XXX,YYY,ZZZ), where XXX, YYY and ZZZ are the RGB components of the needed colors expressed in
Decimal format (range 0–255).
Note: This feature can be applied to all the objects available in the Widget gallery that have a color property. The
runtime change of the color is possible only thanks to the properties of the SVGs that are composing the object.
This feature can not be applied to other image formats such as JPEG or BMP files.
Changing fill color property according to tag values
6 Project properties
Project properties contain settings for the project.
Path: ProjectView> double-click Project properties> Properties pane
The project Properties pane contains a list of project level user-configurable data.
Basic and advanced properties
Some properties are displayed only in advanced mode. To view all project properties:
l Click Show Advanced Properties button to expand the property view in the Properties pane.
Available properties
Id Project name (read only)
Full Path Project path (read only)
Version The Version field is available for users to report the project version.
+ Runtime Properties related with the application runtime. See "Runtime" on the next pagefor details.
Runtime
+ Plug-In Optional modules. See "Plug-in" on page 75for details.
+ Project Properties related with the project. See "Project" on page 76 for details.
+ Web Properties related with the web interface. See "Web" on page 80for details.
+ Events Global events. See "Events" on page 81for details.
Runtime
Context Menu Define how context menu should appear in the HMI project.
on delay = context menu appears touching/pressing and holding for a few seconds an
empty area of the runtime screen, or via Context menu action
on action = context menu appears only via Context menu action.
See "Widget actions" on page 180 for details.
Developer Tool Enable/disables a collection of runtime debugging utility tools.
Buzzer on Touch Enables buzzer when touching a widget on HMI device screen.
Supported widgets:
l buttons
l hotspots
l needles
l fields
l external keys
l combo boxes
l tables items
l control list items
On Windows CE panels, available for from v1.76 ARM / 2.79 MIPS.
Buzzer duration Default 200 ms
Keyboard Enables the use of keyboard macros at runtime when using external keyboards.
JavaScript Debug Enables the JavaScript debugger at runtime for the current project.
Allow JS Remote Enables JavaScript remote debugger for current project.

Debugger
Remote debugging not supported on HMI Client.
Image DB enable Activates an engine used by the Runtime to optimize project performance.
WARNING: This property should only be disabled by technical support

for debugging purposes since this might reduce performance at runtime.
FreeType Font Switches to FreeType the font rendering used by PB610 Panel Builder 600 and runtime.
Rendering
The main reason for using the FreeType is that native WCE engine does not
support very well Asian fonts. The second, not less important, reason is that we
need the same engine in all devices to avoid different rendering, in particular if
static optimization is involved.
Communication icon Delay before display the communication error icon (default is 0 mSec)
delay (ms)
The special value -1 is meaning always disabled
Fast Boot When fast boot is enabled and the User Interface is started before the background server
l Default: User Interface is loaded after the background server is ready to use
l Fast UI: User Interface is loaded before loading the background server
Fast Boot
When fast boot is enabled, the HMI device will provide the welcome screen as fast as possible after the power up. In this
mode, only the minimum necessary features are loaded before starting the User Interface. Loading of protocols, events,
trends, alarms, actions are postponed after loading the User Interface.
There are two flags to set:
l The “Fast Boot” flag available inside the advanced project properties
l The “Fast Boot” flag available inside the Services page of the BSP System Settings tool (see "System Settings" on
page 507)
When fast boot is enabled and the User Interface is started before the background server the JavaScript event
project.onServerReady can be used to get server synchronization.
Example:
if (!project.serverIsReady) {
// Set the callback to wait for server ready
project.onServerReady = onServerReady;
} else {
// Server is ready, call it now
onServerReady();
}
function onServerReady()
{
project.setTag("Tag1", 1);
project.showMessage("Server is ready, tags can be used: " + project.getTag("Tag1")
)
Runtime
This is an advance feature available only on Linux platforms
Developer tools
Collection of runtime debugging functions that can be enabled or disabled.
1. In Properties pane, set Developer Tools to true.

2. Download the project.
3. Open context menu.
4. Select Developer tools.
Developer tools list
Tool Description
Show/Hide all Shows a dialog containing information about device status like CPU load, memory usage,
event queues.
CPU statistics Shows information on CPU load. See "CPU Statistics" on the facing page.
Memory statistics Shows information about system RAM . A negative value indicates that free memory is
decreasing.
Event queues Shows information on event queues (size, maximum achieved size, number of processed
events, last and maximum processing time). Timing statistics are only available for non-UI
queue.
Timelog summary Show page loading time.
Embed window Allows embedding in runtime the scene or leave the developer tool window as a standalone
window (dialog).
Reset queue stats Resets statistical information on event queues.
Disable watchdog Disable the watchdog function and prevents system restart in case of freeze or crash of
services.
Ignore exceptions Disables crash report function, exceptions are not saved in the crash report window.
Launch VNC Launches the VNC server if available in runtime. VNC server is available as a plugin for
Windows CE runtime only.
Profiling Measures the time spent for loading/rendering the active page. See "Profiling" on the facing
page
Watchdog
This feature allows you to disable the watchdog. This way you can avoid system restart in case of a runtime crash and
have the time to save the crash report or check system status information (for example,memory available, CPU load,
events queue size and so on).
The crash report dialog is displayed automatically in case of a system freeze or crash allowing users to save a log file of
crash.
Important: Save this file for technical support.
CPU Statistics
On the top row the current machine time is shown along with the total device uptime.
CPU statistics are collected with a frequency of 2000 milliseconds. The actual period and the overhead required to collect
and visualize statistics are displayed as well. The more the actual period is far from the nominal 2000 milliseconds the
higher is the system load. CPU consumption of threads is listed reporting the name of the thread (if available, main thread
is marked with a *), the thread ID, the thread priority and CPU time spent during the 2000 milliseconds period, divided in
user and kernel time.
Profiling
Profiling allows you to check time spent for loading/rendering the active page. Profiling will start from the next page load
and will be active only for the first painting of the page to the screen (the configuration is retained).
Runtime
Profiling option Description
Enable timelog Enable timelog capture. Timing will be visible inside the “Timelog summary”
window.
Save timelog to file Saves a report of profile details and the time spent loading a project and its
pages into a timelog.txt file. This file can be exported and shared for further
analysis.
Important: The execution of this function may reduce page

change performance.
Overlay OnLoad times This view allows displaying time spent on single widgets and is available only for
Overlay Rendering times the rendering and OnLoad steps. The view gives an immediate feeling of where
time is spent. Red zones represent the most time critical zones. Detailed widget
times are visualized by a tooltip window (on Windows platform attached to
mouse over event, on Windows CE press drag and release over the region of
interest). In case of out-of-the-scene widgets some arrows allow to navigate to
these areas and hovering on them the tooltip will show the area summary
Select overlay color Select the overlay color to use
Timelog data
Data Description
Time parsing Time spent parsing current page. Depends on page complexity/number of
widgets.
Time gfx creation Time spent for image rendering. Mainly related to the Onload method.
Time rendering Time spent rendering the page.
Time unloading Time spent unloading the page, if current page depends from another page.
Times are provided in couples: wall time/CPU time. Wall time is the absolute time required by this part which can be higher
than the actual CPU time required since higher priority threads are also running (for instance protocols). The start time
column refers to the page load start time. It can be used to track the actual time required to load a page, since partial times
only refer to the most time critical functions and do not include other times that often contribute significantly to the total
time.
For example, the actual total wall time required to load a page is rendering (which is the last step) start time + rendering wall
time.
FreeType font rendering

New projects use the FreeType font engine as default. Projects created with older versions of PB610 Panel Builder 600
could use an older font engine also after project conversion to avoid any backward compatibility issue.
Switch to FreeType whenever possible for better page rendering.
Once you have switched to the new font rendering, save the project and verify that all texts are displayed correctly in all
project pages.
Font rendering issues
When switching to the FreeType font engine a project created with the older font engine, you may experience the following
problems:
l text requires more/less pixels for rendering thus changing text layout
l widgets are resized to accommodate text
l better rendering can be obtained using antialiasing (antialiasing is a text widget property)
Plug-in
You can choose which software modules are downloaded to the runtime with the project. Software plug-in has been
designed to reduce memory requirements for the HMI application in HMI devices where storage is limited. This option is not
supported in Windows platform.
WebKit Module required by WebBrowser widget
TextEditor Module required by TextEditor widget
PDF Reader PDF Reader
VNC Server VNC Server
Note: Not all software plug-in modules are compatible with all HMI device platform.
Once enabled, software plug-in become part of the runtime. Use PB610 Panel Builder 600 to install it using one of the
following procedures:
l install Runtime/update Runtime

l update package
To remove plug-ins from runtime use one of the following functions in System Mode:
Project
l format flash
l restore factory settings
Important: The system cannot detect automatically which software plug-ins are required by the HMI
application, make sure you select them all in the Project Properties.
Note: Software plug-in support has been designed for embedded HMI devices where storage is limited. This
option is not supported in Windows platform.
Project
These properties define various elements of page behavior.
Home Page The first page loaded at runtime (after log-in page if security is enabled in project).
When security is enabled, you can specify a different homepage for each groups of users.
In this case this setting is ignored. See "User management and passwords" on page 281 for
details.
PageWidth Defines the default size in pixel of an HMI page. Default is the display resolution of the HMI
PageHeight device model selected when creating the project.
Display Mode Defines HMI device orientation.
Project Type Defines HMI device type for the project. According to the model, some project features and
properties are automatically adjusted.
WARNING: Starting from v2, the HMI Runtime will check if the selected
project type is matching with the HMI device model and will advise with a
message when the selected type is not matching: “HMI Type mismatch.
Convert project and download again.”
Panel Memory Size of the available internal panel memory.
PageRequest See the below chapter

CurrentPage
SyncOptions
Hold Time Defines the values for hold time and auto repeat time for buttons and external keyboards.
Autorepeat Time
Note: These properties can be redefined for each button or key in their widget
property table.
Hide Project Loading When hidden, the splash screen stay on the screen until the application is ready to run.
at boot
Target Zoom Factor It is the zoom factor of the HMI device that will be applied when project is loaded at runtime.
Range 0.3–2.9
Default value 1 = no zoom
Background color When the defined page is smaller of the entire display area, colorize the area that is not
option covered from the page (for example when page is Zoom Out)
None Old mode, color is white (default)
Selected color Color to use
Page background Auto adjust color based on background of template or of page
Signature Algorithm to use to signing
l sha256
l sha1
Gesture Passthru Enable the possibility to pass gesture events to underlying widgets after a configurable
Enabled delay. User has to keep pressed the finger and then execute the gesture.
Gesture Passthru Delay When enabled, the gesture events are passed to underlying widgets after this delay (see
(ms) "Gesture events pass thru" on page 376 for details)
Gesture Multitouch Enable multi touch gestures
l false
l true (default)
This property give the possibility to disable the multi touch gestures. This could
be useful to avoid problems with old projects that were not designed to manage
the multi touch gestures.
On Access Denied When user try to use a widget that is locked from the security configuration to read-only
(e.g. a field or a button), a padlock icon is shown for a couple of seconds to highlight that the
widget is not accessible.
l None
l Show Icon
ComboBox View Mode Select the visualization mode of all the Combo Box widgets of the project (see "Combo Box
widget “full screen” mode with images" on page 365 for details)
l Context
Classic view with drop-down menus
l Full screen
Enhanced view with configurable texts and images that will pop up in the middle of
the screen for easy scroll and selection.
Project
PageRequest, CurrentPage and SyncOptions

It is possible to have HMI Runtime exchange devices information on the page shown by the HMI. You can synchronize
pages shown on the HMI device and on HMI Client or to control an HMI project from a controller such as a PLC.
The following properties can be customized:
PageRequest Page to be shown on the HMI device and on HMI Client.

Attached tag must contain an integer value within the range of the available project pages
and must be available at least as a Read resource.
CurrentPage Page number displayed on the HMI device or on HMI Client or on both.
Attached tag must be available at least as a Write resource and must have integer data
type.
SyncOptions Synchronization of project pages with the value contained into the CurrentPage property.
Options can be:
l disable: page number value is ignored,

l local: page number displayed on HMI,
l remote : page number displayed on HMI Client.
l local + remote: page number displayed on HMI and on HMI Client, if different pages
are displayed the last page loaded is considered.
Example: forced page change from controller/PLC to HMI device and HMI Client
Set properties as follows:
PageRequest attached to tag "A"
CurrentPage empty
SyncOptions disable
Set value of tag "A" to display the requested page on HMI device and HMI Client.
Example: forced page change from controller/PLC to HMI and HMI Client. Read current page loaded
on HMI
CurrentPage attached to a tag "B" as read/write
SyncOptions local
Set value of tag "A" to display the requested page on HMI device and HMI Client. Tag "B" will contain the number of page
currently shown by the device.
Example: forced page change from controller/PLC to HMI device and HMI Client. Read current page
loaded on HMI Client.
CurrentPage attached to a tag "B" as read/write
SyncOptions remote
Set value of tag "A" to display the requested page on HMI and HMI Client. Tag "B" will contain the number of page currently
shown by HMI Client.
Example: forced page change from controller/PLC to HMI device and HMI Client. Force HMI Client
page synchronization with HMI device (not vice versa).
PageRequest attached to a tag "A" as Read/Write
CurrentPage attached to the same tag "A" as per PageRequest
SyncOptions local
Set value of tag "A" to display the requested page on HMI and HMI Client. Change page on HMI to display the same page
on HMI Client.
Example: forced page change from controller/PLC to HMI device and HMI Client. Force HMI page
synchronization with HMI Client (not vice-versa).
PageRequest attached to a tag "A" as read/write
SyncOptions remote
Change value of tag "A" to display the requested page on HMI and HMI Client. Change page on HMI Client to display the
same page on HMI.
Example: synchronize displayed page between HMI device and on HMI Client
PageRequest attached to a tag "A" as read/write
SyncOptions local+remote
Changing page on HMI device, same page will be shown on HMI Client and vice-versa.
Web
Web
Web Inactivity Timeout Defines a timeout for PB4Web client. When the timeout expires without any activity the
current user is logged out.
Range 1–86400 s (form 1 s to 24 h)
Default value 600 s
Values 0 = disabled
Web Icon The favorite icon associate at the web pages
Refresh Time Defines the refresh time for the communication between the runtime and PB4Web clients.
Range 500–10000 ms
Default value 3000 ms
Browser Optimization true Web engine optimization enable (default)
false Web engine optimization disable (useful for old

browsers that not support the web engine
optimization)
Enable Global Define if the JavaScrip code defined inside the Project Properties, general triggered from
JavaScript for remote Alarms and Schedulers events, have to run only on local HMI device or even on remote
clients.
None Will not be executed on remote clients (run only inside

the local HMI device)
Client Will be executed on HMI Client
Web Will be executed on Web client
Both Will be executed on both HMI Client and Web clients
Max Bandwidth (Kbs) Limit for maximum data sent by server (useful for old slow browsers). Set to 0 to use all the
available bandwidth (default)
Web clients connection Auto The connection mode is selected by the client (default)
mode
SSE Force the Server-Sent Events mode
Long Polling Force the Long-polling mode
WebPageRequest You can synchronize pages shown on the PB4Web Clients from a controller such as a
PLC.
Page to be shown on the PB4Web Client.
Attached tag must contain an integer value within the range of the available project pages
and must be available at least as a Read resource.
Web Communication Delay before display the communication error icon (default is 0 mSec)
icon delay (ms)
The special value -1 is meaning always disabled
The project.getClientType() can be used to retrieve the running client type. See "Project object" on page 447
inside JavaScript chapter for additional details.
Events
OnWheel Used only in conjunction with wheel input devices. Normally the wheel is used to
increase/decrease the value of a tag without an external keyboard device.
Attach this property to a change of wheel event and use an action like BiStep to
increase/decrease a tag value.
The project's OnWheel Action is executed only when the OnWheel Action
will not overwritten from the loaded page.
Events
7 The HMI simulator
HMI simulator allows you testing projects before downloading it to the HMI device. It may be used to test the project when
no HMI device is available and to speed up development and debugging activities.
The HMI simulator supports:
l online simulation - in communication with real devices (only for protocols with Ethernet or RS-232 communication),
l offline simulation - simulating tag behavior
The data simulation method is set in the Simulator column of the Tag Editor.
Data simulation methods 84
Simulator settings 84
Launching and stopping the simulator 85
Data simulation methods
Data simulation methods

Set tag simulation behavior in the Simulator field of Tag Editor.
Method Description
Variables Data is stored in a simulator variable. This variable holds the value of the tag so you can read and write the
value.
SawTooth A count value is incremented from Offset to Amplitude + Offset value with a Period of 60..3600 seconds.
When the counter reaches Amplitude + Offset, the value is reset to Offset and the counter restarts.
Sine A sine wave value is generated and written to the tag value. Min, Max and Period values can be defined for
Wave each tag.
Triangle A triangle wave value is generated and written to the tag value. Min, Max and Period values can be defined
Wave for each tag.
Square A square wave value is generated and written to the tag value. Min, Max and Period values can be defined
Wave for each tag.
See "Adding tags" on page 30 for details.
Simulator settings
The Simulator works by default with simulated protocols. It can also work with real protocols (Ethernet or serial protocols)
Note: For protocols not supporting communication with external devices, such as the Variables protocol, this
option is always disabled.
Changing simulated protocols

1. Click the simulator Settings icon.
7 The HMI simulator
2. Select Use Simulation to use simulated protocols, otherwise real protocols will be used for communication with
external devices.
Launching and stopping the simulator

To launch the simulator:
1. On the Run menu, click Start Simulator: the Simulator runs on the computer in the same way as the server would
run on the HMI device.
To stop the simulator:
1. On the Run menu, click Stop Simulator or on the simulated page double-click the Exit button.
Launching and stopping the simulator
8 Transferring the project to HMI
device
To transfer the PB610 Panel Builder 600 project to the target HMI device you can use:
l function Run > Download to Target

l function Run > Update Package with the use of a USB device
Download to HMI device 88
Update package 91
The Runtime loader 93
Upload projects 94
Download to HMI device

Path: Run> Download to Target
This function transfers project and HMI Runtime via Ethernet .
Note: The HMI device must have a valid IP address. See "HMI device basic settings" on page 8 for details on
how to assign an IP address.
1. Click the discovery button: a list of the detected IP addresses is displayed.

2. Select the HMI device IP address.
You can even enter the IP address manually or, if available, the host name provided by a DNS server. Using a
service tool like Bonjour, Linux-based HMI devices can be discovered using their hostname (e.g HMI-0d37.local).
Bonjour is a trademark of Apple inc.
3. Click Download: PB610 Panel Builder 600 will switch the HMI device to Configuration Mode and transfer the files.
When the download operation is completed, the HMI device automatically switched back to Operation Mode and the
project is started.
Advanced options
Option Description
Download only Transfers to the HMI device only the modified project files.
changes
Binary format Download files using binary format.
8 Transferring the project to HMI device
Option Description
Delete runtime Modified configuration of recipes, users, schedulers, etc. done at runtime will be deleted and
dynamic files overwritten by the configuration defined in the project.
CAUTION: This operation cannot be undone, deleted dynamic files cannot be

restored.
CAUTION: Dynamic files are not deleted if stored on external devices (USB or
SD Cards).
Download Web Download the PB4Web pages to HMI device.

Project
When transferring a project, PB610 Panel Builder 600 uses a combination of HTTP and FTP connections:
l HTTP connection - issues the commands to switch to transfer mode or to unload running project,
l FTP session - transfers the files to the flash memory in the HMI device.
Advanced Settings
Using the “Advanced Settings” option, you can define the ports to use, but generally, you do not need to enter this
information because HMI devices will provide the ports to use inside the panesl list.
Changing HMI device connection settings

Path: Run> Manage Target
1. Click Target Setup: the Advanced Settings dialog is displayed. Default port for HTTP connections on the HMI
device is port 80.
2. Set correct HTTP, FTP or HTTPS, FTPS ports for the HMI device. (These are the ports used by the system to
connect to the HMI device and may need to be modified when default ports are used by other services or
applications or if the local network requires specific settings.)
3. Specify Hostname to easily identify each device in a network where multiple devices are available. The default
hostname is “HMI” for all devices.
4. Click Download System Files. At the next download the new ports will be used in the HMI device and new
hostname will appear in the drop-down list
Managing big projects

For successful download the project size should be at least 2 MB smaller than the available memory. If not, you run out of
flash memory in the HMI device and a warning message is displayed.
To free more memory:
1. Click Manage Target.

2. Delete the projects you no longer need t to make more memory available.
Update package
The Update Package create a UpdatePackage.zip file to install or update the application inside the HMI device using an
USB memory key.
Creating an update package

Path: Run> Update Package
Option Description
Target HMI device type. Selected automatically if the project is open.
Application Select the application to insert inside the UpdatePackage.zip

Selector
l HMI Runtime
l HMI Client (Available only on Linux devices)
Update package
Option Description
Project Adds open project to update package.
HMI Runtime & HMI Runtime is added to the update package. If the project is open the required plugins are also
Plug-In added to update package.
Binary Format Download files using binary format.
Web Project Download the PB4Web pages to HMI device.
Set Target Sets password to perform critical tasks (for example, project download/upload , board
Password management)
See "Protecting access to HMI devices" on page 485.
User Files Selects files to be copied to the QTHM folder of HMI device. Max size 5 MB
Encrypted Enables encryption of update package so that it can only be unzipped by the HMI Runtime.
Location Location of update package.
Important: When create a package with the HMI Runtime application, always include both project and
the runtime. If you need to use an old project with the latest Runtime version, convert the project first.
See "Installing the application" on page 4 for details.
Example of user's file location

Computer:
C:\Users\Username\Desktop\myFolder
- subFolder1/file1
- subFolder1/file2
- file3
- file4
WinCE devices:
/Flash/QtHmi
- subFolder1/file1
- subFolder1/file2
- file3
- file4
Linux devices:
/mnt/data/hmi/qthmi
- subFolder1/file1
- subFolder1/file2
- file3
- file4
Loading an update package

Path: from the context menu > Update
1. Assuming you have stored the package in the root folder of a USB drive, remove the drive from the computer, plug it
in the HMI device, display the context menu by holding your finger for a few seconds on the screen and select
Update.
2. The system will check for the presence of the update package in the USB drive root and ask confirmation to proceed
with the update.
3. Select Auto select best match and click Next: the procedure is completed automatically. Alternatively use the
browser button to select the file to use.
The Runtime loader

HMI devices are delivered from factory without Runtime.
When you power up the device for the first time, the Runtime Loader window is displayed (see "System Settings" on
page 503for details)
The Runtime Loader presence depends on the device Operating System and may not be available on all the
units. Old versions of HMI devices may not include the Runtime Loader. Contact technical support if you need
further information.
Installing Runtime from PB610 Panel Builder 600

When you download a project the Runtime is automatically installed if needed.
See "Transferring the project to HMI device" on page 87 for details.
Upload projects
1. Click Install Runtime: the procedure is run automatically.
Installing Runtime from a USB drive

1. Prepare the Update Package as described in "Update package" on page 91
2. Plug the USB drive in the device and follow the instructions for the type of device (see "System Settings" on
page 503for details)
Note: Old versions of HMI devices may not support automatic installation of Runtime. Contact technical support
for more information.
Upload projects
Path: Run> Manage Target
You can copy a project from the Runtime to the computer where PB610 Panel Builder 600 is running.
1. In the Runtime tab, select the IP address of the device from the drop-down list Target.
2. Click Retrieve Projects: a list of all the projects available is displayed.

3. Select project to upload
4. Click Upload Project
Upload could be password protected. See "Protecting access to HMI devices" on page 485 for details.
5. If required, enter password. The upload process starts.
A copy of the project is saved in:
C:\Users\username\Documents\PB610 Panel Builder

600\workspace\Uploaded\RuntimeIPAddress\workspace\ProjectName
Note: If the upload operation fails, check firewall settings the computer where PB610 Panel Builder 600 is
running.
9 System Variables (Attach To)
Path: Source> Attach to
System variables are special tags containing information about the HMI runtime.
Note: System Variables are available also as a standard protocol in the Protocol Editor. Use System Variables
as a protocol when you have to transfer data between system variables and tags from devices, or to select
custom refresh rate for a system variable.
Alarms variables 97
Buzzer variables 97
Communication variables 98
Daylight Saving Time variables 98
Device variables 99
Dump information variables 101
FTP client variables 101
Keypad variables 102
Network variables 102
Printing variables 103
Remote Client variables 104
Version variables 105
Screen variables 105
SD card variables 105
Server variables 105
Time variables 106
Touch screen variables 106
USB drive variables 107
User management variables 108
Alarms variables
Number of alarms of the requested type.
Data
Variable Description
type
Alarm not acknowledged True when alarms unacknowledged is pending boolean
(Not Triggered Not Acknowledged<>0) OR (Triggered Not read

Acknowledged<>0) only
Alarm triggered True when at least one alarm is triggered boolean
(Triggered Acknowledged<>0) OR (Triggered <>0) OR (Triggered Not read

Acknowledged<>0) only
Number of missed alarm events Alarms exceeding the event queue. Queue length is defined in the int
engineconfig.xml file.
read
only
Number of not triggered Alarm condition no longer active; alarms already acknowledged int
acknowledged
read
only
Number of not triggered not Alarma condition no longer active; awaiting acknowledgment int
acknowledged
read
only
Number of triggered Alarm condition active; alarms already acknowledged int

acknowledged
read
only
Number of triggered alarms Alarm active: aknowledgement not required int
read
only
Number of triggered not Alarm condition active; awaiting acknowledgment int

acknowledged
read
only
Note: For compatibility reasons, the older names are still valid but they usage is deprecated.
Buzzer variables
Adjust buzzer behavior.
Communication variables
Data
type
Buzzer 0 = disabled int

Setup 1 = enabled (buzzer sounds as audible on any touchscreen event)
2 = buzzer status controlled by Buzzer Control system variable or by Buzzer on Touch
property inside the "Project properties" on page 69
Buzzer on touchscreen (Setup=1) is not available on Linux platforms. See

"Buzzer on Touch" property in alternative.
Buzzer 0 = buzzer off int

Control 1 = buzzer on
2 = buzzer blink
Buzzer Off Duration in milliseconds of off time when blink has been selected. Default = 1000. Range: 100– int
Time 5000.
Buzzer On Duration in milliseconds of on time when blink has been selected. Default = 1000. Range: 100– int
Time 5000.
Communication variables
Communication status between HMI device and controllers.
Data
type
Protocol Summarize the status of the communication protocols. int

Communication
0 = No protocol running, protocol drivers might not have been properly downloaded to the Read
Status
HMI device. only
1 = Protocols loaded and started, no communication error.
2 = At least one communication protocol is reporting an error.
Protocol Error Communication error with error source. ASCII

Message string
For example: "[xxxx]" where "xxxx" is the protocol abbreviation, the error source.
Read
Multiple acronyms appear in case of multiple error sources. Blank when no errors are
only
reported.
Protocol Error Number of communication errors occurred since last reset. Reset value with Reset int
Count Protocol Error Count action, see "System actions" on page 159.
Read
only
Daylight Saving Time variables

Information on the system clock. The variables contain information on the "local" time. Standard Time (solar time) and Day
Light Saving time (DST) are available.
Note: All variables are read only; you cannot use them to update the system clock.
Standard Offset Offset in minutes when standard time is set, with respect to GMT (for example: -8x60 = -480
minutes).
Standard Week Week in which the standard time starts (for example: First = 1).
Standard Month Month in which the standard time starts. Range: 0–11. (for example: November = 10).
Standard Day Day of week in which the standard time starts (for example: Sunday = 0).
Standard Hour Hour in which the standard time starts (for example: 02 = 2).
Standard Minute in which the standard time starts (for example: 00 = 0).
Minute
DST Offset Offset in minutes when DLS time is set, with respect to GMT
DST Week Week in which the DLS time starts
DST Month Month in which the DLS time starts. Range: 0–11.
DST Day Day of week in which the DLS time starts
DST Hour Hour in which the DLS time starts
DST Minute Minute in which the DLS time starts
Device variables
Device settings and operating status information.
Variable Description Data type
Available Free available RAM memory in bytes. uint64

System
read only
Memory
Backlight Activation time in hours of the display backlight since production of the device. unsignedInt
Time
read only
Battery LED Enables/disables the low battery LED indicator (when available). int
0 = disabled
1 = enabled
Not available on Linux platforms (find the platform of your device at "HMI
devices capabilities" on page 499)
Battery Reserved int
Device variables
Timeout Not available on Linux platforms (find the platform of your device at "HMI
Display Returns and adjusts brightness level. int

Brightness
Even when set to 0, the backlight is still on and the Backlight Time counter increases.
Range: 0–255
On WinCE device only:

When set to a low light level (0..3), the backlight stays lit to a higher level for 8 seconds to
allow the user to make the adjustments and then is switched-off.
External Non-operational time after which the display backlight is automatically turned off. The int
Timeout backlight is automatically turned on when the user touches the screen.
-1 = Switch off backlight and disable touch (switch display off). Backlight
Time counter is stopped.
On Linux devices requires BSP v1.0.324 or higher.
-2 = Switch off backlight but not disable touch. If touch is pressed, event is
not passed to applications but screen saver exit and backlight return on.
Available only on Linux devices. Requires BSP v1.0.324 or

higher.
0= Switch backlight on (switch display on)
1..n = Timeout, in seconds, for switch off backlight (screen saver timer)
The timeout value is rounded to multiples of one minute (60,

120, 180, etc,) in all Linux devices.
Find the platform of your device at "HMI devices capabilities" on page 499
Flash Free Free space left in internal Flash memory. uint64

Space
read only
Manufacturer Internal code that identify the HMI type unsignedInt

Code
read only
System Font List of system fonts string

List
read only
System Mode Runtime operation status. int
1 = booting
2 = configuration mode
3 = operating mode
4 = restart
5 = shutdown
System Time the system has been powered since production of the unit (hours). unsignedInt
UpTime
read only
Dump information variables

Status of the copy process to external drives (USB or SD Card) for trend and event buffers.
Dump Error Message Return error message if any error occurs during the dump operation string
read only
Dump Archive Status 0 = initial default state int

1 = operation triggered
read only
2 = operation complete successfully
3 = operation completed with errors
Dump Recipe Status 0 = initial default state int

read only
Dump Trend Status 0 = initial default state int

read only
Reset Recipe Status 0 = initial default state int

read only
Restore Recipe Status 0 = initial default state int

read only
FTP client variables

The FTP client variables are updated when the FTP actions are used.
Keypad variables
FTP Current Command Last FTP command string
read only
FTP Error Message Last FTP error message string
read only
FTP Progress Download/upload progress (0/100%) short
read only
FTP Status Status of last FTP command: short
l 0 = idle read only

l 1 = active
l 2 = done
l 3 = error
Keypad variables
Keypad status.
Is keypad open 0 = no keypad open int
1 = keypad open read only
Network variables
Device network parameters.
Data
type
Adapters This is a JSON string that can be use to read or update the network adapters parameters string
Parameters
Gateway Gateway address of the main Ethernet interface of device string
read
only
IP Address IP address of the main Ethernet interface of device string
read
only
Mac ID MAC ID of the main Ethernet interface of device string
Data
type
read
only
Status Contains the result of the last operation required by writing inside the Adapter Parameters. string
It is updated after each write operation.
read
l Empty string is meaning no errors only
l Last error descriptions
Subnet Mask Subnet Mask of the main Ethernet interface of device string
read
only
Printing variables
Information on printing functions.
Data
type
Completion Percentage of completion of current print job. read only

percentage
Range: 0–100
Current disk usage Folder size in bytes where PDF reports are stored. read only
If Flash has been selected as Spool media type, this value corresponds to
reportspool.
Current job Name of the report the job is processing. Current job is the following: read only
l [report name] for a Graphic Report

l [first line of text] for a Text Report
Current RAM usage Size in bytes of the RAM used to process the current job read only
Disk quota Maximum size in bytes of the folder where PDF reports are stored read only
Graphic job queue Number of available graphic jobs in the printing queue read only
size
Last error message Description of the last returned error string
read only
RAM quota Maximum size in bytes of the RAM used to generate reports read only
Status Printing system status. string
Values: read only
l idle
Remote Client variables
Data
type
l error
l paused
l printing
Text job queue size Number of available text jobs in the printing queue read only
Remote Client variables

On remote clients, the below system variable can be used to know if the server (HMI device) is reachable.
Connection status 0 = client can not reach the server client. The connection int (32 bit)
with server is lost.
read only
1 = client can reach the server. The connection with
server is active.
This is only a client side variable. On HMI

Runtime or PB610 PC Runtime it will be
always 0.
The following system variables are associated to the transferring files to a remote HMI device.
Download from HMI error message Error description ASCII string
read only
Download from HMI percentage Download progress (0→100) read only
Download from HMI status 0 = idle, action is not in use or completed int (32 bit)
1= file download in progress read only
2 = error
Upload to HMI error message Error description ASCII string
read only
Upload to HMI percentage Upload progress (0→100) read only
Upload to HMI status 0 = idle, action is not in use or completed int (32 bit)
1= file upload in progress read only
2 = error
Version variables
Operating System and runtime version.
Main OS Version Version of Main OS. string
Runtime Version Version of runtime. string
Screen variables
Screen status.
Time remaining to unlock Time remaining to unlock screen (see LockScreen action, "Page actions" on page 146)
X Screen resolution Display horizontal screen size in pixel
Y Screen resolution Display vertical screen size in pixel
SD card variables
Information on the external SD card.
SD Card FreeSpace Available space on card in bytes uint64
read only
SD Card Name Name of SD card string
read only
SD Card Size Size in bytes of the card plugged in the slot uint64
read only
SD Card Status 0 = SD card unplugged int

1 = SD card plugged
read only
Server variables
Server status.
Important: All variables refer to server, not to HMI Client.
Time variables
Data
type
Current page Name of current page string
Current project Name of current project string
Operating mode Seconds elapsed since device started operating mode uint64
time
Project load time Date when the project was loaded on the HMI Runtime as in System Date format uint64
(milliseconds).
Time variables
System time expressed in UTC format.
Day Of Month Range: 1–31 int
Day of Week Range: 0 = Sunday, .. , 6 = Saturday int
Hour Range: 0–23 int
Minute Range: 0–59 int
Month Range: 1–12 int
Second Range: 0–59 int
System Time The same as UTC time. It can also be set as date/time for this variable. unsignedInt
Year Current Year int
Touch screen variables

Cursor status and position on the touchscreen. These are properties of the active page and can be selected in the Widget
section.
Note: Page size can be different than HMI device display size.
Variable Description Java Script
Page Cursor position related to page page.primaryTouch.x

Touch
page.primaryTouch.y
X
Page
Touch
Y
Screen Cursor position related touchscreen page.primaryTouch.screenX

Touch
page.primaryTouch.screenY
X
Screen
Touch
Y
Touch 0 = screen not pressed page.primaryTouch.pressed

Press
1 = screen pressed
Touch Generic touch screen changes. This variable contains the concatenation of page.primaryTouchStatus
Status Screen Touch X, Screen Touch Y and Touch Press values (for example,
“924,129,0”).
The main usage of this variable is to trigger an event, using the OnDataUpdate
feature, when something (x, y or click) is changed.
USB drive variables

Information on the external USB drive connected to the device.
User management variables
USB Drive free space Available space in bytes uint64
read only
USB Drive Name Name of USB device string
read only
USB Drive Size Size in bytes of the device plugged in the USB port uint64
read only
USB Drive Status 0 = USB Drive unplugged int

1 = USB Drive plugged
read only
User management variables

Information on users and groups.
Data
type
This Client User- Name of the user logged to the client where the system variable is displayed. string
Name
read
only
This Client Group- Group of currently logged user string

Name
read
only
This Client ID Only for HMI Clients. Local and remote clients connected to the same server (for short
example, runtime) get a unique ID.
read
only
No of Remote- Number of HMI Clients connected to the server short

Clients Alive
read
only
JavaScript
From JavaScript, the variables can be accessed as properties of the _SysPropMgr object.
Example:
var sysVar = project.getWidget( "_SysPropMgr" );
var UserName = sysVar.getProperty("This Client User-Name");

var UserGroup = sysVar.getProperty("This Client Group-Name");
var clientId = sysVar.getProperty("This Client ID");
var numClients = sysVar.getProperty("No of Remote-Clients Alive");
10 System Variables (Protocol)
System Variables communication driver allows to create Tags that point to system information.
System Variables communication driver is not counted as physical protocol.

Refer to Table of functions and limits from main manual in "Number of physical protocols" line.
Protocol Editor Settings 110
Tag Import 110
Default variables 112
Retentive Memory variables 126
Services variables 132
Protocol Editor Settings

Adding a protocol
To configure the protocol:
1. In Config node double-click Protocols.

2. To add a driver, click +: a new line is added.
3. Select the protocol from the PLC list.
The protocol configuration dialog is displayed.
From PLC Model list select the specific System Variables type.
Tag Import
Select the driver in Tag Editor and click on the Import Tags button to start the importer.
The system will require a generic XML file exported from Tag Editor by appropriate button.
Once the importer has been selected, locate the symbol file and click Open.
Tags included in the symbol file are listed in the tag dictionary. The tag dictionary is displayed at the bottom of the screen.
Toolbar item Description
Import Tag(s).
Select tags to be imported and click on this icon to add tags

from tag dictionary to the project
Update Tag(s).
Click on this icon to update the tags in the project, due a new
dictionary import.
Default variables
Check this box to import all sub-elements of a tag.
Example of both checked and unchecked result:
Searches tags in the dictionary basing on filter combo-box

item selected.
Default variables
System Variables - Default protocol allows to create Tags that point to HMI system variables regarding:
l Alarms
l Buzzer
l Communication
l Database
l Daylight Saving Time
l Device
l Dump information
l Network
l Screen
l SD Card
l Server
l Time
l USB Drive
l Version
l Virtual Com Switch

From PLC Model list of Protocol Editor dialog, select Default.
Tag Editor Settings

Path: ProjectView> Config > double-click Tags
1. To add a tag, click +: a new line is added.

2. Select System Variables from the Driver list: tag definition dialog is displayed.
Default variables
Element Description
Memory Type Represents the system variable to which the Tag refers to.
The below section shows the full list of possible system variables, grouped by category.
Alarms Variables
Variable Name Description Data Type
Alarm not True when alarms unacknowledged is pending boolean

acknowledged
(Not Triggered Not Acknowledged<>0) OR read only
(Triggered Not Acknowledged<>0)
Alarm triggered True when at least one alarm is triggered boolean
(Triggered Acknowledged<>0) OR (Triggered read only

<>0) OR (Triggered Not Acknowledged<>0)
Number of missed Alarms exceeding the event queue. Queue int

alarm events length is defined in the engineconfig.xml file.
read only
Number of not Alarm condition no longer active; alarms already int

triggered acknowledged
read only
acknowledged
Number of not Alarm condition no longer active; awaiting int

triggered not acknowledgment
read only
acknowledged
Number of triggered Alarm condition active; alarms already int

acknowledged acknowledged
read only
Number of triggered Alarm active: acknowledgment not required int

alarms
read only
Number of triggered Alarm condition active; awaiting int

not acknowledged acknowledgment
read only
Element Description
Buzzer Variables
Buzzer Setup 0 = disabled int
1 = enabled (buzzer sounds as audible on any

touchscreen event)
2 = buzzer status controlled by Buzzer Control

system variable or by Buzzer on Touch property
inside the "Project properties" of main manual
Buzzer on touchscreen (Setup=1)

is not available on Linux
platforms. See "Buzzer on Touch"
property in alternative.
Buzzer Control 0 = buzzer off int
1 = buzzer on
2 = buzzer blink
Buzzer Off Time Duration in milliseconds of off time when blink int
has been selected. Default = 1000. Range:
100–5000
Buzzer On Time Duration in milliseconds of on time when blink int

has been selected. Default = 1000. Range:
100–5000
Default variables
Element Description
Communication Variables
Protocol Summarize the status of the communication int

Communication protocols.
read only
Status
0 = No protocol running, protocol drivers might
not have been properly downloaded to the HMI
device
1 = Protocols loaded and started, no

communication error
2 = At least one communication protocol is

reporting an error
Protocol Error Communication error with error source. string

Message
For example: "[xxxx]" where "xxxx" is the read only
protocol abbreviation, the error source.
Multiple acronyms appear in case of multiple

error sources. Blank when no errors are
reported.
Protocol Error Count Number of communication errors occurred since int

last reset. Reset value with Reset Protocol
read only
Error Count action, see "System actions" of
main manual
Database Variables
Database link error Last detected error description string

message
read only
Database link status 0 = Undefined (not yet initialized) int
1 = OnLine (ready) read only
2 = OffLine (not available)
3 = Transfer in progress
4 = Error
Database link error Errors counter. Increased after each error int
count
read only
Element Description
Each database variable is an array where index select the database link
connection (Range 1-10)
Variables are updated only when any database connector action is executed
Daylight Saving Time Variables
Standard Offset Offset in minutes when standard time is set, int

with respect to GMT (for example: -8x60 = -480
read only
minutes)
Standard Week Week in which the standard time starts (for int
example: First = 1)
read only
Standard Month Month in which the standard time starts. Range: int
0–11. (for example: November = 10)
read only
Standard Day Day of week in which the standard time starts int
(for example: Sunday = 0)
read only
Standard Hour Hour in which the standard time starts (for int
example: 02 = 2)
read only
Standard Minute Minute in which the standard time starts (for int
example: 00 = 0)
read only
DST Offset Offset in minutes when DLS time is set, with int
respect to GMT
read only
DST Week Week in which the DLS time starts int
read only
DST Month Month in which the DLS time starts. Range: 0– int
11
read only
DST Day Day of week in which the DLS time starts int
read only
DST Hour Hour in which the DLS time starts int
read only
DST Minute Minute in which the DLS time starts int
read only
Default variables
Element Description
All variables are read only: they cannot be used to update the system clock.
Device Variables
Available System Free available RAM memory in bytes uint64

Memory
read only
Backlight Time Activation time in hours of the display backlight unsignedInt

since production of the device
read only
Battery LED Enables/disables the low battery LED indicator int

(when available)
0 = disabled
1 = enabled
Not available on Linux platforms (find

the platform of your device at "HMI
Battery Timeout Reserved int
Not available on Linux platforms (find

the platform of your device at "HMI
Display Brightness Returns and adjusts brightness level. int
When set to a low light level (0..3), the backlight

stays lit to a higher level for 8 seconds to allow
the user to make the adjustments and then is
switched-off.
Even when set to 0, the backlight is still on and

the Backlight Time counter increases. Range:
0–255
External Timeout Non-operational time after which the display int

backlight is automatically turned off. The
backlight is automatically turned on when the
user touches the screen
-1 = Switch off backlight and disable touch

(switch display off). Backlight Time counter is
stopped.
Element Description
Device Variables
On Linux devices requires BSP

v1.0.324 or higher.
-2 = Switch off backlight but not disable touch. If

touch is pressed, event is not passed to
applications but screen saver exit and backlight
return on.
Available only on Linux devices.

Requires BSP v1.0.324 or higher.
0 = Switch backlight on (switch display on)
1..n = Timeout, in seconds, for switch off

backlight (screen saver timer)
The timeout value is rounded to

multiples of one minute (60, 120, 180,
etc,) in all Linux devices.
Find the platform of your device at "HMI devices

capabilities" on page 499
Flash Free Space Free space left in internal Flash memory uint64
read only
Manufacturer Code Code number that identifies the HMI short
read only
System RAM Usage Current RAM memory used from HMI, uint64

expressed in byte
read only
System Font List List of system fonts string
read only
System Mode Runtime operation status int
1 = booting
2 = configuration mode
3 = operating mode
4 = restart
Default variables
Element Description
Device Variables
5 = shutdown
System UpTime Time the system has been powered since unsignedInt
production of the unit (hours)
read only
Dump information Variables
Dump Error Message Return error message if any error occurs during string
the dump operation
read only
Dump Archive Status 0 = initial default state int

read only
Dump Recipe Status 0 = initial default state int

read only
Dump Trend Status 0 = initial default state int

read only
Reset Recipe Status 0 = initial default state int

read only
Restore Recipe 0 = initial default state int

Status 1 = operation triggered
read only
Element Description
Network Variables0
Gateway Gateway address of the main Ethernet interface string

of HMI
read only
IP Address IP address of the main Ethernet interface of string

HMI
read only
Mac ID MAC ID of the main Ethernet interface of HMI string
read only
Network Adapter JSON string that can be use to read or update string
Parameters the network adapters parameters
Network Status Contains the result of the last operation required string
by writing inside the Adapter Parameters. It is
read only
updated after each write operation.
l Empty string is meaning no errors

l Last error descriptions
Subnet Mask Subnet Mask of the main Ethernet interface of string

HMI
read only
Screen Variables
X Screen resolution Display horizontal screen size in pixel int
read only
Y Screen resolution Display vertical screen size in pixel int
read only
Default variables
Element Description
SD Card Variables
SD Card FreeSpace Available space on card in bytes uint64
read only
SD Card Name Name of SD card string
read only
SD Card Size Size in bytes of the card plugged in the slot uint64
read only
SD Card Status 0 = SD card unplugged int
1 = SD card plugged read only
Server Variables
Page name Name of current page string
read only
Current project Name of current project string
read only
Project load time Date when the project was loaded on the HMI uint64
Runtime as in System Date format
read only
(milliseconds)
Last operating mode Seconds elapsed since device started operating uint64
start time mode
read only
All variables refer to server, not to HMI Client.
Element Description
Time Variables
Day Of Month Range: 1–31 int
Day of Week Range: 0 = Sunday, .. , 6 = Saturday int
Hour Range: 0–23 int
Minute Range: 0–59 int
Month Range: 1–12 int
Second Range: 0–59 int
System Time The same as UTC time. It can also be set as unsignedInt
date/time for this variable
Year Current Year int
System time expressed in UTC format
USB Drive Variables
USB Drive FreeSpace Available space in bytes uint64
read only
USB Drive Name Name of USB device string
read only
USB Drive Size Size in bytes of the device plugged in the USB uint64
port
read only
USB Drive Status 0 = USB Drive unplugged int
1 = USB Drive plugged read only
Default variables
Element Description
Version Variables
Main OS version Version of Main OS string
read only
Runtime version Version of Runtime string
read only
Virtual Com Switch Variables
VCS status Provides status of VCS service. unsignedByte
0 = Service enabled read only
1 = Client connected in interleaved mode
2 = Client connected in exclusive mode
3 = Service disabled (default)
VCS disable Provides manual override of VCS service. boolean
0 = VCS service enabled
1 = VCS service disabled (default)
VCS port Provides current listening TCP port on unsignedShort

HMI by VCS service
Data Type Each system variable has a specific data type, described in above tables.
The following table shows the details of any data type used for system variables.
Data Type Memory Space Limits
short 16-bit data -32768 ... 32767
int 32-bit data -2.1e9 ... 2.1e9
unsignedByte 8-bit data 0 ... 255
unsignedShort 16-bit data 0 ... 65535
Element Description
unsignedInt 32-bit data 0 ... 4.2e9
uint64 64-bit data 0 ... 1.8e19
string Array of elements containing character code defined by

selected encoding
Arraysize In case of string Tag, this property represents the maximum number of bytes available in
the string Tag.
Note: number of bytes corresponds to number of string chars if Encoding property is set to
UTF-8 or Latin1 in Tag Editor.
If Encoding property is set to UCS-2BE, UCS-2LE, UTF-16BE or UTF-16LE one char
requires 2 bytes.
Conversion Conversion to be applied to the tag.
Depending on data type selected, the list Allowed shows one or more conversion typs.
Value Description
Inv bits inv: Invert all the bits of the tag.
Example:
1001 → 0110 (in binary format)
9 → 6 (in decimal format)
Negate neg: Set the opposite of tag value.
Example:
25.36 → -25.36
AB -> BA swapnibbles: Swap nibbles in a byte.
Example:
15D4 → 514D (in hexadecimal format)
Retentive Memory variables
Element Description
Value Description
ABCD -> swap2: Swap bytes in a word.

CDAB
Example:
9ACC → CC9A (in hexadecimal format)
ABCDEFGH swap4: Swap bytes in a double word.

->
Example:
GHEFCDAB
32FCFF54 → 54FFFC32 (in hexadecimal format)
ABC...NOP swap8: Swap bytes in a long word.

->
Example:
OPM...DAB
142.366 → -893553517.588905 (in decimal format)
0 10000000110
000111001011101101100100010110100001110010101100000
1
→
1 10000011100
101010100001010001011011011011001011011000010011110
1
(in binary format)
BCD bcd: Separate byte in two nibbles, read them as decimal (from 0
to 9)
Example:
0001 0111 = 23
0001 = 1 (first nibble)
0111 = 7 (second nibble)
Select conversion and click +. The selected item will be added to list Configured.
If more conversions are configured, they will be applied in order (from top to bottom of list
Configured).
Use the arrow buttons to order the configured conversions.

System Variables - Retentive Memory protocol allows to create Tags that point to a memory area whose content is
maintained when HMI is powered off.
The physical support for retentive memory is based on FRAM technology.
Important: Not all HMI devices include FRAM memory. If FRAM memory is not available, persistency
is supported using user memory storage (Flash or hard disk drive). Flash technology has a limitation
in the maximum number of write operations. The use of Flash as storage media for retentive memory
with frequent write operations may damage the memory components. Check HMI device data for
availability of FRAM memory.
Important: Retentive memory is 16 KB flat memory area organized in bytes and accessible through an
offset. Refer to schema below.
Retentive memory vs. recipes storage

Recipe data is saved in flash memory (except forPB610 PC Runtime) while retentive data is saved in a FRAM.
Flash memory is not suitable for a high number of write operations, while FRAM supports a virtually unlimited
number of write operations and should be preferred when frequent write operations are required.

From PLC Model list of Protocol Editor dialog, select Retentive Memory.
Tag Editor Settings


Element Description
Memory Type Fixed to Retentive Memory
Offset Offset address where tag is located. Range: 0-16383
SubIndex This parameter allows resource offset selection based on selected Data Type
Data Type Data Type Memory Space Limits
boolean 1-bit data 0 ... 1
byte 8-bit data -128 ... 127
short 16-bit data -32768 ... 32767
int 32-bit data -2.1e9 ... 2.1e9
Element Description
int64 64-bit data -9.2e18 ... 9.2e18
uint64 64-bit data 0 ... 1.8e19
float IEEE single-precision 32-bit floating 1.17e-38 ... 3.4e38

point type
double IEEE double-precision 64-bit floating 2.2e-308 ... 1.79e308

point type
string Array of elements containing character code defined by selected

encoding
binary Arbitrary binary data
Note: to define arrays. select one of Data Type format followed by square brackets like “byte
[]”, “short[]”…
Arraysize l In case of array tag, this property represents the number of array elements.
l In case of string tag, this property represents the maximum number of bytes available in the
string tag.
Note: number of bytes corresponds to number of string characters if Encoding property is set to UTF-8
or Latin1 in Tag Editor.
If Encoding property is set to UCS-2BE, UCS-2LE, UTF-16BE or UTF-16LE one character requires 2
bytes.
Element Description
Value Description
Example:
Example:
25.36 → -25.36
Example:
ABCD -> CDAB swap2: Swap bytes in a word.
Example:
ABCDEFGH -> swap4: Swap bytes in a double word.

GHEFCDAB
Example:
ABC...NOP -> swap8: Swap bytes in a long word.

OPM...DAB
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
to 9)
Example:
0001 0111 = 23
Element Description
If more conversions are configured, they will be applied in order (from top to bottom of list Configured).
Cleaning Retentive Memory

Use the ClearRetentiveMemory action to clear the content of the retentive memory.
Tip: Use this action to set the memory content to a known status at any time.
See Actions > Tag Actions section of main manual for more details.
JavaScript interface for this action is:

project.clearRetentiveMemory();
Preserving Retentive Memory at project download

When a project file is downloaded to an HMI, or when the active project is modified, the content of retentive memory is
usually deleted.
If is needed to preserve the content of retentive data at project download or update, select the Keep retentive data on
project update option in the settings tabs of the HMI device.
This setting will be ignored if Delete runtime dynamic files option is selected from Download to Target window.
Services variables
Preserving Retentive Memory in Simulator

Simulator of PB610 Panel Builder 600 supports the retentive memory. To enable retentive memory during project simulation
use the option "Keep retentive data on project simulation" in context menu.
Services variables
Services variables give the possibility to read the status and delivering commands to VNC Server.

Path: ProjectView> Protocols
1. Click + and select System Variables: the System Variables dialog is displayed.
2. Select Services from the PLCModels list.
Tag Editor Settings


VNC status variables are supported only from Linux devices with BSP version 1.0.344 or greater. (See "HMI devices
capabilities" on page 499)
Element Description Data type
VNC Start Write 1 inside this tag to force the VNC server to start. boolean
This is a write only variable, command will executed any time Write Only
you rewrite it.
VNC Stop Write 1 inside this tag to force the VNC server to stop. boolean
you rewrite it.
Services variables
Element Description Data type
VNC Restart Write 1 inside this tag to force the VNC server to restart. boolean
you rewrite it.
VNC State VNC server state int
Read Only
0 IDLE
1 STARTING
10 RUNNING
100 CONNECTING
200 CONNECTED
-1 ERROR
Write Only Variables cannot be read. Be sure to not use the R/W access mode to avoid the read error icon.
11 Actions
Actions are functions used to interact with the system and are normally executed when events are triggered.
Events can be triggered by various widgets, for example on press and on release of a button. Not all actions are available
for all the events of an object.
Actions are linked to widgets in the Event section of the Property pane (Page Editor).
Alarm actions 136
Database actions 137
Event actions 140
MultiLanguage actions 140
Keyboard actions 141
Media Player actions 143
FTP actions 143
Page actions 146
Print actions 153
Recipe actions 154
Remote Client actions 158
System actions 159
Tag actions 170
Trend actions 173
Text Editor actions 177
User management actions 177
Widget actions 180
Alarm actions
Alarm actions
Mainly used to acknowledge or reset alarms.
SelectAllAlarms
Selects all alarms.
Mode TOGGLE
Reverses the select status.
Alarms that are not triggered or have no pending acknowledge or reset requests will never
be selected.
SELECT
Selecting all alarms that are triggered or that have acknowledge or reset request pending
UNSELECT
Unselect all alarms
SelectAlarm
Select a specif alarm.
AlarmID Alarm ID
Selection Flag TRUE

Select the alarm.
Alarms that are not triggered or have no pending acknowledge or reset requests will not
selected.
FALSE
Unselect the alarm.
AckAlarm
Acknowlege a specific alarm or all selected alarms.
AlarmID Specific Alarm ID
SELECTED
All selected alarms
Acknowledges selected alarms.
11 Actions
ResetAlarm
Resets a specific alarm or all selected alarms that are not triggered and acknowledged.
SELECTED
All selected alarms
EnableAlarms
Enable or disable a specific alarm or all selected alarms.
Disabled alarms will not generate alarm events.
SELECTED
All selected alarms
Selection Flag TRUE

Enable the alarm(s).
FALSE
Disable the alarm(s).
Database actions
DBInit
Important: This action is used only once on an empty database. It is not an initialization command to
be called any time the HMI device starts.
Creates the set of tables required by the project. You do not need to use this action if the database already contains the
necessary tables.
Use Custom SQL query parameter to define the pages to be created. Leave empty to generate default table names
Database actions
Tip: Add this command inside a SetUp page of your project, used by authorized personal only when installing the
application for the first time.
JavaScript Interface
project.dbInit(dbLinkName, sqlCustomQuery);
DBWriteTags, DBReadTags
Transfer the values of the selected tags to/from the remote database.
project.dbWriteTags(dbLinkName, sqlCustomQuery, Tags);
project.dbReadTags(dbLinkName, sqlCustomQuery, Tags);
DBWriteGroups, DBReadGroups
Transfer groups of tags between the HMI device and the database.
11 Actions
project.dbWriteGroups(dbLinkName, sqlCustomQuery, Groups);
project.dbReadGroups(dbLinkName, sqlCustomQuery, Groups);
DBWriteTrend
Inserts the values of the last data sampled in the selected range of time inside the Trends table of the remote database.
project.dbWriteTrends(dbLinkName, sqlCustomQuery, trendName, durationIndex)
DBWriteEvents
Inserts the values of the last events in the selected range of time inside the Events table of the remote database.
project.dbWriteEvents (dbLinkName, sqlCustomQuery, archiveName, durationIndex)
DBWriteRecipes, DBReadRecipes
Transfer the recipe data to/from the remote database.
Event actions
project.dbWriteRecipes(dbLinkName, sqlCustomQuery, recipeNames)
project.dbReadRecipes(dbLinkName, sqlCustomQuery, recipeNames)
DBResetErrors
Reset all the three status variables of the selected database link. "Database variables" on page 1.
project.dbResetErrors(dbLinkName)
Event actions
Used by Alarm History widget to scroll events/alarms backward/forward in table view (event buffer widget).
ScrollEventsBackward
Scrolls events/alarms backward in table view (event buffer widget).
ScrollEventsForward
Scrolls events/alarms forward in table view (event buffer widget).
MultiLanguage actions
Selects the application language.
11 Actions
SetLanguage
Sets the language used. The selected language will be applied at runtime to all applicable widgets.
Keyboard actions
Changes the use of keypads.
SendKey
Sends one character to a numeric widget. The KeypadType property of the numeric widget must be set as Macro.
SendKeyWidget
Sends one character to a specific widget.
Example
The Up and Down buttons use the SendKeyWidget action in association with the Control List Widget.
Keyboard actions
ShowKeyPad
Shows the default operating system touch keypad.
Note: might not be supported by all operating systems.
11 Actions
Keyboard
Enables/disables the use of actions when using external keyboards. Action execution can be enabled/disabled both at
project and at page level.
The effect is equivalent to the use of the property Keyboard for project and page.
Media Player actions

Interact with the Media Player widget at runtime.
Action Description
PlayMedia Starts playing the video.
StopMedia Stops the video.
ReloadMedia Restarts video from the beginning.
PauseMedia Pauses the video.
BrowseMedia Selects the video to play.
FTP actions
Used to upload and download files to and from a remote FTP server.
ftpGET
Download files from a remote FTP server
FTP actions
FtpConfig Configuring the FTP parameters
FtpRemoteFileName File name on the remote FTP server to download (source)
FtpLocalFileName File name on local HMI device (destination)
ftpPUT
Upload files to a remote FTP server
FtpConfig Configuring the FTP parameters
FtpLocalFileName File name on local HMI device (source)
FtpRemoteFileName File name on the remote FTP server to download (Destination)
Filenames can contain wildcards.
When transferred, system variables are updated with the status of ongoing operations (see "FTP client variables" on
page 101for details).
FTP Server Configuration

To configure the FTP parameter, enter the following information for the FtpConfig setting:
FTP Address FTP server IP Address
Server Port Port for FTP connection (default = 21).
Authentication Select the FTP authentication to use:
l Normal (Username and password required)

l Anonymous
User Name Username of the remote FTP account
Password Password of the remote FTP account
Click + to add more FTP servers configuration.
Tip: Use tags if you want change the server parameters dynamically from the HMI Runtime.
11 Actions
FTP JavaScript Interface

ftpConfig
ftpCONFIG (IPAddress, Port, Authentication, UserName, Password)
Set the FTP parameters to use on next FTP calls
IPAddress FTP server IP Address.
Port Port for FTP connection (default = 21).

l Anonymous
UserName Username of the remote FTP account
ftpGET
ftpGET (remoteFileName, localFileName, [callback])
Download files from a remote FTP server
remoteFileName File name on the remote FTP server to download (source)
localFileName File name on local HMI device (destination)
callback Function that will be call at the end of the FTP transfer
ftpPUT
ftpPUT (remoteFileName, localFileName, [callback])
Upload files to a remote FTP server
remoteFileName File name on the remote FTP server to download (source)
localFileName File name on local HMI device (destination)
callback Function that will be call at the end of the FTP transfer
Example:
project.ftpCONFIG("192.168.0.200", "21", "true", "admin", "admin");
Page actions
project.ftpGET( "data.txt",
"\\USBMemory\\data.txt",
function(ftpStatus) {fnFtpGetFinished(ftpStatus);} );
function fnFtpGetFinished(ftpStatus) {
alert(ftpStatus);
}
Page actions
Page navigation. Page actions can be used with the following events:
l OnMouseClick,
l OnMouseRelease,
l OnMouseHold
l OnActivate
l OnDeactivate
l Alarms
l Schedulers.
LoadPage
Go to the selected page of the project.
HomePage
Go to the home page.
You can set the home page in the Behavior section of the Project Widget, see "Project" on page 76
PrevPage
Go to the previous page.
NextPage
Go to the next page.
LastVisitedPage
Go to the previously displayed page
ShowDialog
Opens a dialog page defined in the project.
11 Actions
CloseDialog
Close dialog pages.
Note: This action is applicable only to dialog pages.
CloseDialog options
Option Description
All Closes all open dialogs
Selected Closes only active dialog
DialogName Closes dialog specified as fileName property
project.closeDialog(DialogID);
Page actions
Where DialogID:
All Closes all open dialogs
Selected Closes only active dialog
DialogName.jmx Closes dialog specified as fileName parameter
Examples
Example Behavior
project.closeDialog("All"); All open dialogs are closed
project.closeDialog("Selected"); The selected dialog is closed
project.closeDialog("Dialog1.jmx"); All instances of Dialog1 are closed
The function project.closeDialog(); without parameter works as project.closeDialog("Selected");.
ShowMessage
Displays a popup message. Enter the text of the message to be displayed.
LaunchApplication
Launches an external application.
App Name Executable name with extension (for example, "notepad.exe" to run Notepad)
Path Application path.
Arguments Application specific arguments (for example, \flash\qthmi\Manual.pdf to open the

document “Manual.pdf”)
Single Instance Argument to start the application in a single instance or multiple instances.
When single instance is selected, the system first verifies whether the application is
already running; if so, then the application is brought to the foreground, if not, then
the application is launched.
FlushRuntimeCache Flush all runtimes cache to free as more ram as possible before running the
application.
Note: Arguments with spaces must be quoted (for example, "\Storage Card\Manual.pdf")
Example:
11 Actions
LaunchBrowser
Opens the default web browser. You can define URL address as argument.
Note: Only works on platforms having a native web browser (for example, on Windows CE PRO with Internet
Explorer enabled).
LaunchVNC
Starts VNC server and opens the configuration.
Macro available only for HMI devices based on Windows CE platform.

On HMI devices based on Linux platform the VNC service can be enabled from the "Service" tab of the "Linux
Devices" on page 504 BSP v1.0.44 or higher required.
See "Plug-in" on page 75 to include it on Windows CE devices.
LaunchPDFViewer
Starts PDF Viewer.
On WCE devices, only works on devices that include PDF Viewer. See "Plug-in" on page 75 to include it on
Windows CE devices.
On Linux devices, BSP v1.00.44 or greater is required.
Note that the pathname of the arguments field uses native OS format (see "HMI devices capabilities" on page 499).
On WinCE devices, the HMI application is installed on path \Flash\QTHMI\ and pathname's syntax use the backslash
character.
Page actions
On Linux devices, the HMI application is installed on path /mnt/data/hmi/qthmi/deploy/ and pathname's syntax use the
slash character.
11 Actions
-hide-open-button (available only on Linux devices)
Using this option, the icon to open a different file will be removed from the PDF toolbar (to restrict navigation to PDF file
already opened and passed via command line).
LaunchUpdater
Updates project and runtime from an external device.
Page actions
Use Path parameter to specify the folder that will contain the update package file. Leave the path parameter empty if you
prefer select the file manually on the HMI device when the macro is invoked.
When the LaunchUpdater macro is executed, the below dialog is showed on HMI device
Note: Not supported in devices based on Windows platform.
project.launchUpdater(strPath)
Examples
project.launchUpdater("\\USBMemory")
LockScreen
Temporarily locks the touch screen. Allows cleaning the touch screen.
The system variable Time remaining to unlock displays the time remaining to unlock.See "Screen variables" on
page 105
LoadProject
Unload current project and load the selected project inside the HMI device.
The project name has to be specified using relative path, as for the below example:
LastVisitedProject
Unload current project and return to previous project
11 Actions
Print actions
Manages print tasks.
PrintGraphicReport
Prints a graphic report.
reportName Assigns a name to the report
silent false = allows to set printer properties at runtime
fileName File name (available only for PDF reports)
Supported placeholders:
l %n = Report name
l %p = Project name
l %y = Year, %M = Month, %d = Day
l %h = Hour, %m = Minutes, %s = Seconds.
folderPath Folder Path (available only for PDF reports)
Note that the pathname of the arguments field uses native OS format (see "HMI devices
capabilities" on page 499).
l On WinCE devices
Path for USB Device is "\USBMemory"
l On Linux devices
Path for USB Device is "/mnt/usbmemory"
"testFolder" will be inside "/mnt/data/hmi/qthmi/deploy/testFolder"
PrintText
Prints a string.
text String to be printed
This action works in line printing mode and uses a standard protocol common to all printers that support it. Text is printed
immediately line by line or after a timeout custom for each printer model.
Note: printing could a few minutes for models not designed for line printing.
Not available on Linux platforms (find the platform of your device at "HMI devices capabilities" on page 499)
Recipe actions
PrintBytes
Prints an hexadecimal string representing data to print (for example, "1b30" to print < ESC 0 >.
bytes Exadecimal string to print
This action works in line printing mode and uses a standard protocol common to all printers that support it. Text is printed
immediately line by line or after a timeout custom for each printer model.
Note: printing could a few minutes for models not designed for line printing.
EmptyPrintQueue
Flushes the current printing queue. If executed while executing a job, the queue is cleared at the end of the job.
PausePrinting
Puts the current printing queue on hold. If executed while executing a job, the queue is paused at the end of the job.
ResumePrinting
Restarts a queue previously put on hold.
AbortPrinting
Stop the execution of the current job and removes it from the queue. If the queue has another job, then, after aborting, the
next job starts.
Recipe actions
Used to program recipe management.
DownLoadRecipe
Copy recipe data from HMI device flash memory to the controller (e.g. PLC, local variable, depending on the protocol).
RecipeName Name of recipe to download
RecipeSet Number of recipe set to copy.
curSet = download currently selected recipe set
11 Actions
UpLoadRecipe
Saves recipe data from the controller (e.g. PLC, local variable, depending on the protocol) to the device Flash Memory.
RecipeName Name of recipe to upload
RecipeSet Number of recipe set to copy.
curSet = upload currently selected recipe set
WriteCurrentRecipeSet
Sets the selected recipe as current recipe set.
RecipeName Name of recipe to set as current recipe
RecipeSet Recipe set to define as current recipe set
DownLoadCurRecipe
Downloads current set of recipe data to the controller.
No parameter is required.
UploadCurRecipe
Uploads set of controller data to current recipe set.
No parameter is required
ResetRecipe
Restores factory settings for recipe data. Original recipe data will overwrite uploaded recipes
Select the recipe that you want to reset to factory data.
DumpRecipeData
Dumps recipe data to internal or external storage. Data is saved in .csv format.
RecipeName Name of recipe to dump
FilePath Destination folder
l Internal = \Flash\QTHMI\workspace\Dump
l USB drive = \USBMemory
l SD Card = \Storage Card
l Public Network = \\<hostname or IP>\sharePath
Recipe actions
l Private Network = \\<username>:<password>@<hostname or IP>\sharePath
Note: supported formats for external memory are FAT or FAT32 (NTFS format is
not supported).
Note: Private networks are supported only from Linux devices with BSP 1.0.25
and above.
FileName Tag that specifies a filename.
The below wildcards are supported
l %r = Recipe name
l %d = Dataset name
Example: %r_%d
DateTimePrefixFileName true = the dumped file will have date and time as prefix to its name (for example D2012_01_
01_T10_10_recipe1.csv)
TimeSpec Time format:
l Local = the time values exported are the time of the HMI device.
l Global = the time values exported are in UTC format.
RestoreRecipeData
Restores previously saved recipe data.
RecipeName Recipes to restore:
l AllRecipes
Data of all recipes will replaced with the data read from the external file
l CurrentRecipe
Only the data of the current selected recipe will replaced with the data read from the external file
RecipeDataSet Available only when RecipeName=CurrentRecipe.
Select the data sets to restore:
l AllRecipeDataSet
All data set will restored
l curSet
Only the data set of the current selected data set will restore
Restore Type Available only when RecipeDataSet=AllRecipeDataSet.
This parameter define the behavior when the numbers of data sets inside the file to restore is not
matching with the data set number inside the HMI device
11 Actions
l Replace
All data sets that are inside the device are removed and replaced with the data sets from the
csv file
l Match
Replace only the data set inside the device that have the same data set id
l MatchAndAdd
Replace the data set inside the device that have the same data set id and add the additional
data set found inside the csv file (Note: data sets that are inside the device but not inside the
csv file are not removed from the device)
FilePath Source folder
Note: supported formats for external memory are FAT or FAT32 (NTFS format is not
supported).
Note: Private networks are supported only from Linux devices with BSP 1.0.25 and above.
FileName Attached tag from which read the file name at runtime.
BrowseForFile true = shows the Open dialog to browse the file to read.
false = no dialog is shown,
AddRecipeDataSet
Adds a new dataset to the selected recipe. The new dataset is appended at the end of the already defined datasets.
Remote Client actions
RecipeName Recipe where the dataset is added.
CopyFrom Dataset from where parameters values are copied from to initialize the new dataset
NewSetName Name of new dataset.
Here you can you can use a tag reference.
DelRecipeDataSet
Deletes a dataset from the selected recipe. Deleting a dataset will rearrange the position number of the datasets that
follow.
RecipeName Recipe where the dataset is to be deleted.
DataSet Dataset to be deleted.
Remote Client actions

Used to upload and download files to and from a remote HMI device. These actions can only be used from a remote HMI
Client to access remote files via FTP.
Important: Enable FTP support and give all necessary user rights to the folders used to transfer files.
UploadToHMI
Opens a file Open dialog to select a file to be uploaded to the remote HMI device.
11 Actions
Destination Destination path on HMI device for file upload
Filter File extensions of the files to be displayed separated by commas (for example, *.txt)
DownloadFromHMI
Opens a file Open dialog to select a file to be downloaded from the remote HMI device.
Note: Only files matching the set filter are displayed and can be downloaded.
Source Source path on the HMI device for file download
Filter File extensions of the files to be displayed separated by commas (for example, *.txt)
boolean project.uploadToHMI(dirPath, strFilter);
boolean project.downloadFromHMI(dirPath, strFilter);
dirPath Source path on the HMI device for file download/upload
strFilter File extensions of the files to be displayed separated by commas (for example, *.txt)
Return values:
True Transfer successful
False Transfer failed
Note: When transferred, system variables are updated with the status of ongoing operations.
System actions
Used to manage system properties.
Restart
Restarts the runtime.
System actions
DumpTrend
Stores historical trend data to external drives (USB drive or SD card).
TrendName Name of historical trend to store
FolderPath Destination folder:
Note: supported formats for external memory are FAT or FAT32 (NTFS format is not
supported).
Note: Private networks are supported only from Linux devices with BSP 1.0.25 and above.
FileFormat Binary = the buffer is dumped in binary format (a .dat file and .inf file). Both these files are then
required to convert data in .csv format by an external utility.
Compatibility CSV = the buffer is dumped to the specified location as a .csv file format compatible
with versions 1.xx
Compact CSV = the buffer is dumped to the specified location as a .csv file using a newer format
See "Exporting trend buffer data" on page 226
DateTimePrefix true = the dumped file will have date and time as prefix to its name (for example D2012_01_01_T10_
10_Trend1.csv)
FileName Enabled when the DateTimePrefixFileName=true
The below wildcards are supported
l %n = Trend name
l %y = Year
l %M = Month
l %d = Day
l %h = Hour
l %m = Minutes
l %s = Seconds
Example: \%n\%y%M%d\%h%m%s
11 Actions
Additional parameters available only when the selected FileFormat is Compact CSV
When both “Select Fields” and “Select Curves” parameters are empty, the .csv file is dumped in the old
“Compact CSV” without columns' selection format. See also "Exporting trend buffer data" on page 226
Select Select the columns to export inside the dumped file.

Fields
Available columns are:
l Date and Time

l Date
l Time
l Value
l Quality
Note that "Attach to tag" can be used to define columns to be exported at the runtime from the HMI
application. The tag must contain a string with the list of fields to be exported separated by commas.
Example:
l "" (Empty string = all available fields)

l "DateTime,Value,Quality"
l "Date,Time,Value"
Select Select the curves to export inside the dumped file

Curves
Note that "Attach to tag" can be used to define curves to be exported at the runtime from the HMI
application. The tag must contains a string with the list of curve names to be exported separated by
commas.
Example:
l Empty string or "All curves" will export all datasets

l "Name1,Name2,Name3"
l "Name1,Name3"
Date Select the Date and Time format

Format
Using "Attach to tag" is possible define the date format at runtime through a string
Date Placeholder
d The day as number without a leading zero (1 to 31)
dd The day as number with a leading zero (01 to 31)
ddd The abbreviated localized day name (e.g. 'Mon' to 'Sun')
dddd The long localized day name (e.g. 'Monday' to 'Sunday').
M The month as number without a leading zero (1-12)
System actions
Date Placeholder
MM The month as number with a leading zero (01-12)
MMM The abbreviated localized month name (e.g. 'Jan' to 'Dec').
MMMM The long localized month name (e.g. 'January' to

'December').
yy The year as two digit number (00-99)
yyyy The year as four digit number
Time Placeholder
h The hour without a leading zero (0 to 23 or 1 to 12 if AM/PM

display)
hh The hour with a leading zero (00 to 23 or 01 to 12 if AM/PM

display)
m The minute without a leading zero (0 to 59)
mm The minute with a leading zero (00 to 59)
s The second without a leading zero (0 to 59)
ss The second with a leading zero (00 to 59)
zzz The millisecond with leading zero
z The millisecond
AP Use AM/PM display. AP will be replaced by either "AM" or

"PM".
ap Use am/pm display. ap will be replaced by either "am" or

"pm".
Language Select the language to use.
Note: execution of the DumpTrend action will automatically force a flush to disk of the data temporarily
maintained in the RAM memory. See "History trends" on page 229 for details on how to save sampled data to
disk.
Note: external drives connected to USB port must have format FAT or FAT32. NTFS format is not supported.
WARNING: Be aware there are limits in the max number of files that can create inside a folder. Limits
are depending of different factors and are not simple to calculate, you can think as 999 the max
number of files that can be use inside a folder.
11 Actions
To convert binary dump files to .csv

The TrendBufferReader.exe tool is stored in the Utils folder of the PB610 Panel Builder 600 installation folder.
Use the following syntax:

TrendBufferReader -r Trend1 Trend1.csv 1
where:
Trend1 = name of the trend buffer without extension resulting from the dump (original file name is trend1.dat)
Trend1.csv = name for the output file.
WARNING: The TrendBufferReader.exe is an old utility that not work with the new multi tags buffers.
Using of this utility is not recommendable. The utility is not more maintenanced because now there is
the possibility to dump trend buffer directly in .csv format.
.csv file structure

The resulting .csv file has five columns
Column Description
Data Type Data type of sampled tag:
0 = empty
1 = boolean
2 = byte
3 = short
4 = int
5 = unsignedByte
6 = unsignedShort
7 = unsignedInt
8 = float
9 = double
Value Value of the sample
Timestamp Timestamp in UTC format

(UTC)
Sampling Sampling interval time in milliseconds

Time(ms)
Quality Tag value quality. Information coded according the OPC DA standard and stored in a byte data (8 bits)
defined in the form of three bit fields; Quality, Sub status and Limit status.
The eight quality bits are arranged as follows: QQSSSSLL. For a complete and detailed description of all
the single fields, please refer to the OPC DA official documentation.
System actions
Commonly quality values

The most commonly used quality values returned by the HMI acquisition engine are:
Quality
Quality Description
Code
0 BAD The value is bad but no specific reason is given
4 BAD Specific server problem with the configuration. For example, the tag has been
deleted from the configuration file (tags.xml).
8 BAD No value may be available at this time, for example the value has not been
provided by the data source.
12 BAD Device failure detected
16 BAD Timeout before device response.
24 BAD Communication failure
28 BAD No data found for upper or lower bound value Trend interface specific flag.
32 BAD No data collected (for example, archiving not active.
Trend interface specific flag.
This value is also used to indicate a temporary offline status (for any condition
where sampling was stopped).
64 UNCERTAIN No specific reason.
The value has ‘pegged’ at some lower limit.
The value has ‘pegged’ at some higher limit.
The value is a constant and cannot move.
84 UNCERTAIN Returned value outside its defined limits defined.
In this case the Limits field indicates which limit has been exceeded but the
value can move farther out of this range.
The value has ‘pegged’ at some lower limit.
11 Actions
Quality
Quality Description
Code
The value has ‘pegged’ at some higher limit
The value is a constant and cannot move.
192 GOOD -
DeleteTrend
Deletes saved trend data.
Define the name of the trend from which you want to delete logs.
DumpEventArchive
Stores historical alarm log and audit trail data to external drives, such as USB memory or SD card.
EventArchive Name of buffer to dump data
FolderPath Destination folder
Note: supported formats for external memory are FAT or FAT32 (NTFS
format is not supported).
Note: Private networks are supported only from Linux devices with BSP
1.0.25 and above.
DumpConfigFile Dump the description files of the archives
DumpAsCSV true = the buffer is dumped to the specified location as a .csv file
false = the buffer is dumped in binary format (a .dat file and .inf file). Both these files are
then required to convert data in .csv format by an external utility.
DateTimePrefix true = the dumped file will have date and time as prefix to its name (for example D2012_
01_01_T10_10_alarmBuffer1.csv)
timeSpec Time format:
System actions
csv Colums Select the columns to dump into the .csv file.
Available only when the EventArchive is an alarms buffer
FileName The below wildcards are supported
l %n = Event archive name

l %y = Year
l %M = Month
l %d = Day
l %h = Hour
l %m = Minutes
l %s = Seconds
Available only when the DateTimePrefixFileName=true
Language Select the language to use.
Available only when the EventArchive is an alarms buffer
Dumping in CSV Format

DumpAsCSV = true
For Alarms buffers, the additional "csv Colums" parameter give the possibility to select the columns to export inside the
.csv file
Note: available only for Alarms buffers.
11 Actions
Dumping in BINARY Format

DumpAsCSV = false
When exporting Event buffers in binary format and DumpConfigFile is set to true (recommended settings), there are two
folders:
l data, containing data files,

l config, containing configuration files for .csv conversion.
Once the two folders are copied from the USB drive to the computer disk, the folder structure will be:
\config\
alarms.xml
eventconfig.xml
\data\
AlarmBuffer1.dat
AlarmBuffer1.inf
AlarmBufferReader.exe
To convert dump files to .csv

The AlarmBufferReader.exe tool is stored in the Utils folder of the PB610 Panel Builder 600 installation folder.
AlarmBufferReader AlarmBuffer1 FILE ./AlarmBuffer1.csv
where:
System actions
l AlarmBuffer1 = name of the dumped .dat without extension

l AlarmBuffer1.csv = name for the output file.
The utility AuditTrailBufferReader.exe is available for Audit Trail buffers.
AuditTrailBufferReader AuditTrail FILE ./AuditTrail.csv
where:
l AuditTrail = name of the dumped buffer without extension and

l AuditTrail1.csv = name for the output file.
DeleteEventArchive
Deletes saved Event buffers log data.
Specify the name of Event buffer to delete from the Event logs.
ResetProtoErrCount
Resets the Protocol Error Count system variable.
See "System Variables (Attach To)" on page 95 for details.
SafelyRemoveMedia
Provides for safe removal of SD card or USB drive fromHMI.
SaveEventArchive
Save the records located within the audit trail to a signed file. The file signature will ensure that the records within the report
are not altered.
EventArchive Name of buffer to dump data
FolderPath Destination folder
l Private Network = \\<username>:<password>@<hostname or
IP>\sharePath
Note: supported formats for external memory are FAT or FAT32 (NTFS
format is not supported).
11 Actions
Note: Private networks are supported only from Linux devices with BSP
1.0.25 and above.
FileName The below wildcards are supported
l %n = Event archive name

l %y = Year
l %M = Month
l %d = Day
l %h = Hour
l %m = Minutes
l %s = Seconds
Format Format of the output file
l CSV
Signed Generate the file signature.
The algorithm to use to signing is defined inside the project properties

parameters
See "Project" on page 76 for the available algorithms
PeriodMode Defines the time window to export
l All events
l Today
l Yesterday
l Last week
l Last month
l Current week
l Current month
l Custom
The additional parameters "periodFrom" and "periodTo" will be shown
Separate Date and Uses two separate columns for Date and Time
Time
Date Format Select the Date and Time format
Signed file
When the "Signed file" parameter is true, two files will be added in addition to fileame.csv:
Tag actions
l filename.csv.sign
The file signature will ensure that the records within the file filename.csv file have not been altered
l ssl-HMI.crt
A copy of the certificate of the HMI device required to verify the authenticity of the report.
For more information about the certificate and how to verify signed files, see "x.509 Certificate" on page 274.
For more information about the exported information see "Exporting audit trail as .csv files" on page 299.
LogMessage
Add a message into the audit trail buffer.
This macro give the possibility to developer to decide to keep track of some events (e.g. when a button is pressed, when a
page is activate, etc.) into the audit trail. The attach to tag to have the possibility to define the message to log at runtime is
supported.
EventArchive Name of the audit buffer where add the message
Message Message to add inside the audit buffer
DeleteOldFiles
This macros delete files older that a give number of days.
In PC there is no restriction in using path. In panels it is allowed in dynamic media and data partition (/Flash in WinCE and
/mnt/data in Linux )
It will be developer responsibility to configure the application to avoid the possibility to delete system
files.
FolderPath Folder where search the files to delete
FileTypes List of files to delete separate by comma. Wildcard are supported
Example: *.png,*.jpg
OlderDays Minimum number of days without changes
Tag actions
Interacts with tags.
11 Actions
DataTransfer
Exchanges data between:
l two controllers,
l registers within a controller,
l from system variables to controllers,
l from controllers to system variables
The various tag types include a controller tag, a system variable, a recipe tag and widget property.
ToggleBit
Toggles a bit value of a tag.
BitIndex allows you to select the bit to be toggled: toggling requires a read-modify-write operation; the read value is
inverted and then written back to the tag.
SetBit
Sets the selected bit to “1".
BitIndex allows you to select the bit position inside the tag.
ResetBit
Resets the selected bit to “0”
BitIndex allows you to select the bit position inside the tag.
WriteTag
Writes constant values to the controller memory. Specify tag name and value.
StepTag
Increments or decrements tag value.
TagName Name of tag to increase/decrease
Step Step value
Do not step over limit Enables step limit
Step Limit Value of step limit, if enabled.
BiStep
This action is similar to the StepTag action but the direction Increment/Decrement is automatically chosen by the rotation
of the Wheel. Tag value will be increased when the Wheel is rotated clockwise. Tag value will be decreased in when the
Wheel is rotated counterclockwise.
Tag actions
TagName Name of Tag on which execute BiStep Tag action
Step Value to be added/subtracted to Tag at every wheel rotation (depends on Event step property)
Event step This property allows to chose if adding/subtracting step values at every single wheel step, or at
every rotation event.
false = The step value is added/subtracted to the Tag at every rotation event.
Example: rotate the wheel performing 5 wheel steps in a single event, Tag will be
increased/decreased by 1.
true = The step value is added/subtracted to the Tag at every single wheel step.
Example: rotate the wheel performing 5 wheel steps in a single rotation, Tag will be
increased/decreased by 5.
Do not step over If true, enables lower and upper limits, which represents the lower and the higher value that the
limit Tag can assume due a BiStep Tag action
LowerLimit If "Do not step over limit" is true, this property represents the lower value that the Tag can
assume due a BiStep Tag action
UpperLimit If "Do not step over limit" is true, this property represents the higher value that the Tag can
assume due a BiStep Tag action
Available only inside OnWell Actions
ActivateGroup
Forces the update of a group of tags.
Tags are updated either when used in the current page or continuously, if defined as active in the Tag Editor. This action
forces all the tags of a group to be continuously updated.
DeactivateGroup
Deactivates a group of tags, that is stops forcing the update of a group of tags.
EnableNode
Enable/disables action for offline node management. No communication is done with a disabled node.
Protocol ID Unique identifier of selected protocol
NodeID Node identifier in selected protocol. Can be attached to a tag.
Enable Node communication status:
False = disabled
True = enabled
11 Actions
When attached to a tag, tag = 0 means False
BACnetClearPriority
Refer to the BACnet manual inside the “Communication Drivers” folder for a detailed description of BACnet actions.
BACnetClearAllPriorities
BACnetSetPriority
ClearRetentiveMemory
When set to 0, clears the content of the Retentive Memory.
ForceReadTag
Force a refresh of the specified tag from the remote controller.
Trend actions
Used for Live Data Trends and Historical Trends Widget.
RefreshTrend
Refreshes the Trend window.
It can be used in any Trends/Graphs widgets. Specify the widget as a parameter for the action.
ScrollLeftTrend
Scrolls the Trend window to the left side, by one-tenth (1/10) of the page duration.
Note: with the real-time trends pause the trend using the PauseTrend action, or the window will be continuously
shifted to the current value.
ScrollRightTrend
Scrolls the Trend window to the right side, by one-tenth (1/10) of the page duration.
Note: with the real-time trends pause the trend using the PauseTrend action, or the window will be continuously
shifted to the current value.
Trend actions
PageLeftTrend
Scrolls the Trend window by one-page. For example, if the page size is 10 minutes, then use the PageLeftTrend action to
scroll the trend left for 10 minutes.
PageRightTrend
Scrolls the Trend window by one-page. For example, if the page size is 10 minutes, then use the PageRightTrend action
to scroll the trend right for 10 minutes.
PageDurationTrend
Sets the page duration of the Trend window.
Define trend name and page duration.
Note: you can set page duration at runtime using a combo box widget.
ZoomInTrend
Reduces page duration.
ZoomOutTrend
Extends page duration.
ZoomResetTrend
Reset the zoom level back to the original zoom level.
ZoomInYAxisTrend
Reduces Y Axis.
ZoomOutYAxisTrend
Extends Y Axis.
ZoomResetYAxisTrend
Reset the Y Axis zoom level back to the original zoom level.
PauseTrend
Stops plotting the trend curves in the Trend window.
When used with real time trend the plotting stops when the curve reaches the right border of the graph. This action does not
stop trend logging.
ResumeTrend
Resumes trend plotting if paused.
11 Actions
ShowTrendCursor
Shows value of the curve at a given point on the X axis.
It activates the trend cursor. A cursor (vertical line) will be displayed in the trend widget.
When the graphic cursor is enabled, the scrolling of the trend is stopped.
The ScrollCursor action moves the graphic cursor over the curves, or over the entire Trend window.
ScrollTrendCursor
Scrolls the trend cursor backward or forward.
The Y cursor value will display the trend value at the point of the cursor. Scrolling percentage can be set at 1% or 10%. The
percentage is calculated on the trend window duration.
SetTrendView
Use this macro to change the axis ranges of the trend view.
When both Min X=0 and Max X=0, the static values defined inside the properties of widget are used. The same for the Y
axe.
Trend actions
ScrollTrendToTime
Scrolls the Trend window to a specified point in time.
Use this action when you need to scroll to a specific position in a trend window when a specific event occurred.
Example
1. Configure an action for an event (for example, an alarm) that executes a data transfer of the system time into a tag.
2. Select that tag as ScrollTrendtoTime parameter: the trend windows will be centered at the time when the event
was triggered.
ConsumptionMeterPageScroll
Scrolls the page backward or forward in a Consumption Meter widget.
Trend Name Trend widget ID (for example, TrendWindow3)
Page Scroll Direction Direction of page scrolling (Forward/backward)
11 Actions
Text Editor actions

Macros used to interacts with the TextEditor widget.
Reference to "TextEditor widget" on page 404 for details
User management actions

User management and security settings.
LogOut
Logs off the current user. The default user is then automatically logged in. If no default user has been configured, the logon
window is displayed.
SwitchUser
Switches between two users without logging off the logged user: the user login dialog appears. User can click Back to go
back to the previously logged user.
User management actions
The server continues running with the previously logged user, until the next user logs on. One user is always logged onto
the system.
ChangePassword
Change current user password: a dialog appears
ResetPassword
Restores the original password together with the settings specified in the project for the current user.
AddUser
Reserved to users with Can manage other users property set.
Adds a user at runtime: a dialog appears.
DeleteUser
Deletes a user at runtime: a dialog appears.
11 Actions
EditUsers
Edits user settings.
DeleteUMDynamicFile
Deletes the dynamic user management file. Changes made to users settings at runtime are erased. The original settings
are restored from the project information.
ExportUsers
Exports user settings to an .xml file (usermgnt_user.xml) in encrypted format to be restored when needed.
Set destination folder for the export file.
Important: The user file is encrypted and cannot be edited.
Note: supported formats are FAT or FAT32. NTFS format is not supported.
Widget actions
ImportUsers
Imports user settings from a previously saved export .xml file (usermgnt_user.xml).
Set source folder for the import file.
Note: supported formats are FAT or FAT32. NTFS format is not supported.
Widget actions
ShowWidget
Shows or hides page widgets.
Widget Widget to show/hide
SlideWidget
Shows the sliding effect of a widget, or of a widget group.
Note: The widget or grouped widgets can actually be outside of visible part of the page in the project and slide in
and out of view.
Widget Widget to slide
Direction Sliding direction
Speed Transition speed of sliding widget
X Distance Travel distance of X coordinate in pixels
Y Distance Travel distance of Y coordinate in pixels
Slide Limit Enable/Disable movement limits of the widget with respect to the x, y coordinates
X Limit Limit position of slide action for x coordinate
Y Limit Limit position of slide action for y coordinate
Toggle Visibility Show/hide widget at the end of each slide action
Image Widget Image displayed during slide action
BeginDataEntry
Displays a keypad and starts data entry on a data field without touching the widget itself. This action can be used to
activate data entry using a barcode scanner.
11 Actions
Java Script Interface

project.beginDataEntry(wgtName [, pageName])
wgtNameWidget Widget name
pageName Active page for data entry. Optional parameter. Useful to select a data field inside a non-modal
active dialog box.
TriggerIPCamera
Captures an image from an IP Camera. Only works on pages that include an IP Camera widget.
MoveIPCamera
Sends remote commands to a camera that supports them. See "IP Camera widgets" on page 379 for details. Make sure
that the IP Camera supports movement commands.
RefreshEvent
Refreshes the event buffer for Alarm History widget. See "Alarms History widget" on page 209 for details.
ContextMenu
Displays the context menu.
If Context Menu property of Project Widget has been set to On delay context menu can appear also touching for a few
seconds the background area of the screen. See "Project properties" on page 69
ReplaceMedia
Replaces existing media files with new files from USB/SD card. Can be used to replace video files of MediaPlayer
widgets, or images of project.
Note: New media files must have same name and format of the files to be replaced.
Media Type Type of file to update
Device Device where new media files are supplied
sourcePath Folder where new media files are stored (for example, "\USBMemory")
Image Resize Resizes new images to the size of images to be replaced. Not applicable to video files.
Silent Replaces media automatically. As defau a dialog is displayed for the user to specify file
location.
Widget actions
Java Script Interface

void replaceMedia(var sourcePath, var bSilent, var Device, var nMediaType, var
bResize)
project.replaceMedia("Images", true, "\USBMemory", 1, true);
12 The HMI Client
HMI Client is a standalone application which provides remote access to the HMI Runtime, and is included in the PB610
Panel Builder 600. The HMI Client uses the same graphic rendering system as the runtime in the HMI devices, it relies on a
specified HMI Runtime as server for live data.
HMI Client acts as a remote client and communicates to the server, sharing the local visualization with the tag values that
are maintained or updated by the communication protocol.
HMI projects contain properties indicating which page is currently displayed on the HMI and can force the HMI to
switch to a specific page. You can use these properties to synchronize pages showed on the HMI device
and HMI Client or to control an HMI device with a PLC. See "Project" on page 76 for details.
To avoid unexpected behavior:

l be sure to use the same version of the HMI Runtime
l use "FreeType Font Rendering" to be sure to use the same font rendering engine on both HMI
Client and HMI Device (see "Runtime" on page 70)
Client application on PC 184
Client application on HMI 185
Settings and time zone options 186
Client application on PC
Client application on PC
To run the HMI Client application on PC:
1. From the Start menu > PB610 Panel Builder 600 >HMI Client: the client opens in a browser-like style window.
2. Type the server/device IP address in the address bar (for example: http://192.168.1.12): HMI Client will connect to
the server and the same graphical application running on the device will be loaded in the client window.
The Client application toolbar
Element Description
HMI server address IP address of the remote HMI device (e.g. 192.168.0.1:80)
Connection status Network request status. Red during data exchange.
Reload from cache Reloads project
BookMark Bookmarks preferred pages and reload them.
Settings Opens Settings dialog
Reload options
Option Description
F5 Reloads project from cache
Shift + F5 Downloads project to client
Transferring files to a remote HMI device

You can upload and download files to and from a remote HMI device using two dedicated actions. These actions can only
be used from a remote HMI Client and access remote files via FTP.
See "Remote Client actions" on page 158 and "Remote Client variables" on page 104.
Important: Enable FTP support and give all necessary user rights to the folders used to transfer files.
Workspace
Project files are uploaded from the device and stored in HMI Client into the following cache folder.
%appdata%\ABB\[build number]\client\cache
where:
[build number] = folder named as build number, for example 01.90.00.608.
12 The HMI Client
Client application on HMI

To run the HMI Client application on Linux HMI device:
1. From the Run > Update Package menu, create an Update Package and install the HMI Client application in to the
HMI device (see "Update package" on page 91 for additional information)
2. Type the server/device IP address in the Setting dialog that will be available when HMI device start (for example:
http://192.168.1.12): HMI Client will connect to the server and the same graphical application running on the device
will be loaded in the client window.
Context Menu
The Context Menu, available with a right mouse click, will show the below commands:
Settings and time zone options
Option Description
Zoom Select view size at runtime
l Zoom In
l Zoom Out
l Zoom 100%
Pane Mode Enables/disables pan mode after a zoom in
Logout Logs off the current user.
Show system settings Allow the HMI settings and the management of system components. See "System
Settings" on page 503 for details.
Reload Reload remote project
l From cache
l From server
Setting Open the HMI Client Settings. See "Settings and time zone options" below for details
Could be password protected
About Shows information about the HMI Client version.

In the Settings dialog you can configure client settings and decide how to display project time stamp information.
12 The HMI Client
Remote Server
Connection settings
Server Address IP address of the remote HMI device (e.g. 192.168.0.1:80)
Auto connect at startup When the panel starts, use the Server Address to try to connect automatically to the
remote server.
Fit to screen size Adapts the view to the screen size
Time settings
Use Widget Defaults Displays time information according to the widget settings.
Local Time Translates all timestamps in the project into the computer local time where the client is
installed.
Global Time Translates all timestamps in the project into UTC format.
Server Time Translates all timestamps in the project into the same used by HMI device/server in order
to show the same time.
Important: Make sure you set the HMI RTC correct time zone and DST options.
Settings
Interface Settings
Context Menu Delay(s) Context menu activation delay. Range: 1–60 seconds.
Show Busy Cursor Display an hourglass when the system is busy
Use Keypads Display keypads when user touches a data entry field.
Set to disable when an external USB keyboard is connected to the device.
FTP settings
Port FTP communication port
HTTP settings
Protocols Communication protocol used by HMI Client to communicate with an HMI device.
Update Rate Polling frequency to synchronize data from server. Default = 1 s.
Timeout Maximum wait time before a request is repeated by the HMI Client. Default = 5 s.
Reuse connection Enables reuse of the same TCP connection for multiple HTTP requests to reduce
network traffic.
12 The HMI Client
Note: When enabled, this option may cause high latency if the proxy server
does not immediately terminate old requests thus saturating connection
sockets. This is often the case with 3G connections.
Enable compression Compresses data to reduce download times. Default = disabled.
CAUTION: enabling this option could causes excessive CPU overhead.
Time Settings Used by the client to adapt the widget time stamp information.
Password
This dialog give the possibility to change the internal password of the HMI device for the admin user (the default password
is "admin").
Password protection is not available on PC version of the HMI client
13 Using the integrated FTP server
HMI Runtime system uses an integrated FTP server.
Connect to the HMI device FTP server using any standard FTP client application. The FTP server responds on the
standard port 21 as default.
Important: The server supports only one connection at a time; if you are using a multiple connection
FTP client disable this feature on the client program or set the maximum number of connections per
session to 1.
FTP settings
FTP default credentials
When User Management/Security is disabled use the following credentials for incoming connections:
User name admin
Password admin
Changing FTP settings

Path: ProjectView> Security> UserGroups > Authorization Settings
You can change FTP permissions and account information in the Ftp tab of the admin authorizations dialog.
See "Configuring groups and authorizations" on page 282 for details.
FTP settings
14 Using VNC for remote access
VNC is a remote control software which allows you to see and control the HMI application remotely using your local mouse
and keyboard.
Remote access is particularly useful for administration and technical support. In order to use it you need to:
l start a server in the HMI device

l install a viewer on the remote device
Starting VNC server on WinCE devices 194
Starting VNC server on Linux devices 195
Starting VNC viewer 195
Starting VNC server on WinCE devices
Starting VNC server on WinCE devices

VNC server is a plug-in. It can be enabled and downloaded as part of the Runtime. "Plug-in" on page 75.
Installing VNC server

Path: ProjectView > Project properties
1. In the Properties pane set VNC Server to true to enable the plug-in.
2. Install or update the runtime to add the VNC server.
Starting/stopping the VNC server

The VNC server is located in the folder \Flash\qthmi\VNC and is activated using the action launchVNC. If enabled from the
project properties, it can also be activated from the runtime context menu Developer tools> Launch VNC.
To enable the runtime contextual menu see "Project properties" on page 69
VNC Options dialog
From the VNC Options dialog you can perform several tasks.
Tab Functions
Control Star/stop the VNC server and connect to viewer
Options Define security information for server access using a VNC viewer
Advanced Enable automatic activation of VNC server at HMI device startup.
Select Silent Startup to keep the VNC Options dialog in the background when Autostart is
enabled.
Enable Show Taskbar Icon when debugging out of KIOSK mode.
Out Contains the configuration settings for an outgoing connection to a listening VNC viewer software.
14 Using VNC for remote access
Important: Settings in the Advanced tab are reserved to expert users and should be modified when the
VNC server is used in conjunction with a VNC repeater to overcome firewall problems or optimize
VNC performances according to the network configuration.
Connecting to viewer
Many modern VNC viewers offer the possibility to start the software in listening mode. The reason is that mobile devices
most of the time do not have a public IP address to refer to. So it is practical to have a public IP address on an Office
Computer which runs a listening VNC viewer. A user can then easily call for support by pressing the Connect to viewer
button on the Control tab.
VNC default settings

TCP port 5900
Password null
Important: The VNC server allows only a single client.
Starting VNC server on Linux devices

VNC server is a service embedded inside the BSP that can be activated from the Services tab of the device System
Settings. See "System Settings" on page 507 for details.
Starting VNC viewer

No VNC viewer is provided as part of PB610 Panel Builder 600.
Many compatible VNC viewers are available for free download (for example, TightVNC).
Starting VNC viewer
15 Alarms
The alarms handling system has been designed to provide alerts through pop-up messages, typically to display warning
messages indicating any abnormal condition or malfunction in the system under control.
Whenever a bit changes, or the value of a tag exceeds a threshold set in the alarm configuration, a message is displayed.
Specific actions can also be programmed to be executed when an alarm is triggered.
Important: No default action is associated with any alarm.
You can define how an alarm is displayed on the HMI device, if it requires user acknowledgment, and if and how it is logged
into the event list.
Alarms are configured in the Alarms Configuration Editor and, thus, are available for all the pages of the project. An alarm
widget can display more than one alarm at a time, if sized appropriately. You can trigger the opening or closing of the Alarm
window with an event.
You work with alarms in the same way as you work with any other event. You may not want to display a dialog when an
alarm is triggered and you can associate to it any other available action.
Alarms Editor 198
Remote alarms acknowledge 200
Alarm state machine 201
Setting events 202
Active Alarms widget 204
Alarms History widget 209
Managing alarms at runtime 209
Enable/disable alarms at runtime 210
Displaying live alarm data 210
Exporting alarm buffers to .csv files 211
Exporting alarm configuration 211
Alarms Editor
Alarms Editor
Path: ProjectView> Config > double-click Alarms
Adding an alarm
Click + to add an alarm.
Name Name of alarm
Groups Groups associated with the alarm. They can be used in widgets display filters.
Enable Enable/disable triggering of alarm.
Alarms can be enabled or disabled at runtime as well (see "Enable/disable alarms at runtime"
on page 210 for details).
Ack Enable/disable acknowledgment of alarm, if selected the operator must acknowledge the alarm once
triggered to remove it from the Active Alarm widget.
Reset Used with the Ack option, if selected, acknowledged alarms stay in the alarm list, labeled as Not
Triggered Acked, until the operator presses the Reset button in the alarm widget.
Buffer Buffer file where the alarm history will be saved.
Trigger Triggering condition depending on alarm type:
l limitAlarm: alarm triggered when tag value exceeds its limits. The alarm is not triggered if the
value reaches the limits.
l valueAlarm alarm is triggered when tag value is equal to the configured value
15 Alarms
l bitMaskAlarm: the bitwise AND operator compares each bit of the bitmask with the tag value
corresponding to that Alarm. If both bits are on, the alarm is set to true. You can specify one or
more bit positions (starting from 0) inside the tag. The Bit position must be given in decimal format;
if more bits are specified, each position must be separated by a ",".
l deviationAlarm: alarm triggered if the percentage of deviation of the tag value from the set point
exceeds a set deviation.
l protAlarm:BACN : alarm is triggered from the remote BACnet device.
This trigger mode is available only when the protocols configuration contains a BACnet
device. Refer to the BACnet manual inside the “Communication Drivers” folder for a
detailed description of BACnet alarm events.
Tag Tag whose value will trigger the alarm when it exceeds the set limits.
The alarm can refer to the value of this tag, or to the state of a bit if bitMaskAlarm has been selected as
trigger.
Remote Tag used by the PLC to enable/disable the alarm.

Enable
l Changing the enable status from the Alarms Widget will change the tag value
l When the tag cannot be read (e.g. communication error) the alarm is disabled
l No tags related to the alarm are refreshed when alarm is disabled.
Tip: It could be useful to enable the logging of the alarm's enable flag
Remote Tag used by the PLC to acknowledge the alarm. A transition of this tag from 0 to a non zero value is
Ack considered an acknowledgment request.
Remote alarms acknowledge
Leave empty if remote acknowledgment is not required.
See "Remote alarms acknowledge" below for details.
Ack Notify Tag used by the HMI device to notify when the alarm is acknowledged from the device or from the PLC.
0 = set to this value when alarm is triggered
1 = set to this value when alarm is acknowledged.
Action Actions executed when the alarm is triggered. Additional conditions can be specified in the Events
column.
See "Setting events" on page 202 for details.
User Actions executed when user press the action button in the active alarm widget.
Action
See ""Active Alarms widget" on page 204 for details.
Description Alarm description. This text supports the multiple language features and can be a combination of static
and dynamic parts, where the dynamic portion includes one or more tag values.
See "Displaying live alarm data" on page 210 for details.
Custom It is an additional alarm description that can be used to show additional information inside the alarms
Field # widgets. For example, could be an index to use to show a picture related with the alarm.
Color Foreground and background colors of alarm rows based on the status of alarm.
AckBlink Blinking for triggered alarms. If selected the alarm rows blinks until acknowledged. Only effective if Ack is
selected.
Severity Severity of the alarm. If multiple alarms are triggered simultaneously, actions will be executed based on
severity settings.
0 = not important
1 = low
2 = below normal
3 = normal
4 = above normal
5 = high
6 = critical
Events Conditions in which the alarms are notified, logged or printed.
See "Setting events" on page 202 for details.
Remote alarms acknowledge

When the Remote Ack parameter is set, an alarm can be acknowledged from a PLC device setting a tag value to a
nonzero value. The acknowledged status is notified to the PLC device by the Ack Notify flag.
15 Alarms
Alarms acknowledgement process

Remote Ack tag is set/reset by the PLC to request the acknowledge, and Ack Notify is set/reset by HMI device to notify
the execution of the acknowledge.
1. When an alarm condition is detected the HMI device set Ack Notify to 0 and all related actions are executed.
2. When the alarm is acknowledged (by HMI device or remotely), Ack Notify is set to 1
3. It's up to the controller to set Remote Ack to 1 to acknowledge the alarm or reset it to 0 when the HMI device send a
notification that the alarm has been acknowledged (Ack Notify = 1)
WARNING: When an alarm is triggered, some signals need to be update/communicated through the
connected devices. We assume the Acknowledge to be a signal pushed from an operator and not
released automatically from a controller device. This allows for time required to communicated the
original signals.
Tip: Using the same tag both for Remote Ack and Ack Notify can connect more devices to the same controller
and acknowledge the alarms from any HMI device.
Alarm state machine

The runtime implements the alarm state machine described in this diagram.
States and transitions between states are described according to the selected options and desired behavior.
Setting events
Setting events
Path: ProjectView> Config > Alarms > Events column
Events are defined using the Alarms Editor.
See "Alarms Editor" on page 198 for details.
Notifying events
Path: ProjectView> Config > Alarms > Events column > Notify tab
Set conditions under which the alarms will be posted in the alarm widget.
15 Alarms
Here you define the behavior of the default alarm widget available in the Widget gallery and decide in which cases the
widget is updated by a change in an alarm status.
CAUTION: Make only the adjustments required by the specific application while leaving all other
settings as default.
Logging events
Path: ProjectView> Config > Alarms > Events column > Log tab
Set conditions for which you want to store the specific event in an alarm history buffer.
The alarm history is logged in the Event Buffer.
Executing actions
Path: ProjectView> Config > Alarms > Events column > Actions tab
Set conditions under which the action(s), configured for the specific alarm, must be executed.
By default, actions are executed only when the alarm is triggered; other alarm states can also be set to execute actions.
Print events
Path: ProjectView> Config > Alarms > Events column > Print tab
Set conditions for which you want to print the specific event
Active Alarms widget
Setting storage device

Path: ProjectView> Config > Events Buffer> Storage Device tab
1. Open the Storage Device dialog.

2. Select a device for event data storage.
Data is automatically saved every five minutes except for alarm data which is saved immediately.
Use source timestamp
Events are stores with the timestamp of when the HMI device detect the event. When “Use source timestamp” is selected,
the events are stored with the timestamp received from the remote device.
Available only for device’s protocols that support this feature (OPC UA Client and BACnet)

You can insert the Active Alarms widget in a page to display the alarms and to acknowledge, reset or enable/disable them.
15 Alarms
Alarm filters
Path: ActiveAlarm widget> Properties pane> Filter
Define filters used to display only some of the configured alarms. Filters are based on alarm fields, which means you can
filter alarms according to name, severity, description and so on.
Filter 1 is the default filter. It's managed by the combo box Filter 1, and has two options: Show all alarms and Hide Not
Triggered which, when selected, allows to display only active alarms.
Filter 2 is, by default, not configured and available for customization.
Filter's expressions make use of AWK language, the expressions are applied to the data contained in the selected Filter
column of the Alarm widget.
Setting filters
Path: ActiveAlarm widget> Properties pane> Filter
To set one of the two available filters:
1. Select Filter Column 1 and choose the value to filter for (e.g.: Name, State, Time, Groups)
2. In DataLink attach a combo box widget. Use Shift+ left-click to select the combo box.
3. In the Properties pane select list property and open dialog to customize combo box values
4. In the combo box configuration dialog, specify String List and the regular expression to filter values.
Filters first example

You want to show all alarms matching Filter 1 with value equal to 10. Then properties settings: Filter column 2 = Value,
Filter 2 = 10
Filters second example

You want to show all alarms matching a Severity value from 3 to 6 (Normal to Critical). Then properties settings: Filter
column 2 = Severity, Filter 2 = [3-6]
Filters third example

You want to show all alarms matching a value from 11 to 19. Then properties settings: Filter column 2 = Severity, Filter 2
= ^(1[1-9]$)
Meaning:
^ = match must starts from the beginning of the string
1[1-9] = first char must be 1 and the second char must be between 1 and 9
$ = end of the comparison.
15 Alarms
Filters expression examples
Filter by String list Data list
State Hide Not Triggered ^((Not Triggered Acked|Not Triggered Not Acked|Triggered).*$)
Value 10 < Value < 20 ^(1[0-9]$)
Value 20 <= Value <100 ^([2-9].$)
Value 100 < Value < 200 ^(1[0-9][0-9]$)
Value Value 2?/3?/4?/5? ^([2-9].*$)
Value Value >= 100 ^([1-9][0-9][0-9].*$)
Value Value >= 20 ^([2-9].*$|[1-9][0-9][0-9].*$)
Sorting alarms
Path: ActiveAlarm widget> Properties pane> Sorting
The sorting function allows you to sort alarms at runtime in the alarms widget by clicking on the column header.
Note: The severity value displayed here is set in the Alarm Editor.
Action
When the "User Action" associate with the alarm (see “"Alarms Editor" on page 198 for details) contains valid actions, the
Action icon is showed. Pressing the icon, the configured actions will be executed.
WARNING: If you are using an older converted project, you have to substitute the old Active Alarms
Widget with the new one from the Widgets gallery
Note: The image can be modified from the Colums property of the Active Alarms widget
Enable/Disable Alarms
At runtime the Alarms Widget can be used to enable or disable the alarms.
15 Alarms
Saves changes made in the Enable column in the alarm widget. This action is used with the Save button in the alarm
widget.
Alarms History widget

Logs and display an alarm list if Buffer property in Alarms Configuration Editor is set.
Attaching widget to buffer

Path: AlarmHistory widget> Properties pane> Buffer > EventBuffer
In Properties pane > Event select the Event Buffer from which the alarm list is retrieved
Managing alarms at runtime

When an alarm is triggered it is displayed in the Active Alarms widget where you can acknowledge and reset it. You can
filter the alarms displayed using several filters, for example you can hide not triggered alarms or show all alarms.
See "Active Alarms widget" on page 204 for details.
Enable/disable alarms at runtime
IMPORTANT: The Active Alarms widget is not displayed automatically. You must add a dedicated
action that will open the page containing the alarm widget when the alarm is triggered.
Enable/disable alarms at runtime

You can enable or disable the alarms at runtime.
To enable an alarm select the Enable option in the alarm widget.
Disabled alarms are not triggered and therefore not displayed at runtime.
Note: Alarms can be configured to be enable/disable even from the PLC.

See Alarm Configuration Editor for details.
Displaying live alarm data

Both in the Active Alarms and in the History Alarms widget you can set the alarm description to display live tag data.
To show the tag value, set a placeholder in Description entering the tag name in square brackets, for example "[Tag1]". At
runtime, in Description column of Active Alarms widget the current value of the tag will be displayed.
There are two type of placeholders
l [TagName]
When alarm is triggered, tag value is read and continuously updated
l [!TagName]
When alarm is triggered, tag value is read and frozen
In History Alarms widget or in .csv file, live tag values are the values taken when the alarm's status change (for both types
of placeholders)
Use '\' before '[ ]' if you want to show the '[ ]' in the description string, for example: \[Tag\[1\]\] will display the
string "[Tag[1]]".
Use '\', even when the tag label contains square brackets. For example, to display the live tag value of tag
l TAG\]3 = [TAG\]3]
l TAG\[3\] = [TAG\[3\]]
15 Alarms
Example of Alarm widget
Number of live tags that can be used inside each alarm's description depends on size of used tags. PB610 Panel Builder
600 will check and show a warning message when too many tags are used.
The sum of the bytes that are calculated using the underlying algorithm must be less than or equal to 50
4 bytes + (size of tag + 2) + (size of tag + 2) + (size of tag + 2) + . . .

<= 50
Example:
Exporting alarm buffers to .csv files

To export an event buffer containing an history alarms list, use the DumpEventArchive action.
See "System actions" on page 159 for details.
Note: Tag values displayed in the alarms description are also included in the buffer. Tags are sampled
when the alarm is triggered and that value is logged and included in the description.
Exporting alarm configuration

Click the Export Alarms button: the alarms configuration table is exported into an .xml file.
You can edit the resulting .xml file using third part tools (for example, Microsoft Excel) .
Importing alarm configuration

15 Alarms
1. Click the Import Alarms button and select the .xml file from which to import the alarms configuration: the Import
Alarms dialog is displayed.
2. Select the group of alarms to import and click OK to confirm.
Differences are highlighted in the Import Alarms dialog using different colors
Color Description
Black This is a new alarm and it will be imported
Red This alarm has not been found and will be removed (only if check "Replace project alarms with imported alarms"
is checked)
Blue This alarm has been modified and will be updated.
Gray This alarm is already part of the project and will be skipped.
Automatic synchronization
Select the Keep synchronized option in the Import Alarms dialog to enable the automatic synchronization of the alarm
configuration file.
Whenever changes occur in the alarms configuration, the file will be automatically updated in silent mode.
Tip: Enable this function when the alarm file is managed by a different tool (for example, PLC programming
software) as well as by PB610 Panel Builder 600.
16 Recipes
Recipes are collections of tag values organized in sets that satisfy specific application requirements.
For example, if you have to control room variables (temperature and humidity) in the morning, afternoon and evening. You
will create three sets (morning, afternoon and evening) in which you will set the proper tag values.
Each element of the recipe is associated to a tag and can be indexed into sets for a more effective use. This feature allows
you to extend the capabilities of controllers that have limited memory.
You can add controller data to a page using a recipe widget. Recipe data contains all the controller data items; however
data is no longer read directly from the controller but rather from the associated recipe element in the HMI device.
Recipe data is configured in PB610 Panel Builder 600 workspace; the user can specify default values for each element of
the data records. In HMI Runtime, data can be edited and saved to a new data file, any change to recipe data is therefore
stored to disk. With the use of a separate data file HMI Runtime ensures that modified recipe values are retained
throughout different project updates. In other words, a subsequent project update does not influence the recipe data
modified by the user in the HMI Runtime.
See "Recipe actions" on page 154 for details on how to reset recipe data.
Note: Recipe data can be stored on a Flash memory, on a USB drive or on a SD card.
Managing recipes 215
Configuring a recipe widget 218
Recipe status 219
Uploading/downloading a recipe 220
Backup and restore recipes data 221
Managing recipes
Creating a recipe
To create a recipe for your project:
1. In ProjectView right-click Recipes and select Insert Recipe: an empty recipe is added. You create and configure
recipes using the Recipe Editor.
Managing recipes
Recipe editor
Path: ProjectView> Recipes > double-click RecipeName
Configuring recipe properties

In the Properties pane of each recipe you set the following parameters:
Recipe Name Name of the recipe
Number of sets Number of values sets for each recipe element. Each set has a different configurable name.
Setting up a recipe
1. Click + to add an element of the recipe.
2. Link the tags to each recipe element.
Defining recipe fields

Create a recipe field in the page using a numeric widget and attaching it to a recipe item after selecting Recipe as the
Source.
16 Recipes
In the Attach to dialog you have the choice of all the different recipe variables, such as:
l Current Recipe >Current Selected Recipe Set> Element > Value

l Selected Recipe > Selected Set0 > Element > Value
l recipeList
When numeric widgets are defined as read/write, the default recipe data can be edited at runtime. These new values are
stored in a separate file as modified recipe data.
Note: Since JavaScript API functions are used, the recipe elements and sets can be referenced by name or by
position. To avoid ambiguity between names and index, the names of the recipe elements and sets must include
at least one alphanumeric character.
Storing recipe data

In the Recipe Editor click the storage type icon to select where to store recipe data: the Storage Device dialog is
displayed.
Configuring a recipe widget
For USB drive and SD card storage you can provide the folder location.
WARNING: Recipe configuration files are created automatically when the project is saved and stored
in the data subfolder of the project. To use external storage devices, you need to copy this folder into
the external device. Note that you have the responsibility to manage the data folder inside external
devices. Even dynamic files are not deleted when project is updated using the “Delete dynamic file”
option.
Important: You can add a subfolder but you must not rename the "data" subfolder.
Import/Export recipes
To import/export the recipes configuration of your project:
In ProjectView right-click Recipes and select Export Recipe or Import Recipe
The following formats are supported for import:
l Comma Separated Values (.csv)

l Unicode Text (.txt)
Note: Use the Unicode Text file format when you import a file modified using Microsoft® Excel®.
Configuring a recipe widget

You can choose one of the two recipe widgets available in the Widget Gallery:
l Recipe set: allows you to select a recipe set for upload or download. See "Uploading/downloading a recipe" on
page 220
l Recipe menu: when more recipes have been created for a project, use this widget to manage all recipes and select
the desired sets for each of them.
16 Recipes
Configuring the Recipe Set widget

In the Properties pane of each Recipe Set widget set the following parameter:
Recipe Name Name of the recipe
Recipe status
Each recipe contains two kinds of status parameters
l Recipe Status (blue in the below picture)

Give information regarding the last download or upload operation
l DataSet Status (yellow in the below picture)
Give information of modified datasets
Uploading/downloading a recipe
Recipe Status
After every recipe upload or download, or recipe set modification, the Recipe Status parameters contain a value with the
result of the operation.
Code Function Description
0 Set modified Selected set changed
1 Download triggered Download request triggered
2 Download Done Download action completed
3 Download Error Error during download (for example, unknown set, unknown recipe, controller
not ready, Tags write failed etc.)
4 Upload triggered Upload request triggered
5 Upload done Upload action completed
6 Upload Error Error during upload - same as for download
7 General Error General error (for example, data not available)
DataSet Status
The status of each data set indicates that it has been changed. This information may be useful to not forget to download the
recipe to synchronize the PLC. Both download or upload operations will reset the DataSet Status to 0.
0 Syncronized User synchronized PLC with the dataset values
1 Modified User modified some values of the dataset
Note: After a device startup or a recipe reset/restore, all status values will reset to 0.
Uploading/downloading a recipe
Uploading a recipe
You upload a recipe to an HMI device using a recipe widget and the UpLoadRecipe, UpLoadCurRecipe action in one of
the following ways:
l attach the action to an event of a button or a switch (see ""Attach to" parameters" on page 44 for details)
l configure the action in an alarm action list (see "Alarm actions" on page 136 for details)
l configure the action in a scheduler action list (see "Scheduling events at runtime" on page 266 for details)
16 Recipes
Downloading a recipe
You download a recipe from an HMI device using a recipe widget and the DownloadRecipe, DownLoadCurRecipe
action. See "Recipe actions" on page 154
Backup and restore recipes data

The recipe data stored in an HMI device can be exported for backup and later restored. This is done using the
DumpRecipeData or the RestoreRecipeData actions.
See "Recipe actions" on page 154 for details.
Backup and restore recipes data
17 Trends
Trends allow you to sample and record the values of specified tags according to specific sampling conditions. The trend
function includes trend acquisition and trend display.
Trend acquisition parameters are set in the Trend editor so that data can be stored. Stored data can then be displayed in a
graphical format using a trend widget.
Data logging 224
Exporting trend buffer data 226
Trend widgets 227
History trends 229
Trend widget properties 231
Trend widget gestures 232
Values outside range or invalid 233
Showing trend values 234
Scatter diagram widget 235
Table trend widget 236
Data logging
Data logging
Data can be logged and stored to HMI memory. Data logging allows you to store the values of a group of tags all at the
same time to a buffer. Data logging can be triggered by a timer or by a dedicated tag. Logged data can be exported to a .csv
file or displayed using the historical trend widget. Logged data can be saved locally on a USB device or SD card, or on any
available custom network folder.
WARNING: The operation with removable memory devices (USB Flash drives, SD memory cards)
containing a very large number of files may result in a decrease of system performance.
WARNING: The max number of files inside a SD memory card depends on the type of formatting (e.g.
FAT32 max 65536 files; FAT max 513 files).
WARNING: Flash cards support a limited number of write operations. We suggest to use only good
quality memory cards; in the case your application use intensively the memory card consider a regular
substitution of the memory card.
WARNING: If the data/time is moved back, the samples with invalid date/time are removed from the
trend buffer. When system detects that data/time is invalid (e.g. battery low), a popup is shown to
advise the user and the date/time of the last sample is used to avoid losing data.
Storage is based on trend buffers. Trend buffers are organized as a FIFO queue: when the buffer is full, the oldest values
are discarded unless you configure your trend to create a backup copy of the buffer.
Adding a trend buffer

Path: ProjectView> Config > double-click Trends
1. Click Add to add a new buffer.

2. Click + next to each trend buffer to display all configuration parameters.
17 Trends
Element Description
Total Memory currently used by the trend buffer. See "Table of functions and limits" on page 498 for maximum
memory number of samples allowed for project.
Space
This percentage is calculated as follows:
Trend Name Name of trend that will be displayed in the window property pane.
Active When enabled, the trend runs by default at system startup.
Note: Trends cannot be activated at runtime.
Source Tags sampled by the trend.
Sampling Sampling interval in seconds.

Time (s)
Trigger Tag triggering the sample. When the value of this tag changes, a sample is collected.
Note: Trigger and Source can refer to the same tag.
Timestamp When checked, use the time stamp provided from the remote device.
Available:
l only for device’s protocols that support this feature (OPC UA Client and BACnet)
l when trend buffer is configured to with a single tag
Number of Buffer size.

Samples
Storage Where trend buffer data will be stored.

Device
Backup If Save a copy when full option is enabled, a backup copy of the buffer data is created before it is
Archive overwritten by newer data.
.csv: Backup data using text CSV format.
Time Spec: Dump to CSV the time in local or UTC
Path: Where trend buffer data will be copied
The below wild cards are supported
l %n = Trend name
l %y = Year
Exporting trend buffer data
Element Description
l %M = Month
l %d = Day
l %h = Hour
l %m = Minutes
l %s = Seconds
Sampling This parameter allows to specify a dynamic filter if required.

Filter /
When sampling is done on time basis the offset is applied to the sampled Tag value. If the new value
Trigger
exceeds the specified limits the new value is considered valid and stored, otherwise the new record will
Filter
retain the previous saved value.
When sampling is done on trigger the offset is applied to the trigger Tag value. If the trigger Tag value
change exceeds the specified limits a new sample is taken and stored, otherwise no sampling will be
done.
Sampled Name: name of trend

tags table
Tag: tag to be sampled.
Comment: trend description
Exporting trend buffer data

Use the DumpTrend action to export trend buffer data to a .csv file. See "DumpTrend" on page 160 for the macro
parameters details.
The exported .csv file could have different formats defined from the Dump Trend macro parameters. The different formats
are maintained mainly for compatibilities reasons.
FileFormat: Compatibility CSV
FileFormat: Compact CSV
17 Trends
Note: The first row of the header contains the tags names and tags data types
FileFormat: Compact CSV with columns' selection
Trend widgets
Data logged by the HMI device can be displayed in graphical format using trend widgets.
RealTime trend widget

The real- time trend widget can be used to display the changes of value of a tag. Data is not stored in a trend buffer and
cannot be retrieved for later analysis.
To display a real-time trend:
Trend widgets
1. Drag and drop the RealTime Trend widget from the widget gallery to the page.
2. Attach the tag that you want to sample to the Curve n Value. Data is always plotted against time.
RealTime trend widget properties

Num Number of trend curves to be displayed (Max. 5)

Curves
Page Time range of the x-axis.

Duration
Tip: You can attach a Date Time combo widget to the Page Duration property and
dynamically change page duration at runtime.
Starting Specifies the starting point of the curve when the page is opened.
Position
X Labels Number of ticks on the x-axis scale
Y Labels Number of ticks in the y-axis scale.
Text Trend title and font properties (font size, label, etc.)
Grid Properties of grid presentation (colors)
Cursor Properties of cursor presentation (enable and color)
X Scale Properties of X Scale presentation
Y Scale Properties of Y Scale presentation
Curve Tag that will be plotted in the trend widget. See "Trend widget properties" on page 231 for details.
"n"
You can set the minimum and maximum of the curves (MinY, MaxY). You can attach a tag to
minimum and maximum properties. This enhances the ability to change the minimum and
maximum values dynamically at runtime.
17 Trends
Scaling data
Tag values can be scaled using the X Forms in the Attach to dialog. See ""Attach to" parameters" on page 44 for details.
History trends
Trend data stored in trend buffers can be analyzed using the History Trend widget.
This is a two-step process:
l first you create a trend buffer to collect data for specified tags at specific points in time,
l then you configure a History Trend widget to display the collected data in a graphical format.
See "Data logging" on page 224 for details on how to create a trend buffer.
History Trend widget

History Trend widget displays in graphical format the content of a trend buffer.
Start time is the current time and stop time will be the current time plus the duration of the window. The curve starts from
the left and progresses to the right, data is automatically refreshed during a certain interval time, until the stop time.
When the curve reaches the stop time, the curve will scroll left and the update of the curve will continue until it again
reaches the stop time. At that moment a new scroll is automatically performed and the process repeats.
History trends require a proper configuration of trend buffer.
See "Data logging" on page 224 for details on how to work in the Trend editor.
History trends
Configuring the History Trend widget

1. From the Trends/Graphs section of the Widget Gallery, drag and drop the History Trend widget to the page.
2. In the Properties pane, attach the trend buffer to be plotted in the widget.
You can Select trend directly from the HistoricTrend widget
or use the Attach To... tag to identify the tag that will contains the trend name to show. Using the attach to tag, the
curve to show can be select from the HMI Runtime
17 Trends
For example, connect to CurrentData property of a combo box widget configured with the list of trends to show
Trend widget properties

Some Trend widget properties are only available when the Properties pane is in Advanced view.
Request Samples
Request Sample property can be set for each curve and indicates the maximum numbers of samples read by the widget at
one time from the trend buffer.
Tip: You normally do not need to modify the default value. Adjust it to fine tune performances in the trend widget
refresh, especially when working with remote clients.
Color bands
Use the color bands configuration to customize your graphs background, for example to make certain days or hours stand
out (weekends, night hours, etc.).
1. In the Properties pane, in Color Bands property click +: the Configure Bands window appears.
2. Click + to add as many colors you need.
3. Select multiple cells and click on a color band to assign the color to the selected range of cells.
Note: This feature only uses local time in the trend widget, not the global time option.
Trend widget gestures
Calendar color bands example
Trend widget gestures

Trend widgets support gesture commands:
Gesture Description
pan Touch the widget to scroll the curve within the widget area
pinch Use two fingers to pinch the curve and perform zoom operations
WARNING: Only multi touch HMI devices can generate pinch events
Note: In order to support gestures on Y axis, Min/Max properties of the trend widget must be linked to Min/Max
values of Behavior parameters (default for new trends).
17 Trends
Values outside range or invalid

When trend value goes beyond the limits set for the trend widget, a dotted line is displayed. When the value of the tag is not
available, for example the controller device is offline, no curve is drawn.
Showing trend values
Showing trend values

Trend cursor displays the trend value at a specific point.
Use the actions ShowTrendCursor and ScrollTrendCursor to enable the trend cursor and move it to the required point to
get the value of the curve at that particular point in time.
To display the value of the trend cursor on the page, define a numeric field and attach it to the Cursor Value widget tag.
In this example the Y axis value of the cursor is displayed.
To display the trend timestamp at the position of the cursor, define a numeric field and attach it to Cursor Timestamp
widget tag.
17 Trends
Scatter diagram widget

A scatter diagram is a type of diagram to display values for two variables from a set of data using Cartesian coordinates.
The data is displayed as a collection of points, each having the value of one variable determining the position on the
horizontal axis and the value of the other variable determining the position on the vertical axis. For this reason it is often
called XY graph.
Scatter diagram curves are obtained by a linear interpolation of points. To create a new scatter diagram:
1. Add a Scatter Diagram widget to the page.

2. Select the number of curves to show: each curve is named as Graph1, Graph2,...
3. Customize the general graph properties such as X Min, X Max, Grid details.
4. Define the max number of samples/values for each curve by setting the Max Samples parameter.
Here you set the max number of values to be displayed in the graph starting from first element in the array.
For example: Tag1[20] and Max Samples = 10 will show just first 10 elements of the Tag1 array.
5. Define for each curve the two tags of type array to be displayed (X-Tag and Y-Tag).
When the array tags change, you can force a refresh with the RefreshTrend action .
Table trend widget
Note: Scatter diagrams support only the RefreshTrend action.
Table trend widget

Path: Widget Gallery> Basic> Trends/Graphs
Display contents of a trend buffer inside a widget
Buttons:
l REFRESH
Retrieve trend data from internal buffer and refresh table view
l BACKWARD/FORWARD
Move the display window forward or backward as specified in the duration parameter
TrendName Trend Buffer from which the samples are retrieved (see "Data logging" on page 224)
Heading Heading label
Page Duration Initial value of time window to show
Time Spec Time format:
l Local = show the time values of the HMI device.

l Global = show the time values using UTC format.
Table Layout Defines the characteristics of the scroll bar and allows to remove the header of the table
17 Trends
Adding or removing trend columns

To add or remove a column, double-click on the grid to enter edit mode and right-click on the column selector to open the
context menu from where to insert or remove a column.
Copy and past fields from another column
Then use the properties panel to select the trend element to add to the new columns
Table trend widget
17 Trends
Table trend widget
18 Data transfer
Data transfer allows you transferring variable data from one device to another. Using this feature an HMI device can
operate as a gateway between two devices, even if they do not use the same communication protocol.
Data transfer editor 242
Exporting data to .csv files 244
Data transfer limitations and suggestions 244
Data transfer editor
Data transfer editor

Path: ProjectView> Config > double-click Data transfer
Use the Data transfer editor to map transfer rules.
Each line in the Data transfer editor defines a mapping rule between two tags. Define more mapping rules if you need
different direction, update method or trigger.
To add a new rule, click +: a new tag line is added.
Data transfer toolbar

Prameter Description
Import/ Export Imports or exports data transfer settings from or to a .csv file.
Search Displays only rows containing the search keyword.
Filter by Display only rows matching filter and search field.
Data transfer parameters

TAG A/ TAG B Pair of tags to be mapped for exchanging through the HMI device.
Direction Transfer direction.
A->B and B->A: Unidirectional transfers, values are always copied from one tag and
sent to the other tag in the specified direction.
A<->B: Bidirectional transfer, values are transferred to and from both tags.
Update Method On trigger: Data transfer occurs when the value of the tag set as trigger changes
above or below the values set as boundaries. Limits are recalculated on the previous
tag value, the same that triggered the update.
18 Data transfer
Note: This method applies only to unidirectional transfers (A->B or B->A).
On Update: Data transfer occurs whenever the value of the source tag changes.
Note: This method applies both to unidirectional and to bidirectional transfers

(A->B, B->A and A<->B).
Note: The Runtime cyclically monitors source tags changes (trigger tag
when using On Trigger or tags to transfer when using On Update) based on
Tag editor Rate parameter. If Rate setting for source Tag is 500 ms (default),
the system checks for updates every 500 ms.
Note: Changes on source tags faster than Rate may be not detected .
Trigger, Tag that triggers the data transfer process. When this tag changes its value outside the
High limit, boundaries set as High limit and Low limit, data transfer is started. The range of
Low limit tolerance is recalculated according to the specified limits on the tag value which
triggered the previous update. No action is taken if the change falls within the limits.
This mechanism allows triggering data transfers only when significant variations of the
reference values occur.
Low limit is less or equal to zero.
Note: If both Low limit and High limit are set to "0", data transfer occurs
whenever the value of the trigger tag changes.
on Startup When selected, data transfer is forced:
l on HMI startup if the quality of the source tag is good

l after communication errors, when the associate device nodes return active
See "Objects" on page 437 for details on quality.
Important: Data transfers executed on startup may have major impact

on the HMI device boot time. Enable this option only when necessary.
Example of limit setting

High limit = 1,9
Low limit = - 0,9
• = points where the data transfer is triggered
Exporting data to .csv files
Exporting data to .csv files

Configuration information for data transfers can be exported to a .csv file.
Example of data transfer settings in .csv file
Column Description
A to G Same data as in the Data transfer editor
H Unique identifier automatically associated to each line.
Important: When you edit the .csv file and you add any extra line, make sure
you enter a unique identifier in this column.
I and J Reserved for future use.
Import/export use the separator character defined inside Windows Regional Settings.
Data transfer limitations and suggestions

Correct definition of data transfer rules is critical for the good performance of the HMI devices. To guarantee reliability of
operation and performance, keep in mind the following rules.
On trigger method
The On trigger method allows only unidirectional transfers, (A->B or B->A)
18 Data transfer
Data transfer based on the On Trigger mode should be preferred since it allows you to force the transfer and monitors only
the trigger tags and not all the tags involved in the transfer.
On update method
The On update method allows changing the values in accordance with the direction settings only when the source value
changes.
Using the On Update method you force the system to continuously read all the defined source tags to check if there are
changes that need to be transferred. The default value of the update rate of each tag is 500 ms and can be modified with
Tag editor.
Performance observations
Data transfer performance depends on:
l number of data transfers defined,
l number of data transfers eventually occurring at the same time,
l frequency of the changes of the PLC variables that are monitored,
Important: Always test performance of operation during project development.
Important: If inappropriately set, data transfer tasks can lead to conditions where the tags involved
create loops. Identify and avoid such conditions.
Tip: Use the scheduler to calibrate the update rate based on the performance of your entire project.
Tip: Use array type tags to optimize data transfer and reduce workload.
Tip: Reduce the number of data transfers to reduce page change time and boot time.
Data transfer limitations and suggestions
19 Offline node management
When one of the controllers communicating with the HMI device goes offline, communication performance of the system
may eventually decrease.
The offline node management feature recognizes offline controllers and removes them from communication until they come
back online.
Additionally, if you know that any of the controllers included in the installation is going to be offline for a certain time, you
can manually disable it to maximize system performance.
Note: This feature is not supported by all communication protocols. Check protocol documentation to know if it
is supported or not.
Offline node management process 248
Manual offline node management process 248
Manual offline configuration 248
Automatic offline node detection 249
Offline node management process
Offline node management process

Steps of the process are:
l The system communicates normally with a certain device. When the device is not responding to a communication
request, the system will repeat the request twice before declaring the device offline.
l When a device is offline, the system sends communication requests to the device with a longer interval, called
Offline Retry Timeout. If the device answers to one of these requests, the system declares it online and restarts
normal communication.
The diagram shows the three communication attempts and the recovery procedure that starts when the Offline Retry
Timeout is elapsed.
Manual offline node management process

Offline node management can be done manually. When a specific device is online and it is communicating normally you
can:
l use an action to declare the device offline: the system stops communication with the device.
l use an action to declare the device online: the system restarts normal communication with the device.
Manual offline configuration

When you know that some devices in communication with the HMI device are going to remain offline for a certain period of
time, you can exclude them from communication using the EnableNode action.
WARNING: All disabled device nodes will remain disabled if the same project is downloaded on the
device, on the other hand, if a different project is downloaded, all disabled devices will be re-enabled.
The same happens with a package update.
Tip: To make this feature more dynamic, you may decide not to indicate a specific NodeID but attach it to the
value of a tag or to an internal variable created to identify different devices that might be installed in your network.
Note: When using the action EnableNode to force a device node back online, communication will start
immediately.
19 Offline node management
Automatic offline node detection

When a device is not answering to communication requests, it is de-activated. The HMI device stops sending requests to
this device. After three seconds, the HMI device sends a single command to check if device is available, if so the
communication is restarted, otherwise it is disabled for another timeout interval.
Default settings can be modified in Protocol editor.
Note: Not all protocols support this feature.
Enable Offline Enables offline management for the protocol

Algorithm
Offline Retry Interval in seconds for the retry cycle after a device has been deactivated. Range:
Timeout 1–86.400 seconds (24h).
Automatic offline node detection
20 Multi-language
Multi-language feature has been designed for creating HMI applications that include texts in more than one language at the
same time
Multi-language feature uses code pages support to handle the different languages. A code page (or a script file) is a
collection of letter shapes used inside each language.
Multi-language feature can be used to define languages and character sets in a project. PB610 Panel Builder 600 also
extends the TrueType Fonts provided by Windows systems to provide different font faces associated with different
character sets.
PB610 Panel Builder 600 also allows you to provide strings for each of the languages supported.
PB610 Panel Builder 600 also allows you to change the display language so that you can see the page look and feel during
the design phase.
Supported fonts for Simplified Chinese

For Simplified Chinese, the following fonts are supported:
Font name Font file
Fangsong simfang.ttf
Arial Unicode MS ARIALUNI.TTF
Kaiti simkai.ttf
Microsoft Yahei msyh.ttf
NSImsun simsun.ttc
SimHei simhei.ttf
Simsun simsun.ttc
Supported fonts for Traditional Chinese

For Traditional Chinese, the following fonts are supported:
Font name Font file
DFKai-SB kaiu.ttf
Microsoft Sheng Hai msjh.ttf
Arial Unicode MS ARIALUNI.TTF
MingLiU mingliu.ttc
PMingLiU mingliu.ttc
MingLiU_HKSCS mingliu.ttc
The Multi-language editor 253
Changing language 254
Multi-language widgets 254
Exporting/importing multi-language strings 256
Changing language at runtime 258
Limitations in Unicode support 258
20 Multi-language
The Multi-language editor

Path: ProjectView> Config > double-click MultiLanguage
Language settings
Language Name identifying the language in the project.

Name
Language ISO 639 language code identifier, used to match language items when importing resources from
Code external xml files.
Writing Select the set of fonts to be used with the language

system
Default Font Default font for project's widgets.
Note: When you choose a new font you are prompted to replace the font used in the widgets
you already created.
Fonts Number of fonts associated with the selected language.
Size Memory used to store font files.
Storage Location of file fonts is a removable external memory.
Tip: Store large font files on removable memory to free memory requirements in the HMI
device.
Adding a language
1. In the Languages tab, click +: a line is added to the table.
2. Enter all language settings.
3. Click Default to set the selected language as the default language when the Runtime starts.
4. Click Save Font to copy the fonts you marked as Removable on an external memory.
Changing language
Important: Font files configured to be stored on removable memory must be provided to the final user
to complete font installation on the HMI device.
Removing fonts
To remove fonts no longer needed:
1. Click on the font number in the Multi-language editor: a dialog with the list of the used fonts is displayed.
2. Select the fonts to be removed and click Remove: removed fonts are replaced with the default font.
Changing language
Changing language during page design
A combo box is available for changing language during page design. If no texts appears, please check Text tab in the
Multilanguage editor and insert missing string.
Multi-language widgets
Multi-language support is available for objects such as buttons, static text, messages, alarm descriptions and pop-up
messages.
Multi-language for label widgets

Double-click on a text widget in a page to open the Text dialog.
20 Multi-language
Enable/disable multi-language function, edit the text for the selected language and choose the font.
Note: Bold, italic and color properties set here for the widget are applied to all languages .
Multilanguage Enable/disable multi-language function for the widget.
Choose text from other Click on button to browse existing message strings in project to pick text for the
widget widget.
Multi-language for message widgets

Double-click on a message widget in a page to open the Message Text dialog.
Multilanguage Enable/disable multi-language function for the widget.
Continuous Index Index for the widget is set of contiguous numbers (example 3, 4,5,6)
Min Starting number for index
Range Number of messages
Choose text from other Click on button to browse existing message strings in project to pick text for the
widget widget.
Exporting/importing multi-language strings
Multi-language for alarm messages

To add a multi-language strings for alarm messages:
1. Open the Alarm editor.

2. Select a language using the language combo box.
3. Enter the text for the alarm in the Description column.
Tip: Text labels with alarm states displayed by alarms widgets can be translated or personalized through the
Multilanguage text editor.
Multi-Language for pop-up messages

To add a multi-language pop-up message:
1. Select a language from the language combo box.

2. Add the Page action ShowMessage and enter the text in the selected language.
Exporting/importing multi-language strings

The easiest way to translate a project into multiple languages is to export all texts to a .csv file, translate the resulting
document and then import the translated text back into the project.
Important: The .csv file exported by PB610 Panel Builder 600 is coded in Unicode, to edit it you need a
specific tool supporting Unicode encoded .csv files.
20 Multi-language
Exporting and reimporting strings

Path: ProjectView> Config > double-click MultiLanguage
To export and re-import multi-language strings:
1. In the Text tab, click Export: all multi-language strings are exported to a .csv file.
Important: Set all languages that will be used in the project before exporting the file. This will
guarantee that the exported file will contain all columns and language definitions.
2. Once the strings have been translated, click Import to re-import them into the project: strings are imported matching
the widget ID and the page number of each widget.
3. Click Save to save the new widget data.
Note: To change the separator used in the exported file, change the regional settings of your computer. When
importing, the separator information is retrieved from the file; if not found, the default character "," is used.
Changing language at runtime
Import constraints
The following formats are supported for import:
l Comma Separated Values (.csv)

l Unicode Text (.txt)
Note: Use the Unicode Text file format when you import a file modified using Microsoft® Excel®.
Changing language at runtime

Changing language with an action
After the project download, the HMI Runtime will start using the language set as default. You can change the language
using the SetLanguage action. See "MultiLanguage actions" on page 140.
Note: Once the language has been changed, it will be used also in future sessions.
The active language code is available from JavaScript API. See "curLangCode" on page 456 for additional details.
Missing fonts
When you change language, if the required fonts are not available in the device memory, a pop-up message prompts you to
insert the memory card containing the missing fonts. At the end of the operation you can remove the memory card.
Limitations in Unicode support

PB610 Panel Builder 600 has been designed for working with Unicode text. However, for compatibility issues with some
platforms, Unicode is supported only in a subset of properties.
20 Multi-language
Area Property Charset Accepted Reserved Chars/Strings
Protocol Alias ASCII [32..126] (space) , ; : . < * >'

editor
Tag editor Name ASCII [32..126] . \ / * ? : > < | " & # %;=
Group ASCII [32..126] <New> \ / * ? : > < | " & #

%;
Comment Unicode
Trends Name ASCII [32..126] \/*?:><|"&#%;
Printing Name ASCII [32..126] \/*?:><|"&#%;

Reports
Alarms Name ASCII [36..126] \/*?:><|"&#%;
Description Unicode [] - for live tags, \ escape

seq for [ and \
Events Buffer Name ASCII [32..126] \/*?:><|"&#%;
Scheduler Name ASCII [32..126] \/*?:><|"&#%;
Languages Language Name ASCII [32..126] \/*?:><|"&#%;
Texts in widgets Unicode -
Texts from import Unicode -

files
User Group Name a-z A-Z _ admin,guest,unauthorized

Group
Comments Unicode -
User Name ASCII [32..126] \/*?:><|"&#%;
Password Unicode -
Comment Unicode -
Recipes Name ASCII [32..126] \/*?:.><|"&%;,
Set Name ASCII [32..126] \/*?:.><|"&%;,
Element name ASCII [32..126] \/*?:.><|"&%;,
General Project Name A-Z,a-z,0-9,-,_ “PUBLIC”, “readme”,

“index.html”
Page Name A-Z,a-z,0-9,-,_ -
Dialog Page Name A-Z,a-z,0-9,-,_ -
Template Page A-Z,a-z,0-9,-,_ -

Name
Limitations in Unicode support
Area Property Charset Accepted Reserved Chars/Strings
Keypad Name A-Z,a-z,0-9,-,_ -
Files A-Z,a-z,0-9,-,_ -
(Images/Video/etc..)
Widgets ID A-Z,a-z,0-9,-,_ -
Runtime PLC UTF-8, Latin1, UCS-2BE, UCS-2LE, -

Communication UTF-16BE, UTF-16LE
21 Scheduler
PB610 Panel Builder 600 provides a scheduler engine that can execute specific actions at set intervals, or on a time basis.
Creating a schedule is typically a two-step process:
1. You create a schedule with a list of actions to be executed when the scheduled event occurs. You do this in the
Scheduler editor
2. You create a runtime user interface that allows the end-user to change settings for each schedule. You do this
adding a Scheduler widget to a page of your project and configuring it to fit user scheduling needs.
Creating a schedule 262
HighResolution schedule 262
Recurring schedule 262
Configuring location for schedules 264
Configuring the Scheduler widget 265
Scheduling events at runtime 266
Creating a schedule
Creating a schedule
Path: ProjectView> Config> double-click Scheduler
l Click + to add a schedule.
Schedule parameters
ID Unique code assigned automatically to the schedule
Name Name of schedule
Type Type of schedule:
l Recurring, see "Recurring schedule" below for details.

l HighResolution, see "HighResolution schedule" below for details
Schedule Scheduler settings and options. See "Recurring schedule" below for details.
Action Actions to be executed at the scheduled time
Priority Priority level for the event. If two schedules occur at the same time, the event with the higher priority will be
executed first.
HighResolution schedule
The HighResolution schedule is used to perform actions that need to be repeated at specified intervals. The interval
between executions is set in milliseconds in the Schedule column.
Note: You cannot change at runtime the settings of this type of schedule. If you need to change the action time
settings at runtime, choose Recurring schedule and set Type to Every. See "Recurring schedule" below for
details.
Recurring schedule
The Recurring schedule is used to perform actions at specified points in time. Settings can be modified at runtime.
21 Scheduler
Recurring scheduler parameters

Type Frequency of the scheduled actions
Mode Specific settings required by each scheduler type
Condition Boolean tag (true/false) to activate the specified actions at the moment the timer is triggered. Actions will
be executed if tag = true. By default, actions are executed when the timer is triggered.
Note: Only tags attached to the Boolean data type are shown.
Actions Actions to be executed by the schedule.
Important: Actions and schedule parameters cannot be modified at runtime
Date Date when the scheduled actions will be executed
Time/Offset This field display one of the following:
Time = when the scheduled actions will be executed
Offset= delay or advance with respect to the selected mode.
Location Reference location to calculate sunset/sunrise time.
weekdays Days of the week in which the scheduled actions will be executed.
On startup Executes schedule at start up
Enable Enables/disables the schedule

schedule
Execute Executes the schedule only once at start up

only at
startup
Schedule type options

Option Description
By Date Actions are executed on the specified date and time.
Daily Actions are executed daily at the specified time.
Every Actions are executed with the specified interval (Range: 1 s–1 day)
Hourly Actions are executed every hour at the specified minute.
Monthly Actions are executed every month at the specified date and time.
Configuring location for schedules
Option Description
Weekly Actions are executed every week on the specified weekday(s) and time.
Yearly Actions are executed every year at the specified date and time.
Schedule mode options

Option Description
Time Depends on the schedule type. Allows you to specify date/time/week data.
Random10 Actions are executed in the time interval of 10 minutes before or after the set time.
For example, if set time is 10:30, actions are executed any time between 10:20 and 10:40.
Random20 Actions are executed in the time interval of 20 minutes before or after the set time.
For example, if set time is 10:30, actions are executed any time between 10:10 and 10:50.
Sunrise+ Actions are executed with a specified delay after sunrise. The delay is set in minutes/hours
and sunrise time is location specific.
Sunrise- Actions are executed with a specified advance before sunrise. The advance is set in
minutes/hours and sunrise time is location specific.
Sunset+ Actions are executed with a specified delay after sunset. The delay is set in minutes/hours and
sunset time is location specific.
Sunset- Actions are executed with a specified advance before sunset. The advance is set in
minutes/hours and sunset time is location specific.
See "Configuring location for schedules" below for details on sunset and sunrise settings.
Note: Mode options are not available for all schedule types.
Configuring location for schedules

Scheduled actions can be configured to be executed at a specific time with respect to sunrise and/or sunset. To do this you
need to define the correct location, based on UTC information. The system will the automatically calculate the sunrise and
sunset time.
Only a few locations are available by default. If your location is not listed, you can add it by entering latitude, longitude and
UTC information in the Target_Location.xml file.
Important: Each platform has its own Target_Location.xml file.
21 Scheduler
Location files position

Application Location file path
PB610 Panel Builder 600 ABB\Panel Builder 600 Suite\languages\shared\studio\config\Target_Location.xml
HMI Devices ABB\Panel Builder 600 Suite\runtime\<HW Platform>\config\Target_Location.xml
Simulator ABB\Panel Builder 600 Suite\simulator\config\Target_Location.xml
PB610 PC Runtime ABB\Panel Builder 600 Suite\server\config\Target_Location.xml
For example, the information for the city of Verona (IT) is shown below:
Location information is also displayed in the dialog together with sunset and sunrise times.
Configuring the Scheduler widget

To display scheduler data on a page:
Scheduling events at runtime
1. Drag and drop a Scheduler widget from the widget gallery into the page.
2. In the Properties pane, click + for the Name parameter: the Schedule List dialog is displayed.
3. Add all the schedules you want to display in the page.
4. In the Properties pane, customize all settings.
Scheduler settings
Name Schedule to be displayed
Columns Columns to be displayed and their characteristics
Show Header Shows/hides column headers
Time Spec Time to be displayed at runtime
Text Font used for text
Display Table styles

At runtime you can modify the following scheduling parameters.
21 Scheduler
Occurrence Information on the type of schedule and time of execution
Condition Condition applied to action execution
Enable Enabels/disables the execution of the scheduled actions without deleting the schedule.
See "Recurring schedule" on page 262 for details on schedule parameters.
22 21 CFR Part 11 Compliance
PB610 Panel Builder 600 includes a set of functions for responding to the requirements specified in FDA 21 CFR Part 11.
The standard is intended to provide a solution for securely handling electronic records and electronic signatures in industrial
applications.
The table lists all the requirements specified by the regulation and reports the functions available in PB610 Panel Builder
600 for compliance.
FDA 21 CFR Part 11 compliance is optional during application development and the application
developer is responsible to configure the application in the proper way.
Chapter Description PB610 Panel Builder 600 compliance level (v2.8)
11.10(a) (a) Validation of systems to ensure accuracy, Reports generated by PB610 Panel Builder 600 can
reliability, consistent intended performance, and the be signed using x.509 Certificates. A certificate that
ability to discern invalid or altered records. includes the public key, necessary to verify the
signature of reports, will be exported with the report.
References:
l "SaveEventArchive" on page 168
l "Scheduler" on page 261
11.10(b) The ability to generate accurate and complete copies Application developer can select the resources
of records in both human readable and electronic (process values, alarms, etc.) whose changes will be
form suitable for inspection, review, and copying by tracked to the audit trail. Each change of the selected
the agency. Persons should contact the agency if resources will be recorded with the name of the
there are any questions regarding the ability of the operator doing the change. The audit trail reports can
agency to perform such review and copying of the be exported to .csv files.
electronic records.
References:
l "Enable/disable audit trail" on page 294

l "Exporting audit trail as .csv files" on
page 299
11.10(c) Protection of records to enable their accurate and Applications can be developed to self-generate
ready retrieval throughout the records retention signed reports to external memory or network folders
period. at predefined interval (e.g. at the end of the day) or
when circular buffer is full. User is responsible to
keep these reports saved for the retention period.
References:
11.10(d) Limiting system access to authorized individuals. Application developer is responsible for the
appropriate security configuration of the application.
References:
l "User management and passwords" on

page 281
11.10(e) Use of secure, computer-generated, time-stamped Audit trail records are stored using a circular buffer
audit trails to independently record the date and time (this is to ensure that the device will not run out of
of operator entries and actions that create, modify, or memory). Audit trails cannot be modified by the
delete electronic records. Record changes shall not operator. Each record contains a sequential number
obscure previously recorded information. Such audit to easily check the presence of all records. The
trail documentation shall be retained for a period at application can be developed to save/export a copy
least as long as that required for the subject of the data at regular intervals (e.g. at the end of each
electronic records and shall be available for agency day); operator is responsible for storing copy of
review and copying. reports in a safe place.
References:
page 299
11.10(f) Use of operational system checks to enforce Macros or JavaScript can be used to configure
permitted sequencing of steps and events, as command sequences in the application.
appropriate.
11.10(g) Use of authority checks to ensure that only The HMI application can be configured
authorized individuals can use the system,
l to be accessible only after user sign in with its
electronically sign a record, access the operation or
own password
computer system input or output device, alter a
record, or perform the operation at hand. l objects can be configured to be available or
not available depending on the user who
logged in to the system
l resources can be configured to require a
password confirmation before be modified
References:

page 281
l "Electronic Signature" on page 295
11.10(h) Use of device (e.g., terminal) checks to determine, Resources can be configured to be accessible only
as appropriate, the validity of the source of data input from selected user groups. List of allowed IP address
or operational instruction. can be configured from the User Management
settings.
References:
l "Modifying access permissions" on page 283
11.10(i) Determination that persons who develop, maintain, Application developer is responsible to define and
or use electronic record/electronic signature assign the appropriate user rights to each user that
systems have the education, training, and have access at the HMI device
experience to perform their assigned tasks.
11.10(j) The establishment of, and adherence to, written Application developer is responsible for establishing
policies that hold individuals accountable and appropriate procedures.
responsible for actions initiated under their electronic
signatures, in order to deter record and signature
falsification.
11.10(k) Use of appropriate controls over systems Application developer is responsible for establishing
documentation including: appropriate procedures.
(1) Adequate controls over the distribution of, access

to, and use of documentation for system operation
and maintenance.
(2) Revision and change control procedures to

maintain an audit trail that documents time-
sequenced development and modification of
systems documentation.
11.30 Persons who use open systems to create, modify, PB610 Panel Builder 600 has been designed for
maintain, or transmit electronic records shall employ operation in closed systems.
procedures and controls designed to ensure the
authenticity, integrity, and, as appropriate, the
confidentiality of electronic records from the point of
their creation to the point of their receipt. Such
procedures and controls shall include those identified
in 11.10, as appropriate, and additional measures
such as document encryption and use of appropriate
digital signature standards to ensure, as necessary
under the circumstances, record authenticity,
integrity, and confidentiality.
11.50(a) Signed electronic records shall contain information All records will be added to the audit trail with time
associated with the signing that clearly indicates all stamp and user id of logged user.
of the following:
References:
(1) The printed name of the signer;
(2) The date and time when the signature was page 299
executed; and l "Table audit widget" on page 298
(3) The meaning (such as review, approval,
responsibility, or authorship) associated with the
signature.
11.50(b) The items identified in paragraphs (a)(1), (a)(2), and

(a)(3) of this section shall be subject to the same
controls as for electronic records and shall be
included as part of any human readable form of the

electronic record (such as electronic display or
printout).
11.70 Electronic signatures and handwritten signatures Application developer is responsible for avoiding
executed to electronic records shall be linked to their using the macros that permit the import/export of
respective electronic records to ensure that the user passwords.
signatures cannot be excised, copied, or otherwise
transferred to falsify an electronic record by ordinary
means.
11.100(a) Each electronic signature shall be unique to one System will ensure that two users with the same id
individual and shall not be reused by, or reassigned cannot be defined. It is user responsibility to avoid
to, anyone else. removal and reassignment of the same user id to a
different user.
11.100(b) Before an organization establishes, assigns, User responsibility.

certifies, or otherwise sanctions an individual's
electronic signature, or any element of such
electronic signature, the organization shall verify the
identity of the individual.
11.100(c) Persons using electronic signatures shall, prior to or User responsibility.

at the time of such use, certify to the agency that the
electronic signatures in their system, used on or after
August 20, 1997, are intended to be the legally
binding equivalent of traditional handwritten
signatures.
(1) The certification shall be submitted in paper form

and signed with a traditional handwritten signature,
to the Office of Regional Operations (HFC-100),
5600 Fishers Lane, Rockville, MD 20857.
(2) Persons using electronic signatures shall, upon

agency request, provide additional certification or
testimony that a specific electronic signature is the
legally binding equivalent of the signer's handwritten
signature.
11.200(a) (a) Electronic signatures that are not based upon PB610 Panel Builder 600 Security functions are
biometrics shall: based on the combination Username/ Password.
(1) Employ at least two distinct identification

components such as an identification code and
password.
(i) When an individual executes a series of signings Users must enter name and password to access the
during a single, continuous period of controlled system. Critical actions can be configured to require
system access, the first signing shall be executed entering again the password before execution is
using all electronic signature components; started.
subsequent signings shall be executed using at least
one electronic signature component that is only References:

executable by, and designed to be used only by, the
individual.
page 281
(ii) When an individual executes one or more l "Electronic Signature" on page 295
signings not performed during a single, continuous
period of controlled system access, each signing
shall be executed using all of the electronic signature
components.
(2) Be used only by their genuine owners; and Each user is responsible to not divulge own
password. Passwords defined by administrator for
(3) Be administered and executed to ensure that
first access can be forced to be redefined at first use.
attempted use of an individual's electronic signature
by anyone other than its genuine owner requires References:
collaboration of two or more individuals.
l "Configuring users" on page 289
11.200(b) Electronic signatures based upon biometrics shall be PB610 Panel Builder 600 does not support
designed to ensure that they cannot be used by biometrics.
anyone other than their genuine owners.
11.300(a) Maintaining the uniqueness of each combined It is not possible to define to define two users with
identification code and password, such that no two the same User ID
individuals have the same combination of
identification code and password.
11.300(b) Ensuring that identification code and password System can be configured to force each users to
issuances are periodically checked, recalled, or define a new and different password after a
revised (e.g., to cover such events as password configurable number of days
aging).
References:
11.300(c) Following loss management procedures to Users can change their password at any time.
electronically deauthorize lost, stolen, missing, or Administration can redefine each user's password
otherwise potentially compromised tokens, cards, and force them to redefine at the first login.
and other devices that bear or generate identification
References:
code or password information, and to issue
temporary or permanent replacements using l "User management actions" on page 177
suitable, rigorous controls.
x.509 Certificate
11.300(d) Use of transaction safeguards to prevent Failed logging attempts are logged to audit trail.
unauthorized use of passwords and/or identification
codes, and to detect and report in an immediate and
urgent manner any attempts at their unauthorized
use to the system security unit, and, as appropriate,
to organizational management.
11.300(e) Initial and periodic testing of devices, such as tokens User is responsible for ensuring appropriate
or cards, that bear or generate identification code or measures.
password information to ensure that they function
properly and have not been altered in an
unauthorized manner.
x.509 Certificate
To ensure authenticity of reports generated by HMI devices, HMI Runtime can generate reports with signed files to verify
the authenticity and the integrity of the generated reports.
HMI Runtime uses asymmetric cryptography keys to sign files and x.509 standard to manage public key certificates. The
picture shows the architecture.
Workflow
1. Each HMI device contains two keys:
l Key1 is the secret key, that is used to sign the reports generated by the HMI device. This key is securely
stored inside the HMI device.
l Key2 is the public key that anyone can use to verify the authenticity of the reports signed by the HMI device.
2. The macro SaveEventArchive can be used to generate signed reports (see "SaveEventArchive" on page 168 for
additional details)
3. Users can use the public key and the signed file to verify a report is authentic and has not been modified after it has
been generated.
Authenticity of the public key
Before verifying a report (Report.csv) with its signed file (Report.csv.sign), users must be sure of the authenticity of the
public key (HMI.crt).
The public key can be signed by a Certificate Authority (CA) that guarantees its authenticity. As an alternative, the public
key can be taken directly from the HMI device
x.509 Certificate
The internal x.509 certificate files

You can generate a self-signed certificate with a dedicated function in System Settings. You can also export or import the
internal certificate file.
Users can personalize the information contained in the certificate. They can keep the self-signed certificate or retrieve the
"Certificate Signed Request" to submit to a Certificate Authority for the validation. Then the certificate signed by the
Certificate Authority can be imported inside the HMI device. (See the x.509 Certificate section inside the "System
Settings" on page 503)
You can import certificates with or without private key. When the certificate contains the private key, the internal private
key of the HMI device will be substituted with the key found in the certificate. Certificates are encoded base64..
You can import inside each HMI device the same certificate file to have a unique public certificate file for all your
HMI devices.
Example of a certificate with both public and private keys.
PB610 PC Runtime
When using PB610 PC Runtime the certificate files can be found inside the folder:
%AppData%\ABB\<Version>\server\config\ssl-certificate
Batch files to manage certificate files using the public OpenSSL-Win32 tool
Here are example of how certificate files can be managed using a public OpenSSL-Win32 library
Reference.: https://www.openssl.org/
21 CFR Part 11 - Tips
Creating self-signed certificates
@echo off
set OpenSSL="C:\Program Files (x86)\OpenSSL-Win32\bin\openssl.exe"
set CertificateName=HMIDeviceID
rem Generate an RSA key

%OpenSSL% genrsa -out ssl-certificate.key 2048
rem Creating Certificate Signing Requests

%OpenSSL% req -new -key ssl-certificate.key -out ssl-certificate.csr -subj
"/C=IT/L=Verona/O=CompanyName/OU=RD Team/CN=%CertificateName%"
rem Creating Certificate

%OpenSSL% x509 -req -days 3650 -in ssl-certificate.csr -signkey ssl-
certificate.key -out ssl-certificate.crt
pause
Verify a signed report
@echo off
set FileToCheck=Report.csv
rem Extract public key from the certificate

%OpenSSL% x509 -in HMI.crt -pubkey -noout > publicKey.pem
rem Verify Signature

%OpenSSL% dgst -sha256 -verify publicKey.pem -signature %FileToCheck%.sign
%FileToCheck%
rem Remove public key

del publicKey.pem
pause
SaveEventArchive (see "SaveEventArchive" on page 168) generates signed reports using the "sha256"
algorithm.
See project properties in "Project" on page 76 for other available algorithms.

Suggestions to development a CFR11 compliant application
User management macros

User management macros that could be use from any user
l Login
l Logout
l SwitchUser
l ChangePassword
User management macros that could be used from administrator only
l ResetPassword
l AddUser
l EditUsers
l ExportUsers,
Deprecated macros that must not be used inside CFR 21 part 11 compliance applications
l ImportUsers
l DeleteUser
l DeleteUMDynamicFiles,
23 User management and passwords
You can restrict access to various widgets and operations by configuring users, users groups and assigning specific
authorizations to each group.
Each user must be member of one and only one group. Each group has specific authorizations and permissions.
Authorizations and permissions are divided in two categories:
l Widget permissions: hide, read only, full access

l Action permissions: allowed or not allowed.
By organizing permissions and groups you can define the security options of a project.
Enable/disable security management 282
Configuring groups and authorizations 282
Modifying access permissions 283
Assigning widget permissions from page view 288
Configuring users 289
Default user 290
Managing users at runtime 290
Force remote login 291
Enable/disable security management
Enable/disable security management

Path: ProjectView> right-click Security> Enable
The padlock symbol indicates whether the function is enabled or disabled.
Important: Security settings are effective only if the security function is enabled.
Configuring groups and authorizations

Path: ProjectView> Security> double-click UserGroups
Three predefined groups are available by default (admin, guest and unauthorized): they cannot be deleted nor renamed.
You can, however, modify authorizations and other settings.
Adding a user group

Click + to add user group.
Name Name of users group
Authorized Authorization granted
Home Page Page displayed when users belonging to this group log in
Use Last Visited When selected, the last page displayed by the previous user will be displayed when users
Page belonging to this group log in
Comments Any comment or description for the group
Authorization Opens the Admin Authorization dialog to set access permissions.

Settings
See "Modifying access permissions" below for details.
Modifying access permissions

Path: ProjectView> Security> double-click UserGroups > Authorization Settings column
Click the button: a dialog appears with a list of widgets and actions. You can modify access permissions for each one in the
list.
Widget permissions
In the Widget tab you can define widget access options at project level, at page level or at widget level for all the widgets
used in the project. Lower levels permission (for example, widget level) overrides higher levels (that is, page and project
levels).
Use Base settings to set default permissions at project level.
Possible settings are:
l Full Access to enable read/write access to the widget

l Read Only to enable readonly access to the widget
l Hide to hide widget for selected group
Changing a widget permission

To change access permission for an individual widget in a page of the project, navigate to that widget within its page on the
right pane and customize its access options. Otherwise, all widgets take the permissions set at project or page level.
For example, if page permission for a widget is set at project level to Read Only, then all the same widgets will have
permission Read Only. When you select a widget inside a page from the tree structure, permission is actually set to Use
Base Settings. You can change this setting and modify access permissions only for this widget in this page.
Access priority
Widget permissions are considered with the following priority:
Permission level Priority
Project level - Basic settings Low
Page level Medium
Widget level High
This allows you to specify exceptions for an action or a widget directly from the page view.
For example, if you set permissions for a widget at project level to Read Only and to Full Access at page level then the
page level settings will prevail.
Access permissions can be modified directly from the project page. See "Assigning widget permissions from page view" on
page 288 for details.
Action permissions
In the Action tab you can define action authorizations at project level, at page level or at widget level. Actions can be either
Allowed or Not Allowed.
Action permissions can be modified directly from the project page. See "Assigning widget permissions from page view" on
FTP authorizations
In the Ftp tab you can set specific authorizations for the FTP server.
Element Description
Enable FTP authorization Enables the FTP function for the specific group
Permission Type of permission:
l Read-Only
Element Description
l Read-Write
Root Folder Folder to be used as root for FTP access. This is a relative path.
Additional folder Extra folders to be used as root for FTP access (for example, on USB drive or SD card)
Allowed IP Addresses List of IP addresses from which FTP connection can be accepted.
Important: This setting is common to all users groups.
HTTP authorizations
In the HTTP tab you set restrictions to HTTP access to the web server integrated in HMI Runtime.
Wildcards can be used to identify a range of IP addresses.
For example, the two following rules set the HMI device unit can only be accessed by all the IP addresses 192.168.*.* on
your local network in which only the IP address of 192.168.1.20 can access the device without entering a login name.
Element Description
IP list IP addresses authorized to access the HTTP server. By default all.
Login When disabled, the username and password are not required.
Access limits List of resources for which access is limited
Effect of these settings depends on whether the option Force Remote Login has been selected. See "Force remote login"
on page 291 for details.
Force Remote Default Access to

Access limits
Login workspace
- Full -
Disable Full Can be used to block access to some files/folders or to require

authorization
Enable No Access Can be used to open access to files/folders
Important: This setting is common to all users groups.
Adding an HTTP configuration
To add and configure a new access click +: the Access limits dialog is displayed.
To restore the default configuration click the Set default access limits icon. Default configuration allows access to the
following:
l PUBLIC folder and Index.html
Miscellaneous settings
In the Miscellaneous tab you can define various authorization settings.
Note: Some of these settings are group specific, while other are common to all groups.
Option Description
Can enter config mode Enables switching from runtime to configuration mode. Normally used for maintenance.
Can manage other Gives super user privileges at runtime to manage the select groups. Allows adding, deleting
users and modifying users' permissions.
Assigning widget permissions from page view
Option Description
Can load factory Restores factory settings.

settings
Can zoom Enables zoom in/out in context menu at runtime
Can see log Allows user to see logs at runtime
Can create backup Allows user to backup project.
Number of users Maximum number of users that can be connected to the HMI Runtime at the same time.
allowed to login Default is 3.
Assigning widget permissions from page view

You can assign different levels of security, to different user groups, on a single widget, directly from the project pages.
1. Right-click on the widget and select Security settings.

2. Choose the group: the authorization dialog for the group is displayed.
3. Set the security properties to access the widget.
See "Modifying access permissions" on page 283 for details.
Configuring users
Path: ProjectView> Security> double-click Users
In the Users editor, click + to add a user: one row is added to the table.
Name User name
Default User This user is automatically logged in when the system is started or after another user has
logged off. Only one Default user can be set
Group User group
Password User password. Note that for security reasons the password will never be displayed
Passwords are encrypted and cannot be retrieved not even for specialized
technicians
Comments Further user description
Exception Allows to change the values forced from the User Settings parameters
Change Initial This user is forced to change his password at first log in
Password
Logoff time (minutes) Minutes of inactivity after which the user is logged off. Set to 0 to disable
Password Minimum Minimum length of password

Length
Must Contain Special Password must contain at least one special character
Characters
Must Contain Password must contain at least one numeric digit

Numbers
Password cannot be The new password must be different from the last 3 used passwords
reused
Default user
Password aging Number of weeks before forcing a password change (1/52 weeks)
(weeks)
Warning (days) Show a warning message before password expires (1/30 days)
Users Settings
From the Settings command, there is the possibility to define parameters values that will be common to all users.
Users with the Exception flag checked are not force to use the common parameters.
Default user
You can define only one default user in a project. This is the user automatically logged in at system start up and when the
currently logged user logs out or is logged out after time-out.
To log into HMI Runtime with a different user, use one of the actions:
l SwitchUser
l LogOut
See "User management actions" on page 177for details.
Managing users at runtime

The default user, if any, is automatically logged in when the HMI Runtime is started. If no default user is configured, the
system requires a user name and password. See "User management actions" on page 177for details on the actions that
can be executed on users.
Removing user data

All the user information modified at runtime is stored in dedicated files. To remove these dynamic files and all the changes
applied to user configuration at runtime you can:
l on HMI Runtime: execute the action DeleteUMDynamicFile

l with PB610 Panel Builder 600: select the Delete Dynamic Files in the download dialog.
Force remote login

Path: ProjectView> right-click Security> Force Remote Login
Select this option to force user to log in when using remote access viaHMI Client. If not selected, remote access will use
the same level of protection of local access.
Important: This function only works when user management is enabled.
Tip: Use this option when you have a default user but at the same time you want to protect remote access.
See "Enable/disable security management" on page 282for details.
The only files/folders still accessible when this flag is enabled are:
l PUBLIC folder and Index.html.
See "Modifying access permissions" on page 283 for details on HTTP access limits.
Force remote login
24 Audit trails
The Audit trail is a chronological sequence of audit records. Each record contains information on the actions executed and
the user that performed them.
This function provides process tracking and user identification with time stamp for events.
Enable/disable audit trail 294
Electronic Signature 295
Table audit widget 298
Exporting audit trail as .csv files 299
Configure audit events 300
Enable/disable audit trail
Enable/disable audit trail

Path: ProjectView> Security > double-click AuditTrail
Audit trail logging can be enabled from the “Enable Audit Trail” check box
When enabled, all changes to the selected resources will be logged to the audit buffer with the time stamp, user name that
performed the operation and some additional information concerning the modified resource (e.g. new value and previous
value for tags)
From the main tabs (Tags, Alarms, Recipes and Miscellaneous) of the Audit trail Editor you can switch between the list
views of the available resources.
Audit Enable tracking of the selected resource
Signature The user password is required before allowing the resource to be modified from the user (see "Electronic
Signature" on the facing page to additional information)
Audit Internal buffer where store the related audit events (see "Configure audit events" on page 300 to additional
Buffer information)
Comment Comment space available for the developers
Tags
l Keep track of when tag value changes.
Alarms
l Keep track of when user acknowledges or resets an alarm event
Recipes
l Keep track of when user downloads or uploads recipes
Miscellaneous Resources
24 Audit trails
l User login details

Keep track of when user login, logout or change password
l User management actions
Keep track of when a user is added, removed or when the user properties are modified
l System actions
Keep track of system actions (HMI Device Restart, Power On, Backup, Update, Download, enter in System
Setting, open Project Manager)
l FTP actions
Keep track of ftpGET, ftpPUT, OpenTextEditor, SaveTextEditor
l Buffer actions
Keep track of dump and delete actions on alarms, audit or trends buffers
LogMessage Macro
In addition of that, the LogMessage macro gives the possibility to define additional events to log to the audit trail buffer.
See "LogMessage" on page 170 for additional details.
Electronic Signature
For each resources listed within the Audit Trail editor, it is possible configure the HMI Runtime to require the password
confirmation before changing it. If the audit trail log is enabled, the user has the option of adding a comment that will be
recorded within the Track Log.
Path: ProjectView> Security > double-click AuditTrail
The user password is required before allowing the resource to be modified by the user
Electronic Signature
The introduced password will be not required again for the commands released in the next 10 Sec.
The validity time can be modified from the Settings dialog.
24 Audit trails
Table audit widget
Table audit widget

Path: Widget Gallery> Basic> Audit Tables
Display contents of the audit trail inside a widget
Buttons:
l REFRESH
Retrieve trend data from internal buffer and refresh table view
l BACKWARD/FORWARD
Move the display window forward or backward as specified in the duration parameter
Filter:
Use the combo box to select the column where search for and the text filed on the right to enter the string to search to.
AuditBuffer Event Buffer from which the event list is retrieved (see "Configure audit events" on page 300)
Heading Heading label
Default Duration Initial value of time window to show
Time Spec Time format:
l Local = show the time values of the HMI device.

l Global = show the time values using UTC format.
24 Audit trails
Filter List Labels to show in filter column selection
Table Layout Defines the characteristics of the scroll bar and allows to remove the header of the table
Exporting audit trail as .csv files

Data recorded inside the audit trail can be exported inside a csv file using the SaveEventArchive action. See
"SaveEventArchive" on page 168 for details.
File structure
Exported data file has the following content
RecordID Each record is stored with a progressive number which will give the possibility to easily identify missing
records or confirm that they are not lost. Note that the progressive number is not reset to zero when the
buffer is deleted.
Date, Time Event time stamp. Time can be configured as local or global from the dump action.
User ID User that perform the operation
Interface LOCAL: when the action is performed in the HMI device
CGI: when the action is performed by a remote client.
SYSTEM_IDAL: when the action is performed from the HMI Runtime application
Action Action executed.
Configure audit events
Exported data file has the following content
Status Result of the executed action
l S_OK
Action executed correctly
l E_FAIL
Action non executed
l S_NEEDNOT_NOTIFY
Action triggered (will be executed asynchronously)
Information Additional info related with the executed action.

You can have more than one set of audit records. You need to configure a dedicated event buffer.
Creating an event buffer

Path: ProjectView> Config> double-click Event Buffer
1. In the Event Buffer editor, click +: a row is added to the table.

2. Select Audit for Type.
3. Configure buffer parameters.
Id Buffer identification number
Name Buffer name
Enable Enable/disable logging
Size Size of log file. Data is automatically saved to disk every 5 minutes.
Type Type of events logged:
l Alarms
24 Audit trails
l Audit
l Generic
Storage Device Device where audit data will be stored
25 Reports
A report is a collection of information that will be printed when triggered by an event. When the programmed event is
triggered, the printing starts in background.
You can configure reports, their contents, trigger conditions and output printer in the Reports editor.
Not all widgets can be used in reports. When configuring reports, PB610 Panel Builder 600 provides access to a dedicated
widget gallery featuring only widgets available for reports.
Reports format can be customized using predefined templates for page layout.
Note: Report printing is not supported by HMI Client.
Adding a report 304
Configuring text reports 304
Configuring graphic reports 305
Print triggering events 306
Default printer 307
Adding a report
Adding a report
Path: ProjectView> Config > double-click Reports
In Reports editor, click Graphic Report or Text Report: one new row is added to the table.
Report types
Report
Description
type
Text Use for line-by-line printing of alarms.

Reports
Only used for line printers.
Text is sent to the printer without using any special driver.
Important: This printing mode requires using a physical port and only works on
Windows CE platforms.
Graphic Contain graphical elements and may include complex widgets such as screenshots or alarms.
Reports
Important: Each printer requires a specific printer driver. See "Configuring graphic
reports" on the facing page for a list of supported printer drivers.
Configuring text reports

Use the Reports editor . Paper Size in number of characters.
Setting printer options

Use printer options to control flush of pages on printer.
Printing starts either immediately or after a timeout. In printer options you can force flush as soon as a specific condition
occurs, after a specified number of events, lines or seconds.
Note: Text reports do not support PDF format.
Setting alarms layout

Paper Size is the width of paper in number of characters.
Adding fields to the report

To add an item to the report, drag and drop it on the template page from the Available fields list.
25 Reports
Re-size the field using the mouse, a tool tip shows the dimension in number of characters.
Note: If the text does not fit in the dedicated space, the auto wrap is applied.
Configuring graphic reports

Use the Report editor to configure graphic reports.
Adding a report page

Click + to add a new page to the report layout.
When the mouse goes over a page, two icons are displayed and allow you to reorder or delete the pages.
Modifying report page content

1. Double click on a page to edit its content: the Graphic Report editor appears.
Each page is divided in: header, footer and page body.
2. Double click on the area you want to edit: the edit area is shown in white, others are grayed out.
The Widget Gallery is context-sensitive and displays only the widgets available for the area you are editing.
Widgets available for reports

Widgets that can be used for a graphic report:
Print triggering events
Widget Function
Page Automatic page numbering

Number
Screenshot Screen capture of the page currently displayed by the HMI device. The report page is automatically
resized to fit the HMI device page.
Note: The full screen is printed, including all open dialogs.
Alarm Entire contents of the event buffer (default buffer is Alarm Buffer1).
Text Widgets such as labels and numeric fields
Print triggering events

Report printing can be triggered by events.
Configuring alarm printing

1. In the Alarms editor, open the Event Types dialog from the Events column.
2. In Print tab select all the conditions for which you want to trigger printing.
Important: Only one report can be set as Active alarm report in a project and it can be either a text
report or a graphic report.
25 Reports
Adjusting printer settings at runtime

A graphic report printing can be started also using the action PrintGraphicReport.
Set the action property silent to false to have a pop-up dialog.
Default printer
Printer setting
You can set a default printer for all graphic reports. Each report can then be configured to use the default printer or any other
printer available. Click Printer Setting button to set printer parameters.
For PDF printers you also define the folder where files are saved by using Printed Files Location.
Supported printers
List of printers and printer languages supported by the Windows CE driver printCE.dll. Printers not available in the list but
compatible with these languages are supported.
Printer Languages
HP PCL 3, HP PCL 5e, HP PCL3GUI HP PCL3/PCL5e/PCL3GUI, including DeskJet, LaserJet,

DesignJet
Epson ESC/P2 ESC/P2, LQ
Epson Stylus Color Epson Stylus Color
Epson LX (9-pin) 9-pin printers, Epson LX, FX, PocketJet
Cannon iP100, iP90, BubbleJet BubbleJet, iP90, iP100
PocketJet II, 200, 3 Pocket Jet
MTE Mobile Pro Spectrum MTE Mobile Pro Spectrum
Adobe PDF File Adobe PDF file
Default printer
Printer Languages
SPT-8 SPT-8
M1POS M1POS
MP300 MP300
Zebra Zebra CPCL language
Intermec PB42, PB50, PB51, PB2, Intermect PB42/50/51/2/3 with ESC/P language
PB3
Datamax Apex Datamax Apex
Supported ports
The following ports are supported:
l LPT1 (USB printers)

l File (PDF)
Note: On Windows platform, only PDF and default printers are supported. Default printer is the default OS printer
and it can be connected with any kind of port (not only USB).
Tested printers
The following printers have been tested with printCE drivers in Windows CE HMI devices.
Driver Printer Model Graphic Line
Custom Plus 4 Kube II Yes Yes
Epson Epson AcuLaser M2310 Yes Simulate

ESC/P 2
Epson LX Epson LX-300+II No Yes

(9-pin)
HP PCL 3 HP LaserJet P2015dm Yes Simulate
HP LaserJet 4700dtn Yes Yes
HP PCL 3 HP Deskjet 1010 Yes No

GUI
HP Deskjet D5560 Yes No
HP LaserJet 4700dtn No Yes
HP PCL 5e HP LaserJet P2015dm Yes Simulate
HP LaserJet 4700dtn
INTERMEC Intermec PB50 with ESC/P language with 4 inch roll paper. Yes Yes
Note: The HMI device crashes when trying to print on
25 Reports
Driver Printer Model Graphic Line
Intermec PB50 printers in standby mode after a first

successful print job.
PDF - Yes No
Default printer
26 Screen saver
Screen saver can be used to display a slide show when the HMI device is not in use. The slide show starts after a timeout if
none of the following events occur:
l touch of display
l mouse movement
l external keyboard key pressed
Enabling the screen saver function

Path: ProjectView> Config > right-click Screen Saver> Enable
Important: You must enable the screen saver before you can configure it.
Configuring a screen saver

Path: ProjectView> Config > double-click Screen Saver
Slide show parameters

Timeout Time after which the slide show starts
Slide Interval between slides

Interval
Storage Location of the images used in the slide show.

Device
Images stored locally are saved in workspace\projectname\screensaver and can be downloaded to the
HMI device when the project is downloaded.
Images stored on USB or SD devices are saved in a screensaver folder on the device itself.
Important: Only JPEG and PNG images are supported.
Associating actions to the screen saver

Actions can be triggered by the screen saver start and/or stop.
l Click + next to Actions in the onStart tab to configure actions to be executed when the screen saver starts.
l Click + next to Actions in the onStop tab to configure actions to be executed when the screen saver stops.
27 Backup/restore of Runtime and
project
You can backup all the content of the HMI device, including
l HMI Runtime
l HMI Application Project
to an external memory. This backup copy can be used to restore the content of the HMI device at a later time or copy it to a
new HMI device.
The backup function is available only if enabled for the logged user. See "Modifying access permissions" on page 283 for
details.
Note: Backup is not supported in Windows Runtime and in HMI Client.
Backup function
The backup function automatically performs the following procedure:
1. Unloads the current project to unlock files in use.

2. Archives the content of the \QTHMI folder (containing HMI Runtime, projects, dynamic files such as recipes,
alarms, trends and so on) to a .zip file (standard or encrypted).
3. Reset the HMI device (reloads the project).
To start the backup procedure:
1. In HMI Runtime right click to open the context menu.

2. Select Backup: the Backup dialog is displayed.
3. Select the path for storing the backup file.
Note: The backup process does not include files stored in USB and SD cards. Dynamic data such as recipes,
trends, events stored in these devices will not be included in the backup.
Restore function
Restore the backup package can be perform on HMI device
l from the Context Menu (see "Update package" on page 91 for details)
l or from the System Settings (see "System Settings" on page 503 for details)
28 Keypads
Several keypads are provided by default in the PB610 Panel Builder 600 so that they can be used for data entry.
The alphabet keypad can be use associate with a string data type
The numeric keypad can be use associate with a numeric data type
The calendar keypad can be use associate with a date data type
Creating and using custom keypads 317
Deleting or renaming custom keypads 319
Keypad type 319
Keypad position 320
28 Keypads
Creating and using custom keypads

You can either create a new keypad or customize an existing one.
Creating a keypad
1. In ProjectView, right-click Keypads and select Insert Keypad: the New Keypad dialog is displayed.
2. Select one of the available keypads, or Blank to create a keypad from scratch. In this case a blank keypad is
displayed.
3. Use the Keypad Widgets and Keypad Buttons from the Widget Gallery to create your custom keypad.
The keypad you create, as in this example, will be saved in the project folder.
Creating and using custom keypads
Attaching custom keypads to fields

Custom keypads can then be reused for any field where the Keypad property points to it as in this example.
Tips and tricks with custom keypads

By default, any numeric widget (read/write numeric field) are assigned the numeric keypad.
If you want to apply a customized version of the numeric keypad to all the numeric widgets you add to your project proceed
as follows:
1. Create a new keypad and select Numeric as Keypad type. This will be a backup of the original settings for the
numeric keypad.
2. Customize the default numeric keypad and save it. This customized version of the numeric keypad will now be
assigned as default in the project.
See "Deleting or renaming custom keypads" on the facing page for details on how to rename a custom keypad.
Up-down arrows keypad

This type of keypad is particularly useful to move the cursor up and down within widget requiring this functionality. Here an
example using a Control List widget. See "Control list widgets" on page 369 for details.
28 Keypads
Deleting or renaming custom keypads

In ProjectView, right-click on a custom keypad and select one of the options:
l Remove KeyPad Page to remove the keypad from the project

l Rename Keypad Page to rename the keypad.
Keypad type
Path: ProjectView> Keypads > double-click a keypad > Properties
Set Keypad Type parameter for a keypad to define the type of data entry.
Keypad position
Keypad
Description
Type
Auto Default setting
Decimal Only numeric keys are accepted. Entering 10, the keypad returns 10 that will be displayed
as "10" if the attached field is numeric or ASCII, as 'A' if the attached filed is hexadecimal.
Hexadecimal Only hexadecimal keys are accepted. Entering 10, the keypad returns 16 that will be
displayed as "16" if the attached field is numeric or ASCII, as "10" if the attached field is
hexadecimal.
Ascii All keys are enabled. Entering 1A, the keypad returns 1A that will be displayed as '1' if the
attached field is numeric, as "1A" if the attached field is ASCII or if the attached field is
hexadecimal.
Keypad position
Runtime Positioning property of keypads can be used to define where keypads will appear in the screen.
Option Description
Automatic The best position is selected according to here data entry is required.
Absolute X,Y coordinates are entered to identify the exact position
Left-top Predefined screen positions
Left-center
Left-bottom
Center-top
Center-center
Center-bottom
Right-top
Right-cente
Right-bottom
Select the Lock Keypad position option if you do not want the keypad to be moved by dragging.
29 External keyboards
HMI Runtime has been designed to work with external keyboards connected via USB.
Keyboards can be used for:
l data entry (default)

l execute actions mapped on specific keys
For example, the right arrow key OnClick event can be mapped to the LoadPage action.
Keyboard can be programmed at project level so that settings will be inherited by all the pages. In each page you can then
choose which key setting will be inherited from the project and which one you will customize for the specific page.
Opening external keyboards

1. In the Page Editor, click on the icon on the right of Keyboard/Script at the bottom of the workspace: the
Keyboard/Script Editor is displayed.
2. Select the Keyboard tab.
Each row in the Keyboard Editor corresponds to a key.
For each key, the following information is displayed:
Element Description
Label Key name
Code Key code
Enable Key enable status
Inherits project actions Defines whether the key is inheriting the action programmed at the project level
Here the possible configurations:
Inherits
Enable project Editor appearance HMI Runtime behavior
actions
Checked Unchecked Action lists show the page actions (or nothing if the Only the page actions (if
list is empty) any) will be executed.
Checked Checked Action lists show the project actions only and Only the configured project
cannot be edited actions (if any) will be
executed.
Unchecked Checked Inherits project actions check box and all action No page or project action
lists are disabled. Action lists show the project will be executed.
actions only.
Unchecked Unchecked Inherits project actions check box and all action No page or project action
lists are disabled. Action lists show the project will be executed.
actions only.
Search and filter 323
Displayed keys 323
Removing action associations 323
Keyboard layout 324
Enable/disable keyboard 324
Associating actions to keys 324
Search and filter

To display a filtered set of keys, in Filter by select key name and type a letter in the search field: only the keys containing
that letter in their name will be displayed in the Keyboard editor.
Alternatively, in Filter by select key code and type a letter in the search field: only the key containing that letter in their
code will be displayed in the Keyboard editor.
Displayed keys
You can easily select what keys will be listed in the Keyboard editor window. To display a limited set of keys, select an
option in Shows.
Option Description
all keys All keys available in the keyboard layout are listed
modified keys Only the keys associated with actions at the page level are listed
modified keys in project Only the keys associated with actions at project level are listed
Removing action associations

To remove all the associations you created between keys and actions:
1. Select the keys for which you want to remove the association.
2. Click the Clear all actions of selected keys button.
If you are working at page level, page actions will be removed, if you are working a project level, project actions will be
removed.
Keyboard layout
Keyboard layout
Select the layout of the keyboard from the Keyboard Layout combo box. Generic Keyboard refers to a generic
international keyboard layout.
Enable/disable keyboard
You can enable/disable keyboard actions both at project and at page level. To enable keyboard actions, in the Properties
pane set Keboard macro to true.
You can enable/disable keyboard actions also at runtime using the KeyboardMacros action. See "Keyboard actions" on
Associating actions to keys

You associate actions to a keys from the Keyboard editor.
1. Click + next to the key you want to program: the fields for key configuration are displayed.
1. Click + to add actions.
You can associate actions both to the OnClick event and toe the OnHold event.
See "Events" on page 54 for details.
Note: Also JavaScript code can be associated to a key event.
Associating actions to keys
30 Tag cross reference
The Tag Cross Reference pane displays a list of tag names used in current project organized according to their location
and use.
From this pane you can:
l verify where each tag is used (alarms, pages, recipes, schedulers, trends, and so on)
l identify invalid tag references (references to tags not defined in the tag editor)
l identify tags not used in the project
Note: The Tag Cross Reference pane may not be list all tags used in JavaScript code.
Updating data in the Tag Cross Reference pane 331
Opening the Tag Cross Reference pane
Path: View> Toolbars and docking windows > Tag Cross Reference
Click the Tag Cross Reference tab to open the Tag Cross Reference pane.
Meaning of colors
Black Protocol Tags
Magenta Recipe Tags
Blue System Variable Tags
Dark Green Alias Tags
Red Invalid Tags
Example:
Working in the Tag Cross Reference pane

The Tag Cross Reference pane provides a set of standard functions.
Element Function
Group by Groups tags by Location (alarms, pages, trends and so on) or Tag name
Show Filters tags and displays:
l All Reference: all tags

l Invalid Tag Reference: tags not listed in the Tag Editor.
l Unused Tags: tags listed in the Tag Editor but not used in project.
Search field Applies a filter to display a limited number of tags
Filter by Filters tags by Location, Tag or Property.
Navigate the listed tags to find where they are used inside the project.
Double-click on a tag to open the editor or page where it is used.
Invalid tag references will be listed in red color:
Delete unused tags
From the unused tags view, is possible select one or more tags and delete them from the tag editor. To select a tag click a
tag, to select multiple tags use SHIFT or CTRL keys.
Be aware that eventually tags referenced inside JavaScript may not be found (depends on how the
code was written). Even it is not a good practical to using tags’ references inside custom widgets,
even tags’ referenced inside Custom Widgets may not be detected from the Tag Cross Reference
engine.
Updating data in the Tag Cross Reference pane

Manual update
By default, the information displayed in the Tag Cross Reference pane must be updated manually. To do this, click the
refresh button . A warning sign is displayed when a refresh is needed.
Automatic update
Path: View> Properties
You enable the automatic update of the Tag Cross Reference pane from the PB610 Panel Builder 600 Properties page.
Select the Auto Update option.
Exporting data
Data displayed in the Tag Cross Reference pane can be exported in .csv file.
Data is organized in the exported file according to how it was grouped in the pane.
Grouped by File format
Location RESOURCE, RESOURCE DESC, WIDGET-ID, ATTRIBUTE, TAG
Tag TAG, RESOURCE, RESOURCE DESC, WIDGET-ID, ATTRIBUTE
Note: The separators used in export operation depends on regional settings of your computer.
Updating data in the Tag Cross Reference pane
31 Indexed addressing
Indexed addressing allows you to select a set of tags depending on the value of another tag. This is very useful, for
example, to use the same graphics to visualize a set of data coming from different sources, all the user has to do is pick the
source to monitor from a list.
Creating an indexed addressing set 334
Using indexed tag set in pages 337
Creating an indexed addressing set

Scenario
In this scenario, environment data is collected from with four rooms, each equipped with temperature, pressure, and
humidity sensors. Data is available as follows:
Room Number Temperature Pressure Humidity
1 Room1-Temperature Room1-Pressure Room1-Humidity
Using the indexed addressing feature, you can use a single table format to arrange all data in the HMI device.
Data from the three different sensors can be displayed in a single page where the room number is used as a selector
(combo box) to pick the correct set of tags.
How to create an indexed tag set

Path: ProjectView> Tags
To do this you need to create an indexed tag set.
1. In the Tag Editor, define protocols and tag. Define a tag for each data to be indexed, in this example you must create
a tag for each sensor in each room.
2. Create a tag to be used as index tag. In this example you create a "RoomNumber" tag that could be of type
UnsignedInt using Variable protocol.
3. From ProjectView, select Config> Tags, double-click Indexed Tag Set: the Indexed Tag Set editor is displayed.
4. Click + to add an Indexed Tag Set. In this example you will call it "Room".
5. Select the tag "RoomNumber" to use as a selector for the room number.
6. Create an Index Instance for each set of data. In this example, one for each room.
7. Create an Alias for each type of data and rename the table columns appropriately. In this example "Temperature",
"Pressure" and "Humidity".
8. Double-click on each cell to associate the correct tag.
Note: The Index Tag datatype can be a number, a string or any type of simple data types.
Note: To reference an array data type use the array index = -1
Autofill function
An Indexed Tag Set table may become very complex and filling it may be an error prone procedure. Enable the Autofill
feature to make sure aliases are entered correctly.
Click to enable the Autofill feature: the Autofill Table is displayed.
This function uses regular expression for populating the table with tags trying to match the filter where the keyword
$(Instance) will be replaced with the defined Index values and the keyword $(Alias) with the defined alias labels.
Autofill example
“Room$(Instance)-$(Alias)” will match all tag names:
Room1-Temperature,
Room1-Pressure,
Room1-Humidity,
Room2-Temperature,
“Room0*$(Instance)-$(Alias)” will match all tag names:
Room1-Temperature,
Room01-Pressure,
Room001-Humidity,
Room2-Temperature,
Room02-Pressure,
Room002-Humidity,
Autofill table elements

Element Description
Fill Fills in missing entries in the tag table using the set filter (if any). For example, when new instances or new
aliases are added you can use this option to fill in the new entries.
Replace Replace all table entries with those provided by the Autofill table.
Reset Resets the tag filter to empty, no automatic fill is done.
Suggests a valid filter expression for your project.
Note: Filters are saved as project preferences and can be set for the entire table or for a column. Once a filter is
set for a column, the table filter is ignored. You can therefore selectively change the filter for handling a particular
alias only.
Note: To reference the elements of an array use the \ character to disable the regular expression interpretation of
the square brackets (array tags are differentiated by Italic).
Using indexed tag set in pages

Once an indexed tag set has been created, you can use it to create a page for the HMI device as in this example.
To create this page:
Using indexed tag set in pages
1. Create a page and add a combo box, three labels and three numeric fields.
2. Use the index tag created for the room number for the combo box, "RoomNumber" in this example. This will be the
selector for the room number.
3. Create a list for the combo box. In this example use the following list.
Index String List
0 Room Number
1 Room 1
2 Room 2
3 Room 3
4 Room 4
4. Attach to each numeric field value the corresponding Alias variable (Room > Temperature, Room > Humidity,
Room > Pressure).
32 Storing data to external databases
PB610 Panel Builder 600 allow to connect to the SQL4Automation Connector, a software solution for the industrial usage.
It connects HMI, PLC and robotic controls directly with SQL databases. HMI directly access SQL databases via the
connector and can query data from tables, insert, change and delete data in tables by using SQL commands [structured
query language].
The database site communicates by ODBC. Therefore all SQL databases can be integrated, which support an ODBC
interface. The SQL syntax needs to be adapted to the given database, e.g. MS SQL Server, mySQL, MS Office Access,
SQLite, Oracle, PostgreSQL...
To store data into an external database:
1. Install the SQL4Automation tool on the computer hosting the database or in a computer between the HMI device and
the database.
2. Configure the SQL4Automation tool.
3. Create a project that use the dedicated DB actions to access at the external database.
Installing SQL4Automation 341
Configuring SQL4Automation 341
Configuring the HMI project 343
Transfer data with JavaScript 344
Database tables 345
Custom tables 346
Connection Limits 346
Installing SQL4Automation
Download the latest version of SQL4automation and install it on the computer. Refer to www.sql4automation.com for
details and download.
Procedures described in this document refer to SQL4Automation Connector Version 3.3.2.0
Configuring SQL4Automation
Important: Refer to the SQL4Automation user manual for detailed configuration instruction.
Here is a quick description of how to access to a MS Office Database (MS Access).
You must have the MS Office Suite installed on a computer and create an empty database using Microsoft Access.
Start SQL4Automation and follow the procedure to configure your SQL4Automation Connector:
1. Select ODBC Admin: the ODBC Data Source Administrator dialog is displayed.
2. Select the System DSN tab.
3. Click Add: the Create New Data Source dialog is displayed.
4. Select the Microsoft Access Drive
5. Click Finish to confirm.
Configuring SQL4Automation
6. Enter Data Source Name and Description then click Select: the Select Database dialog is displayed.
7. Select your Access database.
9. At the fist connection, click New to select your Data Source

10. Select the IP address of your computer. This will be the connection IP Address used from your HMI device.
11. Select the Data Source.
13. Click Connect.
14. Select License> Activate Test License: when the Link 1 led turns green the procedure has been completed
correctly.
Configuring the HMI project

Path: ProjectView> Config > double-click Database Links
To save a project data to an external database you need to create a link with the specific database
1. In the Database Links editor select Enable to enable the function.

2. click Add to create a new link.
3. Enter the IP Address the computer hosting the SQL4Automation Connector.
Important: The link name here is not necessarily the same defined inside the SQL4Automation
Connector. But this is the name to be used in all actions using the remote database.
Transfer data with JavaScript
Transfer data with JavaScript

Some actions used to transfer data from a HMI device to a remote database can be used as macros inside a JavaScript
code as in the example below.
Status of database connection is available through system variable tags. See "Database variables" on page 1.
Error status can be reset with actions. See "Database actions" on page 137
function myButton1_onMouseClick(me, eventInfo) {

var CustomSQL = '' ;
var DatabaseLink ='Link1';
project.dbInit(DatabaseLink, CustomSQL);
};

var Tags ='Alarm1;SystemTime;Tag01;Tag02;';
project.dbReadTags(DatabaseLink, CustomSQL, Tags);
};

var Tags ='Alarm1;SystemTime;Tag01;Tag02;';
project.dbWriteTags(DatabaseLink, CustomSQL, Tags);
};
dbQuery
project.dbQuery(databaseLink, customSQL, dbCallback);
Using this query you can execute SQL Queries.
databaseLink Link to the database to use
customSQL String with the SQL query
dbCallback() Function that will be call when query data are ready
dbCallBack
project.dbCallBack(dbStatus, dbResponse);
dbStatus 0: no error found
dbResponse Query response. Table column names followed by its rows:
In the example:
TagnName - Tagvalue
Tag09 - 103
Tag10 - 302
Database tables
Here the structure of the database tables used by the database actions.
Note: These tables can be generated on an empty database from the DBInit action.
Table: Tags
FieldName Text(255) PRIMARY KEY
TagValue Text(255)
Table: Trends
Id Long Integer PRIMARY KEY
TrendName Text(255)
SampleTime Text(255)
TrendValue Text(255)
Quality Text(255)
RefreshTime Text(255)
Custom tables
Table: Recipes
Recipe Text(255) PRIMARY KEY
SetName Text(255) PRIMARY KEY
ElementName Text(255) PRIMARY KEY
SetValue Text(255)
Table: Event
Id Long Integer PRIMARY KEY
EventName Text(255)
SampledTime Text(255)
EventType Text(255)
EventSubTime Text(255)
EventValue Text(255)
Custom tables
SQL queries released from the DB actions are listed inside the project file config\dbconnector.xml.
Modify the commands defined inside this file to customize the SQL strings released from the DB actions and then get
access to a different structured database.
Example
CREATE TABLE myTagsTable (tagname VARCHAR(255) PRIMARY KEY, tagvalue VARCHAR(255))

UPDATE myTagsTable SET Tagvalue= '%_JMV' WHERE Tagname= '%_JMT'
INSERT INTO myTagsTable (Tagname, Tagvalue) Values ('%_JMT', '%_JMV')
Where "%_JMV" will be replaced with the tag value and "%_JMT" with the tag name.
Connection Limits
SQL4Automation is delivered as a USB dongle with a license for a predefined number of connections. Connections are
called "Links" inside SQL4Automation Connector. The number of connections depends on the license you have purchased.
SQL4Automation Connector can be installed on the same Computer/Server running the databse:
Or onto a separated Computer/Server:
Connection Limits
33 OPC UA Server
Path: ProjectView> Config > Interfaces > double-click OPC UA
Use OPC UA Server to publish data according to the OPC UA standard.
Enable OPC UA Server Main flag to activate OPC UA Server.
Data values defined in the HMI device are published by the OPC UA Server.
Features
Enable alarms Activates publication of real-time alarms data (active alarms).
Enable historical alarms Activates publication of historical alarms data.
Enable trends Activates publication of trends data.
Tag groups Only tags belonging to selected groups will be available to the OPC UA Server.
Alarm groups Only alarms belonging to selected groups will be available to the OPC UA Server.
Network
Node Name Enter node name or leave empty to use host name.
Port Port number of OPC UA Server.
Port number proposed as default may be different from port used by OPC UA
Client.
Authentication
Select authentication options for OPC UA Server.
OPC UA Clients will be responsible for choosing, from available options, the most appropriate option to use
according to their capabilities.
User authentication
Using x.509 Certificates
Anonymous Anonymous clients accepted.
User/Password Authentication with user name is accepted.
Any valid user has unrestricted access to OPC UA Server (see "Configuring
users" on page 289).

OPC UA provides a secure communication channel using digital certificates. Configurable levels of end-to-end security
ensuring encryption, confidentiality and integrity of each message are available. When enabled, the server validates the
client certificate and vice versa.
OPC UA Clients will be responsible for choosing, from available options, the most appropriate option to use
according to their capabilities.
Security Mode Description
None Connection without certificate is allowed.
Not recommended in public networks.
Sign OPC UA Client must provide its own certificate: communication through signed
messages is allowed.
SignAndEncrypt OPC UA Client must provide its own certificate: communication through signed and
encrypted messages is allowed.
Security Policy Description
Basic128Rsa15 Accepted encryption level (used only when Security Mode is active).
Basic256 Accepted encryption level (used only when Security Mode is active).
Basic256Sha256 Accepted encryption level (used only when Security Mode is active).
Automatically trust any new All certificates provided from any OPC UA Clients are accepted.
clients
Trusted Certificates Only OPC UA Clients that provide one of the listed certificates are accepted.
To add a new certificate to the list of trusted certificates, you must have the
certificate file supplied by the owner of the OPC UA Client device. Both
binary and ASCII certificate file formats are accepted.
33 OPC UA Server
Global Discovery Server

OPC UA Server is compatible with the GDS Push Model. This means that you can use a remote GDS tool for central
certificate management.
To be able to successfully connect to OPC UA Server, you must retrieve the certificate of the GDS tool
and add it to the trusted certificate list of OPC UA Server.
Example
When an OPC UA Client attempts a connection with the OPC UA Server, the server checks if the client certificate is
available inside its own trusted certificate list. If it is not found, the communication will be rejected and the certificate will be
stored in a list of unreliable certificates.
Using a GDS tool, you can connect to the OPC UA Server, inspect available certificates and define trust or not trust state
of each certificate.
Certificate Files
HMI device will store certificates inside the subfolders of folder "/workspace/<ApplicationName>/config/pkiserver"
l own
Own certificate and private key
l trusted
Trusted self signed certificates and CA certificates
l rejected
Rejected certificates
l issuers
Trusted intermediate (not directly trusted) CA required to validate the trust chain
Server Identity
Manufacturer name Human readable name of the manufacturer of the product.
OPC UA Client can retrieve this information from tag:

ServerName|Objects|Server|ServerStatus|BuildInfo|ManufacturerName
Product name A human readable name for the product running in the server.
The OPC UA Client can retrieve this information from tag:

ServerName|Objects|Server|ServerStatus|BuildInfo|ProductName
Certificate Parameters
Server certificate can be either generated automatically or by adding an existing certificate file.
Automatically generate self-signed certificate
If auto generated certificate is enabled the certificate is regenerated after every change made by user to certificate
parameters. The certificate is also replaced by any explicitly set certificate.
Certificate parameters
Each certificate must contain information that should identify the certificate and its restrictions. If you have chosen to use a
self-generated certificate, enter the information you want to be inside the self-generated certificate. Otherwise parameters
are read from the certificate you have supplied.
Server Name Name of the certificate (e.g. the device name).

(Common Name)
Organization Organization name
Unit Organization unit
This field could be useful to differentiate different divisions within an

organization.
Location Locality field denotes the city where organization resides in
State State or Province field specifies where the organization is physically located.
Content of State or Province field should not be abbreviated. For example,

"CA" is not a valid state name. "California" is the proper state name.
Country The X.509 naming scheme standard requires a 2-character country code.
Country code for the United States is US; country code for Italy is IT.
Produc URI A globally unique identifier for the server.
Example: "urn:NodeName:CompanyName:ServerName"
DNS Names DNS name or IP Address of the device where this OPC UA Server is installed.
IP Addresses Multiple DNS Names and/or IP Addresses can be in a single certificate.
The certificate will be valid only if the IP address where the OPC UA
Server is running is included in this list.
Validity Period of validity of the certificate starting from creation date
Key Length Length of the key used by RSA encrypting algorithm
Script to generate a Certificate
If you want provide your own certificate, note that the certificate must include the “Subject Alternative Name (SAN)”
parameters as required by the OPC UA standard.
Here is an example of how to generate a certificate using a public OpenSSL-Win32 library (Reference:
https://www.openssl.org/)
33 OPC UA Server
@echo off
set NodeName=HMI-Server
set IPAddress=192.168.44.165

%OpenSSL% genrsa -out server-key.pem 2048

%OpenSSL% req -new -key server-key.pem -out server.csr -subj
"/ST=Italy/C=IT/L=Verona/O=CompanyName/OU=R&D Team/CN=OPCUAServer@%NodeName%
rem Creating Certificate (.pem)

echo subjectAltName=URI:urn:%NodeName%:CompanyName:OPCUAServer,IP:%IPAddress% >
san.txt
echo
keyUsage=digitalSignature,nonRepudiation,keyEncipherment,dataEncipherment,keyCertSign
>> san.txt
echo extendedKeyUsage=critical,serverAuth,clientAuth >> san.txt
echo authorityKeyIdentifier=keyid,issuer >> san.txt
echo basicConstraints=CA:TRUE >> san.txt
%OpenSSL% x509 -req -days 3650 -in server.csr -signkey server-key.pem -out
server.crt -extfile san.txt
rem Convert Certificate (.der)

%OpenSSL% x509 -in server.crt -outform der -out server.der
rem Not necessary files

del san.txt
pause
Using self-signed certificates

This chapter is a step by step example that explains how to configure two HMI devices to communicate using self-signed
certificates
OPC UA Server
1. Create a simple project including a few tags

2. Open the OPC UA dialog and enable OPC UA Server. Be sure to enable tag groups (e.g. select “All”)
3. Enter in “IP addresses field” the IP address of the HMI device where OPC UA Server will run
4. Download the project to the HMI device
OPC UA Client
33 OPC UA Server
5. Create a simple project

6. Add the OPC UA Client protocol. Enter the IP address of the remote OPC UA server and its port number (48010).
Leave certificate parameters empty.
7. Open tag editor and import tags. Select “OPC UA Discovery” mode
8. Choose to copy the certificate to the clipboard as shown in the figure. Then, close this dialog and return to protocol
configuration dialog to paste the certificate inside the “Server Certificate” field.
9. Repeat step 7, accept the Server OPC UA certificate and import some tags. Note that you can accept the certificate
permanently or temporarily. If you accept the certificate permanently, a copy of the certificate will be saved inside
your computer for later use without popup again the dialog to asking for confirmation.
The certificate file will be copied inside the folder:

%AppData%\Roaming\ABB\studio\OPCUA\pki\trusted\certs
10. Open again the protocol dialog box. Select the Security Policy = Basic256 and Security Mode = SignAndEncrypt
Since in the OPC UA Client protocol parameters we left empty the “Client certificate” field, the OPC UA Client protocol has
generated its own certificate and sent it to the OPC UA Server but since the server does not know this certificate it rejects
the connection request. Now we have to tell the server to trust these certificates. There are different ways to do it.
Make rejected certificate trusted using FTP client:
1. Connect to OPC UA device using an FTP client

2. Look inside the certificate folders and move the rejected certificate from the rejected folder to the trusted folder.
/workspace/<YourProjectName>/config/pkiserver/rejected
/workspace/<YourProjectName>/config/pkiserver/trusted/certs
You can double click the certificate file to open it and look to certificate parameters to be sure about the certificate
you are validating
Now the communication will start
Make rejected certificate trusted using GDS tool:
1. Open the GDS tool and export its certificate

2. Open the project and add the certificate of the GDS tool to the Trusted Certificate list
3. Download the updates project to the HMI device
Now you can manage certificates using the tools in the HMI device.
33 OPC UA Server
Using external certificates

This chapter is a step by step example explaining how to configure two HMI devices to communicate using external
certificates.
Generate certificates
You can use the script given in this manual to generate a copy of your own certificates, one for OPC UA Server and another
one for OPC UA Client.
1. Install a OpenSSL-Win32 library (Reference.: https://www.openssl.org/)

2. Use the script ("Script to generate a Certificate" on page 352) to generate OPC UA Server certificate. Be sure to set
the IPAddress variable with the IP Address of the HMI device where OPC UA Server will run before running the
script.
3. Find in the OPC UA Client protocol manual a sample script to generate a certificate for the OPC UA Client protocol
OPC UA Server
4. Create a simple project that using a few tags

5. Open the OPC UA dialog and enable OPC UA Server. Be sure to enable tag groups (e.g. select “All”)
6. Add the client.der certificate to the Trusted Certificate area to enable the OPC UA Client to communicate with OPC
UA Server
7. Remove the check on “Automatically generate self-signed certificate” and add the server certificate (server.der) and
the server private key (server-key.pem)
OPC UA Client
Alarm map
9. Create a simple project

10. Add OPC UA Client protocol.
11. Enter the IP address of the remote OPC UA server and its port number (48010).
12. Open the ASCII version of the server certificate (server.crt), remove all Newline characters and then copy and paste
the ASCII characters of your certificate inside the Server Certificate field.
13. Repeat the same with Client Certificate (client.crt) and Client private key (client-key.pem)
14. Select the Security Policy Basic256 and the Security Mode = SignAndEncrypt
15. Open tag editor and import tags. Select “OPC UA Discovery” mode
16. Accept OPC UA Server certificate, import some. Note that you can accept the certificate permanently or
temporarily. If you accept the certificate permanently, a copy of the certificate is saved inside your computer to later
usage without asking you for confirmation
You will note that OPC UA Client is retrieving data from OPC UA Server using the given certificates.
Alarm map
The alarm states are mapped to OPC UA states according to the following rules:
OPC UA Alarm state PB610 Panel Builder 600 Alarm state
Opcua.Alarm.Active True when alarm state is triggered
l TRIGGERED
l TRIGGERED_NOT_ACKED
l TRIGGERED_ACKED
Opcua.Alarm.Acked True when alarm acknowledgment is not required
l TRIGGERED_ACKED
l NOT_TRIGGERED_ACKED
l NOT_TRIGGERED
Opcua.Alarm.Retain True when alarm is pending
l TRIGGERED |
l TRIGGERED_NOT_ACKED |
l TRIGGERED_ACKED |
l NOT_TRIGGERED_ACKED but a RESET is required
Opcua.Alarm.Confirmed True when alarm is returned (Not triggered, acknowledged and reset)
l NOT_TRIGGERED
This info is available only when alarm is configured to required a RESET
34 Special widgets
Widgets designed for special purposes are called special widgets and include control lists, date and time widgets, variable
widgets and so on.
BACnet widget 360
Browser widget 360
Canvas Widget 361
Combo Box widget 364
Consumption Meter widget 368
Control list widgets 369
DateTime widget 373
Gesture area widget 374
IP Camera widgets 379
JavaScript function block widget 382
Media Player widgets 384
Multistate Image widget 386
Multistate Image Multilayer widget 387
Network Adapters widget 389
RSS Feed widget 389
Scrolling RSS Feed widget 390
Table widget 391
TextEditor widget 404
Variables widget 406
BACnet widget
BACnet widget
Path: Widget Gallery> BACnet
BACnet widgets are special widgets that let you interact with native BACnet objects.
l BACnet Calendar
l BACnet Scheduler
l BACnet Effective Period
These widgets are using special keypads that are added into the keypads folder when widgets are used. Generally, you do
not need to take care of these keypads unless you want customized them.
Refer to the BACnet manual inside the “Communication Drivers” folder for a detailed description of BACnet special
widgets.
BACnet widgets are not supported on Web pages.
Browser widget
Path: Widget Gallery> Media> Web Controls
Use this widget to embed web pages into your HMI device pages. This is an HTML5 compatible browser widget based on
the WebKit engine.
Note: The WebKit library is available as a plugin (see "Plug-in" on page 75 for details) to download to the HMI
Runtime only when required.
34 Special widgets
Important: This widget is not supported by MIPS based devices.
Home Page Default URL to open when widget is shown on the page.
Zoom to Fit Automatically scales content to the size of view area.
Time out Page load timeout in seconds.
Clear History Automatic history clear on load
Scroll Shows/hides scrollbars
Show Progress cursor Shows/hides loading cursor
This allows you to save around 3 MB of space if the widget is not required in your project.
An Hyper Link widget is available to create pages hyperlinks. Once clicked these links notify to the browser widget that a
particular web page is to be loaded.
Important: HTTPs protocol is not supported.
Canvas Widget
Path: Widget Gallery> Basic> Generic Canvas
Canvas widget can be used to draw graphic via JavaScript scripting.
Note: the JavaScript methods are the same that are available for the HTML5 <canvas> tag
Canvas Widget
Canvas Width Canvas size.

Canvas Height
Note this is not the widget size. For example, the canvas size could be
500x500 pixels where the widget size could be 100x100 pixels. Draw Hint
parameter will define how to stretch the canvas size to fit the widget size.
Draw Hint Define how fit the canvas inside the widget size
l Clip
No Transformation is applied, coordinate system is not scaled and
drawing is clipped inside the widget bounding rectangle.
l Fit to size
Fit to the widget size preserving the canvas model aspect ratio.
l Stretch
Fit to the widget size ignoring the canvas model aspect ratio.
Example using a Canvas size larger than the widget size:
Design Time Preview Canvas preview inside PB610 Panel Builder 600
Note the JavaScript code could use data not available inside
PB610 Panel Builder 600 but only inside the HMI device
Auto Clear Background Automatic clear the background before draw canvas. When disabled, the
painted items are persisted and is not necessary redraw everything from
scratch.
OnDraw Action The OnDraw event is executed when the page is painted. This event has to
be linked with the JavaScript code that draws the canvas graphic.
OnMousePress Action Mouse events

OnMouseRelease Actions
OnMouseDrag Actions
Available Canvas Methods

// Painter Save/Restore
l void save(); // calls painter save

l void restore(); // calls painter restore
34 Special widgets
// Scale/Transform
l void scale(qreal x, qreal y);

l void rotate(qreal angle);
l void translate(qreal x, qreal y);
l void transform(qreal m11, qreal m12, qreal m21, qreal m22, qreal dx, qreal dy);
l void setTransform(qreal m11, qreal m12, qreal m21, qreal m22, qreal dx, qreal dy);
// Gradient
l CanvasGradient createLinearGradient(qreal x0, qreal y0, qreal x1, qreal y1);

l CanvasGradient createRadialGradient(qreal x0, qreal y0, qreal r0, qreal x1, qreal y1, qreal r1);
// Rectangle Functions
l void clearRect(qreal x, qreal y, qreal w, qreal h);

l void fillRect(qreal x, qreal y, qreal w, qreal h);
l void strokeRect(qreal x, qreal y, qreal w, qreal h);
l void rect(qreal x, qreal y, qreal w, qreal h);
// Path
l void beginPath();
l void closePath();
l void moveTo(qreal x, qreal y);
l void lineTo(qreal x, qreal y);
l void quadraticCurveTo(qreal cpx, qreal cpy, qreal x, qreal y);
l void bezierCurveTo(qreal cp1x, qreal cp1y, qreal cp2x, qreal cp2y, qreal x, qreal y);
// Drawing Text
l void fillText(const QString &text,qreal x, qreal y);
// Arc
l void arcTo(qreal x1, qreal y1, qreal x2, qreal y2, qreal radius);
l void arc(qreal x, qreal y, qreal radius, qreal startAngle, qreal endAngle, bool anticlockwise);
// Fill/Stroke
l void fill();
l void stroke();
l void clip();
l bool isPointInPath(qreal x, qreal y) const;
// Image manipulation (Draw CImageWgt using target and source rect)
l void drawImage(QObject *pObjImage, qreal sx, qreal sy,qreal sw, qreal sh, qreal dx, qreal dy,qreal dw, qreal dh);
l void drawImage(QObject *pObjImage, qreal dx, qreal dy);
l void drawImage(QObject *pObjImage, qreal dx, qreal dy, qreal dw, qreal dh);
l void drawImage(const QVariant& image, int width, int height, const QString& format, qreal sx, qreal sy,qreal sw,
qreal sh, qreal dx, qreal dy,qreal dw, qreal dh);
// Pixel manipulation
Combo Box widget
l ImageData createImageData(double sw, double sh);//Empty Image

l ImageData createImageData(ImageData fromImage);//from another Image
l ImageData createImageData(ArrayBuffer value); //From arraybuffer
l void putImageData(ImageData imgData,double dx, double dy);
l void putImageData(ImageData imagedata, double dx, double dy, double dirtyX, double dirtyY, double dirtyWidth,
double dirtyHeight);
l ImageData getImageData(qreal sx, qreal sy, qreal sw, qreal sh);
Canvas JavaScript Example

The canvas is initially blank. To display something, a script first needs to access the rendering context and draw on it:
var ctx = me.context2d;
then you can use the canvas methods, as in the below example
function GenericCanvasWgt1_onDraw(me, eventInfo)

{
var ctx = me.context2d;
ctx.fillStyle = 'red';
ctx.fillRect(0,0,250,250);
ctx.fillStyle = 'green';
ctx.fillRect(250,0,250,250);
ctx.fillStyle = 'blue';
ctx.fillRect(0,250,250,250);
ctx.fillStyle = 'black';
ctx.fillRect(250,250,250,250);
}
function GenericCanvasWgt1_onMouseDown(me, eventInfo)

{
alert("X = " + eventInfo.posX + "\nY = " + eventInfo.posY );
}
The update method can be used to dynamically redraw a canvas widget
function BtnStd1_btn_onMouseClick(me, eventInfo)

{
var myCanvasWidget = page.getWidget("GenericCanvasWgt1");
myCanvasWidget.update()
}
Combo Box widget

Path: Widget Gallery> Basic> Controls
Use this widget as a selector widget or to filter rows in a table to display only the values selected in the combo box.
34 Special widgets
Index Index of the selected item.
List / String Item strings in the combo box.

List
Note: This field is multi-language.
Data / Data List Returns the value in the Data List column (as string) in the Data field of the widget.
Tip: Use this parameter to return a custom value based on an item selected in
the combo box.
Text Format of displayed text.
Attaching data vs. attaching indexes
In many projects you may need to attach fields such as Index or Data to tags to know the values of the selected item in the
combo box. Use:
l Index: to display the index (integer) of the selected item (0...n).

l Data: to display the data value (string) specified in the Data List column.
Combo Box widget “full screen” mode with images

From the "Project properties" on page 69 the look and behavior of Combo Boxes can switches from Context mode to Full
Screen mode
Path: ProjectView> double-click Project properties> Properties pane> Project> ComboBox View Mode
Combo Box widget
ComboBox Select the visualization mode of all the Combo Box widgets of the project
View Mode
Context
Classic view with drop-down menus
Full screen
Enhanced view with configurable texts and images that will pop up in the middle of the
screen for easy scroll and selection.
Context view example
Full screen view example
Additional parameters available in full screen mode

The additional "Image List" column will be available inside Combo Box> List parameter:
34 Special widgets
Note: Some properties are displayed only in advanced mode.
Image Return, inside the attached tag, the file name of the selected image
Button Define the look of the Combo Box
l Show background = true

Combo Box button is showed
l Show background = false
Only image or text is showed
ListView Layout parameters of the Combo Box in edit mode
ListViewItems Define the items type that will be inside the Combo Box
Image Mode:
l Only Text
l Only Images
l Text and Images
Consumption Meter widget
Consumption Meter widget

Path: Widget Gallery> Basic> Trends/Graphs
Use this widget to monitor a resource which is continuously increasing. The system reads the value of the resource and
calculates the increment in a set range of time, the increment is then displayed in a bar-graph in a trend-like window.
Different colors can be used to used in the graph based on the time frame.
Tip: Use this widget to calculate the power consumption of a system.
Value Resource monitored
Graph Time period displayed in the window

Duration
Graph
Duration
Units
Bar Duration Time period represented by each bar in the graph

Bar Duration
Units
Time Periods Assigns a specific color to highlight the increment of the monitored resource in a specified
time period (minimum resolution = 1 hour).
Color Bar color and width

Bar Width
Bar Value Show/Hide the value of each bar
Consumption Number of labels to be displayed on graph.

Meter
Example: how to monitor energy consumption

In the following example a widget is design tho monitor energy consumption with a weekly scale and a daily unit.
34 Special widgets
1. Attach a tag to the physical variable to monitor. In this example, to the total energy consumed (Tag KWh). This tag
contains an incremental number that indicates how many KW/h have been consumed from when energy
consumption started.
2. Add a Trend and link it to the tag to be monitored, Tag KWh.
3. Add a Consumption Meter widget to a page.
4. Attach the Value property of the Consumption Meter to the Trend you created in step 2.
5. Set Graph Duration/Units to 1 week: this will give you a weekly graph of consumed energy.
6. Set Bar Duration/Units to 1 day, this is the time range when energy consumption is calculated.
7. In Consumption Meter set the number of labels to show in the bar graph, in this case 7 to display a weekly graph.
8. From the Time Periods property open the Configure Time Periods dialog: set the different colors for different
values of Tag KWh in each bar.
Tip: To assign the color to the cells of the table, select the cells and click on the desired color, or enter the
index value of the band (1, 2, 3) into the cell.
9. Add as many color bands as you need, in this example 3 color bands.
10. Assign a band to each hour in the weekly table, in this example a red band (E1) is used to indicate the range of time
in the day/week where the cost of energy is the highest.
Note: You can apply a scale factor to each color band, if needed.
The result is a bar graph consumption meter showing daily consumption of energy in KW/h, with colors indicating the
different energy costs. The height of each bar represents the amount of energy in the time range considered, 1 day in this
example.
Use the action ConsumptionMeterPageScroll to scroll the bar graph back and forth and the action RefreshTrend to refresh
the bar graph since data is not refreshed automatically.
Important: No other Trend action is currently supported by the Consumption Meter widget.
Control list widgets

Path: Widget Gallery> Advanced> Control List
Use these widgets to represent the status associated with a particular process and to control that process from the same
widget.
Two types of control lists are available:
l a group control list, with a limited set of navigation button already included, and
l a basic control list with no pre-configured button to be navigated using the touch screen feature.
Value The value corresponding to the status of the widget. If there is a tag attached to the value property, when
loading the widget, the State will be aligned with the tag value.
State State of widget. The widget highlights the item related to its State with a different background color (see
"state color" in the properties of the widget).
Selection State selection. The selected item will be displayed with a small triangle on the left side of the list.
Write Select the State update mode

Mode
l Write On Select: The state is updated automatically to be aligned with the cursor position.
l Write On Enter: The status is updated with the cursor position only when the user presses enter
Scrollbars Select the scroll mode of the table

Type
l Gesture: Pan gesture can be used to smoothly scroll the table.
l Scrollbar: Use the scrollbar to scroll the table
34 Special widgets
Read Defines whether the list is only an indicator.

Only
List Data List of status items. Each item has a status name, a corresponding value and a flag that enables to display
the item inside the widget.
Defining states
Add/remove states, that is items in the list, from the List Data property.
Any value can be assigned to a state. When you activate the state, by selecting the related item if in WriteOnSelect mode
or selecting it and confirming with enter if Write On Enter, this will write the value assigned to state to the tag linked to the
Control List widget Value .
Manage list data items from JavaScrip code

The list of data items can be modified, at runtime, from JavaScript code using the setProperty("listData",
<NewControlList>). The below example shows how to modify the list of items
function SetItemsList_btn_onMouseClick(me, eventInfo)

{
var NewControlList = [["OFF",100,true],["ON",101,true],["MAN",102,true],
["AUTO",103,true]];
var ControListWgt = page.getWidget("controlListBtn.controlList");
ControListWgt.setProperty("listData", NewControlList);
}
Where
- NewControlList is an array with the items description
- controlListBtn.controlList is the ID of the Control List Widget to modify
The getProperty("listData"), instead, will just return a comma separated string of just the names.
34 Special widgets
function Read_btn_onMouseClick(me, eventInfo)

{
var ListData = ControListWgt.getProperty("listData");
}
Where the result of ListData will be: "OFF,ON,MAN,AUTO"
State
The getProperty("state") can be used to retrieve the State value. Here is an example of the JavaScript code
function controlListBtn_onDataUpdate(me, eventInfo)

{
var State = ControListWgt.getProperty("state");
project.setTag("State", State);
return false;
}
DateTime widget
Path: Widget Gallery> Basic> Controls
Use this widget to display and edit current date and time .
In the Properties pane different formats are available for representing date and time.
For the Time Spec property select which time the widget will show at runtime.
Gesture area widget
Time options
Option Description
local shows local time, the time of the HMI device where the project is running
global shows Global Time (GMT)
server shows time information as handled by the server side of the HMI device
Gesture area widget

Path: Widget Gallery> Buttons> Others
Gesture Area Widget is a hotspot button that generates gesture events.
34 Special widgets
Gesture Events Description
OnSwipeLeft An event is release when swipe gesture is detected
OnSwipeRight
OnPinchOpen An event is release when pinch gesture is detected
OnPinchClose
RotateClockwise An event is release when rotate gesture is detected
RotateAntiClockwise
OnPan A series of events released during the gesture.
OnPinch Only JavaScript can be used to service these events, through the JavaScript code
the developer can manage the gestures events as he prefer.
OnRotate
WARNING: Only multi touch HMI devices can generate OnPinch and
OnRotate events
OnPan
boolean onGesturePan(me, eventInfo)
This event occurs when one point inside the area has pressed and a linear movement has been detected.
me Object triggering the event.
eventInfo id = Gesture id; it is used to identify different gestures.
running = True except for last event delivered to notify gesture completion.
dx = Total X axis movement in screen pixel units from initial touch position .
dy = Total Y axis movement in screen pixel units from initial touch position.
OnPinch
boolean onGesturePinch(me, eventInfo)
This event occurs when two points inside the area have been pressed and a linear movement has been detected.
me Object triggering the event
dx = Total X axis movement in screen pixel units from initial touch position. It
represents the distance change between fingers. Positive value means that the
Gesture area widget
distance is increasing; negative value means that the distance is decreasing. This
amount may be used to control a zoom value.
dy = Total Y axis movement in screen pixel units (see dx).
OnRotate
boolean onGestureRotate(me, eventInfo)
This event occurs when two points inside the area have been pressed and a rotate movement has been detected.
drot = How many degrees (0/360) have been added since the previous event.
trot = Total degrees (0/360) of the entire movement.
Positive numbers meaning clockwise rotation, negative anticlockwise rotation.
Gesture events pass thru

To use a widget (e.g. a button or a slider) covered from a gesture object, you have to keep pressed the widget 200 mSec to
move the control to the underlying object. The time that must be waited for to send the command to the underlying object
can be modified from the “Gesture Passthru Delay” parameter that is available in the advanced properties view.
Gesture Passthru Enabled Enable the possibility to pass gesture events to underlying widgets after a
configurable delay. User has to keep pressed the finger and then execute the gesture.
default = Use the value defined in the project properties. See "Project" on page 76
true = Gesture passthru enabled
false = Gesture passthru disabled
Gesture Passthru Delay (ms) The time that must be waited for to send the command to the underlying object
0/500 mSec
-1 Use the delay defined in the project properties. See "Project" on

page 76
Examples of using gesture events in association with JavaScript

Here some example of using gesture events in association with JavaScript code to identify gestures and program the
requested actions
34 Special widgets
Swipe Gesture
How to recognize a "swipe" gesture to change page in the application.
1. Put a Gesture area widget into the page

2. Configure the OnPan Action to trigger a JavaScript function
3. Write the JavaScript code that recognize and manage the swipe gesture
Pinch Gesture
How to recognize a "pinch" gesture to resize an image.
1. Put a Gesture area widget into the page over the image
2. Configure the OnPinch Action to trigger a JavaScript function
3. Write the JavaScript code that recognize and manage the pinch gesture
Gesture area widget
Pan Gesture
How to recognize a "pan" gesture to move an image.
1. Put a Gesture area widget into the page over the image
2. Configure the OnPan Action to trigger a JavaScript function
3. Write the JavaScript code that recognize and manage the pan gesture
34 Special widgets
IP Camera widgets
Path: Widget Gallery> Media> IP Camera
Use these these widgets to show images captured from an IP Camera or a video stream.
IP Camera widgets
Camera URL URL of the IP Camera when used in JPEG format.
Refresh Rate Number of JPEG images for second allowed. Max rate = 1 fps.
User Name Name of user allowed to access the camera.
Set this parameter when access to the camera is password protected.
Password Password to access the camera.
MJPEG Camera URL URL of MJPEG streaming (for example, http://192.168.0.1/video.cgi)
When this widget is used to stream HTTP MJPEG, Camera URL and Refresh Rate are ignored.
Performance of streaming is not fixed and depends on many factors such as: frame size, frame compression level, CPU of
HMI device, quality of IPCamera. Based on these factors the widget can reach up to 25 fps.
You can add multiple IP Camera widgets, but this will reduce the frame rate for each widget.
Supported IPCameras
The following IP Cameras have been tested so far:
IPCamera Protocol URL
Apexis APM-J901-Z-WS PTZ IP Camera MJPEG http://{ip_address}/videostream.cgi
HTTP http://{ip_address}/snapshot.cgi
AXIS M3027-PVE Network Camera MJPEG http://{ip_address}/axis-cgi/mjpg/video.cgi
HTTP http://{ip_address}/axis-cgi/jpg/image.cgi
DAHUA DH-IPC-HD2100P-080B 1.3mp HTTP http://{ip_address}:9988/onvif/media_

Outdoor Vandalproof service/snapshot
D-Link DCS-5605 PTZ MJPEG http://{ip_address}/video/mjpg.cgi
D-Link DCS-900W IP Camera MJPEG http://{ip_address}/video.cgi
D-Link DCS-932L MJPEG http://{ip_address}/video.cgi
Edimax IC-7100P PTZ MJPEG http://{ip_address}/mjpg/video.mjpg
HTTP http://{ip_address}/picture.jpg
Foscam FI8916W MJPEG http://{ip_address}/videostream.cgi
HTTP http://{ip_address}/snapshot.cgi
Foscam FI9803 EP MJPEG http://{ip_address}:88/cgi-

bin/CGIStream.cgi?cmd=GetMJStream&usr=
{user}&pwd={pass}
34 Special widgets
IPCamera Protocol URL
NOTE:
l port 88 may be different as per IP Camera

settings
l {user} = username defined into IP Camera
settings
l {pass} = password defined into IP Camera
settings
Hamlet HNIPCAM IP Camera MJPEG http://{ip_address}/video.cgi
HTTP http://{ip_address}/image.jpg
MOXA VPort 254 (Rugged 4-channel MJPEG http://{ip_address}/moxa-cgi/mjpeg.cgi

MJPEG/MPEG4 industrial video encoder)
HTTP http://{ip_address}/moxa-
cgi/getSnapShot.cgi?chindex=1
NVS30 network video server MJPEG http://{ip_address}:8070/video.mjpeg
HTTP http://{ip_address}/jpg/image.jpg
Panasonic WV-Series Network Camera MJPEG http://{ip_address}/cgi-bin/mjpeg
Ubiquiti UniFi Video Camera HTTP http://{ip_address}:7080/images/snapshot/camera/

{camera_guid}?force=true
NOTE:
l {camera_guiID} can be found into IP Camera

Webpage
l port 7080 may be different as per IP Camera
settings
Zavio F3210 2MP Day & Night Compact IP MJPEG http://{ip_address}/stream?uri=video.pro3

Came
HTTP http://{ip_address}/cgi-bin/view/image?pro_0
NOTE:
l MJPEG video streaming can be configured

selecting "video profile 3" with 640x480
resolution into IP Camera settings.
PTZ Controls widget

PTZ (pan–tilt–zoom) cameras are cameras capable of remote directional and zoom control.
The PTZ Controls widget uses the MoveIPCamera action to send HTTP/cgi commands to the PTZ IP Camera.
JavaScript function block widget
Camera URL URL of IP Camera
User Name Name of user allowed to access the camera.
Set this parameter when access to the camera is password protected.
Password Password to access the camera.
Command Command to send to the PTZ controller (for example, decoder_control.cgi?command=0)
Authentication methods
The authentication method is automatically set by the camera web server to which the widget connects. Authentication
methods supported are:
l Basic
l NTLM version 1
l Digest-MD5
JavaScript function block widget

Path: Widget Gallery> Basic> JSFunctionBlock
JavaScript Function Block is a widget that contains JavaScript logic that is executed when tags values change.
value1 Objects that will trigger the OnDataUpdate action.

...
value16
OnDataUpdate Action that will be executed when a change of an associated value is detected
Note: This widget is rendered only in PB610 Panel Builder 600, and it is not rendered in the HMI device.
34 Special widgets
Example:
A JavaScript code that check the combination lock of three selectors
See "Widget events" on page 432for the description of the onDataUpdate parameters
Media Player widgets
Media Player widgets

Path: Widget Gallery> Media> Media Player
Use these widgets to play videos from a playlist. The video files can be stored on a USB drive, on the Flash card or an SD
Card.
Two widgets are available: one includes a multimedia frame with buttons to play and stop the video, the other is a plain
frame where the video is played without user control.
Media Player Open file browser of Windows to select the video files to collect into the play list. The
List selected files will downloaded inside the HMI device with the project
Loop Style Define how the video is played.
l NoLoop: plays all the videos in the playlist, then stops.

l LoopOne: repeats the first video in the playlist.
l LoopAll: repeats the entire playlist.
l Random: plays the videos in a random order.
Note: The Media Player widget only works with some HMI devices (see "HMI devices capabilities" on
page 499). It doesn’t work the HMI Client.
Note: You can have only one Media Player widget in a page.
Supported video encoding

Two groups of codecs are supported:
l DSP based video codecs

l Software video codecs
List of HMI devices that support the DSP (video hardware acceleration) is available on "HMI devices
capabilities" on page 499.
34 Special widgets
DSP video codecs

These include:
l H264 using AVI/MP4 container, CABAC off and Level 3 (suggested)

l MPEG4 using MP4 container
On WinCE devices BSP v1.55 or greater is required

On Linux devices BSP v1.0.269 or greater is required
Software video codecs

This is only:
l Microsoft MPEG4 v3 using an AVI container.
Be aware that video performance are depending from the chosen resolution, bit rate and device capabilities. If
video rendering is not smooth, try to reduce the resolution or the bit rate of your video.
The videos encoded with Microsoft MPEG4 v3 are not using the hardware acceleration and have more
limitations. To prevent the videos from running jerky, a maximum resolution of 640x512 pixels and a bit rate of
1300 kb/s are suggested. In addition, the size of the Media Player widget used on the page should have the
same size as the videos in the play list, in order to avoid up scaling and down scaling. Audio is not supported.
Converting a video
The FFMPEG (www.ffmpeg.org) can be used to convert a video into the correct codec supported from the HMI device.
Using the folder structure of the below picture, the following batch file could be used to convert any video file.
Multistate Image widget
Now you can open the converted video with a standard video player, such as Windows Media Player and check the quality.
You can add the resulting video to the play list of the Media Player widget.
Note : The FFMPEG tool is not distributed with the PB610 Panel Builder 600.
Using Media Player in JavaScript

The Media Player widget can be also referenced in JavaScript programs with the following syntax:
//get the mediaplayer widget.

var mediaWgt = page.getWidget('MediaPlayerWgt2');
//load the play list
mediaWgt.setProperty('medialist', '/Storage Card/demo_3.avi,/Storage Card/video1_
3.avi');
// set the loopstyle 0 - noloop, 1 - loop one, 2- loop all, 3 - random
mediaWgt.setProperty('loopstyle', 2);
//start playing the first file.
mediaWgt.mediapath = '/Storage Card/demo_3.avi';
See "JavaScript " on page 427 for details on how to work with JavaScript.
Multistate Image widget

Path: Widget Gallery> Basic> Images
34 Special widgets
Use this widget to display an image from a collection based on the value of a tag used as Index. You can use this widget
also for simple animations.
Value Index of image to display.
For example, set Value=0, to display the image with index 0 in the image collection.
Images Images collection with associated index.
Animate Set to true, to enable a slide show.
Time interval Interval between images in the slide show.
Multistate Image Multilayer widget

Path: Widget Gallery> Basic> Images
Use this widget to create different animations and select the most suitable at runtime.
Multistate Image Multilayer widget
Setting up widget layers

1. Open the Layers dialog from the Properties pane.
2. Click + to add as many layers as you need.
3. Double click on each layer to add as many images as you want to include in the layer.
4. Drag and drop images into the frame to add it to current layer.
5. Define widget properties.
Default Layer shown at runtime.

Layer
Name Name of selected layer.
Default Frame shown when current layer is displayed.

Frame
Color / Fill Fill color for images of current layer.
Animate Enables slide show for active layer. Animations can be started/stopped at runtime attaching
it to a tag.
Time Time interval of slide show, if enabled.

Interval
Preview Slide show simulation.
34 Special widgets
Note: Default Layer, Default Frame, Color and Fill can be changed at runtime, attaching the to a tag.
Network Adapters widget

Path: Widget Gallery> Basic> Control
Use the IP Widget to set the network adapters parameters.
The system variable Network->Status contains the result of the last operation performed by the IP Widget (see "Network
variables" on page 102for details)
RSS Feed widget

Path: Widget Gallery> Media> RSSFeed Source
Use this widget to display on the HMI device your favorite RSS feeds directly from the Internet.
Scrolling RSS Feed widget
RSS Source Feed URL
Note: Feed sources cannot be modified at runtime.
UpdateRate Refresh time
The RSS Feed widget has been specifically designed to work with Pocket Internet Explorer.
Scrolling RSS Feed widget

Path: Widget Gallery> Media> RSSFeed Scroll
Use this version of the main RSS Feed widget to display highlights inside a text line using a smoothing scrolling text.
This widget has additional properties.
Scrolling Scrolling speed
Title Separator Separator character between highlights
34 Special widgets
Table widget
Path: Widget Gallery> Basic> Table
Use this widget to create a table with data provided from a data source.
To configure a table:
1. Put a table widget on the screen and configure the template of the table.
2. Add widgets into cells to configure one or more rows that will be used as row templates when the table will be filled
with data provided from the data source.
3. Select a data source that will be used to fill the rows of the table
4. Define the links from widgets and data source.
Configure the table widget

Table widget has two states:
l View mode
l Edit mode.
Click on the table to manage the widget in view mode, double click to enter in the edit mode. To exit and return to view
mode click outside the table.
View Mode
In view mode, you can configure the table layout. Drag and drop the table onto the page, resize the table, define number of
template rows, number of columns and the main table properties.
Table widget
Edit Mode
In edit mode, it is possible configure the format and the content of each cell of the table. Each row of the table will act as a
row template.
To configure the look of the table, click on table's selectors to select the item to configure.
Add or remove rows or columns
34 Special widgets
To add or remove rows or columns, double click over the grid to enter in edit mode and right click over column or row
selector to open the context menu.
Merge or split rows or columns
To merge or split rows or columns, double click over the grid to enter in edit mode and move the cursor over the ribbons:
l Double click the black triangle to merge the two adjacent rows or columns (1)
Note that merge is possible only with an empty row or column.
l Double click on ribbon to split the selected row or column (2)
To configure the contents of cells, drag and drop the widgets inside the cells.
Table widget
If you need more widgets inside a single cell, create a group of widgets and copy the group from the page to the
cell.
Configuring the data source

The data source, that provide the data to fill the table, could be a Table Data Source Widget or a JavaScript Object.
Table Data Source Widget

Path: Widget Gallery> Basic> Table
1. Drag and drop a Table Data Source Widget onto the page
2. Set the Table Model parameter to link at the data source.
Select the Data Source and inside the TableDataSrcWgt Editor add the rows and columns that are needed. In the following
example, we have defined two row templates:
34 Special widgets
l Row 0
Header of the table. Contains only static text.
l Row 1
Template of rows with data. On the first column we added a label that will contain the description and on the second
column a field that will contain the value.
Each row must be assigned a row type. The row will take on the format of the corresponding row template. Widgets that
were placed in each cell of the row template will appear in rows of that type.
Define links with data source
1. Double click over the Table widget to enter in edit mode and select a widget
2. Select the property that is to be read from the data source
3. Select the column of the data source that will provide the data
The below picture is showing how our example will be rendered at runtime
Table widget
Fixed Header
If you want the first row will be not scrollable, check the "Fix Header" check box on Data Source toolbox or set true the
"Show Header" propert inside the Data Source properties panel (note the parameter is available only in advanced view).
Multilanguage
To enable the Multilanguage support right click on the Multilanguage icon of the column. The icon will change color to
indicate that the support is enabled.
Avoid enabling the Multilanguage support when not necessary to better performance.
Import/Export Data Source
The configuration of the Data Source can be imported/exported using xml files
JavaScript Object
In alternative to the Data Source Widget, for data to fill the table could be provided from a JavaScript Object. In this case,
we have to fill an array of elements with the data to use and assign the array to the table widget.
var myTable = page.getWidget("TableWgt1");
34 Special widgets
myTable.model = model;
model is an array of elements with the table definition and data. The first element of the array will contain the template of
the rows while the other elements will contain the data to fill in the rows of the table
model[0] = row_templates; // row templates

model[1] = row_data1; // data of the row1
The row templates is a multi dimensional array where each array defines the datalink of one template row.
On the below example, we have a template for two rows.
var row_templates = {
_h : [
[ [] , [] ], //rowType = 0
[ ["text"] , ["value"] ] //rowType = 1
]
}
The first row has two columns that do not contain data links. We use this template for the header on the first row of our
table.
The second row defines the template of one row with the “text” property of the widget into the first column and the “value”
property of the widget into the second column. They will be dynamically filled using the data provided inside the model
variable.
On the below example we define a row of data
var row_data = {
_t : 1,
_v : ["Temperature:", { _c : "dl" , s : "_TagMgr", a : "Tag1", i: 0, m : 2 }]
}
The first element is the row template to use while the second element is the array with the data to use. In our example
“Temperature:” is the text to use inside the widget on the first column, while the other element is a datalink that will provide
the value to fill the value property of the widget into the second column.
The datalink element:
_c : "dl" Identify the element as a Datalink
s : "_TagMgr" Specify the source of data is the Tag Manager
a : "Tag1", i: 0, m:2 Specify tag name and index (necessary when the tag is an array) and the
read/write mode
Table widget
l m=0 is Read Only

l m=1 is Write Only
l m=2 is Read/Write
The below JavaScript code will generate the same table of the previous example using the Table Data Source Widget
var model = [];
var row_templates = {
_h : [
[ [] , [] ], //rowType = 0
[ ["text"] , ["value"] ] //rowType = 1
]
}
var row_data1 = {
_t : 0,
_v : [],
_h : true
}
var row_data2 = {
_t : 1,
_v : ["Temperature:", { _c : "dl" , s : "_TagMgr", a : "Tag1", i: 0, m : 2 }]
}
var row_data3 = {
_t : 1,
_v : ["Humidity:", { _c : "dl" , s : "_TagMgr", a : "Tag2", i: 0, m : 2 }]
}
var row_data4 = {
_t : 1,
_v : ["Noise:", { _c : "dl" , s : "_TagMgr", a : "Tag3", i: 0, m : 2 }]
}
var row_data5 = {
_t : 1,
_v : ["Brightness:", { _c : "dl" , s : "_TagMgr", a : "Tag4", i: 0, m : 2 }]
}
model[0] = row_templates;
model[1] = row_data1;
34 Special widgets
var myTable = page.getWidget("TableWgt1");

myTable.model = model;
Note the first row (row_data1) contains the directive _h: true to avoid the first line will be scrollable.
var row_data1 = {
_t : 0,
_v : [],
_h : true
}
Multilanguage
A multi languages text can be entered using the below element:
{ _c : "ml" , mltext : {"en-US" : "Temperature:" , "it-IT" : "Temperatura:"} }
_c : "ml" Identify the element as a Multilanguage text
mltext : { ... } List of couples: "ID Language":"Text"
Example:
l "en-US" : "Temperature:"
l "it-IT" : "Temperatura:"
Example:
var row_data2 = {
_t : 1,
_v : [ { _c : "ml" , mltext : { "en-US" : "Temperature:",
"it-IT" : "Temperatura:"} },
{ _c : "dl" , s : "_TagMgr", a : "Tag1", i: 0, m : 2 }
]
}
Row background color

Using the Rows background parameter is possible define the column of the Data Source Widget that will contains the
background color of the associate row.
To configure the background color of the rows of the table:
1. Add a new column inside the Data Source Widget to contain the background color of each row
2. Configure the “Row background” color parameter of the Table to point to the color column of the Data Source Widget
Table widget
Table Filter
Content visible inside the table can be filtered using the “Table Filter” property. On datalink you can use a formula (see
"Formula" on page 50 chapter for additional details) to define the criteria to use to filter the data.
Each row of the table will be visible only when the Datalink of the Table Filter return true value.
Example 1
34 Special widgets
If you want choice to see only the rows that contain “something” inside the Description column, you can use the below
formula:
=$Contains($('Description:TableDataSrcWgt'),$('value:SearchOnTable'))
Where
l 'Description:TableDataSrcWgt' is a Dynamic Field of the Data Source Widget used from the table to identify the
column to check
l 'value:SearchOnTable' is the value of a text field that will contains the string to search
Example 2
To use flags to define the parameters to expose inside the table:
First, add a new column inside the Data Source that will contains the flags that will enable the associate row. Then, link the
datalink of the table filter to the new column that contains the flags
Table widget
34 Special widgets
Horizontal scroll position

The “Horizontal scroll position” give the possibility to keep synchronized the horizontal scroll movements of two tables.
Horizontal scroll position parameter is available only in Advanced Proprieties View mode
Precached Pages
Normally the HMI Runtime retrieve only the data that will be visible into the display. To make table scrolling more pleasant,
it may be useful to preload the data of the next and previous rows of the displayed ones. Using the Precached Pages
parameter is possible define how many pages will be preloaded
l 0 = no pages preloaded
l N = number of pages to preoload
Example:
Using a table with 4 rows and Precache Pages = 2
l Number of row to preload are 8 (2 pages x 4 rows)

l 4 rows before (to be ready to manage scroll table up)
l 4 row above (to be ready to manage scroll table down)
TextEditor widget
Precached Pages parameter is available only in Advanced Proprieties View mode
TextEditor widget
Path: Widget Gallery> Advanced> Editor
Use this widget to edit text files. Widget can load the text file from the local HMI device or download the file from a remote
device using an ftp connection.
Note: TextEditor widget is available as a plugin (see "Plug-in" on page 75 for details) to download to the HMI
Runtime only when required.
34 Special widgets
Widget Buttons
Button Description
Open Load text file inside the TextEditor
Save Save text file
Cancel Remove all changes from last OPEN or SAVE command
Edit Enter in edit mode
Insert Insert a new line
Delete Delete current line
Up/Down Move cursor up/down
Widget Properties
Option Description
Keyboard TextEditor widget has an embedded keyboard. When widget is used without the embedded
keyboard, the alphabetic keyboard will be displayed when enter edit mode.
l Hidden
l Visible
FTP Config FTP parameters to download the text file from a remote FTP server. Leave this filed empty
to load the text file from the local HMI device.
FTP Address FTP server IP Address
Server Port Port for FTP connection (default = 21).

l Anonymous
User Name Username of the remote FTP account
File Name File name to edit. When empty a file browser to load a local file will be opened
Syntax Highlight Type Displays text in different colors according to the selected language
l None
l GCode
Variables widget
Variables widget
Path: Widget Gallery> Advanced> Data Sources
Use this widget to add internal variables for operations such as data transfer or to be used in JavaScript programs.
Note: The variables are local to the page where the widget has been inserted.
When you drag and drop this widget into you page, a place holder will be displayed to indicate the widget location, but it will
not be visible at runtime.
Setting the widget

To create variables and assign values to them, open the Variables dialog from the Variables property in the Properties
pane.
These variables can then be referenced from the Attach tag dialog, from the Page Editor.
34 Special widgets
If you need global variables, configure them at project level, adding the desired variables to the global variable widget.
Using variables in JavaScript

Variables can be also referenced in JavaScript programs with the following syntax:
For local variables:
var varWgt = page.getWidget("_VariablesWgt");

var compVar = varWgt.getProperty("VariableName");
For global variables:
var varWgt = project.getWidget("_VariablesWgt");

var compVar = varWgt.getProperty("VariableName");
Variables widget
35 Custom widgets
PB610 Panel Builder 600 has a large widget library which includes predefined dynamic widgets (buttons, lights, gauges,
switches, trends, recipes, and dialog items), as well as static images (shapes, pipes, tanks, motors).
You can drag and drop an object from the gallery to the page, and then size, move, rotate or transform it. All widgets in the
gallery are vector based, so they do not loose definition when resized.
You can, however, modify any of the pre-defined widgets to create your own custom widget. Custom widgets can be made
up of several elements only including the properties needed to their purpose.
Creating a custom widget 410
Adding properties to a custom widget 412
Using structured tags 415
JavaScript in custom widgets 417
User's Gallery 420
Creating a custom widget
Creating a custom widget

1. Drag and drop on a page all the widget you want to use to compose your custom widget.
2. Select and group them.
3. Right-click on the grouped object and select Convert To Widget: the Custom Widgets Catalog dialog is
displayed.
Include used custom When checked, list all the widgets used inside the project. Even system
widgets widgets.
Name You can define everything you prefer, but is common keep a name structure.
The folder com.hmi is reserved for the system widgets
Description Widget description.
Version Widget version.
All widgets that share the same version share the properties defined from the
Inheritance parameter.
Inheritance Properties shared between widgets with the same version
l Full (both Graphic and Logic)

l Only Graphic
l Only Logic
l Disable
Modify a custom widget

To modify a custom widget, simple double clicks the custom widget to enter in edit mode.
35 Custom widgets
If the Inheritance flag is enabled, a lock icon will appear to warn you that you are add changes that will be propagated to all
the other custom widgets that share the same version. Click the padlock icon to confirm to enter in edit mode, padlock will
be open. Click again when modifies are done.
Padlock is showed only when the Inheritance is enabled.
Resize a custom widget

When sizes of custom widget is changed, the new sizes will not be propagated to the other widget instances.
“Restore Widget Original Size” command can be used.
Share properties
When a custom widget is modified, all the modifies will be propagated to all the other custom widgets that share the same
version and that are configured to inherit the widget properties.
Adding properties to a custom widget
Using widgets components

Widgets are usually made up of many parts, for example a button is a complex widget including two image widgets, a
button widget and label.
To display a list of all the elements that are part of a widget, select the widget, open the padlock and open the ObjectView
pane: all the element making up a complex widget are listed in hierarchical order.
To select a single widget, select it directly form the ObjectView pane.

When you create a custom widget, you need to define the properties that will be displayed for it in the Properties pane.
35 Custom widgets
1. Right-click on the grouped object and select Widget catalog: the properties dialog is displayed.
2. Click + to open the Property Select dialog: this lists all the properties of all the grouped widgets.
3. Select the properties you want to define for your custom widget.
4. Define each property's details.
Note that you can create folders and use drag & drop to move or reorganize the Properties list
Properties Name shown in the Properties pane.
Description Any comment on the property to be displayed in the Properties pane.
Id The name exposed by PB610 Panel Builder 600, to JavaScript functions and Attach Tag dialog.
Support Tags Specifies if the property supports the “Attach to" attribute.
Read only Property exposed only in read mode
Advanced Specifies whether each property should appear in the advanced, or in the simple view mode of the
Properties pane.
Aliased Internal properties linked with the exposed property

properties
Combining properties
To combine two or more properties:
1. Select the primary property in the Properties list dialog.

2. Click + in the Aliased properties toolbar: the Property Select dialog is displayed.
3. Select the properties you want to combine.
4. Click OK: the combined attributes will be shown in the Aliased properties list box.
Example
If you insert into a “Color” property the fill color of all widgets (e.g. filed1.fill and BtnStd4.btn.fill) when you set the exposed
Color property of the custom widget all colors of the included widgets will changes.
Reset Widget Properties

The "Reset Widget Properties" reset the modified properties values to original values.
35 Custom widgets
Using structured tags

A common problem using a widget that use many tags is the need to create instances of the widget by giving only the tag
name of the structure that contains all the tags instead to configure each single tag.
For example, think about the below widget. It use four tags, the room name, temperature, humidity and pressure. If we want
use two instances of this widget for two different rooms we have to configure eight tags, four tags for each room.
By using a Parameter property, is possible to set all the data links of the widget by giving only the name of the structure.
A “Parameter” field can be added inside the custom widget using the "Add Parameter" icon:
Using structured tags
To configure the data links of the custom widget the keyword ${RoomID} can be used to reference at the structure instance
Type filter
Typically, value of the parameter will be an element of a structured tag. Using the “Type filter” parameter, the “Select
datatype text” will list filtered tags.
35 Custom widgets
The “Select datatype text” will return a string while the “Attach to” will return a datalink to a tag that will contains
the string to use.
getParameter
From JavaScript you can read the parameters' value using the getParameter()
object getParameter(paramID)
Example:
var myWidget = page.getWidget("myWidget");

function BtnStd3_btn_onMouseClick(me, eventInfo)
{
alert("Room is: " + myWidget.getParameter("RoomID"));
}
You can also use getProperty(), but getParameter() is more efficient to read custom widget parameters
JavaScript in custom widgets

JavaScript functions can be embedded in custom widgets.
After doing a double click on the custom widget and clicked on the padlock, the edit mode is active and it is possible to
associate the JavaScript code to the available events.
JavaScript in custom widgets
Note the usage of the operator this. that is necessary to allow the multiple instance of the custom widget.
If you need to reference to an element of the widget, you can use the keyword wgt.. For example, use wgt.id to reference at
the id of the active widget instance.
35 Custom widgets
If you cut and paste some instances of the custom widget of the above example and execute it, e.g. inside the simulator,
you will obtain the below result.
onActivate property
To initialize the custom widget is possible to define the onActive property with an initializing function as for the below
example.
The onActivate() function will be execute when the page is loading
User's Gallery
Note that the custom widget can also past inside the User’s Gallery for later reuse.
The JavaScript code used inside the examples of this chapter
/*!
javascript module: widget-1.0.js
javascript source file path: lib\com\example\widget-1.0\widget-1.0.js
*/
this.wMSG = wgt.getWidget(wgt.id+".field1")
this.BtnStd1_btn_onMouseClick = function (me, eventInfo)

{
var now = new Date();
this.wMSG.setProperty("value", now.toString().slice(0, 24));
}
this.onActivate = function()
{
this.wMSG.setProperty("value", "Button never pressed");
};
this.onActivate();
User's Gallery
Widgets created from the developers can be saved inside the Widgets Gallery to be available during development of new
projects.
User widgets toolbar
35 Custom widgets
Command Description
Open the selected widgets folder into the PB610 Panel Builder 600 editor
Add a new widgets folder
Delete current selected folder
Select the user widgets folder
To add a new widget into the user gallery, open the widget folder and then edit the gallery page creating or adding the new
widget.
Tip: To import a user gallery sub folder, simply copy the folder to import inside the main user gallery folder.
User's Gallery
36 Sending an email message
Send emails using the SendMail action, including tags in the email body and attachments.
The SendMail action has been created for working with alarms and schedulers but can be triggered and executed by many
other events.
Configuring the email server 424
Configure emails 424
Configuring the email server
Configuring the email server

To configure the email server, enter the following information for the EmailConfig setting:
SMTP Address SMTP server address.
Server Port Port for SMTP server connection (default = 25).
Require Auth Select if the SMTP server requires authentication.
User Name Username for sending mail using SMTP server.
Password Password for sending mails using SMTP server.
Encryption Encryption type (none or SSL).
Click + to add more email servers.
Tip: Use tags if you want change the server parameters dynamically from the HMI Runtime.
Configure emails
Enter the following information for the EmailInfo setting:
Name Optional, this information is only for the log.
Description Optional, this information is only for the log.
From Optional, sender email address (for example, [email protected]).
To Recipient e-mail addresses. To enter multiple addresses, separate them with a semi-colon.
Subject Subject of email.
Attachment Path of the file to be sent as attachment. Only one attachment at a time can be sent.
Note: The maximum size of the attachments is usually set by the SMTP server.
Body Main content of the email. Here you can insert live tags if you include them in square
brackets.
For example, a message body as “Tag1 value is [Tag1]”, will be sent as “Tag1 value is 45”, if
the current value of Tag1 is 45.
Tip: Attach a string tag to the From, To and Subject fields so that their value can be changed in the HMI
Runtime.
36 Sending an email message
WARNING: The maximum size for the message body is 4096 bytes, the exceeding text will be
truncated.
Adding email templates

Click + to add more templates.
Configure emails
37 JavaScript
The purpose of this section is to describe how JavaScript is used in the PB610 Panel Builder 600 applications, not to
explain the JavaScript language.
PB610 Panel Builder 600 JavaScript is based on the ECMAScript programming language http://www.ecmascript.org , as
defined in standard ECMA-262.
If you are familiar with JavaScript, you can use the same type of commands in PB610 Panel Builder 600 as you do in a web
browser. If you are not familiar with the ECMAScript language, refer to:
https://developer.mozilla.org/en/JavaScript
JavaScript editor 429
Execution of JavaScript functions 429
Events 431
Widget events 432
Page events 434
System events 435
Objects 437
Widget class objects 437
Widget properties 438
Widget methods 441
Page object 442
Page object properties 442
Page object methods 443
Group object 445
Group object methods 445
Project object 447
Project object properties 447
Project object methods 447
Project object widgets 456
Print reports object 457
State object 460
State object methods 460
Keywords 461
Global functions 462
Handling read/write files 462
Sign in from JavaScript 465
Limitations in working with widgets in JavaScript 467
Debugging of JavaScript 468
37 JavaScript
JavaScript editor
PB610 Panel Builder 600 includes a powerful JavaScript editor.
Right-click in the editor to display available commands.
Execution of JavaScript functions

JavaScript functions are executed when events occur. For example, a user can define a script for the OnMouseClick event
and the JavaScript script will be executed when the button is pressed on the HMI device.
JavaScript functions are executed only when the programmed event occurs and not cyclically. This approach minimizes
the overhead required to execute logic in the HMI device.
PB610 Panel Builder 600 provides a JavaScript engine running on the client side. Each project page can contain scripts
having a scope local to the page where they are added; global scripts can be created to be executed by scheduler events or
alarm events.
In both cases scripts are executed on the client. This means that if more than one client is connected to the HMI device (for
external computer running the HMI Client), each client will run the same script, providing different output results depending
on the input, since inputs provided to different clients may be different.
For example, if a script acts according to the position of a slider and this position is different on the different clients, the
result of the script will be different on each client.
JavaScript functions for page events

JavaScript editor will open when you add a JavaScript action inside an action list.
Execution of JavaScript functions
1. Select the even that will execute the action.

2. Add a JavaScript action from the Widget category.
3. Either leave the default function name, or type a new one.
4. Click OK to confirm: the JavaScript editor displays your function structure.
You can also open the JavaScript editor from the Script tab at the bottom of the workspace.
JavaScript functions for alarms and scheduled events

JavaScript code associated with alarms and scheduled events and not associated with a specific page, can be edited from
the main Project properties page.
Path: ProjectView> double-click Project properties
37 JavaScript
Note: JavaScript actions are client actions so they are executed only when a client is logged in.
Shared JavaScript code

The project global variable can be used to share JavaScript code between the pages. Variables are created/initialized from
the main JavaScript code from the main Project properties page and can then be used from the project pages.
Events
You can add JavaScript to the following categories of events:
Widget events
l Widget events
l Page events
l System events
For events of type:
l OnMousePress
l OnMouseRelease
l OnMouseClick
l OnWheel
JavaScript eventinfo parameter contains the following additional properties:
eventInfo.posX Local mouse/touch X coordinate with respect to widget coordinates
eventInfo.posY Local mouse/touch Y coordinate with respect to widget coordinates
eventInfo.pagePosX Page X mouse/touch coordinate
eventInfo.pagePosY Page Y mouse/touch coordinate
eventInfo.wheelDelta Mouse wheel delta. Integer value with sign representing the rotation direction.
The actual value is the rotation amount in eighths of a degree. The smallest value
depends on the mouse resolution. Typically this is 120, corresponding to 15
degrees.
Widget events
onMouseClick
void onMouseClick (me, eventInfo)
This event is available only for buttons and it occurs when the button is pressed and released quickly.
eventInfo Details of triggered event
function buttonStd1_onMouseClick(me, eventInfo) {

//do something…
}
onMouseHold
void onMouseHold (me, eventInfo)
37 JavaScript
This event is available only for buttons and it occurs when the button is pressed and released after the number of seconds
set as Hold Time in the widget properties.
function buttonStd1_onMouseHold(me, eventInfo) {

//do something…
}
onMousePress
void onMousePress(me, eventInfo)
This event is available only for buttons and it occurs when the button is pressed.
function buttonStd1_onMousePress(me, eventInfo) {

//do something…
}
onMouseRelease
void onMouseRelease (me, eventInfo)
This event is available only for buttons and it occurs when the button is released.
function buttonStd1_onMouseRelease(me, eventInfo) {

//do something…
}
onDataUpdate
boolean onDataUpdate (me, eventInfo)
This event occurs when data attached to the widget changes.
Page events
eventInfo An object with the fields listed below (you can refer fields using “.” - dot notation)
oldValue = Widget value before the change
newValue = Value which will be updated to the widget
attrName = Attribute on which the event is generated
index = Integer attribute index if any, default = 0
mode = W when the user is writing to the widget. R in all others status.
The event is triggered before the value is passed to the widget. A JavaScript code can intercept the event and decide to
avoid to update the widget by return true value.
Note: if there are additional macros associate at the event, all macros will be execute regardless of the return
value used inside the JavaScript code.
function buttonStd1_onDataUpdate(me, eventInfo) {

if ( eventInfo.newValue > 100) {
//do something...
return true; // To avoid to continue and update
// the widget (e.g. not update the linked tag)
}
return false; // To continue and update the widget
// (e.g. update the linked tag)
}
Page events
onActivate
void onActivate( me, eventInfo )
This event occurs each time the page is displayed.
eventInfo Reserved for future use
JavaScript will be executed when the page is active, that is when the page is loaded.
function Page1_onActivate(me, eventInfo) {

//do something…
}
37 JavaScript
onDeactivate
void onDeactivate( me, eventInfo )
This event occurs when leaving the page.
eventInfo Reserved for future use
function Page1_onDeactivate(me, eventInfo) {

//do something…
}
onWheel
void onMouseWheelClock( me, eventInfo )
This event occurs when a wheel device is moving (for example, a mouse wheel).
function Page1_onMouseWheelClock(me, eventInfo) {

//do something…
}
System events
System events can be related to:
l scheduler
l alarms
l a wheel device
Important: Make sure you do not duplicate JavaScript function names at page and project level. When
a conflict happens, that is two functions with the same name in current page and at project level, the
system execute the JavaScript callback at page level.
When a JavaScript callback is not found in the current page, the system automatically searches for it at project level.
Scheduler events
These events occur when triggered by the associated action in the scheduler.
System events
You can edit the JavaScript from the Project Properties tab.
Alarm events
These events occur when triggered by the associated alarm condition.
You can edit the JavaScript from the Project Properties tab.
onWheel
void onMouseWheelClock( me, eventInfo )
This event occurs when a wheel device is moving (for example, a mouse wheel).
37 JavaScript
function Project1_onMouseWheelClock(me, eventInfo) {

//do something…
}
Objects
PB610 Panel Builder 600 uses JavaScript objects to access the elements of the page. Each object is composed of
properties and methods that are used to define the operation and appearance of the page element. The following objects are
used to interact with elements of the HMI device page:
Object Description
Widget This is the base class for all elements on the page
including the page element
Page This object references the current HMI device page.

The page is the top-level object of the screen.
Group This object associates a set of tags to allow uniform

operation on a set of logically connected tags
Project This object defines the project widget. The project

widget is used to retrieve data about the project such
as tags, alarms, recipes, schedules, tags and so on.
There is only one widget for the project and it can be
referenced through the project variable.
State This object is the class holding the state of a

variable acquired from the controlled environment.
Beside the value itself, it contains the timestamp
indicating when the value was collected and flags
marking the quality of the value.
Widget class objects

The Widget class is the base class for all the elements on a page including the page element.
Widget, in this case, is not used to indicate a specific screen object but a JavaScript class.
Changing widget properties with JavaScript

If you want to change the properties of widgets with JavaScript set the widget property Static Optimization to Dynamic.
Widget properties
Important: If the widget property Static Optimization is not set to Dynamic, changes to properties will
be ignored.
Whenever a call to getWidget fails, the remote debugger reports the following error:
“Trying to access static optimized widget "label1". Disable widget static optimization to access widget from script.”.
This error is visible also using following code fragment:
var wgt;
try {
wgt = page.getWidget('label1');
} catch(err) {
alert("" + err);
}
Widget properties
Some properties are common to all widgets.
objectName
string objectName
Gets the name of the widget, a unique id.
function btnStd04_onMouseRelease(me) {
var wgt = page.getWidget("rect1");
var name = wgt.objectName;
}
(Available on web pages)
x
number x
Gets or sets the widget ‘x’ position in pixels.
wgt.x = 10;
}
y
number y
37 JavaScript
Gets or sets the widget ‘y’ position in pixels.
wgt.y = 10;
}
width
number width
Gets or sets the widget width in pixels.
wgt.width = 10;
}
height
number height
Gets or sets the widget height in pixels.
wgt.height = 10;
}
visible
boolean visible
Gets or sets the widget visible state.
wgt.visible = false;
}
wgt.visible = true;
Widget properties
value
number value
Gets or sets the widget value.
var wgt = page.getWidget("field1");
wgt.value = 100;
}
opacity
number opacity (range from 0 to 1)
Gets or sets the widget opacity. Values are decimals from 0 to 1, where 1 is 100% opaque.
wgt.opacity = 0.5;
}
rotation
number rotation (in degrees)
Gets or sets the rotation angle for the widget. The rotation is done clockwise and by degrees, starting at the East position.
wgt.rotation = 45;
}
userValue
string userValue
Gets or sets a user-defined value for the widget. This field can be used by JavaScript functions to store additional data with
the widget.
wgt.userValue = "Here I can store custom data";
37 JavaScript
Every widget has some specific properties that you can access using dot notation. For an up-to-date and detailed list of
properties you can use the JavaScript Debugger inspecting the widget methods and properties.
Widget methods
Some methods are common to all widgets.
getProperty
object getProperty( propertyName, [index] )
Returns a property.
propertyName String containing the name of property to get
index Index of the element to get from the array (default = 0)
Almost all properties that are shown in the PB610 Panel Builder 600 Properties pane can be retrieved using the
getProperty method. The index value is optional and only used for widgets that support arrays.

var shape = page.getWidget("rect2");
var y_position = shape.getProperty("y");
}

var image = page.getWidget("multistate1");
var image3 = image.getProperty("imageList", 2);
//…
}
setProperty
boolean setProperty( propertyName, value, [index] )
Sets a property for the widget.
Page object
Parameters
propertyName String containing the name of property to set
value String containing the value to set the property.
index Index of the element to set in the array (default = 0)
Almost all properties that are shown in the PB610 Panel Builder 600 Properties pane can be set by this method. The index
value is optional and only used for Widgets that support arrays (for example, a MultiState Image widget). The
setProperty method returns a boolean value (true or false) to indicate if the property was set or not.

var setting_result = shape.setProperty("y", 128);
if (setting_result)
alert("Shape returned to start position");
}

var image = page.getWidget("multistate1");
var result = image.setProperty("imageList", "Fract004.png", 2);
//…
}
Page object
This object references the current HMI device page. The page is the top-level object of the screen.
Page object properties

Properties available at page level.
backgroundColor
string backgroundColor (in format rgb(xxx, xxx, xxx) where xxx range from 0 to 255)
Page background color.
page.backgroundColor = "rgb(128,0,0)";
}
37 JavaScript
width
number width
Page width in pixels.
var middle_x = page.width / 2;
}
(Available on web pages, get only)
height
number height
Page height in pixels.
var middle_y = page.height / 2;
}
(Available on web pages, get only)
userValue
string userValue
Gets or sets a user-defined value for the widget. This field can be used by JavaScript functions to store additional data with
the page.
page.userValue = "Here I can store custom data";
}
Page object methods

Methods that can be used at page level.
getWidget
object getWidget( wgtName )
Returns the widget with the given name.
wgtName String containing the widget name
Page object methods
Return value
An object representing the widget. If the widget does not exist, null is returned.
var my_button = page.getWidget("btnStd1");
}
setTimeout
number setTimeout( functionName, delay )
Starts a timer to call a given function after a given delay.
functionName String containing the name of function to call
delay Delay in milliseconds
Return value
A number corresponding to the timerID.
var duration = 3000;

var myTimer = page.setTimeout("innerChangeWidth()", duration);
clearTimeout
void clearTimeout( timerID )
Stops and clears the timeout timer with the given timer.
timerID Timer to be cleared and stopped
var duration = 3000;

var myTimer = page.setTimeout("innerChangeWidth()", duration);
// do something
page.clearTimeout(myTimer);
setInterval
number setInterval( functionName, interval )
37 JavaScript
Starts a timer that executes the given function with the given interval.
functionName String containing the name of function to call
interval Interval in milliseconds
Return value
A number corresponding to the timerID.
var interval = 3000;

var myTimer = page.setInterval("innerChangeWidth()", interval);
clearInterval
void clearInterval( timerID )
Stops and clears the interval timer with the given timer.
timerID Timer to be cleared and stopped
var interval = 3000;

var myTimer = page.setInterval("innerChangeWidth()", interval);
// do something
page.clearInterval(myTimer);
clearAllTimeouts
void clearAllTimeouts()
Clears all the timers started.
page.clearAllTimeouts();
Group object
A group is a basic logical element that associates a set of logical tags.
Group object methods

Methods that can be used with group objects.
Group object methods
getTag
object getTag( TagName )
Gets the tag specified by TagName from the group object.
TagName String representing the tag name
Return value
An object that is the value of the tag or, if tag value is an array, the complete array. If you need to retrieve an element of the
array, check the method getTag available in the project object. Undefined is returned if tag is invalid.
var group = new Group();

project.getGroup("GroupName", group);
var value = group.getTag("Tag1");
getCount
number getCount()
Returns total number of tags in this group.

var value = group.getCount();
getTags
object getTags()
Returns the list of all tags in group.
function {
project.getGroup("enginesettings", group);
var tagList = group.getTags();
for(var i = 0; i < tagList.length; i++){
var tagName = tagList[i];
//do something…
};
37 JavaScript
Project object
This object defines the project widget. The project widget is used to retrieve data about the project such as tags, alarms,
recipes, schedules, tags and so on. There is only one widget for the project and it can be referenced through the project
variable.
Project object properties

Properties to be set at project level.
startPage
string startPage
Page shown when the project is started.
var startPage = project.startPage;

project.startPage = "Page2.jmx";
Project object methods

Methods to be used at project level.
nextPage
void nextPage()
The script executes the Next page action.
project.nextPage();
prevPage
void prevPage()
The script executes the previous page action.
project.prevPage();
lastVisitedPage
void lastVisitedPage()
The script executes the last visited page action.
project.lastVisitedPage();
homepage
void homePage()
The script executes the Home page action.
project.homePage();
loadPage
void loadPage(pageName)
The script executes to load the set page defined in the script.
project.loadPage("Page5.jmx");
WARNING: When page change, all active time events are forced to removed and the JavaScript
procedure will run until the end before switch to the new page.
showDialog
void showDialog(pageName)
The script executes to show the dialog page.
project.showDialog("Dialog.jmx");
closeDialog
void closeDialog()
The script executes to close the currently-opened dialog page.
project.closeDialog();
showMessage
void showMessage( message )
The script executes to display the message popup.
37 JavaScript
project.showMessage("Hi This is test message");
getGroup
number getGroup( groupName, groupInstance, [callback] )
Fast read method; this gets the values of all tags in a group.
groupName String containing the name of the group
groupInstance Group element to be filled
callback String containing the name of the function to be called when the group is ready
Return value
A number value that is the status: 1 for success, 0 for fail.

var status = project.getGroup ("enginesettings", group);
if (status == 1) {
var value = group.getTag("Tag1");
if (value!=undefined) {
// do something with the value
}
}
var g = new Group();

var status = project.getGroup ("enginesettings", g,
function (groupName, group) { fnGroupReady(groupName, group);} );
function fnGroupReady(groupName, group) {

var val = group.getTag("Tag1");
if (val!=undefined) {
// do something with the value
}
}
getTag
object getTag( tagName, state, index, forceRefresh)
void getTag( tagName, state, index, callback, forceRefresh)
It returns the tag value or the complete array if index value is -1 of the given tagName.
tagName String of tag name
state State element to be filled
index Index if the tag is of array type. -1 returns the complete array. Default = 0.
callback Function name if an asynchronous read is required. Default = “".
forceRefresh (Optional parameter) True = the Runtime will read an updated value of the tag directly from the device.
Default is false.
Return value
Tags value is returned. If tag is array type and index = -1 then the complete array is returned. For non-array tags provide
index as 0.
var state = new State();

var value = project.getTag("Tag1", state, 0);
//
//for non array type
//tags index is not considered, so can be left as 0
//
if (value!=undefined) {
//...do something with s
}

project.getTag("Tag1", state, -1,
function(tagName, tagState) { fnTagReady(tagName, tagState); });
function fnTagReady(tagName, tagState) {
if (tagName=="Tag1") {
var myValue = tagState.getValue();
}
}
setTag
number setTag( tagName, tagValue, [index], [forceWrite] )
Sets the given tag in the project. Name and value are in strings.
37 JavaScript
tagName String of tag name
tagValue Object containing the value to write
index Index if the tag is of array type. -1 pass the complete array. Default = 0.
forceWrite Boolean value for enabling force write of tags, the function will wait for the value to be written before it
returns back. Default = false.
Return value
Interger value for denoting success and failure of action when forceWrite is true. 0 means success and -1 means failure. If
forceWrite is false, returned value will be undefined.
var val = [1,2,3,4,5];

var status = project.setTag("Tag1", val, -1, true);
if (status == 0) {
// Success
} else {
// Failure
}
var val = "value";

project.setTag("Tag1", val);
updateSystemVariables
void project.updateSystemVariables()
Force system variables to refresh.
project.updateSystemVariables()
selectAllAlarms
void project.selectAllAlarms(bool selected)
Select/unselect all alarms
project.selectAllAlarms(true)
ackAlarms
void project.ackAlarms()
Acknowledge all selected alarms
project.selectAllAlarms(true);
project.ackAlarms();
resetAlarms
void project.resetAlarms()
Reset all selected alarms
project.resetAlarms();
enableAlarms
void project.enableAlarms()
Enable all selected alarms
project.enableAlarms();
getRecipeItem
object getRecipeItem (recipeName, recipeSet, recipeElement)
Gets the value of the given recipe set element.
recipeName String representing the recipe name
recipeSet String representing the recipe set, can be either the recipe set name or 0 based set index.
recipeElement String representing the recipe Element, can be either the element name or 0 based element index.
Return value
An object with the value of the recipe. undefined is returned if invalid. If of type array, an array object type is returned.
var value = project.getRecipeItem("recipeName", "Set", "Element");
37 JavaScript
setRecipeItem
number setRecipeItem (recipeName, recipeSet, recipeElement, value )
Gets the value of the given recipe set element.
recipeElement String representing the recipe Element, can be either the element name or 0 based element index.
value An object containing the value to store in the recipe. It can be an array type.
Return value
Interger value for denoting success and failure of action. A ‘0’ means success and ‘-1’ means failure.
var val = [2,3,4];

project.setRecipeItem("recipeName", "Set", "Element", val);
if (status == 0) {
// Success
} else {
// Failure
}
downloadRecipe
void downloadRecipe (recipeName, recipeSet )
Downloads the recipe set to the corresponding tag.
project.downloadRecipe("recipeName", "Set");
uploadRecipe
void uploadRecipe (recipeName, recipeSet )
Uploads the value of tags into the provided recipe set.
project.uploadRecipe("recipeName", "Set");
launchApp
void launchApp( appName, appPath, arguments, singleInstance)
Executes an external application.
appName String containing the application name
appPath String containing the application absolute path
Arguments String containing the arguments to be sent to application
singleInstance true = only single instance allowed, false = multiple instances allowed
Note the pathname's syntax depend from the native OS format (see "HMI devices capabilities" on page 499).
On WinCE devices, the pathname's syntax need double backslash character.
project.launchApp("PDF.exe","\\Flash\\QTHMI\\PDF","\\USBMemory\\file.pdf","true");
On Linux devices, the pathname's syntax need slash character (even double slash character is permitted).
project.launchApp
("pdfViewer","/mnt/data/hmi/qthmi/deploy","/mnt/usbmemory/test.pdf","true");
getClientType
string getClientType()
Return the client type
Client Type Description
local Running on HMI device
remote Running on HMI Client client
web Running on Web client
var clientType = project.getClientType();

if (clientType=="web") {
// Currently running on web client
} else if (clientType=="remote") {
// Currently running on HMI Client
} else if (clientType=="local") {
// Currently running on HMI Device
}
37 JavaScript
login
int project.login("username", "password")
Access to the system with the given credentials
var ReplyCode;
ReplyCode = project.login("admin", "admin");
if (ReplyCode != 0) {
alert("Access denied");
}
Return value
0 No Error
1 Error: You are not authorized.
2 Error: Connection lost with the Runtime.
3 Error: The username or password you entered is incorrect
4 Error: The password entered is incorrect
5 Error: Action cannot be executed
6 Error: Passwords do not match
7 Error: Password length too short
8 Error: Password must contain numbers
9 Error: Password must contain special characters
10 Error: Password must be different than previous passwords
11 Error : User already exist
12 Error: Password cannot be empty
13 Error: Your password has expired
14 Warning: Your password will expire soon
logout
project.logout(AllowDefaultUser)
Exiting the system
project.logout(); // Logout even from default user

project.logout(true); // Logout even from default user
project.logout(false); // Logout only if not logged as default user
Project object widgets
Project object widgets

getCurrentPageName
string getCurrentPageName()
Return the name of current active page
// Get PageMgr widget

var pageMgr = project.getWidget( "_PageMgr" );
// Show Current Page

var currentPageName = pageMgr.getCurrentPageName();
project.showMessage( "Current active page is: " + currentPageName );
hasPage
boolean hasPage(string pageName)
Return true if the page exist, false otherwise
// Get PageMgr widget

var pageMgr = project.getWidget( "_PageMgr" );
//Page exists
var pageExists = pageMgr.hasPage( "Page10" );
if (pageExists) {
project.showMessage( "Page10 exists" );
} else {
project.showMessage( "Hei Page10 not exists!" );
}
curLangCode
string curLangCode
Property of MultiLangMgr widget. Contains the code of the active language.
// Get MultiLangMgr widget

var MultiLangMgr = project.getWidget( "_MultiLangMgr" );
// Show curLangCode
var curLangCode = MultiLangMgr.curLangCode;
project.showMessage( "Current active language is: " + curLangCode );
37 JavaScript
Print reports object

printGfxReport
void printGfxReport( reportName, silentMode)
Prints the graphic report specified by reportName.
reportName String containing the report name
silentMode True = silent mode enabled. No printer settings dialog is displayed.
project.printGfxReport("Report Graphics 1", true);
printText
void printText( text, silentMode)
Prints a fixed text.
text String to print
project.printText("Hello I Am Text Printing",true);
printBytes
void printBytes( text, silentMode)
Prints a hexadecimal string representing data to print. For example, "1b30" to print < ESC 0 >
text Hexadecimal string to print
project.printText("1B30",true); // Print: ESC 0
emptyPrintQueue
void emptyPrintQueue()
Empties the print queue. Current job will not be aborted.
Print reports object
project.emptyPrintQueue();
pausePrinting
void pausePrinting();
Suspends printing operations. Will not suspend the print of a page already sent to the printer.
project.pausePrinting();
resumePrinting
void resumePrinting();
Resumes previously suspended printing.
project.resumePrinting();
abortPrinting
void abortPrinting();
Aborts current print operation and proceed with the next one in queue. This command will not abort the print of a page
already sent to the printer.
project.abortPrinting();
printStatus
project.printStatus;
Returns a string representing current printing status.
Status string Description
error An error occurred during printing
printing Ongoing printing
idle System is ready to accept new jobs
paused Printing has be suspended
var status = project.printStatus;

project.setTag("PrintStatus",status);
printGfxJobQueueSize
project.printGfxJobQueueSize;
Returns the number of graphic reports in queue for printing.
37 JavaScript
var gfxqueuesize = project.printGfxJobQueueSize;

project.setTag("printGfxJobQueueSize",gfxqueuesize);
printTextJobQueueSize
project.printTextJobQueueSize;
Returns the number of text reports in queue for printing.
var textjobqueuesize = project.printTextJobQueueSize;

project.setTag("printTextJobQueueSize",textjobqueuesize);
printCurrentJob
project.printCurrentJob;
Returns a string representing current job being printed
var currentjob = project.printCurrentJob;

project.setTag("printCurrentJob",currentjob);
printActualRAMUsage
project.printActualRAMUsage;
Returns an estimate of RAM usage for printing queues
var myVar = project.printActualRAMUsage;

alert(" actual ram usage is "+ myVar);
printRAMQuota
project.printRAMQuota;
Returns the maximum allowed RAM usage for printing queues
var ramquota = project.printRAMQuota;

project.setTag("printRAMQuota",ramquota);
printActualDiskUsage
project.printActualDiskUsage;
Returns the spool folder disk usage (for PDF printouts)
var myVar1 = project.printActualDiskUsage;

alert(" actual disk usage is "+ myVar1);
State object
printDiskQuota
project.printDiskQuota;
Returns the maximum allowed size of spool folder (for PDF printouts).
var ramquota = project.printRAMQuota;

var diskquota = project.printDiskQuota;
printSpoolFolder
project.printSpoolFolder;
Returns current spool folder path (for PDF printouts).
var spoolfolder = project.printSpoolFolder;

project.setTag("printSpoolFolder",spoolfolder);
printPercentage
project.printPercentage;
Returns current job completion percentage (meaningful only for multipage graphic reports)
var percentage = project.printPercentage;

project.setTag("printPercentage",percentage);
State object
This is the class holding the state of a tag acquired from the controlled environment.
State object methods

Methods to be used with state objects.
getQualityBits
number getQualityBits()
Returns an integer - a combination of bits indicating tag value quality.

var qbits = state.getQualityBits();
37 JavaScript
getTimestamp
number getTimestamp()
Returns time the value was sampled.
Return value
A number containing the timestamp (for example 1315570524492).
Note: Date is a native JavaScript data type.

var ts = state.getTimestamp();
isQualityGood
boolean isQualityGood()
Returns whether the value contained in this state object is reliable.
Return value
A Boolean true if quality is good, false otherwise.

if (state.isQualityGood()) {
// do something…
}
Keywords
Global objects are predefined and can be referenced by the following names.
page
object page
References the page object for the current page.
var name = wgt.objectName;
}
Global functions
project
object project
References the project widget.

var value = group.getCount("Tag1");
Global functions
print
void print( message )
Prints a message to the HMI Logger window.
message Message string
print("Test message");
alert
void alert( message )
Displays a pop-up dialog with the given message. The user must press the OK button in the dialog to continue with the
execution of the script.
message Message string
Note: The alert function may be used for debugging JavaScript functions.
alert("Test message");
Handling read/write files

Create folder
boolean fs.mkdir(strPath);
Creates a folder, if not already existing, in the specified path. Returns true on success and false if it fails.
37 JavaScript
strPath Path string
Remove folder
boolean fs.rmdir(dirPath);
Remove directory at strPath if exists and empty. Returns true on success and false if it fails.
dirPath Folder string
Read folder content

object fs.readdir(dirPath);
Reads the contents of a folder. Returns an array of the names of the files in the folder excluding '.' and '..'. Returns empty
list if it fails.
dirPath Folder string
Read file
object fs.readFile(strfile [,strFlag]);
Opens the strFile file in read mode, reads its contents and returns it.
strFile File name string
strFlag Read file mode:
“b” reads and returns as binary file (otherwise returns a text file)
Write file
fs.writeFile(strFile, fileData, [strFlag]);
Creates the strFile file if not present. Opens the strFile file in write mode and writes the data fileData to the file.
fileData Data to be write on the file in byte array
strFlag Write file mode:

l “a”: appends fileData to the end of the text file
Handling read/write files
l “r”: replaces the contents of the file with fileData

l “ab”: appends fileData to the end of the binary file
l “rb”: replaces the contents of the binary file with fileData
Default flag is for writing text file in append and write mode. File path will be created if not present.
Returns -1 if write error occurs.
Append file
int fs.appendFile(strFile, fileData);
If the files does not exist creates it, otherwise append to existing file. Returns the number of character written or -1 on error.
fileData Data to be write on the file in byte array
File exists
boolean fs.exists(strPath)
Returns true if the file or folder exists at strPath.
strPath Path string
Remove file
boolean fs.unlink(strPath)
Removes the given file at strPath from filesystem if exists. Returns true on success and false if it fails.
strPath Path string
File status
object fs.stat(strPath)
Retrieves information on the file/folder present at the specified path.
strPath File/folder path string
var fileStats = var fs.stat(strPath)
37 JavaScript
fileStats.isFile True if path is a file
fileStats.isDir True if path is a folder
fileStats.size Size in bytes of that file
fileStats.atime Date object representing the last read access time
fileStats.mtime Date object representing the last write access time
fileStats.ctime Date object representing the creation time
fileStats.perm File permissions
If path is invalid both isFile and isDir fields return false.
File permission table
0x4000 File is readable by the owner of the file
0x2000 File is writable by the owner of the file
0x1000 File is executable by the owner of the file
0x0400 File is readable by the user
0x0200 File is writable by the user
0x0100 File is executable by the user
0x0040 File is readable by the group
0x0020 File is writable by the group
0x0010 File is executable by the group
0x0004 File is readable by anyone
0x0002 File is writable by anyone
Important notes on file handling

Path for files and folders are expected to be UNIX style. This means the backslash character (\) is not recognized. Use
slash character (/) instead.
File system object is a client side object. So operations are performed on local file system, not on server file system.
Current JavaScript API to get access at the device file system has been designed to manipulate small files. When a file is
read, the entire file contents is temporarily stored inside the RAM available for JavaScript environment (16MB) and an
exception is raised when there is not enough available memory. Good programming practice is to include the
fs.readFile() call inside a try/catch block.
Sign in from JavaScript

Using the project.login() and project.logout() function is possible automatize the user sign in from a remote device. This
could be useful, e.g., to perform the sign in by reading a user badge with a badge reader device.
Sign in from JavaScript
This chapter show an example of how configure the application to manage the sign in by a remote device.
The application must have a default user
Since the project's functions are working only when the application is active, the application must start with a default user,
maybe with read only privilege. Reading the badge, the application can be switched to a user with additional privilege.
Later, the logout command will reactivate the default user without any particular privileges
In the below example we are using three tags to communicate with the remote device:
l TAG_USERNAME
l TAG_PASSWORD
l TAG_LOGIN
The TAG_LOGIN will be the command code to execute.
The remote device has to fill the required TAG_USERNAME and TAG_PASSWORD parameters, then fill the TAG_LOGIN
parameter with the required login or logout command. Engine on HMI-RUNTIME will detect the TAG_LOGIN changes and
perform the required command, then reset the TAG_LOGIN to its idle status.
TAG_LOGIN Commands
0 Idle
1 Login request
2 Logout request
At the project level, we have to add a JavaScript function block to detect when TAG_LOGIN will changes. The JavaScript
code attached at the OnDataUpdate Action of the JavaScript function block will execute the required login/logout
command.
37 JavaScript
The JavaScript code attached at the OnDataUpdate Action
var Username;
var Password;
var Login_CMD;
function _JSFunctBlock_onDataUpdate(me, eventInfo)

{
Username = "";
Password = "";
Login_CMD = "";

project.getTag("TAG_USERNAME", state, 0, "plc_Login(tagName, tagState)");
project.getTag("TAG_PASSWORD", state, 0, "plc_Login(tagName, tagState)");
project.getTag("TAG_LOGIN", state, 0, "plc_Login(tagName, tagState)");
return false;
}
function plc_Login(tagName, tagState)

{
if (tagName=="TAG_USERNAME") {
Username = tagState.getValue();
}
if (tagName=="TAG_PASSWORD") {
Password = tagState.getValue();
}
if (tagName=="TAG_LOGIN") {
Login_CMD = tagState.getValue();
}
if (Username!="" && Password!="" && Login_CMD!=""){

if (Login_CMD==1) {
Reply = project.login(Username, Password);
};
if (Login_CMD==2) {
Reply = project.logout(false); // Logout only if not logged as default
user
};
project.setTag("TAG_LOGIN", 0);
project.setTag("TAG_REPLY", parseInt(Reply));
}
}
See also:
l "login" on page 455
Limitations in working with widgets in JavaScript

Widgets cannot be instantiated by JavaScript, they can only be accessed and changed. If you need additional widgets on
the page, you can add hidden widgets on the page, and then display or position them using JavaScript.
Debugging of JavaScript
PB610 Panel Builder 600 and HMI Runtime include a JavaScript debugger.
Two types of debuggers are available:
l Runtime debugger: a debugger running directly on the HMI device

l Remote debugger: a debugger running on a remote computer connected to the HMI device via Ethernet (usually
computer running PB610 Panel Builder 600)
Enabling debugging
In the Properties pane of a page, set JavaScript Debug to true.
For schedulers and alarms debugging, enable JavaScript Debug in Project properties.
In the HMI Runtime, when the events are called, the debugger will show the debug information. In the Locals pane you can
inspect all variables and elements.
For a complete reference guide about JavaScript Debugger refer to :
http://qt-project.org/doc/qt-4.8/qtscriptdebugger-manual.html
37 JavaScript
Remote JavaScript Debugger

Path: Run> Start JS Remote Debugger
1. Set the Allow JavaScript Remote and the JavaScript Debug parameters in the project Properties to true in all the
pages where debugging is required.
2. Download the project: the following message is displayed on the runtime.
3. In the JS Debugger window, select the IP of the HMI device and click Attach to connect the debugger to the HMI
device.
Remote JavaScript debugger connects to HMI Runtime using port 5100/TCP.
Note: The Remote JavaScript debugger tool is not supported in HMI Client.
JavaScript Memory Usage

When the memory exceeds the maximum, an out of memory exception is thrown with a custom message. Please note that
we do not have a fine control over the actual memory usage so it is mainly a soft limit. Moreover we can't forbid the
allocation (this will break the engine implementation), so exception is thrown only when the memory is already over the
limit. Before raising the exception, a garbage collection is forced to see if some memory can be freed.
JavaScrip memory limit can be accessed from the global object $EngineMemory. The default is 16MB, which should be
enough for the typical JavaScript usage (mainly control, without many allocations).
l $EngineMemory.setLimit()
set maximum memory allowed for JavaScript (the default limit is 0x00FFFFFF)
l $EngineMemory.getLimit()
get maximum memory allowed for JavaScript
l $EngineMemory.getSize()
get currently used memory from JS (fastMallocStat)
Test memory exception
To generate and test memory exception you can use the following snipped. Please note that we need to reset the memory
limit to 0xffffffff to be able to run the alert, otherwise the memory allocations required to pop up the alert would fail.
38 Handling Gestures
Some widgets have the capability to detect and manage pan and pinch gestures.
l Trends (see "Trend widget gestures" on page 232 for details)

l Alarms Widget
l Combo box Widget
l Table Widget
l PDF Viewer
l Gesture Area Widget. Special widget designed to customize handling of gesture events (see "Gesture area widget"
on page 374 for details)
For widgets based on table presentation, when the Scrollbars Type parameter has been set to "Gesture", the pan gesture
is used to smoothly scroll the table.
l Alarms
l Control List
WARNING: Pinch and Rotate gesture requires two fingers. Them are available only with HMI devices
supporting multi touch operation (see "HMI devices capabilities" on page 499)
Tip:Using multi touch HMI device you can implement safe commands by programming a command to be
executed only when two buttons are pressed at the same time.
39 Web access
PB4Web allows users to access HMI projects from a remote web browser running on a computer or on a mobile device
such as a tablet or a phone. With PB4Web, users can create a web project to display at a remote location the same
graphical display shown on the HMI device. PB4Web projects are based on HTML5 technology which means that no plug-
ins or external software is needed for displaying the information.
This document assumes that you have a basic understanding of how to operate the web browser on your mobile devices as
well as how to set up a connection to the HMI device where the server is running. For example, you must know how to set-
up Wi-Fi access if you are working with tablet or phone devices to access the PB4Web pages on the HMI device.
Supported platforms and browsers 474
Generating page for Web access 474
Platform specific Home pages 476
Testing the Web project 476
Downloading the Web project 477
Web connectivity issues 478
Web supported features 479
Troubleshooting and FAQ 483
Privacy 483
Supported platforms and browsers
Supported platforms and browsers

PB4Web supports 3 platforms:
l web, for desktop browsers,

l phone, for smart phone devices
l tablet, for tablet devices
You can therefore create pages of different content and size for the different platforms. For example, you may want to
create a set of smaller pages in your project for phones whereas you will use full size pages for desktop web browsers and
tablets.
Working with a computer

PB4Web works with all modern web browsers. The following browsers have been tested for compatibility with PB4Web:
l Mozilla Firefox 50+

l Microsoft Internet Explorer 11+
l Apple Safari 10+
l Google Chrome 52+
Working with tablets or phones

PB4Web works with most tablet and phone devices. The following tablets have been tested for compatibility with
PB4Web:
l iOS 10+ - Mobile Safari

l Android 7+ - Chrome for Android 55+
Generating page for Web access

Path: ProjectView> Web> Pages
Right-click the Pages node and select Insert Page to add a web page.
39 Web access
Any widgets and features can be used in PB610 Panel Builder 600; however, not all features are currently available in
PB4Web. If the project includes a feature that is not available, PB4Web will still work correctly but the feature will not be
available on the remote client device.
See "Web supported features" on page 479 for a list of the features supported in PB4Web and of the existing limitations.
Web page properties

In addition of the standard page's properties, there is an addition property
Fit to Screen Size How the page will adapted to the browser's viewport
l None
l Fit to Screen
Simple modify the zoom level to adapted the page to viewport of the browser
l Responsive Design
Smart modify the zoom level to adapted the page to viewport of the browser
respecting the restrictions defined inside the grid layout
Exporting pages
To select pages to export from the current project.
Platform specific Home pages
1. On the Run menu, click Web Project Settings: the Web Project Settings dialog is displayed.
2. Select the web pages you wish to export. By default all project and dialog pages are selected.
3. For each platform, select the home icon next to the page you want to define as the Home page. Only one Home
page can be selected for each platform. All other home icons are grayed.
WARNING: When you download a project to the HMI device, make sure the Download Web
Project option is selected.
Platform specific Home pages

The Home Page of the PB4Web project defines the first page that is shown in the browser of each platform type and
defines the starting point for your web project. Pages that can be accessed from home page depend on the how other pages
are linked in the project.
For example, if you have designed a set of pages for a phone platform, set as a Home Page a page appropriately sized for a
mobile phone display. Then include in this page only links to other phone pages: the user will only access phone pages
when browsing the PB4Web project from a phone.
Testing the Web project

You can test your PB4Web project using the online simulator opening a standalone web page directly from a browser.
Testing with the online simulator

PB610 Panel Builder 600 includes an web server in the online simulator. You can start the simulator and access your
PB4Web project from a web browser. The pages will be served from the simulator.
39 Web access
1. Create your project (see "Generating page for Web access" on page 474).
2. On the Run file, choose Start Simulator: the project will start running in a separate window.
3. Open a web browser (see "Supported platforms and browsers " on page 474 for a list of browser compatible with
PB4Web).
4. Enter the following address: http://localhost:81: this tells the web browser to read the web pages from the local
computer and use port 81, used by default by the online simulator in PB4Web.
5. Test your project in the browser.
Important: If you make any changes to the project pages in PB610 Panel Builder 600 you must stop
and restart the simulator.
Note: If you are using a device (for example, a smartphone) that is not the localhost where the simulator is
running, you will be required to enter username and password.
Downloading the Web project

After testing the PB4Web pages, you can download the project to the desired HMI device.
The PB4Web project is downloaded together with the PB610 Panel Builder 600 project, see "Download to HMI device" on
After the download process is completed, the HMI project automatically starts on the HMI device and the PB4Web project
is ready to be used.
Running PB4Web from a browser

1. Open a web browser and enter the IP adress of your HMI device: the login page is displayed.
Web connectivity issues
2. Enter User Name and Password and click Sign In: the Home page will be displayed.
See "User management and passwords" on page 281 for details on how to create credentials.
You can interact with the project using the browser in the same way you interact with a device when touching the screen:
click buttons to change pages, view indicators and gauges, drag slider handles to change values, and so on. The PB4Web
project will manage all communications with the web server while you are interacting with the HMI device remotely.
Web connectivity issues

Here are described the most common issues you might encounter when connecting remotely to your HMI device.
Server disconnection
Since PB4Web runs remotely from the HMI device, the server might disconnect from the browser (for example if the server
is stopped or the network cable is unplugged). If this happens, a ‘disconnect’ icon will appear in a toolbar on top of the
PB4Web as in this example.
39 Web access
Once the server is back online, the red circle-bar icon will disappear indicating normal communications with the device.
The “Connection status” system variable can be used to know the status of the connection. See "Remote Client
variables" on page 104 for additional details.
Note: If you make changes in the PB4Web pages while the server is disconnected, these changes will be visible
on the client but will not be transferred to the server until the connection is restored.
Inactivity timeout
PB4Web will require you to re-enter your login credentials if the browser has been inactive for several minutes. If no activity
is detected for 10 minutes, the login screen will reappear and you need to enter your login credentials to continue operation.
A timeout feature guarantees that no unauthorized access is possible.The web inactivity timeout can be modified from the
Project Properties table.
User session termination

A user session can be terminated either from the server or from the user.
In specific conditions the server might send a request to the client (browser) to perform the login process. In this case the
user is redirected to the login page and then back to the page where he was working. This will happen for example if the
user clears the browser cache or browser cookies.
Note: If the user is working in a dialog when redirected to the login page, he will be then redirected to the page
from which the dialog was opened.
Non-Active PB4Web Project

The PB4Web page displayed in your browser might come from a project that is no longer active in the device. In this case a
confirmation box is displayed and you can return to the active project.
Note: This redirection assumes that the current active project has PB4Web pages in it.
If you choose to stay in the non-active project all the actions you perform in the browser may not be executed properly as
the PB4Web cannot perform any server-bound communication.
Web supported features

Currently not all PB610 Panel Builder 600 features are supported in PB4Web. Here a list of features supported and
limitations, classified by category.
When you copy and paste objects from standard pages to a web pages, make sure that all objects are
supported in web pages. Eventually remove unsupported objects from the web page after paste.
Category Supported features Limitations
Widgets l Basic (Text/Numeric, Images, Shapes, Trends/Graphs, Recipes, l AttachToTag of

Controls, Alarms, Texture, JSFunctionBlock, Generic Canvas e Grid system variables
Layout) is not supported
l Buttons l Font files without
l Meters web download
permissions flag
l Switches
enabled are not
l Lights loaded from the
l Media (IP Camera) PB4Web
l Icons l Widget properties
with Attach to…
l Factory Automation
dynamic behavior
may not work for
all properties
supported by
PB610 Panel
Builder 600.
l Multistate Image
Multi-Layer is not
supported.
l Alarm Color based
on trigger condition
is not supported in
Web
l Can not edit the
Alarm widgets in
runtime
l The ComboBox
View Mode in full
screen is not
supported
l BACnet widgets
are not supported
Alarms l Alarms limits in PB4Web is the same of HMI device (500..2000 l On

based on target) Smartphone/Tablet
(in general
embedded
devices) based on
HW a user could
expect
performance
problems with >
500 alarms.
39 Web access
Actions l Widgets (JavaScript) l JavaScript is

l Page (HomePage, LoadPage, NextPage, PrevPage, supported (see
LastVisitedPage, ShowDialog, CloseDialog, ShowMessage, "JavaScript " on
LaunchBrowser) page 427
JavaScript chapter
l Multilanguage (SetLanguage)
for a list of
l Tag (WriteTag, StepTag, SetBit, ResetBit, ToggleBit) supported
l Trend/Graph (RefreshTrend, ScrollLeftTrend, ScrollRightTRend, features)
PageLeftTrend, PageRightTrend, ScrollUpTrend, ScrollDownTrend,
l Page actions are
PageUpTrend, PageDownTrend, PageDurationTrend, ZoomInTrend,
not supported in
ZoomOutTrend, ZoomResetTrend, ZoomInAxisTrend,
alarm trigger
ZoomOutAxisTrend, ZoomResetXAxisTrend, PauseTrend,
condition
ResumeTrend, ShowTrendCursor, ScrollTrendCursor,
ScrollTrendToTime, setTrendView) l The page's
l Alarm (ResetAlarm, AckAlarm, SelectAllAlarms, EnableAlarms) OnWheel event is
not supported
l System (DumpTrend, DeleteTrend, DeleteEventArchive)
l Recipes (DownLoadRecipe, UpLoadRecipe,
WriteCurrentRecipeSet, DownLoadCurRecipe, UpLoadCurRecipe,
ResetRecipe, DumpRecipeData, RestoreRecipeData,
AddRecipeDataSet, DelRecipeDataSet)
l User Management (LogOut e ChangePassword)
XForms l Formula
l Scaling
l Bit/Byte Index
l ColorPalette
Keypads l Only numeric keypads widgets are supported. l Custom keypads

are not supported.
The numeric
keyboard will be
displayed as
numeric widgets
with a read/write or
write mode.
Dialog Page l Supported, you can show them and close them based on the l Dialog pages
ShowDialog and CloseDialog actions. support only modal
dialogs.
User l The login mechanism verifies user credentials on the server. The
Management user name and password are based on the user credentials defined in
"User management and passwords" on page 281.
Concurrent l The web server in the HMI device supports three concurrent l If more than 3
User connections at a time. connections are
Connections attempted from
remote browsers,
only the first 3
connections will be
permitted.
Secure Socket Layer (HTTPS)

Linux devices support the Transfer Protocol over Secure Socket Layer (HTTPS). To use this protocol access at the web
page using the below syntax:
https://<device_ip_address>
Note that since the self-certificate provided from the HMI device is not firmed from a known Authority, you will get a
warning message.
Simple click the ADVANCE button to continue.
Working with keypads in PB4Web

The user can click on the Numeric widget and a text box will be displayed in which the new value can be inserted.
After inserting the value the user can either press Enter, or equivalent in touch devices, or click Save to make the newly
inserted value permanent. Only meaningful numbers will be accepted during the save process. Anything else will be
ignored and will not result in a value change.
39 Web access
Troubleshooting and FAQ

Enable JavaScript
PB4Web requires JavaScript to provide interactivity with the server and the user. PB4Web will not work if JavaScript is
disabled in your browser.
By default most browsers come with JavaScript enabled. But if you have disabled JavaScript in the past, please re-enable
JavaScript before accessing PB4Web pages.
Browser cache
PB4Web includes resources that change infrequently such as CSS files, image files and JavaScript files. These resources
take time to download over the network which increases the time required to load the PB4Web page in your browser.
Browser caching allows these resources to be saved by a browser and used without requesting them each time from the
server. This results in faster loading of PB4Web pages.
Caching is normally enabled by default, for optimal PB4Web performance make sure it has not been disabled.
Note: PB4Web pages will still work properly with disabled browser caching, however resource loading time will
be slower compared with normal cached operations.
Using a proxy
Some users may be accessing the PB4Web project through a proxy. The proxies may control the number of parallel
connection for the browser.
Make sure that the maximum parallel connections allowed (max connections) is not more than 16 and not less than 12.
Why I'm not able to see changes in the web pages?

Every time a new web page is added edited into the project, you need to download the project to the device. However,
when you connect the device IP address, the web browser might display cached pages instead of the latest downloaded
pages. To avoid this behavior you can:
l disable cache of your web browser

l force web page refresh
l by-pass browser cache
Privacy
We do not use cookies to collect private information from any user.
Privacy
A cookie is a piece of data stored on the user’s hard drive containing information about the user. Usage of a cookie is in no
way linked to any personally identifiable information while on our device. Once the user closes their browser, the cookie
simply terminates.
40 Protecting access to HMI devices
The following operations are password protected on the HMI device:
l HMI Runtime management: install HMI Runtime and update HMI Runtime
l Board management: replace main BSP components such as Main OS, Configuration OS, Bootloader, and so on
l Download and upload of project files
l Optional services on Linux devices (e.g. SSH Protocol, VNC Server)
WARNING: Unauthorized access to the device can cause damage or malfunctions. When connecting
the device to a network protect the network against unauthorized access.
Measures for protecting the network include:
l Firewall
l Intrusion Prevention System (IPS)
l Network segmentation
l Virtual LAN (VLAN)
l Virtual Private Network (VPN)
l Security at physical access level (Port Security).
Further information, guidelines and standards regarding security in information technology: IEC 62443, ISO/IEC 27001.
Changing password on HMI device 486
Ports and firewalls 486
Changing password on HMI device
Changing password on HMI device

To change the password on the HMI device, use one of the following methods:
l From the HMI Runtime context menu: Settings> Password tab.
l Use the Set Target Password function in update package: the password is updated by HMI Runtime just after the
update process is completed.
l Using HMI device "System Settings" on page 503 Tool
Leave “Old password” empty as default if target password is not set.
For Windows HMI Runtime, password is saved into:

Users\[username]\AppData\Roaming\ABB\buildNumber\server\config\RemoteUpdateConfig.xml.
Ports and firewalls

Here a list of all the ports used by PB610 Panel Builder 600 components.
Remote Board Runtime/Project

Port Usage
Access Management Management
80/tcp HTTP port Yes - Yes
21/tcp FTP cmd port - - Yes
2100/tcp Board port - Yes -
16384- FTP data port (passive mode) - Yes Yes

17407/tcp
990/udp UDP broadcast (Device - Optional Optional

discovery)
40 Protecting access to HMI devices
Remote Board Runtime/Project

Port Usage
Access Management Management

discovery)

discovery)

discovery)
5900/tcp VNC Server VNC only - -
5100/tcp JS Remote Debugger - - Optional
Remote access
Remote access is required to connect to HMI Runtime using:
l HMI Client
l Internet Browser
Runtime and project management ports

You use these ports to connect to HMI Runtime for operations such as update, installation and project download.
Board management ports

You use these ports to connect to the HMI device for Board operations such as BSP update, splash image download and
so on.
Note: When broadcast service is not available, for example in VPN networks, type in the exact IP address to
connect to the HMI device from PB610 Panel Builder 600.
Ports and firewalls
41 Tips and tricks to improve
performance
PB610 Panel Builder 600 allows great flexibility for a project designers.
Follow these guidelines to create projects that perform better in terms of boot time, page change and animations.
Static Optimization 490
FAQ on Static Optimization 493
Page caching 494
Image DB 494
Precaching 494
FAQ on precaching 494
Static Optimization
Static Optimization
Static optimization is a technique used in PB610 Panel Builder 600 to improve runtime performance.
Using a lot of images and pictures in a project might degrade performances, static optimization merges several images into
a single background image thus reducing rendering and loading times. Using this method only one raster image needs to be
loaded and rendered instead of many single raster and/or vector images.
When you create a project in PB610 Panel Builder 600, the pages might contain widgets such as texts, images,
background images, background colors and so on which can be classified as:
l Static: values or properties do not change at runtime.

l Dynamic: values or properties change at runtime.
Note: Based on security settings, static parts of widgets could be not merged to background. This happens
when a widget is configured as “hide” in security settings.
Important: When you change the properties of widgets with JavaScript set the widget Static
Optimization to Dynamic, otherwise changes to properties will be ignored.
When downloading or validating a project, PB610 Panel Builder 600 identifies static components and renders them as
background images to .png files. These background images are saved as a part of the project under the folder /opt.
Background images can be created as follows:
l full page background images, containing all widgets merged to page background
l group background images, containing a group of static widgets merged together to form a group background. For
example, the Gauge group is normally composed by a background, a scale, a label and a needle, where background
scale and label can all be merged to a single background image.
The Static Optimization page attribute enables and disables static optimization of the whole page. If it is set to false the
optimization is totally disabled.
Finer control can be achieved setting the Static Optimization attribute of each single widget as follows:
l Normal: PB610 Panel Builder 600 automatically detects if the widget can be merged with the background. This can
be used if the widget is not a dynamic widget and does not overlap, that is it is not stacked above, a dynamic widget.
l Static: The image is forced to be merged with the background. This can be used when the static widget overlaps a
dynamic transparent widget.
Note: In this case the automatic optimization will fail because it does not make any assumption on invisible
areas which might be rendered at runtime.
l Dynamic: The widget is not optimized at all. Use this flag when a static widget needs to be changed by JavaScript.
41 Tips and tricks to improve performance
Tips for best performance

1. First of all: avoid placing static widgets over a dynamic widget. The overlapping area is computed considering the
bounding rectangles of the widgets, that is the rectangles delimited by editing handles.
2. Do not use static optimization if your pages contain almost only dynamic objects. Static optimization would save
many almost identical full size images for each page using up a lot of memory space that could be more effectively
used to improve project performance with other techniques (such as, for example, page caching).
3. Bounding rectangles can include transparent areas, minimize transparent areas (for example splitting the image in
multiple images) since they can be a waste of resources even when optimized.
4. Optimize image size. The image will be rendered at the size of the image widget containing the image. For best
performances the widget needs to be the same size of the image.
5. Avoid using Scale to fit for image widgets, since this forces a rescaling at runtime for dynamic images and “hides”
the actual image size during editing.
6. Use Size to fit to make the widget to the real size of his contents.
7. If overlapping cannot be avoided make sure to place the static widgets in the back, that is behind the dynamic
widget.
8. Choose the image file format based on the HMI device you are connecting to.
Static Optimization
9. Avoid using too many widgets in a single page. Often widgets are placed outside the visible area or their
transparency is controlled by a tag. Since widgets are loaded even if they are not visible, having too many widgets in
a page can significantly slow down the page change time.
10. Split a page with many widgets into multiple pages with less widgets.
11. For popping up new graphic elements in a page, prefer dialog pages with controlled positioning to transparent
widgets.
12. Check the opt folder to see if static optimization is working as expected, the widgets z-order might need to be
adjusted.
13. Numeric fields are often used to run JavaScript code on OnDataUpdate event even if the widget doesn’t need to be
visible on the page. In this case place the widget outside the page visible area instead of making it invisible, altering
font color or visibility property. In the latter case you might end up with many left over wedges.
14. Use a HotSpot button if you need a touch area to react to user inputs.
15. If you reuse a widget from the gallery or you create your own, remember to set the correct optimization properties.
For example button widgets are dynamic widgets, if you use a button widget just for its frame it won’t be optimized
since the button widget is dynamic. If you just need the frame you should use the Up image.
16. With many pages having many dynamic widgets and using a common template:
1. set template static optimization to true,
2. set page static optimization to false, since the background is already provided by the template.
In this scenario the background image can be reused by many different pages thus saving memory space.
17. Do not use dynamic widgets, such as buttons, only for graphic purposes, when the button function is not needed,
use image widgets instead to obtain the same graphical effect.
Here is an example of a correct and an incorrect use of static optimization.
Supported image formats

PB610 Panel Builder 600 supports several raster formats like BMP, PNG, JPEG, TIFF and the vector format SVG. Here a
list of pros and cons:
Image
Pros Cons
format
RASTER l Fast rendering l Big file size

l Well l Fixed resolution
standardized
VECTOR l Small file size l Complex SVG images with many graphic items and layers
(SVG) l Rescale without can be slow to render.
quality loss l Creating an optimized SVG is not simple.
l Can handle l Only Tiny 1.2 (http://www.w3.org/TR/SVGTiny12/)
dynamic supported.
properties
Note: Scour software is free tool that can be used to remove foreign code from file
(http://www.codedread.com/scour/).
Static optimization of templates

Template pages can have large amounts of static content. However, static optimization cannot be applied to a template
page, since where the template is used is based on the page design.
If a huge background image should be repeated in every page that uses the same template, this would increase the
footprint of the device as the same static image would be created for each of the pages using the template page.
FAQ on Static Optimization

Q: In a page where there are a few identical widgets, in the opt folder I see a PNG for each one of
them. If they are really identical, why should the software duplicate them instead of having just one
PNG?
A: The software does not know if static images are actually the same since each widget could have different
settings/properties altering the actual rendering at runtime.
Q: Why are the static images stored in a separate folder called opt instead of storing them directly
in the project folder?
A: This avoids name collisions and allows skipping the upload of optimization images
Q: Why are the static images stored as a PNG files instead of common JPEG files?
A: PNG format uses a lossless compression for images and supports transparencies. JPEG files would render fuzzier
compared to the PNG files with a different result in PB610 Panel Builder 600(not using optimization) and HMI Runtime.
Q: What will happen when no optimization is done in the software?

A: Every single widget is rendered at runtime. In particular SVG images may require a lot of time to render in an embedded
platform.
Page caching
Page caching
Once accessed all pages are kept in a RAM cache up to the maximum allowed cache size depending on the actual
platform’s available RAM. This allows a much faster access since cached pages, once reloaded, only need to re-paint their
content without reloading all page resources.
Image DB
Image DB is a technique used to track the usage of image files and reduce the cost of image loading by caching most
frequently used images (example, Push Button images, Gauge needles, Slider thumbs and so on). The same image used in
many different places is therefore loaded just once.
The image DB function will preload the top most used images at startup until memory limit is reached. This would further
improve the individual page loading times.
The file imagecachelist.xml is created in project/opt folder, containing relevant information:
l Fill color (in case of SVG images)

l Size of SVG image
l Number of times an image is used in the project
l Number of different sizes for the same image
Tips for using the Image DB function

1. Use uniform size of buttons, gauges and other widgets wherever possible.
2. Use same color themes among widgets of the same kind.
Precaching
The Precache attribute of pages can be used to notify HMI Runtime to preload some pages in RAM at boot time for quicker
access. Precaching is useful for complex pages having many dynamic widgets.
When this function is enabled on a page, access to the page is faster, however it also slows down boot-time since the
system is not ready until all pages to be precached are not saved into the RAM.
Tips to precaching
1. Enable the precache function just for few pages having many dynamic widgets or for pages frequently used by
users.
2. Do not enable the precache function for all the pages in the project since you would run out of memory and have no
benefit at all.
3. Disable static optimization for pages where the precache function is enabled to reduce memory used.
FAQ on precaching
Page limit for precaching
Based on the size and complexity of a page, the space required for precaching can be from 1,5Mb to 3Mb.
When a project is loaded, HMI Runtime proceeds as follows:
1. Page images are preloaded until 76 MB of memory space is still available (imageDBLowMem)
2. Pages where precache is set to true are preloaded untill 64 MB of memory space is still available
(pageCacheLowMemMax). The images of these pages are loaded in the RAM (into the Image DB).
When the project is ready:
1. Any new page visited is saved in the cache (RAM) with all related images until 40 MB of memory space is still
available(pageCacheLowMemMin)
2. When a page change happens and space in RAM is critical (<40MB), the HMI Runtime starts emptying the cache
(RAM) removing pages and related images until 64 MB of memory space is made available. HMI Runtime removes
data stored in the cache in the following order:
1. last visited pages and bigger and unused images (>320x240),
2. if more memory is needed also the pages in precache and all images loaded in Image DB can be removed.
FAQ on precaching
42 Functional specifications and
compatibility
Here is an overview of the supported functions and related limitations. Limitations indicated here represent a safe limitation,
beyond that proper operation and state-of-the-art performance of the system is not guaranteed.
Table of functions and limits 498
HMI devices capabilities 499
Compatibility 500
Converting projects between different HMI devices 500
Table of functions and limits
Table of functions and limits

Function Max limit
Number of pages 1.000
Number of basic widgets 2.000 x page
Number of tags 10.000
Number of dialog pages 50
Number of dialog pages that can be open at the same 5

time
Number of Recipes 32
Number of parameter sets for a recipe 1.000
Number of elements per Recipe 1.000
Number of user groups 50
Number of users 50
Number of concurrent remote clients 4
Number of schedulers 30
Number of alarms 2.000 (See "HMI devices capabilities" on the facing page)
Number of data transfers 1000
Number of templates pages 50
Number of actions programmable per button state 32
Number of Trend Buffers 30
Number of curves per trend widget 5
Number of curves per scatter diagram widget 10
Number of samples per trend buffer 200.000
Number of tags per trend buffer 200
Number of trend buffer samples for a project 1.200.000 (See "HMI devices capabilities" on the facing
page)
Number of messages in a message field 1024
Number of languages 12
Number of events per buffer 2.048
Number of event buffers 4
42 Functional specifications and compatibility
Function Max limit
JavaScript file size per page 16 KB
Size of project on disk 60 MB (See "HMI devices capabilities" below)
Number of indexed instances 100
Number of indexed alias 100
Number of indexed tag sets 30
Number of physical protocols 4
Number of reports 32
Number of reports pages 32
Max number of variables in variables widget 255
User folder size (UpdatePackage.zip) 5 MB
Number of concurrent FTP sessions 4
FTP additional folders 5
HMI devices capabilities

See "Table of functions and limits" on the previous page for the standard capabilities.
Features not available in Linux devices:
l LaunchBrowser macro
l Printer devices are not supported. Reports can be printed only on PDF files. Print of text reports and alarm events
are not supported.
Features not available in PB610 PC Runtime:
Compatibility
l VNC and PDF Readers plug-in

l Manage Target
l System Settings Tool
l Backup/Restore
l Serial protocols that requires special hardware
l Multi touch features will be available if supported from the hardware and the operative system of the PC
Compatibility
The following compatibility policy has been adopted:
l PB610 Panel Builder 600 version must always be aligned with HMI Runtime on the device,
l the user is responsible for updating HMI Runtime components on the HMI device at any PB610 Panel Builder 600
update,
l the HMI Runtime update can be done directly from PB610 Panel Builder 600 using the Update Target command
available in the Run\Manage Target dialog,
l projects created in a PB610 Panel Builder 600 version no older than V1.00 (00) can be opened and handled by any
newer version,
l projects created with older versions of PB610 Panel Builder 600, opened with later versions and deployed to
compatible HMI Runtime, are ensured to maintain the performance and functionality,
l compatibility between newer versions of HMI Runtime and projects created and deployed with older versions of
PB610 Panel Builder 600 is not ensured.
Important: Do not edit projects with a version of PB610 Panel Builder 600 older than the one used to
create them. It can result in a damage of the project and to HMI Runtime instability.
Converting projects between different HMI devices

Project conversion from different HMI device models is supported, however, some manual operations may be required if
the project uses features not supported in the destination device.
Guideline
Before converting a project have a look if some unsupported features are present (see "HMI devices capabilities" on the
previous page), and adjust your project by removing the unsupported features before converting the project.
In particular:
l Verify limitations and features not supported by the new HMI device (see "Table of functions and limits" on page 498
for details).
l Remove unsupported widgets, actions, system variables, protocols, project properties.
l If the project uses external storage, verify if the same storage path is still available.
l Adjust OS-specific external applications or paths.
l If necessary, reduce project size according to the new HMI device type limitations (see "Limitations" for details).
l Since HMI devices are based on different hardware platforms with different CPU speed, RAM memory size, cache
size, make sure to check project boot time and page loading time for each page in the project.
l Verify JavaScript code for OS-specific operations.
42 Functional specifications and compatibility
OS-specific features
Linux is case sensitive while Windows CE is not. Consequently, projects on Linux HMI devices might have different files
named based on upper and lower case, e.g. 'dump1.csv' and 'Dump1.csv' are not possible on Windows CE HMI devices.
Converting projects between different HMI devices
43 System Settings
System Settings is an internal tool of the HMI device that can be used for the basic device settings or for the system
components update.
Note: the system components can be update even from the PB610 Panel Builder 600 (see "Updating system
components in HMI devices" on page 535 for details)
CAUTION: Working with the System Settings tool is a critical operation and, when not performed
correctly, may cause product damages requiring service of the product. Contact technical support for
assistance.
Linux Devices 504
WinCE Devices 524
Linux Devices
Linux Devices
CP600-eCo products offer a powerful integrated tool called System Settings that allows management and upgrade of
system components. Operations can be done directly on HMI or remotely using web browser.
Runtime Installation
HMI devices are delivered from factory without Runtime, at first power up HMI shows the “Runtime Loader” screen.
Runtime can be installed:
l Automatically, via Ethernet on first project download with PB610 Panel Builder 600
l Manually via USB Memory, creating an “Update Package”. (See the "Update package" on page 91 to create a
runtime package)
Install Runtime via Ethernet

To install Runtime via Ethernet follow the "Download to HMI device" on page 88 procedure.
WARNING: Runtime installation via Ethernet download requires the HMI to have a valid IP address.
The IP address can be assigned in three ways:
l Automatically via DHCP server. This option is enabled by default. If a DHCP server is available on the network IP
address will be assigned automatically by the server.
l Automatically via Auto-IP feature. If DHCP assignment is enabled but no DHCP server is available on the network
the HMI assigns itself an IP Address into range 169.254.x.x with subnet mask 255.255.0.0
l Manually via System Settings. From System Settings menu, in Network section the IP address can be manually
assigned, disabling the DHCP server assignment feature.
Install Runtime via USB Memory

To install Runtime, UpdatePackage or Backup Package via USB device follow this procedure:
1. Create an Update Package from PB610 Panel Builder 600 and copy into an empty USB memory stick
43 System Settings
Note: File systems supported are FAT16/32 and Linux Ext2, Ext3 and Ext4.
2. On HMI select [Startup sequence], then [Install]
3. Double click on “mnt” to access this folder
4. Then on “usbmemory”
Linux Devices
5. Select “UpdatePackage.zip” and confirm with [Ok]
6. The runtime installation begin
7. At the end press "Done" button
43 System Settings
8. Then "Start HMI" button
System Settings
The user interface of System Settings is based on HTML pages and can be accessed both locally on the HMI device
screen and remotely using a Web browser.
Administrator username with full access right is "admin" with default password "admin". Generic username is “user” with
default password “user”
WARNING: For security reasons, change the default passwords for both usernames (passwords can
be modified from the “System Settings -> Authentication” command)
Accessing at the system settings from the HMI device do not require to enter a password until the default
"admin" password is not changed.
System Setting access from Web browser
To access System Settings using a Web browser, enter the IP address of the device, in the following format:
https://IP/machine_config
Linux Devices
Note the remote access use encrypted https protocol on port 443. When the connection is established, the HMI
device send a certificate to use for the encryption. Since the certificate is not signed from a Certificate Authority
you will get a warning message. Please, click on advanced options and choice to proceeding.
Browse through the options available in the menu on the left: the active item is highlighted and related information is
displayed on the right.
Default security protocols proposed by the HTTPS server in the CP600-eCo HMI device are:
l SSLv3 256 bits ECDHE-RSA-AES256-SHA

l TLSv1 256 bits ECDHE-RSA-AES256-SHA
WARNING: We discourage usage of CBC cyber suites in the context of SSL3 or TLSv1.0 connections
since potentially affected by some vulnerabilities.
System Setting access from HMI device
When Runtime is not installed, the System Settings is accessible from the Runtime Loader screen,
43 System Settings
When Runtime is installed the System Settings is accessible selecting “Show System Settings” option of Context Menu,
Enter System Settings via tap-tap procedure
Tap-tap consists in a sequence of several touch activations by simple means of the finger tapping the touch screen
performed during the power-up phase and started immediately after the HMI is powered on.
Linux Devices
When “tap-tap detected” message appears on the top of the screen. Wait for 5 seconds (without touching the screen) to
enter System Settings sub menu
Wait for 5 more seconds (without touching the screen) to enter Default Mode
Select "System Setting" from the HMI Default Mode screen
43 System Settings
System Settings Sections
To change system settings values, enter in edit mode by click the edit button on the right top.
The edit button is available only inside the dialogs that contains modifiable parameters.
Languages
Select the language for the system settings interface
l System keyboard layout: select the layout of the virtual keyboard
System
Info Device information
Status Device status (Free RAM, Up time, CPU Load)
Timers Device timers (System on, Back light on)
PlugIn Hardware plugins information
Logs
Set the persistent log option if you want maintain the log files saved after a power reset.
Use save button to export a copy of the log files.
The log files manager cyclically fill 3 files of 4Mb
Date & Time

Device date and time.
Linux Devices
Current Timezone Timezone region
Current Date Date and Time can set manually only when the Automatic Update is disabled.
Local Time
Automatic Update (NTP) Enable to keep date and time synchronized from a remote server
l NTP Server
Specify the Internet NTP Server address
The NTP Client of the HMI Device is a complete implementation of

the Network Time Protocol (NTP) version 4, but also retains
compatibility with version 3, as defined by RFC-1305, and version 1
and 2, as defined by RFC-1059 and RFC-1119, respectively
Networks
Network parameters. Available parameter in edit mode:
General Settings Device hostname
Avahi Hostname (see "Avahi Daemon" below)
Network Interface Network parameters of the available interfaces
l DHCP
l IP Address
l Net Mask
l Gateway
DNS DNS Servers

Generally provided from the DHCP servers, but can be modified in edit mode
Search Domains
Optional domains that will be used in concatenation with the provided urls
Services
Services are available only when logged as admin.
Mouse click on the enable button to enable/disable the service. Click the service name to list the associate parameters.
Avahi Daemon
Avahi is a system which enables programs to publish and discover services and hosts running on a local network. When it
is enabled, the HMI device can be reached even using the device's host name (in alternative to the IP Address).
43 System Settings
Avahi Daemon runs on UDP port 5353
On Linux and Apple PCs, the Avahi service comes for free with the OS. On Windows PCs instead, you need to
install an Avahi service to be able to reach the panel by his Avahi host name (e.g. you need to install the Apple
Bonjour application - Bonjour is a trademark of Apple inc.).
Bridge Service
Using the bridge service is possible connect together the WAN (eth0) network adapter with the LAN (eth1 or eth2) network
adapters. When used, the two Ethernet adapters are bridged and both Ethernet adapters are sharing the same IP address.
Bridge Service creates a Linux-based layer-2 Network Bridge between two or more network interfaces. If both WAN and
endpoint devices are attached to such bridge, the two networks will be physically joined and endpoints will be available as if
they were directly connected to the WAN
Fast Boot
When fast boot is enabled, at the power up the HMI device will start the HMI application as fast as possible. In this mode,
there are not showed diagnostic information (e.g. the loading bar) but only the minimum necessary features are loaded
before loading the User Interface (e.g. System Settings, VNC, SSH, etc. will be load after loading the HMI application).
To obtain best performance, in addition of enabling the fast boot mode, it is recommended to:
Linux Devices
l disable any service that is not necessary

l avoid keeping enabled the persistent log
l use static IP address instead of DHCP service
Required BSP v1.0.242 or greater
Router Service
This service uses the IP Forwarding and the Network Address Translation to sharing the connections from WAN (eth0)
towards LAN (eth1 or eth2): the connected endpoints may reach the same networks reachable by the gateway (including
Internet if available)
SNMP Server
SNMP is a network protocol that allow to manage network infrastructures. It is commonly used to monitor network devices
as switches, routers, etc. connected to a LAN network.
When the SNMP service is enabled, an SNMP Manager can retrieve information from the HMI device using the SNMP
protocol. Currently, there are not proprietary MIBs available. Only the standard public community MIBs are available in read
only mode.
43 System Settings
Example:
System Name: .1.3.6.1.2.1.1.5.0

System Description: .1.3.6.1.2.1.1.1.0
System UpTime: .1.3.6.1.2.1.1.3.0
Total RAM used: .1.3.6.1.4.1.2021.4.6.0
Total RAM Free: .1.3.6.1.4.1.2021.4.11.0
Idle CPU time (%): .1.3.6.1.4.1.2021.11.11.0
SNMP Server runs on UDP port 161
This service is designed to be used during the development phase. For security reasons, remember to
disable the service before switch to production.
SSH Server
SSH service has been designed only for advanced users. It provides remote login to HMI device using the secure shell
protocol. On PC you can run a SSH Client as, for example, PuTTY that is an open source software distributed under the
MIT license.
The default password for the username the admin is “admin”. See the "Authentication" on the next page chapter
to additional information.
SSH Server runs on TCP port 22
This service is designed to be used during the development phase. For security reasons, remember to
disable the service before switch to production.
VNC Service
VNC is a service that allows remote access to the display of the HMI device. VNC clients can be used to get the remote
control of the HMI device.
Linux Devices
l Port: VNC Server listens for connections on TCP port 5900 (default)
l Multiple clients: allow multiple sessions on the same port (if disabled, previously logged clients are disconnected
upon a new incoming connection)
l View only: do not allow active user interactions (clients can only watch)
l Encryption: activate SSL encryption of connections (not widely supported - check client compatibility)
l Authentication: whether users are authenticated upon session creation. A custom VNC specific password can be
set or system passwords can be used (this option is only available if also Encryption is enabled)
Plugins
This page will show the parameters available to configure the optional plugins modules attached to the HMI device. See the
description of the each plug-in module to additional information.
Management
Management is available only when logged as admin.
From the management area is possible "Update System Components" on the facing page of the HMI device.
CAUTION: Working in the Management area is a critical operation and, when not performed correctly,
may cause product damages requiring service of the product. Contact technical support for
assistance.
Use the “Clear” command inside the “Data” section to remove HMI Runtime from the device (Factory Restore)
Display
Brightness Brightness level of the display
Back light timeout Backlight inactivity timeout
Orientation Display orientation
Restart
HMI device restart command
Authentication
Enter in edit mode to change the authentication passwords.
Administrator username with full access right is "admin" with default password "admin". Generic username is “user” with
default password “user”
WARNING: For security reasons, change the default passwords for both usernames
43 System Settings
x.509 Certificate
HMI Device use a self-certificate to encrypt the Internet communication trough the HTTPS protocol. You can personalize
the certificate with the data of your Company and ask to a Certificate Authority to firm it.
The procedure to personalize and firm your certificate is:
1. Enter in edit mode and fill the necessary parameters, then push GENERATE button to generate a self-signed
certificate with your data.
2. Export the “Certificate Signed Request”
3. Sent the “Certificate Signed Request” to a Certificate Authority to firm it (general this is a paid service)
4. Import the signed certificate into the HMI device
Certificate's parameters
Device Name The name of your device
Organization The legal name of your organization
Unit The division of your organization handling the certificate
State The state/region where your organization is located
Location The city where your organization is located
Country The two-letter ISO code for the country where your organization is location
Valid (days) Validity of the certificate
Key Length Number of bits of the key used from the cryptographic algorithm
Managed certificates are base64 encoding
Required BSP v1.0.239 or greater
EXIT
Exit from the System Setting tool.
Update System Components

CAUTION: Working in the Management area is a critical operation and, when not performed correctly,
may cause product damages requiring service of the product. Contact technical support for assistance
(the latest BSP files will provided from tech support).
The system components of the CP600-eCo device can update locally using an USB memory key or remotely via web
browser.
To update system components enter System Settings in Config OS mode via tap-tap procedure on HMI or open web
browser to https://<HMI-IP-address> and select the “Management” section.
Linux Devices
Expand the component to update and select [Update]
On the opened dialog, click [Browse Image], then select the “xxx-mainos-xxx.tar.gz” file. Click then on [Browse MD5] and
select the “xxx-mainos-xxx.tar.gz.md5” file.
Important: Do not turn off the device while a system component is being upgraded.
At the end of the component update, restart HMI and leave it starting normally.
Enter System Settings in Config OS mode via tap-tap procedure

System Setting in Config OS mode is available via tap-tap sequence, this mode can be accessed also when HMI is facing
a software failure.
Tap-tap consist in a sequence of several touch activations by simple means of the finger tapping the touch screen
43 System Settings
When “tap-tap detected” message appears on the top of the screen, press and hold the finger on touchscreen, to select
“Restart: Config OS”
HMI will restart into System Settings in Config OS mode:
Touchscreen calibration
System Setting Calibration allows to calibrate Touchscreen device, can be accessed by tap-tap procedure.
Linux Devices
When “tap-tap detected” message appears on the top of the screen, wait for 5 seconds (without touching the screen) to
Press on touch screen, “Touchscreen calibration” voice will be highlighted in yellow, hold pressed for few seconds until
touchscreen calibration procedure starts
43 System Settings
Follow the instructions on screen to complete the calibration procedure, system will prompt to touch specific points to
calibrate the touchscreen device.
Password protection
Internal password of the HMI device.
From the Authentication tab, inside the "System Settings" on page 507, activate the edit mode and select the username to
change the associated password.
Password for admin user can modified even from the context menu of theHMI Runtime (see "Context menu
options" on page 8 for details).
Factory restore
System Settings in Default mode allows to uninstall HMI Runtime or change Startup sequence, this mode is available via
tap-tap sequence and can be accessed also when HMI is facing a software failure.
When “tap-tap detected” message appears on the top of the screen. Wait for 5 seconds (without touching the screen) to
Linux Devices
Wait for 5 more seconds (without touching the screen) to enter Default Mode
To uninstall the Runtime from HMI in Default Mode screen select [Startup Sequence]:
From the installed applications view:
1. Select the Runtime you want to remove

2. Uninstall the selected Runtime
43 System Settings
Runtime uninstall process will be performed:
At the end press "Done" button
Configuration mode
WinCE Devices
In the case that it is not even possible to boot the device, there is a special procedure to recovery the device by booting it in
a special mode called configuration mode. From this mode you can open the device management dialog from where you
can delete user data, restore system setting or update the firmware of the device.
To boot the device in configuration mode choice one of the below procedures
l Power on the device and immediately power off when splash screen appear on the screen (if you cannot see the
splash screen, power off the device when you heart the beep-beep). Repeat this procedure for three time then power
on again the device and wait the configuration mode appears.
l Create a special file named “$0030D8$.bin” and put it inside an empty SD card. Insert the SD card into the device
and power on the device. Device will start in configuration mode.
WinCE Devices
The System Settings tool includes a rotating menu, and navigation buttons to scroll between the available options.
For each function and component on the left, the Info pane on the right displays all available information. In the example the
version of the Main OS component is shown.
The System Settings tool can be used in two operating modes:
l User mode
l System mode.
For each mode different options are available.
Runtime Installation
HMI devices are delivered from factory without Runtime, at first power up HMI shows the “Runtime Loader” screen.
43 System Settings
Runtime can be installed:
l Automatically, via Ethernet on first project download with PB610 Panel Builder 600
l Manually via USB Memory, creating an “Update Package”
Install Runtime via Ethernet

To install Runtime via Ethernet follow the "Download to HMI device" on page 88procedure.
WARNING: Runtime installation via Ethernet download requires the HMI to have a valid IP address.
The IP address can be assigned in three ways:
l Automatically via DHCP server. This option is enabled by default. If a DHCP server is available on the network IP
address will be assigned automatically by the server.
l Automatically via Auto-IP feature. If DHCP assignment is enabled but no DHCP server is available on the network
the HMI assigns itself an IP Address into range 169.254.x.x with subnet mask 255.255.0.0
l Manually via System Settings. From System Settings menu, in Network section the IP address can be manually
assigned, disabling the DHCP server assignment feature.
Install Runtime via USB Memory

To install Runtime, UpdatePackage or Backup Package via USB device follow this procedure:
1. Create an Update Package from PB610 Panel Builder 600 and copy into an empty USB memory stick
2. On HMI select [Transfer from disk] and select the UpdatePackage.zip to load.
WinCE Devices
System Settings
System Settings has two operating modes:
l User Mode
a simplified interface that gives users access to the basic settings of the HMI device.
l System Mode
a full interface that gives users access to all the tool's options.
When you access the tool at runtime selecting "Show system settings" from the context menu, the tool is started by default
in User Mode.
Note: Press and hold on a screen area without buttons or other touch sensitive elements to display the context
menu.
To access System Mode:
l Execute a tap sequence on the touch screen during the power-up phase. A tap sequence is a high frequency
sequence of touch activations executed immediately after the device has been powered.
l From the System Setting page in User Mode, restart the panel in Configuration OS mode
Elements available in User Mode

Element Description
Calibrate Touch Calibrate the touch screen
Display Control backlight inactivity timeout and brightness

settings
Time Set HMI device date and time manually or configure NTP servers
Regional Select or customize the regional setting parameters

Settings
BSP Settings Display operating system version and unit operating timers to control buzzer and battery led.
43 System Settings
Element Description
Network Sets IP address and other network settings
Plug-in List List the plug-in modules installed and recognized by the system.
Note: this option may not be supported by all platforms and all versions.
Close Closes the system setting page
WinCE Devices
Element Description
x.509 Certificate You can personalize the certificate with the data of your Company and ask to a Certificate Authority
to firm it.
The procedure to personalize and firm your certificate is:
1. Fill the necessary parameters, then push GENERATE button to generate a self-signed
certificate with your data.
2. Export the “Certificate Signed Request”
3. Sent the “Certificate Signed Request” to a Certificate Authority to firm it (general this is a paid
service)
4. Import the signed certificate into the HMI device
Certificate's parameters
Device Name The name of your device
Organization The legal name of your organization
Unit The division of your organization handling the certificate
State The state/region where your organization is located
Location The city where your organization is located
Country The two-letter ISO code for the country where your
organization is location
Valid (days) Validity of the certificate
Key Length Number of bits of the key used from the cryptographic
algorithm
Managed certificates are base64 encoding
Required BSP v2.29 or greater
Restart Restart the HMI device
l Main OS
Restart the HMI device in the operating mode
l Configuration OS
Restart the HIM device with System Setting tool active in System Mode
Elements available in System Mode

In addition to those available in User Mode, the following features are also available:
43 System Settings
Element Description
Format Flash Formats the internal device flash disk. All projects and the HMI Runtime will be
erased, returning the device to its factory settings.
Restore Factory Settings Restores factory settings as an alternative to Format Flash, in a more flexible
way. The following options are available:
Uninstall HMI: removes the HMI Runtime (entire qthmi folder) at the next start
the device will behave as a brand new unit. This command does not reset settings
such as IP address, brightness or RTC.
Clear System Settings: resets system parameters (registry settings) and

deletes the following files:
\\Flash\\Documents and Settings\\system.hv
\\Flash\\Documents and Settings\\default\\user.hv
\\Flash\\Documents and Settings\\default.mky
\\Flash\\Documents and Settings\\default.vol
System Mode password is also reset.
Clear sysdata settings: clears \Flash\$SysData$ folder
Service call: To be used only by technical support to fix display

problems.
Note: Not all these options are available for all HMI devices and BSPs.
Resize Image Area Resizes the flash memory reserved to store the splash screen image displayed at
power up. Default settings are normally suitable for all units.
Download Configuration OS Checks and upgrades the current version of the operating system used in System
Mode
Download Main OS Checks and upgrades the current version of the main operating system
Download Splash Image Loads a new file for the splash screen image displayed by the unit at power up.
Tip: Update the splash screen image directly from the PB610 Panel
Builder 600 programming software.
See "Update of system components from the application" on page 536 for details.
Download Bootloader Checks and upgrades the current version of the system boot loader.
Download Main FPGA Checks and upgrades the current version of the main FPGA file. This function
may not be available for all platforms and versions.
Download Safe FPGA Checks and upgrades the current version of the backup copy of the FPGA file.
This function may not be available for all platforms and versions.
WinCE Devices
Element Description
Download System Supervisor Checks and upgrades the current version of the system supervisor firmware
(used for the RTC and power supply handling).
Upload Configuration OS Copy the system files from the operator panel on the external device (usually an
USB stick).
Upload Main OS
Upload Splash Image
Upload Bootloader
Upload Main FPGA
Upload Safe FPGA
Upload System Supervisor
Update System Components

System components can be updated using a USB flash drives. For each component, a couple of specific update files are
provided.
Note: Upgrading procedures depend on hardware and operating system versions. Contact technical support for
assistance.
1. Copy all the upgrade files you need to a USB drive and plug it into the USB port of the HMI device.
2. Start the System Settings tool in System Mode (see "System Settings" on page 526for details).
3. Click on the desired download function.
4. Browse the content of the USB drive to the files to download. The example shows Main OS components.
5. Click Download to transfer files to the HMI device.
Note: From this dialog click Upload to transfer files to the USB device.
43 System Settings
6. Follow the instructions displayed to complete the update: the progress of the operation in displayed in a progress
bar.
This operation may require a few minutes.
Important: Do not turn off the device while a system component is being upgraded.
List of upgradable components

The HMI devices support the upgrade of the following components:
Component Description
Application The HMI Application and the HMI Runtime generated from the Run> Update
Package command
Main OS Main Operating System
Configuration OS Backup operating system that ensures units recovery in case of main operating
system corruption
Splash The initial screen shown during the startup of the HMI device
Bootloader Loader to handle device startup
Main FPGA FPGA firmware
Safe FPGA Backup copy of the Main FPGA that ensures unit booting in case of main FPGA
corruption
Important: Use the same file for updating Main and Safe FPGA
components.
System Supervisor Firmware of the system supervisor controller (for example: packaged_GekkoZigBee_
v4.13.bin).
The System Supervisor component can be upgraded from v4.13 or above.
Important: Do not try to update versions V4.08, V4.09, V4.10 and

V4.11 since they do not support automatic update from System
Settings.
Touchscreen calibration
System Setting Calibration allows to calibrate Touchscreen device, can be accessed from System Settings
To access System Settings:
l Execute a tap sequence on the touch screen during the power-up phase. A tap sequence is a high frequency
sequence of touch activations executed immediately after the device has been powered.
or
l Press and hold on an empty area of the screen for a few seconds to display the context menu.
WinCE Devices
From the rotating menu, select “Calibrate Touch” and follow the instructions on screen to complete the calibration
procedure, system will prompt to touch specific points to calibrate the touchscreen device.
Password protection
Internal password of the HMI device can be defined from the System Settings in System Mode (see "System Settings" on
page 526 for details)
From the rotating menu, select “BSP Settings” and then the Password tab to open the set password dialog.
The password must be at least 5 characters long.
Leave “Old password” empty as default if target password is not set.
This feature is available from BSP versions V1.64 ARM UN30/31 and V2.73 MIPS UN20 based on WCE OS.
Factory restore
If you’re having problems with the HMI device, try and restore factory default settings from System Mode.
43 System Settings
1. Enter System Mode.

2. Use one of the following operations available in rotating menu:
l Format Flash, to clean the flash drive and registry configuration.
l Restore Factory Settings, to clean only the select components.
Note: Both operations do not involve firmware factory restore (MainOS, ConfigOS, Bootloader, FPGA images,
etc).
See "System Settings" on page 526 for details.
System Mode
To access System Settings tool in System Mode you may use one of the below procedures:
l TAP-TAP sequence: this procedure consists in a tap-tap sequence over the touch interface during power-up phase.
Tap-tap consist in a high frequency sequence of touch activations by simple means of the finger tapping the touch
screen performed during the power-up phase and started immediately after the device is powered on. When the
procedure succeeded the system returns a visual feedback, the text: “Tap Tap detected, Going to Config Mode” is
displayed in page.
l BIN file procedure: this procedure consists in the use of an SD Card, containing a specific file, called
“$0030D8$.bin”. Copy the BIN file into the SD Card, then insert the card into the proper slot on the device. Power on
the device, when the file is detected the system returns a visual feedback, the text: “Tap Tap detected, Going to
Config Mode” is displayed in page.
Warning: if you are updating a Series Glass Device it is necessary to use the BIN file procedure
WinCE Devices
44 Updating system components in
HMI devices
Most of the system software components can be easily upgraded ensuring a high degree of flexibility in providing updates
and fixes to existing and running systems.
New software modules can be updated
l Directly on HMI device using an USB flash drives (see "System Settings" on page 503 for details)
l From PB610 Panel Builder 600 application (see "Update of system components from the application" on the next
page for details)
Each HMI device is labeled with a product code including all factory settings (hardware, software and firmware
components). Refer to this label for information on your HMI device. The HMI device update tool also provides detail on the
components actually running on the device.
CAUTION: Make sure you use the correct upgrade files, since loading upgrade files unsuitable for
your device will cause serious system malfunction. Always check your device product code.
Note: Upgrade files are distributed upon request as a part of technical support activity.
Service call: Downgrade operations are complex tasks which might cause serious damage to your equipment if
not performed correctly. These operations are reserved to technical support.
Update of system components from the application 536
Settings 537
Update of system components from the application
Update of system components from the application

You can download system components to a single HMI device or to a bulk of HMI devices of the same type using the
Ethernet communication interface.
Path: Run> Manage Target> Board
1. Select the folder that contains the files to download to the HMI device or where to upload files from the HMI device
2. Select one or more HMI device.
3. Select the components that you will download (or upload) to/from the devices
4. Start the Download to HMI or the Upload from the HMI operation
Note:
l The tool is designed to update multiple HMI devices of the same type. Please avoid putting files for different device
type into the same folder
l If the desired target IP is not listed, type it directly into the box. The discovery service is a broadcast service. When
a remote connection is done via VPN or from external networks, it will not work and you will have to enter the
address manually.
l Download of the selected components will be performed only to the compatible devices
l Based on your network and hardware capabilities you can increase the number of devices to update in parallel
l You need to restart the HMI device to finalize the update.
44 Updating system components in HMI devices
Settings
From the Settings tab you can specify the Port and the Password parameters to use to communicate with the HMI
devices. Leave Password empty if no password is set on the HMI device side.
WARNING: Bulk mode is working only with the HMI devices that have the same connection
parameters
Uploading a splash screen picture

You can replace the default splash screen image shown by the devices during the power up phase.
The image used as splash screen must comply with the following requirements:
Filename splash.bmp
Format Bitmap, RGB 565 format
Size < 500 KB
Bitmap width Even number (for example 430x239)
To upload the splash screen image:
1. Rename the new image splash.bmp and copy it in the source folder.
2. Select HMI devices
3. Click Download.
To ensure the best visual results, splash screen images must have a black background.
Settings
45 Communication protocols
This section describes the available protocols.
Note: Changes in controller hardware or protocols may have occurred since this documentation was created.
Always test and verify the functionality of the application. To accommodate developments in the controller
hardware and protocols, drivers are continuously updated. Accordingly, always ensure that the latest driver is
used in the application.
Different physical media, gateways, routers and hubs can be used in the communication network. Also, other devices can
independently make simultaneous use of the network. However, it is important to ensure that the traffic generated by these
devices does not degrade the communication speed (round-trip time) to an unacceptable level.
ABB CODESYS Ethernet 540
ABB CODESYS Serial 550
ABB IRC5 556
ABB IRC5 Linux 561
ABB Mint Controller HCP 571
ABB Modbus RTU 580
ABB Modbus TCP 587
ABB Pluto 593
BACnet 599
CODESYS V2 ETH 629
CODESYS V3 ETH 643
Ethernet/IP CIP 656
Modbus RTU 682
Modbus RTU Server 698
Modbus TCP 713
Modbus TCP Server 730
OPC UA Client 742
Simatic S7 ETH 755
System Variables 795
Variables 797
ABB CODESYS Ethernet

The ABB CODESYS Ethernet communication driver for Ethernet has been specifically designed to support communication
with ABB controllers series AC500 designed for standardized IEC 61131-3 programming, based on the CODESYS V2.3
system.
Note: CODESYS Ethernet Driver is supported with AC500 FW 2.1 or newer and not with AC500 FW 1.xx
Note: To accommodate developments in the controller protocol and hardware, drivers are continuously updated.
Make sure the latest driver is used in the application.
Note: Changes in the controller protocol or hardware may have occurred since this documentation was created.
This may interfere with the functionality of this driver. Therefore, always test and verify the functionality of the
application.
Limitations
CODESYS Level 4 is not supported. Maximum block size is 1024.

Adding a protocol

Add a driver in the Protocol editor and select ABB CODESYS ETH from the list of available protocols.
The following protocols type are supported:
l Tcp/Ip Level 2 Route

l ABB Tcp/Ip Level 2 Route AC
l Tcp/Ip
Select protocol type from the Protocol type combo box in the ABB CODESYS ETH dialog.
Some of the parameters of the dialog are common to the different protocol types, others are specific.
The parameters common to the different protocol types are:
Element Description
Alias Name identifying nodes in network configurations. The name will be added as a prefix to
each tag name imported for each network node.
IP address Ethernet IP address of the controller
Port Port number used for the communication. Default value is 1200 for ABB drivers. For AC500
and 3S drivers select port 1201.
BlockSize The max block size supported by your controller
Timeout Time delay in milliseconds between two retries in case of missing response from the server
device.
PLC Model Byte order that will be used by the communication driver when sending communication
frames to the PLC; Intel is also commonly referred as “little-endian”, Motorola as “big-
endian”
Select “Motorola” for AC500.
Element Description
Protocol type Three different protocol types are available:
l Tcp/Ip
l Tcp/IP Level2 Route
l ABB Tcp/Ip Level2 AC
PLC Network The protocol allows the connection to multiple controllers. To set-up multiple connections,
check “PLC network” checkbox and enter theIP Address per each slave you need to
access.
Protocol types
The Tcp/Ip protocol type corresponds to the 3S Level 4 driver and does not require additional setup besides the common
parameters.
The Tcp/IP Level2 Route protocol type corresponds to the standard 3S Level 2 Route driver and requires two additional
parameters:
Source Destination is the node of the PLC and allows the protocol to read variables in a sub-
Address network. The address is used to read variables when multiple PLCs are connected in a
(SrcAdr), sub-network (serial network) but only one of it has the Ethernet interface.
Destination
Address This is currently not applicable for AC500 PLCs.
The ABB Tcp/Ip Level2 AC protocol type implements a specific variation of the standard Level 2 protocol with the
additional use of a routing driver. This protocol type is normally used to connect to PLCs via other PLCs acting as
gateways.
This protocol type requires the following additional parameters:
l Routing Levels
l Coupler (Level 1)
l Channel (Level 1)
l Address (Level 1)
l Coupler (Level 2)
l Channel (Level 2)
l Address (Level 2)
For detailed information see AC500 and Control Builder documentation, chapter Programming interfaces to the AC500
used by the Control Builder.
Adding an alias name to a protocol

Tag names must be unique at project level, however, the same tag names might need to be used for different controller
nodes (for example when the HMI device is connected to two devices running the same application).
When creating a protocol you can add an alias name that will be added to tag names imported for this protocol.
In the example, the connection to a certain controller is assigned the name Node1. When tags are imported for this node,
all tag names will have the prefix Node1 making each of them unique at the network/project level.
Note: Aliasing tag names is only available for imported tags. Tags added manually in the Tag Editor cannot have
the Alias prefix in the tag name.
The Alias string is attached at the time of tag import. If you modify the Alias string after the tag import has been
completed, there will be no effect on names already present in the dictionary. When the Alias string is changed
and tags are re-imported, all tags will be re-imported with the new prefix string.
CODESYS Software Settings

When you create the project in CODESYS V2, select Download symbol file (Target Settings > General).
Note: ABB CODESYS Ethernet driver supports the automatic symbol file (SDB) upload from the controller; any
change in the tag offset due to new compilation on PLC software side does not require a symbol file re-import.
The Tag file has to be re-imported only in case of tag renaming or addition of new tags.
Standard Data Types

The import module supports variables of standard data types and user defined data types.
The following are considered as standard data types:
Supported l BOOL
data types l WORD
l DWORD
l INT
l UINT
l UDINT
l DINT
l STRING*
l REAL
l TIME
l DATE & TIME
and 1-dimensional ARRAY of the types above. See "Programming concepts" section in the main manual.
Note *: String length for a STRING variable in PLC should be max 80 characters. Declare a
STRING variable either with a specified size (str: STRING(35) or default size (str: STRING)
which is 80 characters.
Tag Conversion
Conversion to be applied to the tag.
Value Description
Example:
Example:
25.36 → -25.36
Example:
Example:

GHEFCDAB
Example:
Value Description
ABC...NOP -> OPM...DAB swap8: Swap bytes in a long word.
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
BCD bcd: Separate byte in two nibbles, read them as decimal (from 0 to 9)
Example:
0001 0111 = 23
Node Override IP
The protocol provides the special data type Node Override IP which allows you to change the IP address of the target
controller at runtime.
This memory type is an array of 4 unsigned bytes, one per each byte of the IP address.
The Node Override IP is initialized with the value of the controller IP specified in the project at programming time.
Node Override IP PLC operation
0.0.0.0 Communication with the controller is stopped, no request frames are generated
anymore.
Different from It is interpreted as node IP override and the target IP address is replaced runtime with
0.0.0.0 the new value.
If the HMI device is connected to a network with more than one controller node, each node has its own Node Override IP
variable.
Note: Node Override IP values assigned at runtime are retained through power cycles.
Exporting tags from the controller

When configuring PLC using the manufacturer’s configuration software, enable Symbol file (file with .sym extension)
creation under the CODESYS programming software:
1. In the Project menu, click Options.

2. Select Symbol configuration.
3. Select Dump symbol entries.
4. Click Configure symbol file: the Set object attributes dialog is displayed.
5. Select Export variables of object.
6. Click OK.
Importing tags
You may import tags from a .sym file exported from a controller. See "My first project" section in the main manual.
Communication status
The current communication status can be displayed using system variables.
See "System Variables" section in the main manual.
Codes supported for this communication driver:
Error Cause and action
Symbols file not present Check Symbol file and download again the PLC program
“tag” not present in Symbols files Check if the Tag is present into the PLC project
Time out on Acknowledge Controller didn’t send acknowledge
Time out on last Acknowledge Controller didn’t send last acknowledge
Time out on data receiving Controller didn’t reply with data
Connection timeout Device not connected
ABB CODESYS Serial
ABB CODESYS Serial

The ABB CODESYS Serial communication driver has been specifically designed to support communication with Series
500 ABB controllers designed for IEC 61131-3 programming, based on the CODESYS V2.3 system.
Limitations
This protocol does not support AC500 firmware version earlier than V2.0.

Adding a protocol

Element Description
Alias Name identifying nodes in network configurations. The name will be added as a prefix to each
tag name imported for each network node.
BlockSize The max block size supported by your controller (limit is 1024 kB).
(ms) device.
Num of Number of times a certain message will be sent to the controller before reporting the
repeats communication error status.
Element Description
Protocol Two different protocol types available:

type
l Serial_RS232: corresponds to the standard 3S driver.
l ABB_RS232_AC: implements a specific variation of the standard Level 2 protocol with
the additional use of a routing driver. Normally used to connect to PLCs via other PLCs
acting as gateways.
The ABB_RS232_AC protocol type requires the proper settings of the following
additional parameters:
l Routing Levels
l Coupler (Level 1)
l Channel (Level 1)
l Address (Level 1)
l Coupler (Level 2)
l Channel (Level 2)
l Address (Level 2)
For detailed information see AC500 and Control Builder documentation, chapter
Programming interfaces to the AC500 used by the Control Builder.
PLC The list allows selecting the PLC model you are going to connect to. The selection will
Models influence the data range offset per each data type according to the specific PLC memory
resources.
ABB CODESYS Serial
Element Description
PLC The protocol allows the connection to multiple controllers. To set-up multiple connections,
Network check “PLC network” checkbox and enter the node ID per each slave you need to access.
Comm... If clicked displays the communication parameters setup dialog.
Element Description
Port Serial port selection.
l COM1: device PLC port.

l COM2: computer/printer port.
Parity, Baudrate, Stop bits Serial line parameters.
Parity must be set to none for AC500.
Mode Serial port mode. Available modes:
Element Description
Element Description
l RS-232
l RS-485 (2 wires)
l RS-422 (4 wires)

CODESYS software settings

When you create the project in CODESYS V2, select Download symbol file (Target Settings > General).
ABB CODESYS Serial
Note: ABB CODESYS Serial driver supports the automatic symbol file (SDB) upload from the controller; any
change in the tag offset due to new compilation on PLC software side does not require a symbol file re-import.
The Tag file has to be re-imported only in case of tag renaming or addition of new tags.

When configuring PLC using the manufacturer’s configuration software, enable Symbol file (file with .sym extension)
creation under the CODESYS programming software:

2. Select Symbol configuration.
4. Click Configure symbol file: the Set object attributes dialog is displayed.
5. Select Export variables of object.
6. Click OK.
Importing tags
You may import tags from a .sym file exported from a controller. See "My first project" section in the main manual.
Data types
Supported l BOOL
data types l WORD
l DWORD
l INT
l UINT
l UDINT
l DINT
l STRING*
l REAL
l TIME
l DATE & TIME
and 1-dimensional ARRAY of the types above. See "Programming concepts" section in the main
manual.
Unsupported l LWORD
data types l LINT
l LREAL
Current communication status can be displayed using system variables. See "System Variables" section in the main
manual.
Symbols file not present Check Symbol file and download again the PLC program
“tag” not present in Symbols files Check if the Tag is present into the PLC project
Time out on Acknowledge Controller didn’t send acknowledge
Time out on last Acknowledge Controller didn’t send last acknowledge
Time out on data receiving Controller didn’t reply with data
Connection timeout Device not connected
ABB IRC5
ABB IRC5
The ABB IRC5 robot controller communication driver has been designed for communication to the ABB Robotics robot
controller family IRC5. This version supports communication towards the IRC5 robot controller I/O system (input and
output signals).
The communication driver cannot meet any hard real-time demands for a number of reasons:
l It executes on a non-real-time operating system.

l Communication is performed with TCP/IP over a network.
l The actual controller might have more high-priority tasks to perform.
A minimal response time in the order of 10-100ms can be expected.
Implementation details
An IRC5 robot controller system uses input and output signals to control the process. Signals can be digital, analog, or
group signal. Such signals are accessible using the PanelBuilder tool.
Signal changes in the robot system are often significant. There are many scenarios where end-users need notification of
these changes.
In the IRC5 controller manual mode, a signal value can be modified only if the signal Access Level is ALL and the
FlexPendant isn't connected. If not, the controller has to be in auto mode. Use the IRC5 robot controller tools RobotStudio
or FlexPendant to change the access level of a signal.
A PanelBuilder application acts as remote client in comparison with FlexPendant which is a local client.
Remote clients do not have all the privileges of a local client, especially in manual mode. For example, in manual mode the
FlexPendant can start and stop IRC5 robot controller programs by using system inputs. This is only available for a remote
client in automatic mode.
A remote client has the possibility to monitor and access several robot controllers from another location.
Safety of personnel
WARNING: A robot is heavy and extremely powerful regardless of its speed. A pause or long stop in
movement can be followed by a fast hazardous movement. Even if a pattern of movement is predicted,
a change in operation can be triggered by an external signal resulting in an unexpected movement.
All safety regulations must be followed when entering safeguarded space. Make sure you are familiar
with the safety regulations as described in the IRC5 operating manuals.
ABB IRC5 driver

The IRC5 driver is supported starting from version PB610 V1.90.0.778.
HMI devices can be connected to ABB robot networks as clients using this communication driver.
The ABB IRC5 driver provides easy handling of the connections to the ABB robot controllers providing specific support for
tag import facilities.
The minimum requirement is the operating system version (BSP version) on the HMI device. Refer to the software user
manual to know the BSP version of your HMI device.
Products Change index Date of production BSP version
CP650, CP660, CP675 B2 or newer WK10 2013 (1103) or later V2.80 or newer
CP620, CP630, CP635 B2 or newer WK10 2013 (1103) or later V1.76 or newer
CP651, CP661, CP665, CP676 A0 V1.76 or newer
Note: You must set the IP submask of the HMI device to 255.255.255.0. Otherwise the communication to the
IRC5 controller does not work.

Adding a protocol

Element Description
Alias Name to be used to identify nodes in network configurations. The name will be added as a prefix
to each tag name imported for each network node
IP Ethernet IP address of the controller.

address
ABB IRC5
Element Description
PLC Only one model type is currently available.

Models
PLC IP address for all controllers in multiple connections. PLC Network must be selected to enable
Network multiple connections.


ABB Robotics controllers programming tool can generate a .cfg symbol file.
The import module supports variables of the following standard data types.
l boolean
l unsignedInt
l float
Note: Only I/O signals can be used and only output signals of the robot controller can be modified by the CP600
device. They can only be modified as long as the IRC5 controller is in automatic mode or the FlexPendant is not
connected and the signal access level is ALL. Input signals can only be monitored.
Importing tags
You may import tags from a .cfg file exported from a controller. See "My first project" section in the main manual.
ABB IRC5
manual.
Codes supported by this communication driver:
Error Cause Action
Can't find the A request is not replied within the specified Check if the controller is connected and
node x.x.x.x " timeout period. properly configured to get network access.
I/O signal The device did received a response with Check if the data programmed in the project
reading error invalid format or contents from the are consistent with the controller resources.
controller.
I/O signal The device did receive a response from the -

quality not controller with poor signal quality.
good
Error The device has no permissions to write -

requesting data into the controller.
mastership
ABB IRC5 Linux
The ABB IRC5 Linux robot controller communication driver has been designed for communication to the ABB Robotics
robot controller family IRC5 from a CP600-Pro or CP600-eCo Panel (with Linux OS).
This version supports communication towards the IRC5 robot controller I/O system (input and output signals) and to
variables in the RAPID user system module.
The communication driver cannot meet any hard real-time demands for a number of reasons:
l It executes on a non-real-time operating system.

l Communication is performed with TCP/IP over a network.
l The actual controller might have more high-priority tasks to perform.
A minimal response time in the order of 10-100ms can be expected.
An IRC5 robot controller system uses input and output signals to control the process. Signals can be digital, analog, or
group signal. Such signals are accessible using the PanelBuilder tool.
With the ABB IRC5 Linux driver also variables which are defined in the system module “User” can be accessed.
Signal changes in the robot system are often significant. There are many scenarios where end-users need notification of
these changes.
In the IRC5 controller manual mode, a signal value can be modified only if the signal Access Level is given. Use the IRC5
robot controller tools RobotStudio or FlexPendant to change the access level of a signal.
A PanelBuilder application acts as remote client in comparison with FlexPendant which is a local client.
A remote client has the possibility to monitor and access several robot controllers from another location.
Remote clients do not have all the privileges of a local client, especially in manual mode, depending on their IO
configuration. For example, in manual mode the FlexPendant can start and stop IRC5 robot controller programs by using
system inputs. This is only available for a remote client in automatic mode.
Therefor it is strongly recommended to set their access level property “Remote client in manual mode” to “Read Only” for all
signals used in the CP600.
Otherwise it would be possible to control the robot from CP600, even if the IRC5 is in manual mode and a person is acting
next to the robot using the FelxPendant for control.
To achieve this, configure a new “Access Level Rule” (e.g. “CP600”) with following settings:
l Local Client in Manual Mode: Write Enabled

l Local Client in Auto Mode: Write Enabled
l Remote Client in Manual Mode: Read Only
l Remote Client in Auto Mode: Write Enabled
ABB IRC5 Linux
Then assign this Access Level (e.g. CP600) to all signals that will be used in the CP600 panel
Then the IO signals can only be modified by the CP600 if the IRC5 controller is in automatic mode.
The RAPID system variables also can only be modified by the CP600 if the IRC5 controller is in automatic mode.
Note: If you change the panel type from a CP600-Pro or CP600-eCo panel to another one or vice versa you need to change
the protocol type from “ABB IRC5” to “ABB IRC5 Linux” or vice versa. After this change a new import of the EIO.cfg file has
to be performed.
Be aware that only the “ABB IRC5 Linux” driver has the possibility to access RAPID system user variables.
Safety of personnel
WARNING: A robot is heavy and extremely powerful regardless of its speed. A pause or long stop in
movement can be followed by a fast hazardous movement. Even if a pattern of movement is predicted,
a change in operation can be triggered by an external signal resulting in an unexpected movement.
All safety regulations must be followed when entering safeguarded space. Make sure you are familiar
with the safety regulations as described in the IRC5 operating manuals.
ABB IRC5 Linux driver

The IRC5 Linux driver is supported starting from version PB610 V2.8.0.364.
HMI devices can be connected to ABB robot networks as clients using this communication driver.
The ABB IRC5 Linux driver provides easy handling of the connections to the ABB robot controllers providing specific
support for tag import facilities.
The minimum requirement is the operating system version (BSP version) on the HMI device. Refer to the software user
manual to know the BSP version of your HMI device.
Products BSP version
CP600-eCo: CP604, CP607, V 307 or newer

CP610
CP600-Pro: CP6605, CP6607, V 304 or newer

CP6610, CP6615, CP6621
Note: You must set the IP subnet mask of the HMI device to 255.255.255.0. Or be sure to use the same IP
subnet mask as well in the HMI and the IRC5 controller. Otherwise the communication to the IRC5 controller
does not work

Adding a protocol

ABB IRC5 Linux
Element Description
Alias Name to be used to identify nodes in network configurations. The name will be added as a
prefix to each tag name imported for each network node
IP address Ethernet IP address of the controller.
user Keep the “Default User”
password Keep the password “robotics”
Element Description
PLC Only one model type is currently available.

Models
PLC IP address for all controllers in multiple connections. PLC Network must be selected to
Network enable multiple connections.

ABB IRC5 Linux

ABB Robotics controllers programming tool can generate a .cfg symbol file. (Mostly named EIO.cfg)
The import module supports variables of the following standard data types.
l boolean
l int
l unsignedInt
l float
l double
Note: In the EIO.cfg import only I/O signals can be used. They can only be modified if the signal access level is
"Write Enable" for Automatic Mode. See "Implementation details" chapter.
Importing tags
You may import tags from a .cfg file exported from a controller. See "My first project" section in the main manual.
This will not include the RAPID system user tags. See "Accessing RAPID tags" chapter.
The variables can be read periodically asking their value to robot controller. To reduce the network traffic it is possible to
"subscribe" the variable that means to ask to the controller to update the value 'on change'. The type of reading is defined
for each variable via the Subscribe checkbox. Additionally it is possible to define the "priority" of subscribed variables.
Priority can assume values of "high" "medium" or "low". Robot controller can accept a limited number of high priority
subscriptions but it assures a fast update of value (< 1sec). Other values are update by some background process and
updated value can be delayed.
WARNING: Subscription is a powerful tool but it must be used carefully: in case of many variables
changing value frequently, it can cause saturation of the communication channel.
Accessing RAPID Tags
It is possible to access Tags that were created in the system module “user”.
Those tags must be created manually in the Tag editor.
Add a new Tag under the ABB IRC5 Linux protocol
ABB IRC5 Linux
Element Description
Memory Select “RAPID”

Type
Data Select the type – for 32 bit tags, “double” is recommended

Type
Convers Not needed

ion
Variable Use the path to the variable in screenshot in following format:

Name RAPID/T_ROB1/user/UserReg01
Element Description
Priority The variables can be read periodically asking their value to robot controller. To reduce the
network traffic it is possible to "subscribe" the variable that means to ask to the controller to
update the value 'on change'. The type of reading is defined for each variable via the Subscribe
checkbox. Additionally it is possible to define the "priority" of subscribed variables. Priority can
assume values of "high" "medium" or "low". Robot controller can accept a limited number of high
Subscri priority subscriptions but it assures a fast update of value (< 1sec). Other values are update by
be some background process and updated value can be delayed.
WARNING: Subscription is a powerful tool but it must be used carefully: in

case of many variables changing value frequently, it can cause saturation of
the communication channel.
It is possible to access simple scalar variables as well as fields of structured variables. To access a field of a structure an
additional notation must be added in the end of the variable name: {index1, index2, index3, …}. Each element corresponds
to one level of nesting in the structure. Indexes starts from 1
I.e.
RAPID/T_ROB1/testmode/gripper in a structured variable. Its full value is:

[FALSE,[[0,0,0],[0.94,0,0.383,0]],[5,[23,0,75],1,0,0,0],0,0,0]]
To get the values of fields the following notation must be used:

RAPID/T_ROB1/testmode/gripper{1} = FALSE
RAPID/T_ROB1/testmode/gripper{2,1,1} = 0
ABB IRC5 Linux
RAPID/T_ROB1/testmode/gripper{2,2,1} = 0.94
RAPID/T_ROB1/testmode/gripper{2,2,3} = 0.383
RAPID/T_ROB1/testmode/gripper{3,1} = 5
RAPID/T_ROB1/testmode/gripper{4} = 0
Each tag must correspond to a scalar field of the structure.
This king of tag does not allow subscription
manual.
Error Cause Action
Can't find the A request is not replied within the specified Check if the controller is connected and
node x.x.x.x " timeout period. properly configured to get network access.
I/O signal The device did received a response with Check if the data programmed in the project
reading error invalid format or contents from the are consistent with the controller resources.
controller.
I/O signal The device did receive a response from the -

quality not controller with poor signal quality.
good
Error The device has no permissions to write -

requesting data into the controller.
mastership
ABB Mint Controller HCP

This communication protocol allows the HMI devices to connect to the ABB motion and servo drive devices using the HCP
and HCP2 communication protocols.
Adding a protocol

Element Description
Node ID Node ID assigned to the controller device.
Protocol Two protocols are available:

Type
l HCP
l HCP2
Timeout Time delay in milliseconds between two retries in case of missing response from the server device.
(ms)
Retry Number of times a certain message will be sent to the controller before reporting the communication error
count status.
PLC PLC model you are going to connect to.

Models
Element Description
PLC The protocol allows the connection of multiple controllers to one HMI device. To set-up multiple connections,
Network check “PLC network” checkbox and enter the node ID per each slave you need to access.
Element Description
Element Description
l COM1= device PLC port.

l COM2= computer/printer port.
Baudrate, Parity, Data Bits, Stop bits Serial line parameters.
l RS-232.
l RS-485 (2 wires).
l RS-422 (4 wires).
Data types
The ABB Mint Controller HCP driver provides the support for two Memory Types which are referring to the same physical
memory area in the Mint controller:
l Comms: should only be used with floating point values. The Mint program on the ABB controller should use
COMMS to access this data.
l CommsInteger: allows a variety of integer-based data types to be selected.
If the Mint controller program uses... then...
COMMS keyword for a tag setup to use the only the bottom 23 bits will be accurate (due to floating point
Commsinteger memory type precision of the COMMS keyword).
COMMSINTEGER keyword for a tag setup to use the the value is precise for the full 32 bits.
Commsinteger memory type
See "Programming concepts" section in the main manual.
Tag Conversion
Value Description
Example:
Example:
Value Description
25.36 → -25.36
Example:
Example:

GHEFCDAB
Example:
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
Example:
0001 0111 = 23
Tag Import
Locate the .xml file exported from Tag Editor and click Open.
Import Tag(s).
Select tags to be imported and click on this icon to add tags from
tag dictionary to the project
Update Tag(s).
dictionary import.
Searches tags in the dictionary basing on filter combo-box item

selected.
manual.
Error Cause Action
NAK The controller replies with a not -

acknowledge.
Timeout A request is not replied within the specified Check if the controller is connected and properly
timeout period. configured to get network access.
Line An error on the communication parameter Check if the communication parameter settings of
Error setup is detected (parity, baud rate, data the controller is compatible with the device
bits, stop bits). communication setup.
Error Cause Action
Invalid The device did received a response with Ensure the data programmed in the project are
response invalid format or contents from the consistent with the controller resources.
controller.
General Unidentifiable error. Should never be Contact technical support.

Error reported.
ABB Modbus RTU
ABB Modbus RTU

The HMI devices can be connected to a Modbus network as the network master using this driver.
This specific implementation of the Modbus RTU driver provides easy handling of the connections to ABB controllers
providing specific support for PLC models and tag import facilities.
The ABB Modbus RTU implementation supports only a subset of the Modbus standard RTU function codes.
01 Read Coil Status Reads multiple bits in the device Coil area
02 Read Input Status Read the ON/OFF status of the discrete inputs (1x reference) in the slave
03 Read Holding Registers Read multiple Registers
04 Read Input Registers Reads the binary contents of input registers (3x reference) in the slave
05 Force Single Coil Forces a single Coil to either ON or OFF
06 Preset Single Register Presets a value in a Register
16 Preset Multiple Registers Presets value in multiple Registers
Note: Communication speed with controllers is supported up to 115200 baud.
Note: Floating point data format is IEEE standard compliant.

Adding a protocol

Element Description
Node ID Modbus node of the slave device.
Timeout (ms) Time delay in milliseconds between two retries in case of missing response from the server
device.
delay Time delay in milliseconds between the end of the last received frame and the starting of a
new request. If set to 0, the new request will be issued as soon as the internal system is
able to reschedule it.
Transmission l RTU: use RTU mode

Mode l ASCII: use ASCII mode
Note: When PLC network is active, all nodes will be configured with the same
Transmission Mode.
PLC Models PLC model you are going to connect to. The selection influences the data range offset per
each data type according to the specific PLC memory resources.
ABB Modbus RTU
Element Description
Element Parameter

l COM2: computer/printer port.
l RS-232.
l RS-485 (2 wires).
l RS-422 (4 wires).
When using the controllers:
l ABB NextMove ES / ESB-2

l ABB e100 Motion Product
l ABB e150 Motion Product
make sure that Parity has been set to "None"
PLC Network The protocol allows the connection of multiple controllers to one operator panel. PLC
Network must be selected to enable multiple connections.
Element Description
Note: PLC model Pluto Safety PLC is available for compatibility reasons. If you
need to connect to this PLC model, please select ABB Pluto protocol.

ABB Modbus RTU
Node Override ID (master devices)

The protocol provides the special data type Node Override ID which allows you to change the node ID of the target
controller at runtime. This memory type is an unsigned byte.
The node Override ID is initialized with the value of the node ID specified in the project at programming time.
Node
Modbus operation
Override ID
0 Communication with the controller is stopped. In case of write operation, the request will be transmitted
without waiting for a reply.
1 to 254 It is interpreted as the value of the new node ID and is replaced for runtime operation.
255 Communication with the controller is stopped; no request messages are generated.
Note: Node Override ID value assigned at runtime is retained through power cycles.
Exporting tags from a controller

The ABB controllers programming supports tag export in .exp format.
To export tags:
Select Project> Export...: an .exp file will be created.
Importing tags
You may import tags from an .exp file exported from a controller. See "My first project" section in the main manual.
Current communication status can be displayed using System Variables. See "System Variables" section in the main
manual.
ABB Modbus RTU
Error Cause Action
NAK The controller replies with a not acknowledge. -
Line An error on the communication parameter setup Check if the communication parameter settings of the
Error is detected (parity, baud rate, data bits, stop controller is compatible with the device communication
bits). setup.
Invalid The device did received a response with invalid Ensure the data programmed in the project are consistent
response format or contents from the controller . with the controller resources.
General Unidentifiable error. Should never be reported. Contact technical support.

Error
ABB Modbus TCP

ABB Modbus TCP driver provides easy handling of the connection to the ABB controllers providing specific supports for
PLC models and tag import facilities.
Various Modbus TCP-capable devices can be connected to the HMI device. To set-up your Modbus TCP device, please
refer to the documentation you have received with the device.
The implementation of the protocol operates as a Modbus TCP client.
The ABB Modbus TCP supports only a subset of the standard Modbus TCP function codes.
06 Preset Single Register* Presets a value in a Register
16 Preset Multiple Registers* Presets value in multiple Registers

Adding a protocol

ABB Modbus TCP
Elemen
Description
t
Alias Name identifying nodes in network configurations. The name will be added as a prefix to each tag
name imported for each network node.

Addres
s
Port Port number used by the Modbus TCP driver. The default value can be changed when the
communication goes through routers or Internet gateways where the default port number is
already in use.
Timeou Time delay in milliseconds between two retries in case of missing response from the server
t device.
UnitID Usually used when communicating over Ethernet-to-serial gateways and then interpreted as the
Slave ID. This value is simply copied into the Unit Identifier field of the Modbus TCP
communication frame. This is rarely used and in most cases can be left zero.
Elemen
Description
t
PLC PLC model you are going to connect to. The selection influences the data range offset per each
Models data type according to the specific PLC memory resources.
PLC IP address for all controllers in multiple connections. PLC Network check box must be selected
Networ to enable multiple connections.
k

ABB Modbus TCP

Node
Modbus operation
Override ID

The ABB controllers programming supports tag export in .exp format.
To export tags:
Select Project> Export...: an .exp file will be created.
Importing tags
You may import tags from an .exp file exported from a controller. See "My first project" section in the main manual.
manual.
ABB Modbus TCP
Error Cause Action
Timeout A request is not replied within the specified timeout Check if the controller is connected and properly
period. configured to get network access.
Invalid The device did received a response with invalid Check if the data programmed in the project are
response format or contents from the controller. consistent with the controller resources.
General Unidentifiable error. Contact technical support.

Error
ABB Pluto
The HMI devices can be connected to a Modbus network as the network master using this generic driver.
This specific implementation of the Modbus RTU driver provides easy handling of the connections to the ABB controllers
providing specific support for ABB Pluto Safety PLC and tag import facilities.
This Modbus RTU implementation supports only a subset of the standard Modbus function codes.
02 Read Input Status Read the ON/OFF status of the discrete inputs (1x reference) in the
slave
16 Preset Multiple Presets value in multiple Registers

Registers

Adding a protocol

The driver configuration dialog is shown in the following figure.
ABB Pluto
Element Description
Timeout (ms) Time delay in milliseconds between two retries in case of missing response from the slave
device.
Delay (ms) Time delay in milliseconds between the end of the last received frame and the starting of a
When set to 1 the panel will report the communication error if the response to the first
request packet is not correct.

Element Description
PLC Models PLC model you are going to connect to. The selection influences the data range offset per
each data type according to the specific PLC memory resources.
Comm… If clicked displays the communication parameters setup dialog.
Element Description

l COM2: computer/printer port (if
available)
Baudrate, Parity, Data bits, Stop Serial line parameters.

bits
l RS-232.
l RS-485 (2 wires).
l RS-422 (4 wires).

ABB Pluto
Node
Modbus operation
Override ID
Tag import
ABB Pluto driver supports tag import.
The ABB Pluto Safety PLC programming suite allows to export tags in .csv format.
1. In the Tag Editor select the driver.
2. Click the Import Tags button to start the import.
3. Locate the .csv file and confirm.
4. To import tags, select one or more tags in the .csv file and click the Import tag button: tags are copied to the
project.
See "My first project" section in the main manual.
manual.
Error Cause Action
Line An error on the communication parameter setup Check if the communication parameter settings of the
Error is detected (parity, baud rate, data bits, stop controller is compatible with the device communication
ABB Pluto
Error Cause Action
bits). setup.
Invalid The device did received a response with invalid Ensure the data programmed in the project are consistent
response format or contents from the controller . with the controller resources.

Error
BACnet
The BACnet communication driver has been designed to connect HMI devices to BACnet networks and supports IP and
MS/TP communication.
The HMI device operates as a BACnet device.
This implementation of the BACnet communication protocol allows integrating HMIs in a BACnet network and exchange
data between HMI and other devices connected to the BACnet network. HMIs provide client capability for displaying
properties of BACnet objects in real time using BACnet/IP or MS/TP network types.
BACnet communication protocol can be:
l Configured as BACnet IP: communication with BACnet devices is established over Ethernet using HMI Ethernet
port;
l Configured as BACnet MS/SP: communication with BACnet devices is established over serial line, using HMI
serial port;
Communication protocol configuration allows defining HMI BACnet ID and object name used to identify HMI in BACnet
network.
BACnet object properties are reachable from HMI using explicit Tag configuration. A single Tag represents a single
property for a BACnet object.
Using the property Present_Value (85) in Tag configuration, the Tag will be connected to the current value of a specific
object (for example in the case of analog values, it will be the measured value).
Adding a protocol

BACnet
Element Description
Panel Device ID Identifies the HMI device in the network.
Object Name BACnet Object Name for the HMI device.
Description HMI device description, for documentation purposes.
Media Type of communication of the protocol.
Element Description
l MS/TP: Master-Slave/Token-Passing communication (RS-485).

l IP: based on standard UDP/IP communication.
Timeout (ms) Time delay in milliseconds between two retries in case of missing response from the
BACnet device.
Panel Node * MS/TP address. Physical device address on the link; it is not passed through routers.
COV Lifetime (s) Desired lifetime of the subscription in seconds before the it shall be automatically
cancelled.. A value of zero indicates an indefinite lifetime, without automatic
cancellation.
Max Master * Highest allowable address for master nodes. Must be less than or equal to 127.
Max Info Frames Maximum number of information frames the node may send before it must pass the
* token. Max Info Frames may have different values on different nodes and may be used
to allocate more or less of the available link bandwidth to particular nodes.
Max MS/TP Maximum length of APDU (Application Layer Protocol Data Unit), which means the
APDU * actual packet length on BACnet network. This value cannot exceed 480 (default value).
Max IP APDU ** Maximum length of APDU (Application Layer Protocol Data Unit), which means the
actual packet length on BACnet network. This value cannot exceed 1476 (default
value).
IP UDP Port ** Port number for IP communication.
Local IP ** IP Address of the network adapter to use for protocol. Not required if the device has only
one Ethernet adapter.
BACnet
Element Description
PLC Models Reserved for future use.
Comm... * If clicked displays the communication parameters setup dialog.
Element Description
Port Communication port.
Baudrate, Parity, Data bits, Stop bits Communication parameters.
Mode Communication mode. Available modes:
l RS-232
l RS-485
l RS-422
Note *: Available only if media is set to MS/TP.
Note **: Available only if media is set to IP.
Tag Editor Settings


2. Select BACnet from the Driver list: the tag definition dialog is displayed.
Elemen
Description
t
Object Type of BACnet object to be referenced. Available object types:

Type
l Device
l Analog Input
l Analog Output
l Analog Value
l Binary Input
l Binary Output
l Binary Value
l Multi-state Input
l Multi-state Output
l Multi-state Value
l Integer Value
l Positive Integer Value
l Large Analog Value
Device ID of the device containing the object.

ID
Data Data type for display presentation. Available data types:

Type
l boolean
BACnet
Elemen
Description
t
l int
l unsignedInt
l float
l double
l string
l binary
l boolean[]
These data types are data types as defined in the software.
The equivalence with BACnet data types is shown in the table:
Software
BACnet data type Notes
data type
BOOLEAN Boolean -
INTEGER Int -
UNSIGNED_INTEGER unsignedInt -
REAL Float -
BIT_STRING boolean-x x = size
CHARACTER_ string-x x = size

STRING
OCTET_STRING binary-x x = size
DATE int or -
unsignedInt
TIME int or -
unsignedInt
BACnetObjectIdentifier int or Use conversions instance and objType

unsignedInt for proper display
Arraysi l In case of array tag, this property represents the number of array elements.
ze l In case of string tag, this property represents the maximum number of bytes available in
the string tag.
Note: number of bytes corresponds to number of string characters if Encoding property is set to
If Encoding property is set to UCS-2BE, UCS-2LE, UTF-16BE or UTF-16LE one character
requires 2 bytes.
Conver Conversion to be applied to the tag.

sion
Elemen
Description
t
Value Description
Example:
Example:
25.36 → -25.36
Example:
Example:

GHEFCDAB
Example:

OPM...DAB
Example:
0 10000000110
BACnet
Elemen
Description
t
Value Description
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
to 9)
Example:
0001 0111 = 23
Configured).
Object BACnet ID of the object to be referenced.

Instanc
e
Object Numeric value of the property to be referenced (example: the value 85 means present-value for
Propert most standard objects).
y The table below specifies all the BACnet Object Properties.
Val Val Val Val

Property Property Property Property
ue ue ue ue
accepted- 175 effective- 32 max-info- 63 reason-for- 100

modes period frames halt
acked- 0 elapsed- 33 max- 64 recipient-list 102

transitions active- master
time
ack- 1 error-limit 34 max-pres- 65 records- 140

required value since-
notification
action 2 event- 35 max- 167 record-count 141

enable segment
Elemen
Description
t
Val Val Val Val

ue ue ue ue
s-
accepted
action-text 3 event- 36 member- 159 reliability 103

state of
active-text 4 event- 130 minimum- 66 relinquish- 104

time- off-time default
stamps
active-vt- 5 event-type 37 minimum- 67 required 105

sessions on-time
active-cov- 152 event- 83 minimum- 68 resolution 106

subscriptio parameter output
ns s
adjust- 176 exception- 38 minimum- 136 scale 187

value schedule value
alarm-value 6 fault- 39 minimum- 150 scale-factor 188

values value-
timestam
p
alarm- 7 feedback- 40 min-pres- 69 schedule- 174

values value value default
all 8 file- 41 mode 160 segmentatio 107

access- n-supported
method
all-writes- 9 file-size 42 model- 70 setpoint 108

successful name
apdu- 10 file-type 43 modificati 71 setpoint- 109

segment- on-date reference
timeout
apdu- 11 firmware- 44 notificatio 17 slave- 171

timeout revision n-class address-
binding
application- 12 high-limit 45 notificatio 137 setting 162

software- n-
version threshold
BACnet
Elemen
Description
t
Val Val Val Val

ue ue ue ue
archive 13 inactive- 46 notify- 72 silenced 163

text type
attempted- 124 in-process 47 number- 73 start-time 142

samples of-APDU-
retries
auto-slave- 169 input- 181 number- 74 state-text 110

discovery reference of-states
average- 125 instance- 48 object- 75 status-flags 111

value of identifier
backup- 153 integral- 49 object-list 76 stop-time 143

failure- constant
timeout
bias 14 integral- 50 object- 77 stop-when- 144

constant- name full
units
buffer-size 126 last-notify- 173 object- 78 system- 112

record property- status
reference
change-of- 15 last- 157 object- 79 time-delay 113

state-count restore- type
time
change-of- 16 life-safety- 166 operation- 161 time-of- 114

state-time alarm- expected active-time-
values reset
client-cov- 127 limit- 52 optional 80 time-of- 115

increment enable state-count-
reset
configurati 154 limit- 182 out-of- 81 time- 116

on-files monitorin service synchronizat
g-interval ion-
recipients
controlled- 19 list-of- 53 output- 82 total-record- 145

variable- group- units count
reference members
Elemen
Description
t
Val Val Val Val

ue ue ue ue
controlled- 20 list-of- 54 polarity 84 tracking- 164

variable- object- value
units property-
references
controlled- 21 list-of- 55 prescale 185 units 117

variable- session-
value keys
count 177 local-date 56 present- 85 update- 118

value interval
count- 178 local-time 57 priority 86 update-time 189

before-
change
count- 179 location 58 pulse-rate 186 utc-offset 119

change-
time
cov- 22 log-buffer 131 priority- 87 valid- 146

increment array samples
cov-period 180 log- 132 priority- 88 value-before- 190

device- for-writing change
object-
property
cov- 128 log-enable 133 process- 89 value-set 191

resubscript identifier
ion-interval
database- 155 log- 134 profile- 168 value- 192

revision interval name change-time
date-list 23 logging- 183 program- 90 variance- 151

object change value
daylight- 24 logging- 184 program- 91 vendor- 120

savings- record location identifier
status
deadband 25 low-limit 59 program- 92 vendor-name 121

state
derivative- 26 maintenan 158 proportion 93 vt-classes- 122

constant ce- al- supported
BACnet
Elemen
Description
t
Val Val Val Val

ue ue ue ue
required constant
derivative- 27 manipulat 60 proportion 94 weekly- 123

constant- ed- al- schedule
units variable- constant-
reference units
description 28 manual- 170 protocol- 96 window- 147

slave- object- interval
address- types-
binding supported
description- 29 maximum- 61 protocol- 139 window- 148

of-halt output revision samples
device- 30 maximum- 135 protocol- 97 zone- 165

address- value services- members
binding supported
device-type 31 maximum- 149 protocol- 98

value- version
timestamp
direct- 156 max-apdu- 62 read-only 99

reading length-
accepted
Array Index for subscribing elements in BACnet arrays.

Index
l -1 means read all elements
l 0 to n means read the specified element
Priority Array example

To read a priority array object it is necessary to set Object Property = 87 and Array Index has to
refer to the priority item to be read.
The following figure shows how to read the 16th item of a priority array.
Elemen
Description
t
Write Write requests priority level. The value is in the range 1-16. 0 is interpreted as 16.
Priority
COV Enable the Change Of Value notification.
Clear/Set Priority
The system offers actions for a more flexible handling of Write Priority.
BACnet
Action Description
BACnetClearPriority Clears the priority array at the position associated to the BACnet tag passed
as parameter.
This action has immediate effect on the BACnet device.
BACnetClearAllPriorities Clears all positions in the priority array.
This action has immediate effect on the BACnet device.
BACnetSetPriority Overrides the Write Priority value configured in the BACnet tag definition.
This action has two parameters:
l TagName: name of the BACnet tag.

l TagPriority: new value of Write Priority for the BACnet tag passed as
parameter.
This action only overrides the value of Write Priority in the BACnet tag
definition and does not perform any communication with the BACnet device.
Any write command that will be performed to the Present Value property of the
BACnet device identified by the tag, will be performed using the new Write
Priority value.
The priority value will be valid until:
l A new call to the BACnetSetPriority action changes it.

l The HMI device is restarted. The value of WritePriority defined in the
project is valid in this case.
Tag Import
BACnet object information can be imported from BACnet EDE (Engineering Data Exchange) files. The EDE file must have
the .csv extension.
The importer uses the characters “,” and “;” as delimiters. They are considered as reserved characters and you cannot use
them in file name.
Use the hierarchical importer to have a ordered list of BACnet objects and properties.
Tags will be created using the string specified in the column object-name of the EDE file. The importer will add the device
ID as a prefix to avoid duplication of tag names.
Note: The importer will ask to locate the State-Texts, Unit-Texts and Object-Types files. Click Cancel to ignore.
The following dialog shows which importer type can be selected.
Importer Description
BACnet EDE v1.0 Requires a .csv file.

Linear
All variables will be displayed at the same level.
BACnet EDE v1.0 Requires a .csv file.

Hierarchical
All variables will be displayed according to BACnet EDE Hierarchical view.
Tag Editor exported Select this importer to read a generic XML file exported from Tag Editor by
xml appropriate button.
BACnet
Import Tag(s).

Update Tag(s).
dictionary import.

item selected.
For tags referring to BACnet objects of type Calendar or Schedule the tag refresh rate is set to “Manual”.
The following BACnet object properties are required for operation of the widgets.
Object Tags to import
Calendar Date_List
Schedule Weekly_Schedule
Exception_Schedule
Default_Value
Effective_Period
DEVICE Object Properties

A BACnet network scanner can detect properties when exploring the network and obtaining data from HMI device.
This are the supported DEVICE object properties:
Object_Identifier BACnetObjectIdentifier
Object_Name CharacterString
BACnet
Object_Type BACnetObjectType
System_Status BACnetDeviceStatus
Vendor_Name CharacterString
Vendor_Identifier Unsigned16
Model_Name CharacterString
Firmware_Revision CharacterString
Application_Software_Version CharacterString
Protocol_Version Unsigned
Protocol_Revision Unsigned
Protocol_Services_Supported BACnetServicesSupported
Protocol_Object_Types_Supported BACnetObjectTypesSupported
Object_List BACnetARRAY[N]of BACnetObjectIdentifier
Max_APDU_Length_Accepted Unsigned
Segmentation_Supported BACnetSegmentation
APDU_Timeout Unsigned
Number_Of_APDU_Retries Unsigned
Device_Address_Binding List of BACnetAddressBinding
Database_Revision Unsigned
BACnet Alarm Events
The special “protAlarm:BACN” trigger mode, available from the Alarms Editor, give the possibility to receive alarm events
from the BACnet native alarms module.
deviceID Identifies the BACnet device in the network.
notificationClassID Notification Class ID to subscribe for the alarm events retrieving
processID Not used
activeMonday Define in which days keep active the alarm events subscription
activeTuesday
l False
activeWednesday
Subscription not active
activeThrusday
activeFriday l True
activeSaturday Subscription active
activeSunday
startHour Define the time window where the alarm events subscription will be active
startMinute
startSecond
endHour
endMinute
endSecond
The alarm widgets will report the alarm information that are provided from the BACnet device.
BACnet
When the special “protAlarm:BACN” trigger mode is used, the widget of the active alarms show the timestamp
provided from the BACnet device while the widget of the historical alarms show the timestamp of when the alarm
events are received from the HMI device. Generally, both timestamps are the same but if you need to show the
timestamp from the BACnet device even inside the widget of the historical alarms you can add a new column
configured to use the “allSourceTimestamp” value from the alarm history widget.
BACnet alarm is a special alarm that require a double space to be stored inside the events buffer. This
means, for example, if the events buffer is configured to contain 1.000 events only the last 500 BACnet
events will be stored.
BACnet Trend Buffer
To use a BACnet trend object as a trend buffer:
1. Open the Trends Editor

2. Click the "Add PLC Trend" button (This button is enabled only when at least one BACnet protocol is configured)
3. Configure the below parameters to identify the BACnet trend object to use.
Device ID Identifies the BACnet device in the network.
Object ID BACnet ID of the trend object to be referenced.
Bit Index When the data type is boolean, it is the index to select the bit to use inside the
BACnet bit_string. It is not used with the other data types.
Data type Specify the type of data of the BACnet trend object. The supported data types
are:
l boolean
l int
l unsignedInt
l float
Time Specification Time format used inside the selected BACnet trend object
l local
l global (UTC)
The trend buffer thus configured can then be used inside any trend widgets.
BACnet Calendar Widget
Use Calendar widget to display content of a BACnet Calendar object.
BACnet
Date_List Connect to the "Date_List" tag of a BACnet calendar object in ReadOnly or

Read/Write.
Note: it can be connected to an alias which indexes a list of BACnet

calendar Date_List(s), in order to use one calendar widget for more
than one calendar object.
Operation of Calendar Widget

The widget shows data for one month.
Use the < and > buttons to select the month to be displayed. The date of first day of the month is shown.
Swing gesture can be used on the widget to select the date.
New
Press the button “New” to enter a new calendar item. The button is active only if the tag associated to the calendar has
been configured as Read/Write.
Calendar item Description
Single Click on a day to select a single day into the calendar
Range Click on the first day and on the last day to select a range of days into the
Calendar item Description
calendar.
l Single click on a day to change previous selected last day of the range.
l Double click on a day to change previous selected first selected day of
the range.
MWD Select a Day or a Week for each year or each month.
Clear All
Press the button “Clear All” to clear the content of the calendar object. The button is active only if the tag associated to the
calendar has been configured as Read/Write. The button is configured to react to an onMouseHold event, to reduce risk of
data loss.
Refresh
Press the “Refresh” button to start a manual refresh of the data of the widget. Always press the Refresh button after
entering data in the calendar.
BACnet Schedule Widget
Use Schedule widget to display content of BACnet Schedule object.
BACnet
Type Select the type of BACnet object controlled by the schedule.
Options are:
l Binary
l Real
l Multistate
Weekly_Schedule Attach to the Weekly_Schedule tag of the schedule object. The tag can be Read
Only or Read/Write.
Exception_Schedule Optionally attach to the Exception_Schedule tag of the schedule object. The tag
can be Read Only or Read/Write. Only attach this property if exceptions are used.
Default_Value Optionally attach to the Default_Value tag of the schedule object. The tag can be
Read Only or Read/Write. Only attach this property if default values are used.
Cal. 0 (Date_List) Optionally attach to the Date_List tag of the schedule widget in Read Only mode.
Use this options to show the “calendar reference” exceptions.
Note: An exception can be a single date, a date range, a mwd or a

calendar reference. In this last case, exception_list does not contain the
date information, but only time-value-priority and a reference to the
calendar. The date_list needed to show the scheduling into the widget is
stored into the relative BACNCalendar, and this is why we need this
datalink. If there is no need to show calendar exceptions in the schedule,
this property can be left void.
Note: If it is not attached to a calendar, it is not possible to insert

calendar exception. See BACNSchedKeypad for details.
Cal. 0 (Object_Name) Optionally attach to the property of the calendar. This name is used to identify the
calendar in the BACNSchedKeypad used to insert calendar exceptions. If Object_
Name is not attached, the calendar is identified with its instance number. This
property is used only if a Cal. 0 (Date_List) is attached to a calendar.
Cal. 1 (Date_List) Option for a second calendar.
Cal. 1 (Object_Name) Option for a second calendar.
Value-color-text Map Defines the association value – Color/Text shown in the schedule. Use this option
to define all possible values available in the BACNSched keypad.
Operation of Schedule Widget

The widget shows data for one week.
Use the < and > buttons to select the week to be displayed. The date of first day and last day of the week is shown.
Swing gesture can be used on the widget to select the date.
New
Press the button “New” to enter a new schedule item. The button is active only if the tag associated to Weekly Schedule or
Exception Schedule has been configured as Read/Write.
BACnet
Schedule item Description
Weekly Select the day and click Weekly button, the following dialog box appears. Then
select the desired value and the time when it should be set. Press OK to
confirm the new item.
Exception Click on a day to select a single day into the calendar.

Single
On the next dialog select the time window, the desired value and its priority.
Exception Click on the first day and on the last day to select a range of days into the
Range calendar.
l Single click on a day to change previous selected last day of the range.
l Double click on a day to change previous selected first selected day of
the range.
Schedule item Description
Exception Select a Day or a Week for each year or each month.

MWD
Exception This option is available only if scheduler is linked to a calendar (configured as

Cal Ref Read/Write)
Select the time window, the desired value and its priority. Value will set on all
days defined from the calendar. If there are more calendars associated with
Scheduler widget, select the calendar to use.
Clear All
Press the button “Clear All” to clear the content of the schedule object. The button is active only if the tag associated to the
calendar has been configured as Read/Write. The button is configured to react to onMouseClick and onMouseHold events.
The onMouseHold event will clear all data in the schedule. The onMouseClick event will recall a dialog box for selection of
data to clear. It is needed to choice to clear weekly data or exception data.
Refresh
entering data in the schedule.
BACnet Effective Period Widget

Use the Effective Period widget to feed information to the Effective_Period tag of a Schedule object, if this is requested.
BACnet Effective_ Attach to the Effective_Period tag of the Schedule object

Period
BACnet
Operation of Effective Period Widget

The widget shows starting date and end date for the period.
Click on the area showing the dates to activate the data entry procedure showing the keypad BACNDateRange.
The keypad shows data for one month.
Use the < and > buttons to select the month to be displayed. The date of first day of the month is shown.
You may use the swing gesture on the widget to select the date.
Select the period clicking of first day and last day of the period. The Effective_Period is show with a different color.
The keypad offers three predefined options:
Option Description
Always The schedule will be always active.
All Month The selected period will be extended to all months.
All Year The selected period will be extended to all years.
Option Description
Refresh
entering data in the widget.
BACnet Keypads
BACnet widgets require dedicated keypads for data entry.
Keypad Description
BACNCal Keypad for BACnet Calendar.
BACNDateRange Keypad for BACnet Effective_Period.
BACNDefVal Keypad for default value (embedded in the BACnet Schedule).
BACNSched Keypad for BACnet Schedule.
This keypad is context sensitive. It will show different options depending on

the type of schedule.
The system is configured to recall the appropriate keypad for each BACnet widget.
manual.
Error Cause
Cannot bind to the device_id Cannot establish communication with the Device ID provided for this tag.
Cannot read the property The type of the property to write cannot be determined.
data type
write conversion error A conversion associated to this tag has failed.
Cannot write ICOM type …. A datatype selected for this tag is not compatible with the BACnet
BACnet type …. property to set.
Timeout on COV A request for COV subscription for this tag has timed out.
subscription
Timeout on waiting COV A COV notification has not been received for this tag whithin timeout.
update
BACnet
Error Cause
Can't get COV for this The selected property for COV notification is unsupported.
property
datagramItem conversion A conversion associated to a tag that is part of a datagram has failed.
error
Timeout waiting on response No response for a request of read or write property within timeout.
datagram element …., no No data available for a tag that is part of datagram.
data available
datagram element …., Read datagram element is of unsupported BACnet type.

Unsupported BACnet data
type
datagram element …., can't A Data Type selected for a tag which is part of a datagram is not
convert BACnet type to …. compatible with the BACnet property to read.
No data in response No data available for a tag.
Datagram element 'element_ The reading of indicated datagram element 'element_URI' was reported
URI' error: 'error_class': as error. The error descriptions error_class and error_code are included
error_code in the message.
datagram object does not The object of the received datagram item does not match the asked
match object.
datagram property does not The property of the received datagram item does not match the asked
match property.
BACnet abort: reason_of BACnet abort message was received. The reason of abort is given.
abort
BACnet reject: reason_of_ BACnet reject message was received. The reason of rejection is given.
rejection
BACnet error: error_class: BACnet error message was received. The error description is given as
error_code combination of error_class and error_code.
parameter 'parameter_name' The protocol parameter parameter_name value is out of range.

out of range
CODESYS V2 ETH
CODESYS V2 ETH communication driver for supports communication through Ethernet connection with controllers based
on the CODESYS V2.3 version.
Protocol Editor settings

Adding a protocol

Element Description
IP address Ethernet IP address of the controller.
Port Port number used by the CODESYS V2 Ethernet driver. The default value is set to 1200,
which is also the default setting of CODESYS-based controllers.
Block Size Maximum block size supported by your controller (limit is 1024 KB ).
CODESYS V2 ETH
Element Description
Timeout Time delay in milliseconds between two retries of the same message when communication
(ms) fails.
Protocol Protocol variant to be used. Please make sure you check which protocol variant is supported
type by the CODESYS runtime you want to connect.
Source Available only when TCP/IP Level 2 Route is selected in Protocol Type. The Destination is
Address, the node of the PLC and allows the protocol to read variables in a sub-network. The address is
Destination used to read variables when multiple PLCs are connected in a sub-network (serial network)
Address but only one have the Ethernet interface.
PLC Two PLC models are available.

Models
l Intel
l Motorola
PLC IP address for all controllers in multiple connections. PLC network check box must be
Network selected to enable multiple connections.
CODESYS V2 Ethernet driver supports connection to multiple controllers starting from version V1.60.
Note: CODESYS V2 Ethernet driver is recommended when creating projects for the internal controller iPLC
CODESYS. To use the CODESYS V2 Ethernet driver with iPLC, configure the IP address of the PLC as
localhost (127.0.0.1).
iPLC CODESYS supports communication with CODESYS V2 Ethernet driver with symbol based support starting from
V1.55 and above.

CODESYS software settings

When creating the project in CODESYS, select Download symbol file.
CODESYS V2 ETH
Note: CODESYS V2 Ethernet communication driver supports the automatic symbol file (SDB) upload from the
PLC; any change in the tag offset due to new compilation of the PLC program does not require a symbol file re-
import. Tag file has to be re-imported only in case of tag rename or definition of new tags.
When the option Download symbol file is not available or cleared, the protocol can work only if the ProjectId tag is
imported. If the tag offset changes because of a new compilation of the PLC program, the symbol file must be re-imported.
Data types
Supported l BOOL
data types l WORD
l DWORD
l INT
l UINT
l UDINT
l DINT
l STRING *
l REAL
l TIME
l DATE & TIME
manual.
Unsupported l LWORD
data types l LINT
l LREAL
Tag conversion
CODESYS V2 ETH
Value Description
Example:
Example:
25.36 → -25.36
Example:
Example:

GHEFCDAB
Example:
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
Example:
0001 0111 = 23
Node Override IP
anymore.
variable.
Tag Import
Exporting Tags from PLC
When configuring PLC using the manufacturer’s configuration software, enable Symbol file (.sym extension) creation under
the CODESYS programming software:

2. Click Symbol configuration.
4. Click OK.
CODESYS V2 ETH
Note: Click then Configure symbol file… and select Export variables of object. We recommend to clear the
check box and re-select to be sure about the proper settings.
In some cases, duplication of symbols for variables associated to integrated I/O modules in the “.sym” file may be
experienced. To remove the duplication selected the “PLC Configuration” voice from the objects list and uncheck the option
“Export variables of object”.
Importing Tags in Tag Editor

CODESYS2 sym v1.1 Requires a .sym file.

Linear

Hierarchical
All variables will be displayed according to CODESYS V2 Hierarchical view.
CODESYS2 sym_xml Requires a .sym_xml file.

v1.0
Hierarchical
CODESYS V2 ETH
Import Tag(s).

Update Tag(s).
dictionary import.

item selected.
Exporting tag arrays

In CODESYS V2 program tag arrays are split into individual elements and one tag for each element is created. In the
following example one array with 10 elements.
CODESYS V2 ETH
Note: If Export array entries is selected, a tag for each element will be created and exported into the .sym file.
The entire tag list will be automatically imported into the Tag editor.
By clearing Export array entries only one tag for each one array can be created.
Note: When Export array entries has been cleared, only one tag is created and exported into the .sym file. The
array is not automatically imported in the Tag editor and tags need to be manually configured in Tag editor.
All tag elements can be referenced in the editor using TagIndex in the Attach to Tag dialog.
CODESYS V2 ETH
manual.
Symbols file not present Check Symbol file and download again the PLC program.
“tag” not present in Symbols files Check if the Tag is present into the PLC project.
Time out on Acknoledge Controller didn’t send acknowledge.
Time out on last Acknoledge Controller didn’t sent last ack.
Time out on data reciving Controller does not reply with data.
Connection timeout Device not connected.
CODESYS V3 ETH
The CODESYS V3 ETH communication driver supports communication thought Ethernet connection with controllers
based on the CODESYS V3 PLC software by the company 3S.
Note: To accommodate developments in the controller protocol and hardware, drivers are continuously updated.
Make sure the latest driver is used in the application.
Note: Changes in the controller protocol or hardware may have occurred since this documentation was created.
This may interfere with the functionality of this driver. Therefore, always test and verify the functionality of the
application.

Adding a protocol

Element Description
Alias Name to be used to identify nodes in network configurations. The name will be added as a prefix
to each tag name imported for each network node.
IP Ethernet IP address of the controller

address
Full Since some implementations of CODESYS V3 at runtime require all four values of the IP address
CODESYS V3 ETH
Element Description
node to be specified in the protocol frames, this flag forces the protocol to create IP addresses using all
address four address fields of the IP.
Variable Variable List is the best method to achieve higher performance in the CODESYS V3
list communication protocol, as it allows requesting multiple data items in a single protocol session.
count
Since some implementations of CODESYS V3 at runtime have a limited number of Variable Lists
that can be allocated, this parameter allows you to set the maximum number of Variable Lists the
communication driver tries to create in the PLC.
PLC Byte order that will be used by the communication driver when sending communication frames to
Model the PLC.
Timeout Number of milliseconds between retries when communication fails.
PLC Enable access to multiple networked controllers. For every controller (slave) set the proper
Network option.
Note: Refer to the controller documentation to verify required values for the parameters Full node address or
Variable list count.
Tag Import
Exporting Tags from PLC
When creating the project using CODESYS V3, properly configure the symbol file to contain the required variables.
1. To add the Symbol configuration in CODESYS V3 project, right click on the Application item from the project tree,
then into the context menu select Add Object > Symbol configuration. The symbol configuration item will be added
to the project tree.
CODESYS V3 ETH
2. Double click on Symbol configuration item, then click on "Build" button.
3. Symbol configuration item contains a list of all the variables available into the CODESYS V3 project, single
variables or groups of variables can be selected by checking the corresponding item in the list.
4. After the symbols have been configured, download the project or use the Generate code function (Build > Generate
code) to create an .xml file containing all the variables read to be imported in the Tag Editor.
Note: GVL global variables are listed in Symbols Configuration only if they are used in PLC program.
To always list global variables right click on GVL and select "Properties". From "Build" tab check "Link Always"
option.
CODESYS V3 ETH
Importing Tags in Tag Editor

CODESYS3 xml v1.0 Requires an .xml file.

Linear
CODESYS3 xml v1.0 Requires an .xml file.

Hierarchical
Import Tag(s).

Update Tag(s).
dictionary import.
CODESYS V3 ETH

item selected.

Data Types
CODESYS V3 ETH
Supported l BOOL
data types l INT
l SINT
l UINT
l UDINT
l DINT
l STRING*
l REAL
l LREAL
l BYTE
l ULINT
l LINT
manual.
Unsupported l LWORD
data types l LINT
Tag conversion
Value Description
Example:
Example:
25.36 → -25.36
Example:
Example:

GHEFCDAB
Example:
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
Example:
0001 0111 = 23
CODESYS V3 ETH
Node Override IP
anymore.
variable.
Application Status
The protocol provides the special data type Application Status which allows you to check or change the applications
status.
The tags pointing to Application Status must contains into field "Tag name" the name of the PLC application (frequently the
default name is "Application")
If the HMI device is connected to a network with more than one controller node, each node has its own Application Status
variable.
Application Status Description
0 RUNNING
1 STOPPED
2 HALTED ON BreakPoint
Note: It is not possible to write 2 as new status
Communication Status
manual.
Ethernet/IP CIP
Ethernet/IP CIP
The protocol has been implemented according to the published Ethernet/IP specifications (available from www.odva.org).
The Ethernet/IP CIP driver has been designed to provide the best performance with the least amount of impact on the
system's overall performance. Although the Ethernet/IP CIP driver is fast, we suggest to use short Tag names. Tags are
read from and written to the device by specifying their symbolic name in the communications request, therefore the longer
the tag name is, the larger the request will be.

Adding a protocol

Field Description

Address
Slot CPU slot number for Logix 5000 models (typically 0). Refer to the controller documentation for
further details.
Field Description
PLC PLC model used to import tags file.

Models
Network option.
Controller Model Logix 5000

The Ethernet/IP CIP driver allows to connect Allen-Bradley ControlLogix and CompactLogix Ethernet controllers.
Communication with ControlLogix® 5500 controllers can be accomplished through an Ethernet/IP communication module
for Ethernet such as the 1756-EN2T or 1756-ENET.
Ethernet communication with CompactLogix™ 5300 controllers requires a processor with a built-in Ethernet/IP port such
as the 1769-L32E.
All trademarks are the property of their respective owners.
The internal memory organization of the Logix CPUs is not fixed but configured by the user at development time. Each data
item can be identified by a string called “Tag”. The RSLogix 5000 software can then export to the application the list of Tags
created for each controller.
The project loaded on the HMI device must refer to Tag names assigned in RSLogix 5000 software at development time.
The Tag Editor supports direct import of the Tag file generated by RSLogix 5000 software in .CSV format.
The implementation of the Ethernet/IP driver also supports access to structured data types which can be imported from
.L5X files.
The driver supports access to both Controller and Program Tags.
Export CSV and L5X files using RSLogix5000

To export the .CSV Tag file:
1. From the Controller Organizer pane, right-click on Controller Tags.

2. Select Export Tags: the Export dialog is displayed.
Ethernet/IP CIP
3. Choose All from the Tags list to export all Tags.

4. Select the Save as type option to .CSV.
5. Click Export: all the Tags are exported to an .CSV file.
To export the .L5X data type file:
1. Choose File > Save As.

2. Select the Save as type option to .L5X.
3. Click Save: all the Tags are exported to an .L5X file.
Import Files in Tag Editor

Ethernet/IP CIP
Select Allen-Bradley RSLogix5000 v15 option.
Import Tag(s).

Update Tag(s).
dictionary import.

item selected.
Note: When importing the array data types, the importer is expanding them creating individual Tags per each
array element; this is valid for all the data types, except for arrays of boolean. In this case they are imported as
“boolean-32” and the single array element can be addressed using “Tag Index” parameter from “Attach to…”
dialog.
Module-Defined and User-Defined data types

RSLogix 5000 allows you to define Tags with several data types.
Data type group Description
Predefined Standard data types such as BOOL, DINT, SINT, INT

and other less common data types such as PID, COUNTER, TIMER.
Module-Defined Data type associated with I/O optional modules usually referenced by aliases.
User-Defined Custom data type defined by user
Ethernet/IP CIP
In order to import Predefined (with the exception of standard data types which are always imported) and Module-Defined
data type you need to edit the ETIPSpecialDataTypes.xml file located under languages\shared\studio\tagimport or
studio\tagimport depending on installed version.
In RSLogix5000 software:
1. From the Controller Organizer pane, select Controller Tags.
2. Filter tags to display only Module-Defined Tags.
Only tags (alias) with data type belonging to optional I/O Modules will be displayed.
Ethernet/IP CIP
In this example alias HYS_Point_IO_Rack_20:I refers to data type AB:1734_3SLOT:I:0. Expand this tag to see how this
data type is structured:
To make sure that HYS_Point_IO_Rack_20:I, and all his sub-tags, will be imported into the project, open the
ETIPSpecialDataTypes.xml file in any text editor and check if the AB:1734_3SLOT:I:0 data type is included. If so you can
proceed with the following data type. If not, you need to add it manually.
The structure is as in this example:
where:
l aaa = Alias/Tag data type

l bbb = Sub-tag Name (it's sub-tag name part after dot)
l ccc = Sub-tag data type
l ddd = Array dimension (0 if it is not an array)
l eee = Style
In the example above:
3. Repeat step 2 for all Module-Defined data types.

4. Repeat the procedure from step 2, filtering Tags to display only Predefined Tags.
Controller Model Omron Sysmac

Data in NJ and CJ controllers can be accessed via CIP protocol.
Each data item can be identified by a string called “Tag”. Use appropriate programming tools for controller to export the list
of Tags.
NJ series controller are programmed using Sysmac Studio:
l NJ301-xxxx
l NJ501-xxxx
CJ series controller are programmed using CX-One:
l CJ2M CPU-3x
l CJ2H CPU 6x-EIP
l Any CPU with a CJ1W-EIP21 attached.
The project loaded on the HMI device must refer to the Tag names assigned in the programming software at development
time. The Tag Editor supports direct import of the Tag file generated by Sysmac Studio software in .NJF format or
generated by CX-One in the .CJF format.
All Tags to be accessed by the HMI device must be declared as Global Variables.
Export NJF files using Sysmac Studio

To export the .NJF Tag file:
1. In Sysmac Studio declare Tags as Global Variables.

2. Set the Network Publish attribute to Publish Only.
2. From the Tools menu, choose Export Global Variables > CX-Designer.
Ethernet/IP CIP
4. Cut and paste the content of the clipboard in any text editor.
4. Save the file as .NJF.
Note: Using Notepad as text editor, make sure to save the text file with .NJF extension by selecting "Save as
type" as "All Files" although the file will be named *.njf.txt and it will not be visible from importer.
Export CJF file using CX-One

To export the .CJF Tag file:
1. In CX-One open the Symbols file in the project.

2. In the Edit Symbol dialog set the Net. Variables attribute to Publication.
3. Copy and paste all the Tags in any text editor.
4. Save the file as .CJF.
Note: Using Notepad as text editor, make sure to save the text file with .CJF extension by selecting "Save as
type" as "All Files" although the file will be named *.cjf.txt and it will not be visible from importer.
Export User Defined structures

To export the .CJS Tag file:
Ethernet/IP CIP
1. In CX-One open the Data Types file in the project.
2. Copy and paste all the Tags in any text editor.
3. Save the file as .CJS.
Note: Using Notepad as text editor, make sure to save the text file with .CJS extension by selecting "Save as
type" as "All Files" although the file will be named *.cjs.txt and it will not be visible from importer.

Select Omron Sysmac to import a .NJF Tags file or Omron CX-One to import a .CJF Tags file.
Once the importer has been selected, locate the Tags file and click Open. The system will ask for User Defined structures
.CJS file. If not required, skip the dialog by clicking on Cancel button.
Ethernet/IP CIP
Import Tag(s).

Update Tag(s).
dictionary import.

item selected.
Note: When importing the array data types, the importer is expanding them creating individual Tags per each
array element; this is valid for all the data types, except for arrays of boolean. In this case they are imported as
“boolean-32” and the single array element can be addressed using “Tag Index” parameter from “Attach to…”
dialog.
Controller Model Micro800

The Ethernet/IP CIP driver provides an easy and reliable way to connect to Allen-Bradley Micro800 controllers.
The scope of variables into a Micro800 controller can be local to a program or global:
Scope Description
Local Variables Program-scoped Tags. Tags are assigned to a specific program in the project and available only
to that program.
These Tags are not supported within this driver.
Global Variables Controller-scoped Tags. Tags belong to the controller in the project and are available to any
program in the project.
These Tags are supported within this driver.
Export ISAXML file using Connected Component Workbench

To export .ISAXML global variables including I/O tags:
Ethernet/IP CIP
1. Select Device tab.

2. Expand Export item.
3. Select Export Device.
4. Click onExport Exchange File tab.

5. Click Export button.
6. Choose a location where to save the export file and click Save.
7. When the export is completed successfully the output information is displayed:
Ethernet/IP CIP
Note: CCW export file is a 7-zip compressed archive. Use a suitable zip utility to extract archive content into a
local folder.

Select Allen-Bradely CCW v15 option.
Directory structure extracted from 7z file is something like: “..\<folder_name>\Micro8xx\Micro8xx\”
Inside this last folder, select the Micro8xx.isaxml file as shown below:
Ethernet/IP CIP
Import Tag(s).

Update Tag(s).
dictionary import.

item selected.

Note: Aliasing tag names is only available for imported tags. Tags which are added manually in the Tag Editor do
not need to have the Alias prefix in the tag name.
The Alias string is attached on the import. If you modify the Alias string after the tag import has been completed,
there will be no effect on the names already present in the dictionary. When the Alias string is changed and tags
are re-imported, all tags will be re-imported with the new prefix string.
Node Override IP
anymore.
variable.
Ethernet/IP CIP
Tag Import
Allen-Bradley L5X v1.1 Requires a .L5X file.

Hierarchical
Check Controller Model Logix 5000 for more details.
All variables will be displayed according to RSLogix5000 Hierarchical view.
Allen-Bradley Requires a .CSVand .L5X (optional) files.

RSLogix5000 v15
Check Controller Model Logix 5000 for more details.
Linear
Allen-Bradley CCW v15 Requires a .ISAXML file.

Linear
Check Controller Model Micro800 for more details.
Omron Sysmac v15 Requires a .NJF file.

Linear
Check Controller Model Omron Sysmac for more details.
Ethernet/IP CIP
Omron CX-One v15 Requires a .CJFand .CJS (optional) files.

Linear
Check Controller Model Omron Sysmac for more details.
Tag Editor exported xml Select this importer to read a generic XML file exported from Tag Editor by
appropriate button.
Import Tag(s).

Update Tag(s).
dictionary import.

item selected.
manual.
Error Cause Action
Invalid The device did received a response with invalid Ensure the data programmed in the project are
response format or contents from the controller . consistent with the controller resources.

Error
Modbus RTU
Modbus RTU
The operator panels can be connected to a Modbus network as the network master using this communication driver.
The Modbus RTU implementation supports only a subset of the Modbus standard RTU function codes.
16 Preset Multiple Registers Presets value in multiple Registers

Adding a protocol

Element Description
Timeout (ms) Time delay in milliseconds between two retries in case of missing response from the server
device.
Delay (ms) Time delay in milliseconds between the end of the last received frame and the starting of a
When set to 1 the panel will report the communication error if the response to the first
request packet is not correct.
Modbus RTU
Element Description
Max read Maximum length in bytes of a data block request. It applies only to read access of Holding
block Registers.
Max read bit Maximum length in bits of a block request. It applies only to read access of Input Bits and
block Output Coils.
Write Modbus function for write operations to Holding Registers. Select between the function 06
Holding (preset single register) and function 16 (preset multiple registers).
Register
If function 06 is selected, the protocol will always use function 06 for writing to the
controller, even when writing to multiple consecutive registers.
If function 16 is selected, the protocol will always use function 16 to write to the controller,
even for a single register write request and the Max read block size parameter of the query
is set to 2. The use of function 16 may result in higher communication performance.
Write Coils Modbus function for write operations to Output Coils. Select between the function 05 (write
single coil) and function 15 (write multiple coils).
If Modbus function 05 is selected, the protocol will always use function 05 for writing to the
controller, even when writing to multiple consecutive coils.
If Modbus function 15 is selected, the protocol will always use function 15 to write to the
controller, even for a single coil write request. The use of function 15 may result in higher
communication performance.

Note: When PLC network is active, all nodes will be configured with the same
Transmission Mode.
PLC Models Allows to select between different PLC models:
l Modicon Modbus (1-based): Modbus implementation where all resources starts

with offset 1.
l Generic Modbus (0-based): Modbus implementation where all resources starts
with offset 0.
l Enron Modbus (1-based): Extends Modicon Mobdus implementation with 32 bit
registers memory area.
l Enron Modbus (0-base): Extends Generic Modbus implementation with 32 bit
Note: The address range used in the Modbus frames is always between 0 and
65535 for the Holding Registers and between 0 and 65535 for Coils.
Element Description
Element Parameter
l COM1: On-board port

l COM2: Optional Plug-in
module plugged on slot#1
or slot#2
l COM3: Optional Plug-in
module plugged on slot#3
or slot#4
Mode Serial port mode. Available

modes:
l RS-232.
l RS-485 (2 wires).
l RS-422 (4 wires).
PLC Network Multiple controllers can be connected to one HMI device. To set-up multiple connections,
select PLC networkand click Add to configure each slave
Tag Editor Settings


2. Select Modbus RTU from the protocol list: tag definition dialog is displayed.
Modbus RTU
Element Description
Memory Modbus resource where tag is located.

Type
Memory Type Description
Coil Status Coils
Input Status Discrete Input
Input Registers Input Registers
Holding Registers Holding Registers
32 bit Registers 32 bit registers memory area.
Available only for Enron Modbus PLC Models
Node Override ID
Modicon Mode
Serial Baudrate
protocol parameter (see Special Data Types for mode
Serial Parity
details)
Serial Stop Bits
Serial Mode
Serial Done
Offset Offset address where tag is located.
Offset addresses are six digits composed by one digit data type prefix + five digits resource
address.
Generic
Studio Modicon Modbus
Memory Type
Offset range Offset range Offset
range
Coil Status 0 – 65535
Input Status 100000 – 165535

0–
Input Registers 300000 – 365535 1 – 65536
65535
Holding Registers 400000 – 465535
32 bit Registers 0 – 65535
SubIndex This allows resource offset selection within the register.
Modbus RTU
Element Description
byte 8-bit data -128 ... 127
short 16-bit data -32768 ... 32767
int 32-bit data -2.1e9 ... 2.1e9
int64 64-bit data -9.2e18 ... 9.2e18
uint64 64-bit data 0 ... 1.8e19

point type
double IEEE double-precision 64-bit floating 2.2e-308 ...

point type 1.79e308

selected encoding
Note: to define arrays. select one of Data Type format followed by square brackets
like “byte[]”, “short[]”…
l In case of string tag, this property represents the maximum number of bytes available
in the string tag.
Note: number of bytes corresponds to number of string characters if Encoding property is set
to UTF-8 or Latin1 in Tag Editor.
requires 2 bytes.
Conversio Conversion to be applied to the tag.

n
Element Description
Value Description
Example:
Example:
25.36 → -25.36
Example:

CDAB
Example:
ABCDEFGH - swap4: Swap bytes in a double word.

> GHEFCDAB
Example:

OPM...DAB
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
Modbus RTU
Element Description
Value Description
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
to 9)
Example:
0001 0111 = 23
Configured).
Node Override ID
The protocol provides the special data type Node Override ID which allows you to change the node ID of the slave at
runtime. This memory type is an unsigned byte.
Node
Modbus operation
Override ID
Modicon Mode
The protocol provide a special data type that can be used to override the Modicon Mode parameter at runtime.
Modicon Mode Description
0 Generic Modbus (0-based). Register indexes start from 0.
1 Modicon Modbus (1-based). Register indexes start from 1.
Note: Modicon Mode parameter value assigned at runtime is retained through power cycles.
Modbus RTU
Serial Parameters Override

The protocol provide special data types that can be used to override the serial parameters at runtime.
Serial Baudrate unsigned 32 bit value for baudrate overriding. Possible values are 150, 300, 600, 1200, 2400, 4800,
9600, 19200, 38400, 57600, 115200.
Serial Parity unsigned 8 bit value for parity overriding. Possible values are described in the following list.
Value Description
0 none parity
1 even parity
2 odd parity
Serial Stop Bits unsigned 8 bit value for stop bits overriding. Possible values are 1, 2.
Serial Mode unsigned 8 bit value for serial mode overriding. Possible values are described in the following list.
Value Description
0 RS-232 mode
1 RS-485 mode
2 RS-422 mode
Serial Done Set to 1 to overwrite the communication line parameters. The parameters are processed all together
only when this variable is set to value 1
Tag Import
Modbus RTU
Type Description
Modbus Generic csv Requires a .csv file.

v1.0
Linear
DELTA PLC csv v1.0 Requires a .csv file.
Schneider Unity v1.0 Requires a .uny file.

Linear
The file containing symbols must be exported in .txt format and later renamed
as .uny. The importer considers only variables located at fixed address and
disregards arrays of strings. All other arrays, except for boolean type, are
expanded.
appropriate button.
Import Tag(s).

Update Tag(s).
dictionary import.
Modbus RTU

item selected.
Modbus Generic csv file structure

This protocol supports the import of tag information when provided in .csv format according to the following format:
NodeID, TagName, MemoryType, Address, DataFormat,...,[Comment]
Note: Fields in brackets are optional as well as fields between Data Format and Comment.
Field Description
NodeID Node the tag belongs to
TagName Tag description
MemoryType l OUTP
l INP
l IREG
l HREG
Address Offset compatible with Modbus notation
DataFormat Data type in internal notation. See "Programming concepts" section in the main manual.
Comment Optional additional description.
Tag file example

Example of .csv line:
2,Holding Register 1, HREG, 400001, unsignedShort,
Note: This line has no comment. When the Comment is missing, the comma as a terminator character is
mandatory.
manual.
Error Cause Action
No response No reply within the specified timeout. Check if the controller is connected and
properly configured to get network access.
Incorrect node The device received a response with an invalid -

address in node address from the controller .
response
The received The device received a response with an invalid -

message too short format from the controller .
Incorrect writing The controller did not accept a write request. Check if project data is consistent with the
data acknowledge controller resources.
Modbus RTU Server
Modbus RTU Server

Modbus RTU Server communication driver allows connecting the HMI device as a slave in a Modbus RTU network.
Standard Modbus messages are used for information exchange.
This approach allows connecting HMI devices to SCADA systems through the universally supported Modbus RTU
communication protocol.
Principle of operation
This communication driver implements a Modbus RTU slave unit in the HMI device. A subset of the complete range of
Modbus function codes is supported. The available function codes allow data transfer between the master and the slave.
The following diagram shows the system architecture.
The HMI device is actually simulating the communication interface of a PLC: Coils and Registers are respectively boolean
and 16 bit integers.
The device always access data in its internal memory. Data can be transferred to and from the Modbus Master only on
initiative of the Master itself.
This Modbus RTU slave implementation supports only a subset of the standard Modbus function codes.
01 Read Coil Status Reads multiple bits in the device Coil area.
03 Read Holding Registers Read multiple device Registers.
05 Force Single Coil Forces a single device Coil to either ON or OFF.
06 Preset Single Register Presets a value in a device Register.
08 Loopback Diagnostic Test Only sub function 00 (Return Query Data) is supported.
15 Force Multiple Coils Forces multiple device Coils to either ON or OFF.
16 Preset Multiple Registers Presets value in multiple device Registers.
17 Report Slave ID Returns diagnostic information of the controller present at the slave
address.
23 Read Write Multiple Read & presets values in multiple device Registers
Registers
Exception Codes
Code Description
01 Illegal Function. the function code received in the query is not supported
02 Illegal Data Address. Data Address received in the query exceeds the predefined data range
(see Tag Definition for detailed ranges of all types).
03 Illegal Data Value. A sub function other than 00 is specified in Loopback Diagnostic Test (Code
08).

Adding a protocol

Modbus RTU Server
Elem
Description
ent
Modb Modbus node ID. Every Modbus server device in the network must have its own Modbus ID.
us ID
Enron If selected, allows to define the first register address and the number of registers for 32 bit registers
32bit memory area.
regist
Note: 32 bit registers are available only for Enron Modbus PLC Models.
ers
32 bit registries memory area definition.
32bit Start value represents the first register address.

reg
Size value represents the number of registries.
Start
Note: A request to one of the registries inside this area gives a 4 byte answer.
32bit
reg
Size
PLC Allows to select between different PLC models:

Model
l Modicon Modbus (1-based): Modbus implementation where all resources starts with offset
s
1.
l Generic Modbus (0-based): Modbus implementation where all resources starts with offset
0.
l Enron Modbus (1-based): Extends Modicon Mobdus implementation with 32 bit registers
memory area.
l Enron Modbus (0-base): Extends Generic Modbus implementation with 32 bit registers
memory area.
Elem
Description
ent
Note: The address range used in the Modbus frames is always between 0 and 65535 for
the Holding Registers and between 0 and 65535 for Coils.
Com If clicked, displays the communication parameters setup dialog.

m...
You have to set parameters according to the values programmed in Modbus Master.
Element Description
Uart Serial port selection.
l COM1: On-board port

l COM2: Optional Plug-in module plugged on
slot#1 or slot#2
l COM3: Optional Plug-in module plugged on
slot#3 or slot#4
Baudrate, Parity, Data bits, Serial line parameters.

Stop bits
Mode Serial port mode. Available options:
l RS-232
l RS-485 (2 wires)
l RS-422 (4 wires)
Tag Editor Settings

Modbus RTU Server

2. Select Modbus RTU Server from the protocol list: tag definition dialog is displayed.
Element Description

Type
Memory Type Modbus Resource
Coil Status Coils
Node Override ID
Modicon Mode
Serial Baudrate
protocol parameter (see Special Data Types for mode
Serial Parity
details)
Serial Stop Bits
Serial Mode
Serial Done
address.
Generic
Memory Type
range
Input Status 100000 – 165535

0–
Input Registers 300000 – 365535 1 – 65536
65535
Modbus RTU Server
Element Description
Data type Data Type Memory Space Limits
byte 8-bit data -128 ... 127
short 16-bit data -32768 ... 32767
int 32-bit data -2.1e9 ... 2.1e9
int64 64-bit data -9.2e18 ... 9.2e18
uint64 64-bit data 0 ... 1.8e19

point type

point type 1.79e308

selected encoding
Arraysize When configuring array or string tags, this option define the amount of array elements or
characters of the string.
Conversio Conversion to be applied to the tag.

n
Element Description
Value Description
Example:
Example:
25.36 → -25.36
Example:

CDAB
Example:

> GHEFCDAB
Example:

OPM...DAB
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
to 9)
Example:
0001 0111 = 23
Modbus RTU Server
Element Description
Configured).
Node Override ID
Node Override
Modbus operation
ID
0 Communication with the slave is stopped. In case of write operation, the device will not respond to
request frames.
Modicon Mode
Serial Parameters Override

The protocol provide special data types that can be used to override the serial parameters at runtime.
Serial Baudrate unsigned 32 bit value for baudrate overriding. Possible values are 150, 300, 600, 1200, 2400, 4800,
9600, 19200, 38400, 57600, 115200.
Serial Parity unsigned 8 bit value for parity overriding. Possible values are described in the following list.
Modbus RTU Server
Value Description
0 none parity
1 even parity
2 odd parity
Serial Stop Bits unsigned 8 bit value for stop bits overriding. Possible values are 1, 2.
Serial Mode unsigned 8 bit value for serial mode overriding. Possible values are described in the following list.
Value Description
0 RS-232 mode
1 RS-485 mode
2 RS-422 mode
Serial Done Set to 1 to overwrite the communication line parameters. The parameters are processed all together
only when this variable is set to value 1
Tag Import
Type Description

v1.0
Linear
Modbus RTU Server
Import Tag(s).

Update Tag(s).
dictionary import.

item selected.

Field Description
MemoryType l OUTP
l INP
l IREG
l HREG
Modbus RTU Server
Tag file example

mandatory.
Current communication status can be displayed using system variables. This communication protocol acts as server and
doesn't return any specific Protocol Error Message.
Modbus TCP
Various Modbus TCP-capable devices can be connected to HMI devices. To set-up your Modbus TCP device, please refer
to the documentation you have received with the device.
The implementation of the protocol operates as a Modbus TCP client only.
This Modbus TCP implementation supports only a subset of the Modbus TCP standard function codes.
01 Read Coil Status Reads multiple bits in the HMI device Coil area.
02 Read Input Status Reads the ON/OFF status of the discrete inputs (1x reference) in the
slave.
03 Read Holding Registers Reads multiple registers.
04 Read Input Registers Reads the binary contents of input registers (3x reference) in the slave.
05 Force Single Coil Forces a single coil to either ON or OFF.
06 Preset Single Register Writes a value to one register.
15 Write Multiple Coils Writes each coil in a sequence of coils to either ON or OFF.
16 Preset Multiple Writes values to a block of registers in sequence.

Registers

Adding a protocol

Modbus TCP
Element Description
IP address Address of the controller.
Port Port number used by the Modbus TCP driver. The default value is 502 and can be changed
when the communication goes through routers or Internet gateways where the default port
number is already in use.
use UDP/IP If selected, the protocol will use connectionless UDP datagrams.
Encapsulat If selected, the protocol will use serial RTU protocol over Ethernet instead of Modbus TCP
ed RTU protocol, independently from TCP or UDP usage.
(ms) device.
Element Description
Modbus ID Usually used when communicating over Ethernet-to-serial gateways and then interpreted as
the Slave ID. This value is simply copied into the Unit Identifier field of the Modbus TCP
communication frame. This must correspond to server configuration. In most cases, server
answers to Modbus ID 1, so this parameter can be left 1.
Max read Maximum length in bytes of a data block request. It applies only to read access of Holding
block Registers.
Max read bit Maximum length in bits of a block request. It applies only to read access of Input Bits and
block Output Coils.
Write Modbus function for write operations to Holding Registers. Select between the function 06
Holding (preset single register) and function 16 (preset multiple registers).
Register
If 06 is selected, the protocol will always use function 06 for writing to the controller, even
when writing to multiple consecutive registers.
If 16 is selected, the protocol will always use function 16 to write to the controller, even for a
single register write request and the Max read block size parameter of the query is set to 2.
The use of function 16 may result in higher communication performance.
If Auto is selected, the protocol will use both function 06 or function 16 depending on number
of registries to be written.
Write Coils Modbus function for write operations to Output Coils. Select between the function 05 (write
single coil) and function 15 (write multiple coils).
If Modbus function 05 is selected, the protocol will always use function 05 for writing to the
controller, even when writing to multiple consecutive coils.
If Modbus function 15 is selected, the protocol will always use function 15 to write to the
controller, even for a single coil write request. The use of function 15 may result in higher
communication performance.
Modbus TCP
Element Description
l Modicon Modbus (1-based): Modbus implementation where all resources starts

with offset 1.
l Generic Modbus (0-based): Modbus implementation where all resources starts with
offset 0.
l Enron Modbus (1-based): Extends Modicon Mobdus implementation with 32 bit
l Enron Modbus (0-base): Extends Generic Modbus implementation with 32 bit
Note: The address range used in the Modbus frames is always between 0 and
65535 for the Holding Registers and between 0 and 65535 for Coils.
PLC IP address for all controllers in multiple connections. PLC Network must be selected to
Network enable multiple connections.
Element Description
Tag Editor Settings


2. Select Modbus TCP from the Driver list: tag definition dialog is displayed.
Modbus TCP
Element Description

Type
Coil Status Coils
Holding registers Holding Registers
Node Override IP
Node Override Port

protocol parameter (see Special Data Types for mode details)
Node Override ID
Modicon Mode
Offset addresses are six digits composed by one digit data type prefix + five digits resource address.
Element Description
Studio Modicon Generic Modbus

Memory Type
Offset range Offset range Offset range
Input Status 100000 – 165535
Input Registers 300000 – 365535 1 – 65536 0 – 65535
byte 8-bit data -128 ... 127
short 16-bit data -32768 ... 32767
int 32-bit data -2.1e9 ... 2.1e9
int64 64-bit data -9.2e18 ... 9.2e18
uint64 64-bit data 0 ... 1.8e19

point type
double IEEE double-precision 64-bit floating 2.2e-308 ... 1.79e308

point type
string Array of elements containing character code defined by selected

encoding
Note: to define arrays. select one of Data Type format followed by square brackets like “byte[]”,
“short[]”…
l In case of string tag, this property represents the maximum number of bytes available in the string
tag.
Modbus TCP
Element Description
Note: number of bytes corresponds to number of string characters if Encoding property is set to UTF-8 or
Latin1 in Tag Editor.
If Encoding property is set to UCS-2BE, UCS-2LE, UTF-16BE or UTF-16LE one character requires 2
bytes.
Conversi Conversion to be applied to the tag.

on
Value Description
Example:
Example:
25.36 → -25.36
Example:
Example:

GHEFCDAB
Example:
Element Description
Value Description

OPM...DAB
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
BCD bcd: Separate byte in two nibbles, read them as decimal (from 0 to
9)
Example:
0001 0111 = 23
Node Override IP
anymore.
variable.
Modbus TCP
Node Override Port

The protocol provides the special data type Node Override Port which allows you to change the network Port of the target
This memory type is unsigned short.
Node Override Port is initialized with the value of the controller Port specified in the project at programming time.
Node Override Port Modbus operation
0 Communication with the controller is stopped, no request frames are generated anymore.
Different from 0 It is interpreted as the value of the new port and is replaced for runtime operation.
If the HMI device is connected to a network with more than one controller node, each node has its own Node Override Port
variable.
Note: Node Override Port values assigned at runtime are retained through power cycles.
Node Override ID
Node
Modbus operation
Override ID
Modbus TCP
Modicon Mode
Tag Import
Modbus TCP
Type Description

v1.0
Linear
DELTA PLC csv v1.0 Requires a .csv file.

Linear
After selecting the .sym file, the following dialog will appear for PLC model
selection.
Kollmorgen txt v1.0 Requires a .txt file.

Linear
Schneider Unity v1.0 Requires a .uny file.

Linear
Type Description
The file containing symbols must be exported in .txt format and later renamed as
.uny. The importer considers only variables located at fixed address and
disregards arrays of strings. All other arrays, except for boolean type, are
expanded.
Import Tag(s).

Update Tag(s).
dictionary import.
Modbus TCP

item selected.

Field Description
MemoryType l OUTP
l INP
l IREG
l HREG
Tag file example

mandatory.
manual.
Error Cause Action
No response No reply within the specified timeout. Check if the controller is connected and
properly configured to get network access.
Incorrect node The device received a response with an -

address in invalid node address from the controller .
response
The received The device received a response with an -

message too invalid format from the controller .
short
Incorrect writing The controller did not accept a write Check if project data is consistent with the
data acknowledge request. controller resources.
Modbus TCP Server
Modbus TCP Server

Modbus TCP Server communication driver allows connecting the HMI device as a server in a Modbus TCP network. It is
possible for Modbus TCP clients to connect then to multiple HMI panels acting as servers. Standard Modbus TCP
messages are used for information exchange.
This approach allows connecting HMI devices to SCADA systems through the universally supported Modbus TCP
communication protocol.
Principle of operation
This communication driver implements a Modbus TCP Server unit in HMI device. A subset of the complete range of
Modbus function codes is supported. The available function codes allow data transfer between clients on the TCP network
and the server. The HMI device acts as a server in the network. It can exchange data with up to 32 clients. This means that
up to 32 clients can be connected to the HMI device at the same time. If all the 32 available connections are in use, any
further attempt to connect by a client will be refused by the system.
The following diagram shows the system architecture.
The device simulates the communication interface of a PLC: Coils and Registers data types are respectively boolean and
16 bit integers.
The device always access data in its internal memory. Data can be transferred to and from the Modbus Client only on the
initiative of the client itself.
This Modbus TCP Server implementation supports only a subset of the Modbus standard function codes.
01 Read Coil Status Reads multiple bits in the device Coil area.
02 Read Input Status Reads multiple bits in the device Coil area.
03 Read Holding Registers Read multiple device Registers.
04 Read Input Registers Read multiple device Registers.
05 Force Single Coil Forces a single device Coil to either ON or OFF.
06 Preset Single Register Presets a value in a device Register.
15 Force Multiple Coils Forces multiple device Coils to either ON or OFF.
16 Preset Multiple Registers Presets value in multiple device Registers.
23 Read Write Multiple Registers Read & presets values in multiple device Registers
Note: For both PLC models the Read Coil Status and Read Input Status function codes both access the same
Coil memory area in the HMI device memory. The Read Holding Registers and Read Input Registers function
codes both access the same Register area in the HMI device memory.
Exception Codes
Code Description
01 Illegal Function. the function code received in the query is not supported
02 Illegal Data Address. Data Address received in the query exceeds the predefined data
range (see Tag Editor Settings for detailed ranges of all types).
03 Illegal Data Value. A sub function other than 00 is specified in Loopback Diagnostic
Test (Code 08).

Adding a protocol

Modbus TCP Server
Element Description
Modbus ID Modbus node ID of the HMI device. Every Modbus server device in the network must have its own
Modbus ID.
Port Port number used by the Modbus TCP protocol. Default value is 502. Set the value accordingly to the
port number used by your Modbus TCP Network.
use UDP/IP If selected, the protocol will use connectionless UDP datagrams.
Encapsulated If selected, the protocol will use serial RTU protocol over Ethernet instead of Modbus TCP protocol,
RTU independently from TCP or UDP usage.
Enron 32bit If selected, allows to define the first register address and the number of registers for 32 bit registers
Note: 32 bit registers are available only for Enron Modbus PLC Models.
Element Description
32 bit registries memory area definition.
32bit reg Start value represents the first register address.

Start
Size value represents the number of registries.
32bit reg Size
Note: A request to one of the registries inside this area gives a 4 byte answer.
l Modicon Modbus (1-based): Modbus implementation where all resources starts with offset 1.
l Generic Modbus (0-based): Modbus implementation where all resources starts with offset 0.
l Enron Modbus (1-based): Extends Modicon Mobdus implementation with 32 bit registers
memory area.
l Enron Modbus (0-base): Extends Generic Modbus implementation with 32 bit registers
memory area.
Note: The address range used in the Modbus frames is always between 0 and 65535 for the
Holding Registers and between 0 and 65535 for Coils.
Tag Editor Settings


2. Select Modbus TCP Server from the protocol list: tag definition dialog is displayed.
Modbus TCP Server
Element Description

Type
Coil Status Coils
Available only for Enron Modbus PLC Models.
Modicon Mode protocol parameter (see Special Data Types for mode details)
address.
Generic
Memory Type
range
Input Status 100000 – 165535

0–
Input Registers 300000 – 365535 1 – 65536
65535
Data type Data Type Memory Space Limits
byte 8-bit data -128 ... 127
short 16-bit data -32768 ... 32767
int 32-bit data -2.1e9 ... 2.1e9
int64 64-bit data -9.2e18 ... 9.2e18
Element Description
uint64 64-bit data 0 ... 1.8e19

point type

point type 1.79e308

selected encoding
l In case of string tag, this property represents the maximum number of bytes available in
the string tag.
requires 2 bytes.
Conversi Conversion to be applied to the tag.

on
Modbus TCP Server
Element Description
Value Description
Example:
Example:
25.36 → -25.36
Example:
Example:

GHEFCDAB
Example:

OPM...DAB
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
to 9)
Example:
0001 0111 = 23
Element Description
Configured).
Modicon Mode
Tag Import
Modbus TCP Server

v1.0
Linear

Linear
After selecting the .sym file, the following dialog will appear for PLC model
selection.
Import Tag(s).

Update Tag(s).
dictionary import.
Modbus TCP Server

item selected.

Field Description
MemoryType l OUTP
l INP
l IREG
l HREG
Tag file example

mandatory.
The HMI device is a server station in the Modbus TCP network. The current implementation of the protocol doesn't report
any communication error code apart from standard communication error codes related to the proper driver loading.
OPC UA Client
OPC UA Client
The OPC UA Client communication driver has been designed to connect HMI devices to OPC UA servers.
This implementation of the protocol operates as a client only.

Adding a protocol

Element Description
PLC Network Enable access to multiple networked controllers. For every controller set proper
options.
Alias Name identifying nodes in network configurations. The name will be added as a prefix
to each tag name imported for each network node.
IP Address IP address of the server.
Port Port number where the server is listening.
Timeout (ms) Time delay in milliseconds between two retries in case of no response from the server
device.
Security Mode Type of authentication:
l None: Certificates are not used

l Sign: Certificates only used for authentication with server.
l SignAndEncrypt: Certificates used for authentication with server and data
encryption.
Security Policy Encryption level to use (used only when Security Mode is active).
l Basic256
l Basic256Sha256
Username Authentication with user name and password

Password
Server Certificate Certificate for OPC UA Server.
Server certificate can be downloaded using tag importer. See "Remote

OPC UA Server certificate" on page 752
Client Certificate Certificate used by OPC UA client. If blank, a certificate is automatically generated.
Client Private Key Key used by OPC UA client. If blank, a key is automatically generated.
PLC Models No options available.
Notes:
l Before choosing security options, be aware that not all security modes might be supported by the OPC UA server.
Make sure to use security mode that is supported.
l When working within a private network you do not need to provide devices' certificates because you trust used
devices. On a public network, instead, the certificate will give you a guarantee of the identity of devices.
External Certificate
ASCII version of the certificate (usually a file with .pem extension) is required.
Edit the certificate files and then copy and paste the full text of your certificate to the certificate fields.
Step 1: Remove header and footer lines
OPC UA Client
Step 2: Remove all Newline characters
Step 3: Copy and paste the single text line of the certificate to the protocol dialog
Script to generate a Certificate
If you want to use your own certificate, note that the certificate must include the “Subject Alternative Name (SAN)”
parameters as required by the OPC UA standard.
Here is an example of how to generate certificate files using a public OpenSSL-Win32 library (Reference:
https://www.openssl.org/)
@echo off
set NodeName=HMI-Client

%OpenSSL% genrsa -out client-key.pem 2048

%OpenSSL% req -new -key client-key.pem -out client.csr -subj
"/ST=Italy/C=IT/L=Verona/O=CompanyName/OU=R&D Team/CN=OPCUAClient@%NodeName%
rem Creating Certificate (.pem)

echo subjectAltName=URI:urn:%NodeName%:CompanyName:OPCUAClient > san.txt
echo
keyUsage=digitalSignature,nonRepudiation,keyEncipherment,dataEncipherment,keyCertSign
>> san.txt
echo extendedKeyUsage=critical,serverAuth,clientAuth >> san.txt
echo authorityKeyIdentifier=keyid,issuer >> san.txt
echo basicConstraints=CA:TRUE >> san.txt
%OpenSSL% x509 -req -days 3650 -in client.csr -signkey client-key.pem -out
client.crt -extfile san.txt
rem Convert Certificate (.der)

%OpenSSL% x509 -in client.crt -outform der -out client.der
rem Not necessary files

del san.txt
pause
Tag Editor Settings

1. Select OPC UA Client from the protocol list.
2. To add a tag, click +: tag definition dialog is displayed.
OPC UA Client
Element Description
Data Type Available data types:
l boolean
l byte
l short
l int
l unsignedByte
l unsignedShort
l unsignedInt
l float
l double
l time
l uint64
l int64
l string
l binary
Note: To define arrays, select one of Data Type format followed by square
brackets.
l In case of string tag, this property represents the maximum number of bytes available
in the string tag.
Note: number of bytes corresponds to number of string characters if Encoding property is set
to UTF-8 or Latin1 in Tag Editor.
requires 2 bytes.
Element Description
Value Description
Example:
Example:
25.36 → -25.36
Example:

CDAB
Example:

> GHEFCDAB
Example:

OPM...DAB
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
to 9)
Example:
0001 0111 = 23
OPC UA Client
Element Description
Configured).
Tag name Name of tag to be used in communication.
Note: Tag properties result from import process. In most cases manual creation of new tags is not necessary.
Node Override IP
anymore.
variable.
Node Override Port

The protocol provides the special data type Node Override Port which allows you to change the network Port of the target
This memory type is unsigned short.
Node Override Port is initialized with the value of the controller Port specified in the project at programming time.
Node Override Port Modbus operation
0 Communication with the controller is stopped, no request frames are generated anymore.
Different from 0 It is interpreted as the value of the new port and is replaced for runtime operation.
If the HMI device is connected to a network with more than one controller node, each node has its own Node Override Port
variable.
Note: Node Override Port values assigned at runtime are retained through power cycles.

OPC UA Client
Importing tags
Tags for OPC UA Client protocol must be imported from OPC UA servers.
1. Select OPC UA Client in the list of available protocols.

2. Click Import Tags.
3. Select Hierarchical importer.
4. Enter address of the server.
5. Choose Security and Authentication mode.
6. Click Browse to connect and retrieve tag dictionary from the OPC UA server.
7. The OPC UA Server will provide its own certificate. You have to accept the certificate to continue and retrieve data.
8. When the discovery process has been completed, click OK to create the dictionary with the tags.
Element Description
Remote URI Address of OPC UA Server in the form: opc:tcp:<IPAddress>:<Port>
Example:
l opc.tcp://192.168.44.165:4840
Security Mode Type of authentication:
l None: No authentication with server and no data encryption.

l Sign: Certificates only used for authentication with server.
l SignAndEncrypt: Certificates used for authentication with server and data
encryption.
Security Policy Encryption level to use (used only when Security Mode is active).
OPC UA Client
Element Description
l Basic128Rsa15
l Basic256
l Basic256Sha256
Username Authentication with user name and password

Password
Client Certificate Certificate used by OPC UA client. If blank, a certificate is automatically generated.
The certificate is used by the importer only if requested by the server
Client Private Key Key used by OPC UA client. If blank, a key is automatically generated.
To be allowed to retrieve data from the OPC UA Server you must provide the required security parameters.
Dialog will be filled automatically with the parameters provided by protocol editor settings (you can simply accept
the proposed values)
Remote OPC UA Server certificate
When OPC UA Server provides its own certificate, you have the option to:
l Accept temporarily
Certificate is accepted for current working session only.
l Accept permanently
Certificate is accepted and copied to computer. Any future import request for the same OPC UA Server will be
accepted automatically without asking confirmation.
The certificate file will be copied inside the folder:

%AppData%\Roaming\...\studio\OPCUA\pki\trusted\certs
l Copy to clipboard
ASCII format of the certificate is copied to the clipboard to allow you to verify its authenticity, save and insert it into
protocol configuration (if required).
To verify a certificate, use a text editor to paste it from the clipboard to a text file with the extension .crt.
You can then double-click the .crt file to allow Windows to view the properties of certificate.
l Cancel
Cancel the import operation
manual.
OPC UA Client
Error Description
Connecting <Error description> Error during connection
Connection while reading: <Error description> Error encountered when connecting for read operation
Bad status while reading: <Error description> Error in read operation
Connection while writing: <Error description> Error encountered when connecting for write operation
Bad status writing: <Error description> Error in write operation
OPC UA client for given node ID not found Wrong node ID information
<Error description> can be one of the following:
Error Notes
BadTimeout Timeout error. No answer from server.
BadSecurityChecksFailed Error during exchange of certificates. Typically occurs when the server does
not accept the client certificate as trusted.
BadCertificatexxxInvalid Error in client or server certificate.
BadNodeUnknown The tag (node) does not exist.
BadAttributeNotFound Attempt to access an invalid attribute.
BadNotWritable Attempt to write to a read-only attribute.
Simatic S7 ETH
Simatic S7 ETH communication driver has been designed to communicate with Simatic controllers through Ethernet
connection.
The Simatic controller must either have an on-board Ethernet port or be equipped with an appropriate Ethernet interface
(either built-in or with a module).
Communication is based on the PG/OP (ISO on TCP) communication functions.
This documents describes the driver settings to be applied in programming IDE software and in S7 PLC programming
software.

Adding a protocol

Element Description

address
Slot Number of the slot where the CPU is mounted. 2 for S7-300, may take a higher value for S7-400
Simatic S7 ETH
Element Description
systems.
PLC List of compatible controller models. Make sure to select the correct PLC model in this list when
Models configuring the protocol.
Network option.
S7-1200 and S7-1500 PLC configuration

S7-1200 (starting from firmware version 4.0) and S7-1500 PLC Series from Siemens have a built-in firewall; by default the
maximum protection level is enabled. To establish communication with these PLC models it is necessary to enable S7
communication with 3rd party devices; this setting is available in TIA Portal programming software.
1. Open the PLC project in TIA Portal.

2. Select the PLC from the project tree and open PLC Properties.
3. In General > Protection choose a permission between the top three (make sure that the tick is present on HMI
column).
Note: If "No access" is selected, the communication with the panel will not be established.
Simatic S7 ETH
4. Scroll down the page and check "Permit access with PUT/GET communication from remote partner".
Note: If variables are defined in "Program blocks", DB must configured as "Not optimized".
To check or change DB optimization, open DB Properties:
In General > Attributes uncheck "Optimized block access":
Simatic S7 ETH
If check box "Optimized block access" is not available (grayed-out) it could be because DB is an "instance DB" linked to an
"optimized access FB".
After compiling the project, tag offsets will be shown close to variable name.
These settings can be applied to TIA Portal programming software, S7-1200 PLC family starting from PLC firmware
version 4.0 and S7-1500 PLC family.
Logo! PLC configuration

To configure communication with Logo! PLC:
1. Open the Logo!Soft Comfort project.

2. Select Tools > Ethernet Connections: the Configure Ethernet Connections dialog is displayed.
3. Right-click on Ethernet Connections and add a server connection.
4. Double-click on the newly created connection: the connection properties dialog is displayed.
5. Select the Connect with an operator panel (OP) and Accept all connection requests options.
6. In the Remote Properties (Client) section, set TSAP to 02.00.
Export using TIA Portal v13, v14 or newer
Simatic S7 ETH
Exporting Program blocks

These files refer to DB tags defined in Program blocks.
1. Configure the Data Block as Not optimized.

2. Right-click on the Data Block and choose Properties:
3. In the General tab select Attributes and unselect Optimized block access.
Note: If the options Optimized block access is not enabled (checkbox grayed out) this might mean that the
Data Block is an "instance DB" linked to an "optimized access FB".
4. Right-click on the Data Block and choose Generate source from blocks:
Simatic S7 ETH
5. Save the file as DBxxx.db, where xxx=number of DB.
Exporting PLC tags

An Excel file refers to PLC tags.
1. Double-click Show all tags: the tag table is displayed.

2. Click the Export button and browse for path file.
3. Define file name.
Simatic S7 ETH
4. Click Save to confirm.
5. Click OK to export.
Exporting PLC data types

To create the file, expand PLC data types item from TIA Portal project tree and right click on the user defined structure.
Then click on Generate source from blocks.
Simatic S7 ETH
In case of multiple PLC data types in PLC project, it is necessary to select them all from PLC data types list, right click
and select Generate source from blocks to create the .UDT file that contains all the PLC data types defined.
In the next step, give a name to the .UDT file and choose the path to where to save the file.
Simatic S7 ETH
This file will content all the PLC data types and it can be used for importing tags in Tag Editor.
Check Tag Import chapter for more details.
Export using TIA Portal v10, v11, v12
Exporting Program blocks

These files refer to DB tags defined in Program blocks.
1. Configure the Data Block as Not optimized.

2. Right-click on the Data Block and choose Properties:
3. In the General tab select Attributes and unselect Optimized block access.
Simatic S7 ETH
Note: If the options Optimized block access is not enabled (checkbox grayed out) this might mean that the
Data Block is an "instance DB" linked to an "optimized access FB".
4. Build the project to make sure TIA Portal calculates the tags offset.
5. Double-click on a DB name.
6. Expand the view of program block selected.
7. Select all rows.
8. Copy and paste into any text editor.
9. Save the file as DBxxx.tia, where xxx=number of DB.
Note: Make sure you use the Save As function or the file will be named DB2.tia.txt and will not be visible from
the importer.
10. Repeat from step 5 for all program blocks.
Note: Make sure that only the following columns are shown in DB editor before copying all data in the txt file
Exporting PLC tags

An Excel file refers to PLC tags.
1. Double-click Show all tags: the tag table is displayed.
Simatic S7 ETH
2. Click the Export button and browse for path file.

3. Define file name.
4. Click Save to confirm.
5. Click OK to export.
Exporting PLC data types

To create the file, expand PLC data types item from TIA Portal project tree and right click on the user defined structure.
Then click on Generate source from blocks.
Simatic S7 ETH
In case of multiple PLC data types in PLC project, it is necessary to select them all from PLC data types list, right click
and select Generate source from blocks to create the .SCL file that contains all the PLC data types defined.
In the next step, give a name to the .SCL file and choose the path to where to save the file.
This file will content all the PLC data types and it can be used for importing tags in Tag Editor.
Check Tag Import chapter for more details.
Export using STEP7

The Simatic S7 ETH Tag importer accepts symbol files (ASCII format .asc) and source files (.awl extension) created by
the Simatic Step7. The symbol file can be previously exported using the Step7 symbol table utility.
Exporting Symbols table

Symbol files (.asc) can be exported from the symbol table utility.
Simatic S7 ETH
1. From the Symbol Table menu in the Symbol Editor choose Export.
2. Assign a name and save the symbol table as ASCII file.
Exporting Sources
These files are created exporting source code.
1. Open any program block in the editor, "OB1" in this example.

2. From the File menu choose Generate Source: the following dialog is displayed:
1. Assign a name, "Sources" in the example, and click OK: the Generate source Sources dialog is displayed.
Simatic S7 ETH
2. Click All > to generate source for all blocks.

3. Select the following options:
l Include reference blocks

l Sort according to program structure
l Symbolic address
4. Click OK to confirm: the "Sources" object is generated in the Step7 project as in the example.
5. Right click on the object and select Export Sources.
The generated .awl file can be imported in the Tag Editor.
Note: The .awl file contains additional information not included in the .asc file exported from the symbol table.
Make sure that reference to all data blocks is inserted in the symbol table. The tags from a data block are imported only if
the symbol table contains a line with the data block name and related comment.
Each entry enables the import filter to import the tags related to the specified data block.
Tag Editor Settings

In the Tag Editor select “Simatic S7 ETH” from the list of defined protocols and click + to add a tag.
Simatic S7 ETH
Element Description
Memory Area of PLC where tag is located.

Type
Data Type Simatic Type
Internal Memory M
Data Block DB
Input I (E)
Output O (A)
Timer value T
Counter value C
SubInd Resource offset within the register.

ex
Data Data block number for Data Block Memory Type.

Block
Data Available data types:

Type
l boolean
l byte
l short
l int
l unsignedByte
l unsignedShort
l unsignedInt
l float
l string
Note: To define arrays, select one of Data Type format followed by square brackets.
Element Description
Arraysi l In case of array tag, this property represents the number of array elements.
ze l In case of string tag, this property represents the maximum number of bytes available in
the string tag.
requires 2 bytes.
Conver Conversion to be applied to the tag.

sion
Depending on data type selected, the Allowed list shows one or more conversions, listed below.
Value Description
Inv bits Invert all the bits of the tag.
Example:
Negate Set the opposite of the tag value.
Example:
25.36 → -25.36
AB -> BA Swap nibbles of a byte.
Example:
ABCD -> CDAB Swap bytes of a word.
Example:
ABCDEFGH -> Swap bytes of a double word.
Simatic S7 ETH
Element Description
Value Description
GHEFCDAB Example:
ABC...NOP -> Swap bytes of a long word.

OPM...DAB
Example:
0 10000000110
0001110010111011011001000101101000011100101011000001
→
1 10000011100
1010101000010100010110110110110010110110000100111101
(in binary format)
BCD Separate the byte in two nibbles, and reads them as decimal (from 0 to 9)
Example:
0001 0111 = 23
S5timer(BCD) Used to support S5timer. Check Simatic S5timer special data type for
more details.
S5timer(BIN) Legacy transformation for S5timer in binary format.
Select the conversion and click on plus button. The selected item will be added on Configured
list.
If more conversions are configured, they will be applied in order (from top to bottom of
Configured list).

String data type

In Simatic S7 PLC two different types of tags manage string variables:
l as Array [1..xx] of characters,

l as String[xx].
Step7 string declaration is shown in this example:
TIA Portal string declaration is shown in this example:
Simatic S7 ETH
Note: When using String[xx] data type specific a conversion must be applied to the tag. If the tag dictionary is
imported from TIA Portal or Step7 using the import tool, however, conversion of the string tags is performed
automatically and no further action is required.
To add a string as an array of characters:
1. Press the + in the Tag Editor.
2. Select string as Data Type.

3. Enter string length in Arraysize.
To add a string data type:
1. Press the + in the Tag Editor.
2. Select string as Data Type.

3. Enter string length in Arraysize.
4. Click +/- to open the Conversion dialog.
5. In the conversion dialog select the S7 String conversion type.
Simatic S7 ETH
6. Click + to add the conversion: the conversion will be listed into the Configured list on the right.
Simatic S5Timer data type

Simatic drivers support a special data type, the S5Timer data type.
The tag must be configured with a specific data type and a conversion must be applied to the tag to correctly read/write a
Simatic S5Timer Variable.
1. In the Tag Editor click + to add a tag.
2. Select unsignedInt as Data Type.
3. Click +/- to open the Conversion dialog.
4. In the conversion dialog select the S5timer(BCD) conversion type.

5. Click + to add the conversion: the conversion will be listed into the Configured list on the right.
Simatic S7 ETH
Node Override IP
anymore.
variable.
Tag Import
Simatic S7 ETH
TIA Portal v13, v14 or Allows to import:

newer
l Program blocks using .dbfile
Linear
l PLC tags using .xlsx file
l PLC data types using .udt file
Check Export using TIA Portal v13, v14 or newer for more details.
TIA Portal v10, v11, v12 Allows to import:

Linear
l Program blocks using .tiafile
l PLC tags using .xlsx file
l PLC data types using .scl file
Check Export using TIA Portal v10, v11, v12 for more details.
Step7 Allows to import:

Linear
l Symbols table .ascfile
l Sources using .awl file
Check Export using STEP7 for more details.
appropriate button.
Import Tag(s).

Update Tag(s).
dictionary import.
Simatic S7 ETH

item selected.
manual.
Error Cause Action
Invalid The device did received a response with invalid Ensure the data programmed in the project are
response format or contents from the controller . consistent with the controller resources.

Error
System Variables
Refer to System Variables > Protocol chapter of User's Manual.
System Variables

Refer to System Variables > Protocol chapter of User's Manual.
Variables
Variables communication driver allows to define Tags which points to HMI internal memory.
Variables Tags are not retentive: when the project starts, the starting value of any Variables Tag is 0 (or "" in case of string
Tag).
Variables communication driver is not counted as physical protocol.

Refer to Table of functions and limits from main manual in "Number of physical protocols" line.

Adding a protocol
1. In the Config node double-click Protocols.

3. Select the Variables protocol from the PLC list.
Tag Editor Settings


2. Select Variables from the protocol list: tag definition dialog is displayed.
Variables
Element Description
byte 8-bit data -128 ...

127
short 16-bit data -32768 ...

32767
int 32-bit data -2.1e9 ...

2.1e9
int64 64-bit data -9.2e18 ...

9.2e18
uint64 64-bit data 0 ...

1.8e19
float IEEE single-precision 32-bit floating 1.17e-38

point type ... 3.4e38
double IEEE double-precision 64-bit floating 2.2e-308

point type ...
1.79e308
string Array of elements containing character code

defined by selected encoding
Note: to define arrays. select one of Data Type format followed by square
brackets like “byte[]”, “short[]”…
l In case of string tag, this property represents the maximum number of bytes
available in the string tag.
Note: number of bytes corresponds to number of string characters if Encoding

property is set to UTF-8 or Latin1 in Tag Editor.
If Encoding property is set to UCS-2BE, UCS-2LE, UTF-16BE or UTF-16LE one
character requires 2 bytes.
Element Description
Depending on data type selected, the list Allowed shows one or more conversion
typs.
Value Description
Example:
Example:
25.36 → -25.36
Example:

CDAB
Example:
ABCDEFG swap4: Swap bytes in a double word.

H ->
Example:
GHEFCDA
B
ABC...NOP swap8: Swap bytes in a long word.

->
Example:
OPM...DA
B
0 10000000110
Variables
Element Description
Value Description
000111001011101101100100010110100001110010101100
0001
→
1 10000011100
101010100001010001011011011011001011011000010011
1101
(in binary format)
BCD bcd: Separate byte in two nibbles, read them as decimal

(from 0 to 9)
Example:
0001 0111 = 23
If more conversions are configured, they will be applied in order (from top to bottom of
list Configured).
Tag Import
The system will require a generic XML file exported from Tag Editor by appropriate button.
Import Tag(s).

Update Tag(s).
dictionary import.
Variables

item selected.
—
ABB Automation Products GmbH
Eppelheimer Straße 82
69123 Heidelberg
Germany
Phone: +49 6221 701 1444
Fax: +49 6221 701 1382
E-Mail: [email protected]
www.abb.com/plc
www.abb.com/automationbuilder
Note:
We reserve the right to make technical changes or modify
the contents of this document without prior notice.
With regard to purchase orders, the agreed particulars
shall prevail.
ABB AG does not accept any responsibility whatsoever for
potential errors or possible lack of information in this
document.
We reserve all rights in this document and in the subject

matter and illustrations contained therein.
3ADR010277, 2, en_US
Any reproduction, disclosure to third parties or utilization

of its contents – in whole or in parts – is forbidden without
prior written consent of ABB AG.
© Copyright 2011 - 2019 ABB.

All rights reserved.

ABB PB610-manual PDF

Uploaded by

Copyright:

Available Formats

ABB PB610-manual PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ABB PB610-manual PDF

Uploaded by

Copyright:

Available Formats

—

PB610 Panel Builder 600

1 Getting started 1 Managing overlapping widgets 58

Assumptions 2 Grouping widgets 59

What´s new 2 Changing multiple widgets properties 66

Installing the application 4 Changing fill color property according to tag

Remote Client variables 104 12 The HMI Client 183

Version variables 105 Client application on PC 184

Screen variables 105 Client application on HMI 185

SD card variables 105 Settings and time zone options 186

Server variables 105 13 Using the integrated FTP server 191

Time variables 106 FTP settings 191

10 System Variables (Protocol) 109 Starting VNC viewer 195

Protocol Editor Settings 110 15 Alarms 197

Tag Import 110 Alarms Editor 198

Default variables 112 Remote alarms acknowledge 200

Retentive Memory variables 126 Alarm state machine 201

Services variables 132 Setting events 202

11 Actions 135 Active Alarms widget 204

Alarm actions 136 Alarms History widget 209

Database actions 137 Managing alarms at runtime 209

Event actions 140 Enable/disable alarms at runtime 210

MultiLanguage actions 140 Displaying live alarm data 210

Keyboard actions 141 Exporting alarm buffers to .csv files 211

Media Player actions 143 Exporting alarm configuration 211

FTP actions 143 16 Recipes 215

Page actions 146 Managing recipes 215

Print actions 153 Configuring a recipe widget 218

Recipe actions 154 Recipe status 219

Remote Client actions 158 Uploading/downloading a recipe 220

System actions 159 Backup and restore recipes data 221

Tag actions 170 17 Trends 223

Trend actions 173 Data logging 224

Text Editor actions 177 Exporting trend buffer data 226

User management actions 177 Trend widgets 227

Trend widget properties 231 Enable/disable security management 282

Trend widget gestures 232 Configuring groups and authorizations 282

Values outside range or invalid 233 Modifying access permissions 283

Showing trend values 234 Assigning widget permissions from page

Enable/disable keyboard 324 IP Camera widgets 379

Associating actions to keys 324 JavaScript function block widget 382

30 Tag cross reference 327 Media Player widgets 384

Page object methods 443 FAQ on Static Optimization 493

Group object 445 Page caching 494

Group object methods 445 Image DB 494

Project object 447 Precaching 494

Project object properties 447 FAQ on precaching 494

Project object methods 447 42 Functional specifications and

39 Web access 473 Settings 537

Supported platforms and browsers 474 45 Communication protocols 539

Platform specific Home pages 476 ABB CODESYS Serial 550

Testing the Web project 476 ABB IRC5 556

Downloading the Web project 477 ABB IRC5 Linux 561

Web connectivity issues 478 ABB Mint Controller HCP 571

Web supported features 479 ABB Modbus RTU 580

Troubleshooting and FAQ 483 ABB Modbus TCP 587

Privacy 483 ABB Pluto 593

40 Protecting access to HMI devices 485 BACnet 599

Changing password on HMI device 486 CODESYS V2 ETH 629