HMI screens¶
An HMI screen is a picture of a site made of widgets: gauges, tank levels, status lights, pump controls and plain values. The HMI home screen is the first thing you see after you sign in.
Note
HMI screens in the app are built in the app. They are separate from the HMI views on a location's page in the web portal (see Locations and HMIs), so a screen you build on one does not appear on the other.
View an HMI screen¶
Open the menu (☰) and tap HMI, or just sign in: the app opens your first HMI screen.
- Switch screens with the bar along the bottom. Each HMI has its own icon and name. Tap one to open it.
- Move around by dragging with one finger. Zoom by pinching.
- Tap Fit to Screen (the expand icon, bottom right) to fit the whole screen on your display.
- Values refresh automatically every 60 seconds while the screen is open.
If your account has no HMI screens yet, the screen is empty and shows Create New HMI at the bottom. See Create an HMI screen.
Widget types¶
| Widget | Shows |
|---|---|
| Radial gauge | One channel as a dial, with a minimum and maximum |
| Linear gauge | One channel as a bar |
| Text box | One channel's value and units as text |
| LED | An on/off state, drawn as a light, pump, valve or alarm symbol |
| Tank | A tank's level |
| Pump controller | A pump's Run, Running, Speed Setpoint, AHO (hand-off-auto) and Error channels |
A widget with a blue border can accept setpoints or commands.
Widget options¶
Tap a widget to select it. Small round buttons appear above it:
- Trend graphs (blue chart icon) opens the Graphs screen with the widget's channels (up to four) over the last 24 hours.
- Change setpoints (purple icon) appears only on widgets that accept commands. See Send a setpoint or command.
Warning
The green check at the right of each widget's title bar does not show whether the widget's channels are in alarm. To see active alerts, open Alerts or Devices.
Send a setpoint or command¶
You can change a setpoint or send a command, such as starting a pump, from any widget with a blue border.
- Tap the widget, then tap Change setpoints (the purple icon above it).
- The Send Command To widget name dialog lists each value you can change:
- Values with fixed choices (for example, hand-off-auto) show buttons. Tap the one you want.
- Numbers show a box with − and + buttons, limited to the channel's range. Type the number or use the buttons.
- Tap Save to send. Tap Cancel to close without sending.
The icon in the widget's title bar shows what happened to the command:
| Icon colour | Meaning |
|---|---|
| Orange | No command sent yet |
| Blue | Sent, waiting for the device to confirm |
| Green | The device acknowledged the command |
| Red | The command failed or timed out. Check the device and try again |
If the command could not be sent at all, a red Command failed message appears for a few seconds.
Note
Sending commands needs the HMI's roles. See Who can edit and send commands.
Create an HMI screen¶
You need the account's Create HMI role. See Roles and permissions.
- Tap the green + button (Create New HMI) at the bottom right of the HMI screen.
- In the Create New HMI dialog, enter a Title. This is the name on the bottom bar.
- Under HMI Icon:, pick Tower, Plant or Pumping Station.
- Under HMI Permissions:, pick a role for each:
- View Role: who the screen is for.
- Edit Role: who can change the screen's widgets.
- Send Command: who can send setpoints and commands from the screen.
- Tap Create.
Warning
Pick the same role for Edit Role: and Send Command:. In this version of the app, editing the screen and sending commands each need both roles, so with different roles only people who hold both can do either. See Who can edit and send commands.
The new, empty screen is added to the bottom bar. Add widgets to it as described next.
Note
The app cannot rename or delete an HMI screen, or change its roles after you create it. Contact D6 Labs support if you need to.
Edit an HMI screen¶
- Open the screen and tap Edit HMI (the pencil icon at the top).
- Make your changes (see below).
- Tap Save (the cloud icon) to keep them. The message Successfully saved HMI changes. confirms it.
To leave without saving, tap Cancel (the X icon). The Discard Changes dialog asks "Are you sure you want to cancel without saving changes?" Tap Yes to discard or No to keep editing.
Note
Editing needs the HMI's roles. See Who can edit and send commands.
Add a widget¶
- In edit mode, tap Add Widget (the gauge-with-plus icon). The Widget Toolbox slides in from the left.
- Drag the widget you want from the toolbox onto the screen.
- Fill in the widget's settings (see Widget properties) and tap Create.
- Close the toolbox with its close button when you are done.
Move or remove a widget¶
- Move a widget by dragging it. Widgets snap to a small grid.
- Remove a widget: tap it, tap the orange Remove icon above it, and confirm with Delete.
Widget properties¶
To change an existing widget, tap it in edit mode, then tap Properties (the gear icon below it). Change the settings and tap Save.
| Setting | What it does |
|---|---|
| Title | The name shown on the widget |
| Device | The device the widget reads from |
| Tags: | One entry per value the widget uses (for example Channel, Level, or the five pump controller tags). Tap a tag to open it |
| Enabled? | Whether the tag is used |
| Channel | Which channel of the device feeds the tag |
| Range Min / Range Max | The scale of a gauge or tank |
| Units | The units shown next to the value |
| Bitmask | LED widgets only. Which bits of the channel's value turn the light on. The default, 65535, uses all bits |
| Inverted? | LED widgets only. Lights the LED when the value is off instead of on |
| Style list | LED widgets only. Draws the LED as LED, Pump, Valve or Alarm |
Who can edit and send commands¶
Each HMI screen has the three roles chosen when it was created. Your administrator assigns roles to users (see Roles and permissions).
| To do this | You need |
|---|---|
| Create a new HMI screen | The account's Create HMI role |
| Edit a screen (add, move, change or remove widgets) | The screen's Edit Role and Send Command role |
| Send a setpoint or command | The screen's Edit Role and Send Command role |
| View a screen | Any user can open every screen in the app |
When you try something you don't have the role for, an Access Denied message appears. Tap Close and ask your administrator. (For HMI edits and commands, the message names the permission, HMI Edit or HMI Modify, rather than one of your account's roles.)