UiIcon

The UiIcon control can be used to display events and values. It looks like a normal button and can be filled with different icons.

UiIcon 1:

Use

Suitable for creating P&I diagrams to represent various plant components (e.g. pump). The attribute Connections can be used to create suitable connections to connect the UiIcon with a main line, for example.

Features

Value displays

Various displays can be added to the UiIcon via the attribute DisplaysData.

UiIcon 2:

Event displays

The attribute EventsData can be used to display various events around the UiIcon.

UiIcon 3:

If the generic approach of TcHmiBa is used and a BaObject / BaView is linked to the control, active events are displayed automatically. When the UiIcon is actuated, the project navigation of the linked object opens and, in the case of an event, the parameter window with the event view opens accordingly.

UiIcon 4:

Attributes

The control inherits from the button and thus has the same attributes. In addition, there are the following attributes.

BA

BaObject

tchmi:framework#/definitions/Symbol

To use the generic functionalities of TcHmiBa. It links a single object or a complete view (including children) to the control.

UiIcon 5:

You can find more detailed information about the generic possibilities of TcHmiBa under Generic HMI.
The attribute is not applicable to all controls.

UiIcon 6:
UiIcon 7:
UiIcon 8:

Common

DisplaysData

TcHmi.BuildingAutomation.Controls.UiIcon.DisplaysData

The attribute makes it possible to create different displays via an editor.

UiIcon 9:

The following properties can be set for each display:

Name

Description

TextColor

Font color of the display.

Value

Display value in the display. If a binding exists and ReadOnly is disabled, the value is written to this binding when the user ends the input.

Position

Position of the display. Several displays created at the same position are arranged on top of each other.

ReadOnly

Determines whether the display is editable or read-only.

Unit

Unit to be appended to the value (if it is a number).

Digits

Number of decimal places.

FontWeight

Font weight of the text.

IsActive

tchmi:general#/definitions/Boolean

The attribute makes it possible to display an active operating state by coloring the icon.

Inactive

Active

UiIcon 10:

UiIcon 11:

HasEvent

TcHmi.BuildingAutomation.EventType

The attribute colors the icon according to the event type set.

If the HasEvent attribute is to be set automatically when an event is active, this can be set via the variable AutoActivateHasEvent.

Event type

Display

Alarm

UiIcon 12:

Fault

UiIcon 13:

Maintenance

UiIcon 14:

Notification

UiIcon 15:

Others

UiIcon 16:

EventsData

TcHmi.BuildingAutomation.Controls.UiIcon.EventsData

The attribute makes it possible to create different events via an editor.

UiIcon 17:

The following properties can be set for each event:

Name

Description

Activate

Determines whether the event is active or not.

Event condition

Determines the type (priority) of the event. The icons are arranged according to their priority in a clockwise direction. Top right is the highest priority.

Event state

Current state of the event.

Event count

Determines how many events of this type and state are active.

Acknowledge symbol

Writes TRUE to the symbol when the event is pressed.

Is Acknowledgable

Determines whether the event can be pressed.

Icon

Icon to use if no event condition is selected to allow user specific icons.

Enable pulse

Evaluation is done only if Event condition and Event state are not used. When activated, a red pulse is displayed around the UiIcon.

ShowDisplays

tchmi:general#/definitions/Boolean

The attribute determines whether the displays defined in the attribute DisplayData are displayed or not.

Connections

Connections can be used to represent connections to other lines in a P&I diagram.

tchmi:framework#/definitions/Padding

Connections can be created here that extend vertically or horizontally away from the UiIcon.

UiIcon 18:

The length of the connection must be specified in each case.

UiIcon 19:

The unit pixel is always used. Percent is not supported at this point.

ConnectionExtensions

tchmi:framework#/definitions/Padding

Here extensions can be created for the connections created above.

UiIcon 20:

The length of the extension must be specified in each case.

UiIcon 21:

The unit pixel is always used. Percent is not supported at this point.

ConnectionsWidth

tchmi:framework#/definitions/PositiveNumber

Specification of the width in pixels for the connections.

ConnectionsColor

tchmi:framework#/definitions/SolidColor

Specification of the color for the connections.

ConnectionsColorPerSide

tchmi:framework#/definitions/TcHmi.BuildingAutomation.FourSidedColor

Defines the color for different connections. The ConnectionsColor attribute must be set to NULL or NONE.