Super Systems Compact HMI User Manual
COMPACT HMI AND
COMPACT HMI EDITOR
OPERATIONS MANUAL
Super Systems Inc.
7205 Edington Drive
Cincinnati, OH 45249
513-772-0060
Fax: 513-772-9466
www.supersystems.com
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 2 of 60
Super Systems Inc.
Super Systems Europe
Super Systems Mexico
Super Systems China
USA Office
Corporate Headquarters
7205 Edington Drive
Cincinnati, OH 45249
Phone: (513) 772-0060
http://www.supersystems.com
Sistemas Superiores Integrales S de RL de CV
Querétaro, QRO CP, MEXICO 76120
Phone: +52 (442) 410 9040
http://www.supersystems.com
Units 3 & 4, 17 Reddicap Trading Estate,
Sutton Coldfield, West Midlands
B75 7BU
UNITED KINGDOM
Phone: +44 (0) 121 329 2627
http://www.supersystemseurope.com
No. 335 XianXia Road
Room 308
Shanghai, CHINA
200336
Phone: +86 21 5206 5701/2
http://www.supersystems.com
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 3 of 60
Table of Contents
Introduction ........................................................................................................................................ 5
Compact HMI Editor ........................................................................................................................... 7
Installation ...................................................................................................................................... 7
Prerequisites .............................................................................................................................. 7
Installation Procedure ............................................................................................................... 7
Solution Overview ........................................................................................................................... 9
Panels ............................................................................................................................................. 9
SSi Options ................................................................................................................................ 11
Tags (Tag Management) ............................................................................................................... 12
Expression Editor ......................................................................................................................... 17
Expression Operators, Constants, and Functions ................................................................... 17
Display Conditions ........................................................................................................................ 19
How Conditions are Prioritized ................................................................................................ 23
Controls ........................................................................................................................................ 26
Indicator Label .......................................................................................................................... 27
Control Button .......................................................................................................................... 29
Image Box ................................................................................................................................. 32
Exporting for the Touch Screen ................................................................................................... 33
Interacting with the Touch Screen .............................................................................................. 34
Using the Main Menu ................................................................................................................... 34
File ............................................................................................................................................ 34
Edit ............................................................................................................................................ 35
Format ...................................................................................................................................... 36
Tools .......................................................................................................................................... 36
Help ........................................................................................................................................... 37
Using the Design Environment Toolbar ...................................................................................... 40
Compact HMI (Use on SSi Touch Screen) ....................................................................................... 43
Prerequisites and Installation ..................................................................................................... 43
Use with Compatible Touch Screens ........................................................................................... 43
Example of Compact HMI Touch Screen Application Design and Rendering ............................ 43
Example Designs ...................................................................................................................... 43
Preparing Solution for Touch Screen ...................................................................................... 49
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 4 of 60
Running the Compact HMI Solution......................................................................................... 51
Revision History ............................................................................................................................... 53
Appendix 1: Software Best Practices .............................................................................................. 54
When Configuring Connections and Tags in Compact HMI Editor ............................................. 54
Backing Up Touch Screen Files (.cfxml and .tdx) ....................................................................... 54
When Saving Multiple Solutions .................................................................................................. 54
Backing Up Development Files .................................................................................................... 55
Appendix 2: Font Measurement Units ............................................................................................. 56
Appendix 3: Typical Wiring Diagrams ............................................................................................. 57
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 5 of 60
Introduction
Compact HMI is a software platform that allows you to create customized HMI screens using an
application called
display of equipment, graphical display of process data, and objects used for interaction with
equipment. These screens can then be run on a compatible touch screen that works with Super
Systems Inc. (SSi) 9000 Series controllers. The touch screen application from SSi that provides
the framework for running customized HMI screens is
Compact HMI can handle communications via the Allen-Bradley DF1, Modbus TCP, and Modbus
RTU communication protocols. Using Allen-Bradley DF1, for example, with the touch screen
connected to a compatible data device (such as a MicroLogix 1400 PLC via an RS-232 serial
connection), Compact HMI can perform I/O operations with the data device and can access
register values within the data device. Design tools within Compact HMI Editor allow you to
program evaluations of register values and design multiple panels for use by the operator.
Figure 1 illustrates the components that make up a Compact HMI system.
Compact HMI Editor. A programmed HMI screen can contain a graphical
Compact HMI.
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 6 of 60
Figure 1 - Compact HMI Platform components
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 7 of 60
Insert the Compact HMI Editor installation media
those shown in Figure 2.
Figure 2 - Example Installation Files
Figure 3 - Compact HMI Editor Setup Wizard screen
Figure 4 - .NET Framework 3.5 Setup Screen
(will appear if needed)
Compact HMI Editor
Installation
Prerequisites
Compact HMI Editor has prerequisites that must be fulfilled in order for the program to run
properly. These include:
• A computer with Windows XP, Vista, 7, or 8
• Microsoft .NET Framework 3.5. Compact HMI Editor setup will install this package if it is not
already present on the computer where Compact HMI Editor is being installed (see Figure
4
). Version 3.5 is required.
In order to use the screen you create with Compact HMI Editor, you need a Super Systems touch
screen with Compact HMI. Refer to the “Use with Compatible Touch Screens” section for more
details.
Installation Procedure
into the USB port, CD/DVD drive, or other proper
location. Open Windows Explorer and browse to
the folder containing the Compact HMI Editor
installation files. You will see installation files like
Double click on the “CompactHMIEditorSetup.msi” file.
If Microsoft .NET Framework 3.5 is installed, the Setup Wizard will appear (Figure 3
). If .NET
Framework 3.5 is not installed, the Setup Wizard will first prompt you to install .NET
Framework 3.5 (Figure 4). .NET Framework must be installed before Compact HMI Editor is
run. An Internet connection is needed in order to download the required files for .NET
Framework 3.5.
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 8 of 60
The installation URL for .NET Framework 3.5 is http://www.microsoft.com/en-
Setup Wizard.
When ready to proceed with installation of Compact HMI Editor, click the Next button on the first
Compact HMI Editor installation (Figure 5).
us/download/details.aspx?id=21, if for some reason it cannot be installed properly using the
screen of the Setup Wizard. The screens below show typical screens that will appear in a
Figure 5 - Compact HMI Editor Setup Screens (in succession)
Once Compact HMI Editor is installed, you may begin using it.
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 9 of 60
Solution Overview
A Solution is a collection of files that will be translated into a complete HMI during runtime.
Each screen within a solution is called a
accessible via the touch screen.
Therefore, a Solution can also be defined as a collection of HMI
Panel. Each Panel represents individual screens
Panels.
Compact HMI Editor creates display files for each Panel. When Compact HMI Editor is first
started, it will load a new Solution. You will be able to add Panels to the Solution.
Panels
You can add a Panel by using File New Panel or right clicking on the Solution name in the
Solution Explorer in the upper right part of the screen and selecting Panel. The Panel will serve
as a container for your display and command controls. Each Panel can have independent
communication setups and basic visual properties. Compact HMI communicates with a data
device using Allen-Bradley DF1, Modbus RTU, and Modbus TCP communications.
The most common settings to be modified on the Panel are the BackgroundImage (under
Appearance) and the Target Device (under the SSi grouping). The Target Device can be modified
at the Panel level. The Panel size should match the resolution of the target screen, which is
determined by the Target Device selection.
Figure 6 - Compact HMI Editor Design Environment
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 10 of 60
Figure 7 - Design Environment with Panels Added
Figure 7 shows a Design Environment view with multiple Panels. On the bottom right is a view of
the Panel's properties.
NOTE: The first Panel created is called “Main” by default. You may change the name of this
Panel (or any others) as you wish. See
Table 1 for descriptions of Panel properties and an
example properties grid in Figure 8.
Remember that Panels can be arranged in the order in which you want them to appear in
Compact HMI on the touch screen. To reorder Panels, simply click and drag each tab into the
order in which you wish it to appear.
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 11 of 60
Appearance
BackgroundImage
The background image
used for the Panel
BackgroundImageLayout
The layout used for the
otherwise would.
Behavior
DoubleBuffered
Do not change this setting.
Design
(Name)
Identifies the name used in
code to identify the object
Locked
Determines whether the
resized
Layout
AutoScaleMode
Determines how the form
change
SSi
See the “SSi Options” section below.
Table 1 - Panel properties
Figure 8 - Panel properties grid
background image.
Possible settings are:
• None: Image will be
applied with no
changes to its
appearance.
• Tile: Image will be tiled
multiple times in the
background (the
smaller the image's
dimensions, the more
frequently it will
appear)
• Center: The image will
be centered in the
background.
• Stretch: The image will
be stretched to fit the
background area.
• Zoom: The image will
be enlarged within the
background area. Note
that the visible part of
the image will appear
larger than it
SSi Options
The active panel must be selected for this to be visible. If a control object is currently selected,
for example, the options will not be visible. Figure 9 shows what the options look like in the
Design View.
control can be moved or
or control will scale when
screen resolution or fonts
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 12 of 60
Figure 9 - SSi Options
Target Device: The touch screen device model on which the Compact HMI will be running.
Models can be selected from a drop-down list. Typically, the models will start with “TPC-“ and
end in a number, sometimes followed by one or more letters. If the model starts with “TPC-3,”
the screen size is usually 3.5”. If the model starts with “TPC-6”, the screen size is usually 5.7”.
Finally, if the model starts with “TPC-12”, the screen size is usually 12.1”
This setting will
determine the size of each panel in the Solution and is extremely important. An incorrect
setting will result in the panels being rendered incorrectly—or not being rendered at all—on the
touch screen.
Contact SSi at (513) 772-0060for help with setting up these options.
Tags (Tag Management)
Compact HMI Editor includes a database framework that allows you to associate connections
with tags and tags with register locations. Each connection is identified by a user-defined name
along with relevant connection details. Each tag is associated with a 16-bit word register. All of
the connection, tag, and register data is contained in a “tags database” that Compact HMI
maintains. This approach allows you to configure Compact HMI to access data in a
straightforward and organized fashion.
To access the tags database, click on Tools Tags (Figure 10) in the Compact HMI Editor main
window.
The Tag Management window will appear (Figure 11). In the example screen shot in Figure 11,
the window is populated with connection, tag, and bit data. More information is provided in this
section on how to configure connection, tag, and bit settings.
Figure 10 - Tag Management
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 13 of 60
Figure 11 - Tag Management window
In the Tag Management window, you can perform several actions:
• Create a new connection name and define the connection parameters;
• Create a new tag under a connection name and associate it with a register location;
• Name tags and register bits associated with tags by using specific designations such as
Input, Output
, and
Alarm
;
• Identify bits that are associated with a bit alarm;
• Filter tags by search string (partial strings are okay); and
• Remove existing connections, tags, and bit definitions.
In the Tag Management window, the File menu provides these options: Add Connection, Add
Tag, and Close. Select Add Connection to add a new connection, Add Tag to add a new tag, and
Close to close the Tag Management window.
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 14 of 60
For Allen-Bradley DF1 Connections
SSi 9000 Series controller.
Figure 12 – New Connection window (DF1)
Connection properties are first defined in the New Connection window (Figure 12). The
parameters that must be set are as follows:
(Example: Figure 12)
• Connection Type: The protocol used
for communication between Compact
HMI and the data device. Available
settings are DF1, ModbusRTU, and
ModbusTCP.
• Connection Name: The user-defined
name for the Connection.
Recommended:
Use a Connection
Name that can be easily associated
with the data device and register
locations from which Compact HMI
will be reading and writing data.
• Host Address: The address of the
touch screen. Normally, this setting
can be kept as the default.
• Target Address: The address of the
data device. Normally, this setting can
be kept as the default.
• COM Port: The COM (serial) Port with
which the Compact HMI touch screen
will be connected to the data device.
This must match the actual COM Port
on which the serial cable is connected
to the touch screen.
The default COM Port is COM 2. Some
touch screens may have only one COM
Port. In such a case, COM 1 will need
to be used for the data device
connection, and an Ethernet
connection will need to be used for the
• Read Offset: The register address where
Compact HMI starts reading. This must be
defined to the word level within the data device.
• Read Count: The default number of registers,
starting with the Read Offset, that will be read.
The default is 100. This value must not exceed
the number of registers actually defined within
the data device.
Generate Tags checkbox: When checked, this
checkbox will cause tags to be generated. The tags
generated will be based on the Read Offset and
Read Count defined in this menu. For example,
with default settings, the tags generated will start
“N7:0” and end “N7:99”. Bits will be created for
each tag as well (Bit 0 through Bit 15).
Super Systems Inc.
Page 15 of 60
For ModbusRTU Connections
(Example: Figure 13)
Figure 13 – New Connection window (ModbusRTU)
For ModbusTCP Connections
Figure 14 – New Communications Window (ModbusTCP)
named Tag0, Tag1, and so on, through Tag99.
• Host Address: The address of the
touch screen. Normally, this setting
can be kept as the default.
• Target Address: The address of the
data device. Normally, this setting can
be kept as the default.
• COM Port: The COM (serial) Port with
which the Compact HMI touch screen
will be connected to the data device.
This must match the actual COM Port
on which the serial cable is connected
to the touch screen.
The default COM Port is COM 2. Some
touch screens may have only one COM
Port. In such a case, COM 1 will need
to be used for the data device
connection, and an Ethernet
connection will need to be used for the
SSi 9000 Series controller.
• Read Offset: The register address
where Compact HMI starts reading.
This must be defined to the word level
within the data device.
Compact HMI and Compact HMI Editor Operations Manual
• Read Count: The default number of registers,
starting with the Read Offset, that will be read.
The default is 100. This value must not exceed
the number of registers actually defined within
the data device.
• Baud Rate: The rate (in units per second) at
which communications bits are sent between
the touch screen and data device. The default is
19200.
Generate Tags checkbox: When checked, this
checkbox will cause tags to be generated. The tags
generated will be based on the Read Offset and
Read Count defined in this menu. For example, if
the Read Offset is 0 and the Read Count is 100, the
tags generated will be named Tag0, Tag1, and so
on, through Tag99.
(Example: Figure 14)
• IP Address: The IP address of the data
device.
• Port: The port number on the data
device through which the data device
will exchange data.
• Read Offset: The register address
where Compact HMI starts reading.
This must be defined to the word level
within the data device.
• Read Count: The default number of
registers, starting with the Read
Offset, that will be read. The default is
100. This value must not exceed the
number of registers actually defined
within the data device.
• Generate Tags checkbox: When checked, this
checkbox will cause tags to be generated. The
tags generated will be based on the Read
Offset and Read Count defined in this menu.
For example, if the Read Offset is 0 and the
Read Count is 100, the tags generated will be
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 16 of 60
Connection types can be changed after a
Figure 15 - Change Connection Type option
Using the tag properties grid, you can name the tag set
Figure 16 - Tag "Data" fields
Each register is made up of 16 bits. The bits are
This feature is intended for future use.
Figure 17 - Bit fields
connection is defined. To do this, right
click on the Connection Name, select
“Change Connection Type”, and select the
Connection Type desired. See an example
in
Figure 15.
The Edit menu allows you to copy an existing connection or tag with all of its properties and bit
settings. Do this by first selecting the item you want to copy, then click
and then click
“
ItemName –
Finally, using the
Paste in the Edit menu. The new (copied) item will be added to the tags list as
Copy(
number
)”. Using the Edit menu’s Delete option, you can remove an item.
Find & Replace option, you can direct Compact HMI Editor to search for a
Copy in the Edit menu,
specific string of text in tag names and replace that text names with text that you enter.
The Sort menu allows you to order connection names and tags alphabetically (by name) or by
address (in the case of tags, that is the register address associated with the tag). Sorting can be
performed in ascending or descending order.
and address offset, and enter a brief description. See
Figure 16.
The default name of the tag will be “NewTag
x
is a sequential number. The Address Offset will be
applied to the Data Offset previously assigned to the
Panel. For example, referring to Figure 9 and Figure
16, if a Data Offset of N7:0 and Address Offset of 4 are
defined, the actual register being evaluated will be
N7:4.
numbered 0 through 15. Compact HMI Editor allows
you to name each bit, add a brief description, and
identify whether the bit is an alarm bit (see
If “Is Alarm Bit” is set to False, Compact HMI will not
identify the bit as an alarm bit; if “Is Alarm Bit” is set to
True, then Compact HMI will identify the bit as an
alarm bit. The default setting for this field is False.
Once configured, tags are used with Compact HMI’s control objects to help determine display
conditions and other characteristics of a control system.
x”,
where
Figure 17).
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 17 of 60
Please refer to Appendix 1: Software Best Practices, “When Configuring Connections and Tags
in Compact HMI Editor,” for information on best practices for configuring connections and tags
in Compact HMI Editor.
Expression Editor
The Expression Editor is used in conjunction with two Control properties: Display Expression
and Display Conditions. The Expression Editor will be displayed when Display Expression or
Display Conditions is selected (for example, from the Control Properties Grid).
NOTE: Some Display Conditions (described in more detail below) and the Expression Editor
utilize Tags.
Expression Operators, Constants, and Functions
Tag names identify register locations within a data device. Each register is constituted by a word
containing 16 bits. Compact HMI Editor provides ways of evaluating values contained within data
device registers against values defined by the user. In order to program valid expressions, it is
important to understand the expression syntax used in Compact HMI.
A Tag can be called using the following syntax:
Tag(“[ConnectionName]TagName”) where
connection and
A particular bit can be called according to one of the following two syntaxes:
TagName
Figure 18 - Expression Editor window
ConnectionName
is the name of a defined Tag within that connection.
is the name of a defined
Compact HMI and Compact HMI Editor Operations Manual
Super Systems Inc.
Page 18 of 60
Operator/Constant/
Function
Purpose
Examples of Use in Valid Expression
Operators and Constants
+
Performs an addition
Tag(“[Connection1]N7:0”) + 15
- Performs a subtraction
Tag(“[Connection1]N7:0”) - 15
*
Performs a multiplication
Tag(“[Connection1]N7:0”) * 15
/
Performs a division and
(division)
Tag(“[Connection1]N7:0”) / 15
Note: 3/2 returns 1.5
\
Performs a division and
(modulus)
1 / Tag(“[Connection1]N7:1”)
Note: 3\2 returns 1
^
Performs an exponential
Tag(“[Connection1]N7:0”) ^ 3
Pi
Returns the value of Pi,
diameter
Pi + Tag(”[Connection]N7:0”)
Logical Operators
<
Less than
Tag(“[Connection1]N7:0”) < Tag(“[Connection1]N7:1”)
>
Greater than
Tag(“[Connection1]N7:0”) > 1
And
Inclusive of more than one
condition
(Tag(“[Connection1]N7:0”) < 10) and
(Tag(“[Connection1]N7:0”) > 5)
<=
Less than or equal to
Tag(“[Connection1]N7:0”) <= 3
>=
Greater than or equal to
Tag(“[Connection1]N7:0”) >= 3
Or
Inclusive of either/or
condition
(Tag(“[Connection1]N7:0”) < 1) or (Tag(“[Connection1]N7:3”) >
14)
<>
Not equal to
Tag(“[Connection1]N7:0”) <> Tag(“[Connection1]N7:1”)
=
Equal to
Tag(“[Connection1]N7:0.1”) = 0
1. Tag(“[ConnectionName]TagName.BitName”) where
name of a defined Connection,
connection, and
BitName
TagName
is the name of a defined Tag within that
is the name of a defined bit within the register represented by
ConnectionName
is the
TagName.
2. Bit(BitNumber,Tag(“[ConnectionName]TagName”)) where BitNumber is the
number of a bit (0 to 15) within the register represented by
connection
ConnectionName.
TagName
that is part of the
In most cases, Tags and bits will be called for the purpose of:
1. Calculating a value, which will typically be displayed and sometimes scaled before being
displayed; or
2. Evaluating a condition as True or False.
Table 2 provides details on the operators, constants, and functions that can be used in Compact
HMI Editor; the purpose of each; and examples of how they may be used in a valid expression.
keeps the decimal value
drops the decimal value
calculation (calculates a
number raised to a certain
power)
which is the ratio of the
circle’s circumference to its
3^3
Note: Pi by itself returns 3.14159265358979
Loading...