HMI Instructions

Instruction Action

ALARMDISPLAY

Alarm Viewer management including list navigation, actions on alarms and filtering.
ANIMATION Executes the equivalent action of a user clicking on a control zone animation.
BIMDISPLAY BIM control management, including model loading, preset handling and object property retrieval.
CAMERADISPLAY Management of security devices of type camera, including access to properties, AV stream handling and PTZ commands via the ONVIF control.

CHART

Manage the operation of an XY Chart.

CHECKLIST

Access properties of the Check-box list form control.

COMBOBOX

Access properties of the Combo-box form control.

LISTBOX

Access properties of the List-box form control.

LOGDISPLAY

Log Viewer management including list navigation and filtering.
MAPDISPLAY Manage the operation of a Map Control.

OPTIONLIST

Access properties of the Option-button list form control.
PIE Manage the operation of a Pie Control in the HMI.

SELECTOR

Select the data that appears in a grid control animation.

TEXTBOX

Access properties of the Text-box control.

TREEVIEW

Access properties of the Tree View form control.

TREND

Modify the operation of a Trend Viewer.
VIDEODISPLAY Video control management including playing and pausing an AV stream or file.
WEBBROWSER Web browser control management, including navigation.

HMI instructions requires to identify the graphic item being scripted, either a base drawing/animation or a graphic control. This is achieved by passing the following arguments to the instruction:

Argument

Meaning

Window

The name of the window that contains the graphic item. Type STR.

Branch

The branch (if any) of the window. Use "*" to indicate the current branch of the program. Type STR

Identity

The identity of the graphic item in the specified window. Type STR.

The argument Identity represents the unique Id of the graphic item in the window or mimic. This unique Id is visible and can be changed with the following tools you find in the menu Display:

  • The Graphic Explorer - The unique Id of each graphic item is indicated with square brackets
  • The Properties list - Property Name

It is also the unique Id used by the VBA scripting engine.

Examples:

Trend(“Show_Legend”, “M1”, “ProcessA”, “Trd3”, 1);

Will display the legend of a trend viewer control named Trd3, located in the mimic named M1 opened with branch ProcessA.

Trend(“Show_Legend”, “M2”, “”, “S2.Trd1”, 1);

Will display the legend of a trend viewer control named Trd1, located in a symbol or group of graphic items named S2, in a mimic named M2 opened with an empty branch.