×
Skip to main content Link Search Menu Expand Document (external link) Right Arrow

Contents

HMI

HMI is part of Energy Machines Cloud complement to the Portal. It is a web application that serves as the project operator’s interface-to-go. HMI can be accessed from a widget or from a project profile. Some of its parts, like Pages or Alarms, are eponymous with parts of the Portal. The important difference here is that HMI is designed for a different usage.

For example, Pages are available as a subsection on the Portal and as a section of HMI alike. The distinction here is that the Portal provides tools to create and/or manage pages (copy, delete, create templates, etc.) whereas HMI is where the user can view pages in their current state.

UI Overview

Figure below contains an overview of the HMI UI.

HMI UI screenshot
Toggle to show/hide interface elements. Click on an element to go to its section.

Fig. 1. Key UI elements of HMI.

The UI consists of the following functional areas:

Menu

Provides navigation between different HMI sections, or views:

  • Pages are highly customizable visuals where tag values, tables, schemes, or other graphically representable data can be arranged on a grid.
  • Alarms are signals of critical conditions that need human attention and/or intervention.
  • Trends visualize historical and real-time tag values.
  • Logs list the project's events in retrospect.
  •  Documents are PDFs and other documents uploaded to the project. Documents are listed in the sidebar to the left while the document viewer occupies the center of the page.
  • Events are scheduled future events.
  •  Help links to this Documentation (opens in new tab).
  •  User Actions provides a limited account management interface where the user can choose preferred unit system (metric vs imperial) and preferred tag naming conventions, log out, or see the current version of HMI software in About.

    User actions menu

All other UI elements are view-specific and vary in appearance from view to view:

Table 1 below lists header elements.

Table 1. Header elements.

Element Description Comment
 Sidebar Toggles navigation and left pane
Opens the list of projects the user has access to The project's name under the EnergyMachines™ logo is a link to the project's profile (opens in a new tab).
Tools with section-specific availability and functionality See each of the HMI sections for details on this toolbar
Current alarm count (turns red and starts blinking if there is an unaddressed alarm) Click to go to Alarms

Navigation

Lists the elements present in the selected view, sorted alphabetically. Directories, if present, are collapsible and listed first. Search field atop provides basic filter functionality.

In some views, the navigation bar also contains a set of management tools detailed in the corresponding articles.

Viewer

Displays the entire content of the selected view, occupying the entire remaining screen space. The viewer may be tabbed and contain further navigation tools depending on the view; see corresponding articles.

Server messages are also shown as pop-ups in the viewer, see Systems for details.


Table of contents