Mobile and NG interface

Mobile-Friendly User Interface

The eGauge App provides ease of access to the Mobile Friendly interface. For information on using the eGauge App, please visit this article.

Overview

The original eGauge UI has existed in pretty much the same form since the creation of the meter. Originally, this UI was designed to focus on a few data points (all power-related). As the eGauge meter has continued to evolve (support for remote devices, additional sensor types, and many more non-power measurements) the original interface has lagged behind the feature set supported by the meter.  An updated and more feature-filled and flexible UI known as the "NG user interface" is available in firmware version 4.1. This new user interface is available on all meters at no additional charge, and simply requires a firmware update

Mobile-Friendly View

Most of the new UI elements are contained within the Mobile-Friendly view. On desktop browsers, the Mobile-Friendly view can be selected by navigating to View -> Mobile-Friendly from the main graph page.  Alternatively, the view can be accessed by appending /ng to the URL used to access the meter (for example, DEVNAME.egauge.es/ng for a device accessed via the proxy server, DEVNAME.local/ng for a device accessed over the local network, IP_ADDR/ng for a device accessed directly or via IP address, etc).

Mobile browsers will default to the NG user interface.

To navigate through the elements in the Mobile-Friendly view, click the menu icon in the top left corner of the page (to the left of the meter name). The expanded menu is shown below:

image-1603724256001.png

The first item (in this case, "Chart") will contain settings specific to the UI element which is currently loaded. The second item, "View", allows the user to switch between the various UI elements. "on startup" allows the user to select either the Chart or Dashboard view to load when the page is opened. The username of the user who is currently logged in ("owner" in this case) can be selected to log out. "Help" redirects to the eGauge support knowledgebase (https://kb.egauge.net/). Note that this link will only work if the computer used to access the meter also has internet access (whether the meter itself has internet access is irrelevant).

"Setup" contains advanced settings and configuration options - those are covered in detail here.

The Mobile-Friendly view contains four major UI elements:

Chart

The chart element provides clean and streamlined graph-based display. This element is similar to the original eGauge interface, but features additional customization options and is optimized for a mobile interface. More information on the chart element is available here

Waveform

The waveform element allows for deep inspection of individual measurements taken by the eGauge. This tool is useful for phase checking and other analysis of raw sensor readings. More information on the waveform view is available here

Dashboard

The dashboard element is a modular display which allows the user a great deal of customization. Multiple layouts can be created to get a better sense of how specific data points relate to one another. These layouts can be saved and utilized by others accessing the device. More information on the dashboard is available here

Classic View

The classic view element simply redirects to the original eGauge interface. This interface is much more limited in terms of customization, but some users may prefer to work with the original interface depending on their needs. More information on the classic view is available here

 

 

 

Chart

Overview

The Chart element is designed to provide a modernized and customizable graph-based display to allow for easy visual evaluation of readings captured by the eGauge meter. The Chart element is optimized for mobile browsers and small screens, with a minimal amount of visual clutter compared to the original graph view. All screenshots in this guide are from mobile browsers.

Make sure to read the main NG interface page before continuing.

Contents:

Navigation

Configuration

Saving and Loading Chart Setups

Downloading Chart Data

 

Navigation

All displayed values are updated once per second. However, a slow or high-latency connection may result in slower updates.

image-1603727759849.png

The Chart element is composed of two parts:

Chart

The chart displays a graphical representation of recorded values, plotted over time. The time period to display can be selected using the "Time period..." dropdown menu in the top right corner of the page.

image-1603729903215.png

Chart Item List

The chart item list contains all chart items available for display in the chart.

image-1603730280426.png

To toggle a chart item on or off within the graph, click or tap the box to the left of the chart item name.

image-1603730015018.png

Chart item on

 

image-1603730032741.png

Chart item off

The chart item list also contains a summary value for that chart item. This value can be toggled between the following using the buttons at the bottom of the screen:

Average - Average value (eg, kW) of the chart item over the period selected in the graph.

Accrued - Cumulative value (eg, kWh) of the chart item over the period selected in the graph.

Now - Current value (eg, kW) of the chart item at the current time.

 

To view a graph of a specific chart item, tap or click on the chart item name. This will load a new graph containing only those values, along with some summary information at the bottom of the page.

image-1603730374465.png

To return to the main chart view, click the "View All" button in the top left of the page.

To compare the currently selected data against another set of data (eg, this week's data against the previous month), use the "Compare to..." dropdown menu in the top right corner of the page.

 

Configuration

By default, the Chart view will contain chart items displaying values obtained from the "Usage" and "Generation" virtual registers configured under Settings -> Installation (assuming these virtual registers are configured). However, most users will want to add additional chart items. 

Charts created in the Chart view cannot be opened in the Dashboard view (and vice versa).

Tap or click the "Add" button above the register list to add a new chart item.

image-1603730764687.png

The list of chart items may be hidden at the bottom of the chart. To reveal the list of chart items, click or tap on the bar at the bottom of the chart and drag up.

image-1620160347264.png

A fresh or empty chart won't have any chart items, and as such won't have an "Add" button. In this case, tap anywhere in the list area to add the first item.

image-1620160498518.png

 

 

Newly added chart items may take a few seconds to start displaying values. This is normal.

To edit an existing chart item, long press on that chart item in the chart item list.

This will open a window where a new chart item can be configured. There are three potential chart items which can be displayed:

Curve

Shaded Area

Ratio

 
Curve

A curve is simply a line generated from the values contained within a register in the eGauge's database. This is the most commonly used chart item. In this example, we'll graph the value of the Usage register (which records total site usage).

image-1603733277616.png

Name of item - name to display on the chart and chart item list. Completely arbitrary, but should make sense to the user.

Value to graph - register used to populate the chart item with data. In essence, the actual value used to generate the line.

Show accrued value - graphs a cumulative value instead of an average value. In essence, this displays a graph of the total value for a register. For most registers, this would be an ever increasing or decreasing line. When this option is selected, a new dropdown "Accrue since" will appear to select the start of recording for this register (eg, since start of hour, since start of day, and so on). Useful for measurements like pulse counts.

Flip sign of graphed value - unlike the original eGauge UI, the chart will graph negative values below the x-axis and positive values above the x-axis. To maintain the desired layout, it may be necessary to flip the polarity of one or more registers so they all graph above or below the x-axis.

Line style - allows the user to define a line color and/or line style (solid, dashed, dot-dash) for the chart item. The "Customize color" option can be selected to choose a specific color or enter a HEX code for the desired color.

image-1603731439996.png

 
Shaded area

A shaded area can be used to add emphasis to the chart. There are many uses here, but in this example we'll replicate the shading present in the "Usage" line on the original eGauge UI.

image-1603732634797.png

Name of item - name to display on the chart and register list. Completely arbitrary, but should make sense to the user.

Lower bound of area - the "bottom" of the shaded area. In this example we're using "zero", a function which returns 0.

Upper bound of area - the "top" of the shaded area. In this example we're using the value of the "Usage" register

Lower and upper bound can be used to highlight the range between two chart items. This relationship cannot be inverted (eg, shading will display if upper > lower but not if lower > upper). A second shaded area item is needed for this.

Reported register value - The value reported for the chart item in the chart item list below the chart. Can be left blank, or associated with a register value. In this case, we're using "Usage" since the value of the shaded area and the value of Usage are the same.

Line style - allows the user to define a line color and/or line style (solid, dashed, dot-dash) for the chart item. The "Customize color" option can be selected to choose a specific color or enter a HEX code for the desired color.

 

This is the result - note the red line for Usage, and the lighter red shaded area associated with that line.

image-1603732711155.png

 

Ratio

As its name suggests, the ratio chart item can be used to display the ratio between two values. These values can be obtained from registers, fixed numerical values, or a combination of the two. Unlike the other chart items, a ratio item will only appear in the list of chart items at the bottom of the page (nothing is displayed in the chart itself). In this example, we'll look at the ratio between total usage and electric heat usage.

image-1603733708295.png

Name of item - name to display on the chart and register list. Completely arbitrary, but should make sense to the user.

Numerator - "top" of the ratio equation. A ratio is simply A/B - this would be value A.

Denominator - "bottom" of the ratio equation. A ratio is simply A/B - this would be value B.

Flip sign of reported value - can be used to flip the sign/polarity of the resulting value if desired.

Ratio chart items always return a percentage. In the case of this example, we can say "the electric heating accounts for approximately 54% of the total electrical usage".

image-1603733898256.png

 

Rearranging and Removing Chart Items

Chart items can be rearranged by clicking the rearrange icon above the register list:

image-1619562733464.png

To rearrange the register list, tap or click on a register and drag it to a new position in the list. To remove a register entirely, tap or click on the register and drag it outside of the list area.

Registers are rendered in order - the first register is displayed in front of all other registers, the next register is displayed behind the first register and in front of the remaining registers, and so on. The page must be reloaded to see changes.

 

Saving and Loading Chart Setups

The layout of a chart (chart items, colors, line styles, data to display, etc) is referred to collectively as a "chart setup". Chart setups can be saved to the meter. This is beneficial, as it allows multiple layouts to be preserved and allows multiple users to select the layout they're interested in. For example, a building manager might want to see a general overview of the site, while a tenant might only be interested in their specific usage profile.

image-1603734159439.png

These functions are accessed using the menu in the top left corner of the page. Tap or click the menu, then tap or click "Chart" and select the desired function.

Save as device default - saves the current chart setup as the default chart setup to load when the page is accessed by any user. 

Restore device default - loads the default chart setup. Use caution here if your current chart setup hasn't been saved!

Name this setup - names and saves the current setup. Once at least one chart setup is saved, the "Manage setups" option will be available, and the different setups can be changed from the chart view itself.

Create empty setup - creates a new chart setup with no chart items. Use caution here if your current chart setup hasn't been saved!

Manage setups - Opens a new window where the user can rename or delete saved chart setups. Click "OK" to save changes, or cancel to discard changes.

image-1603734391656.png

 

Downloading Chart Data

Chart data can be downloaded for use in external processing or to create a backup or report. To do this, click or tap the menu icon in the top left corner of the graph, select "Chart", then select "Download chart data."

The resulting export will only contain values for Curve-type chart items. These values are paired with both a unix timestamp and standard date and time value for ease of processing. The values themselves are instantaneous values, and are automatically presented in the highest granularity available.

For more control over export data, it may be desirable to use the XML API

Chart data is not the same as a backup file. It cannot be restored to the eGauge meter in the event of data loss. For information on creating a backup file, see this article.

Dashboard

Overview

Available in firmware v4.1 and newer, the eGauge interface has a new mobile-friendly dashlet interface available to use on mobile and desktop browsers. This interface (referred to as the Mobile-Friendly interface or the NG User Interface) is designed to provide improve customization and reduced clutter compared to the standard eGauge UI. 

A brief video overview is also available.

Make sure to read the main NG interface page before continuing.

Contents:

Accessing the Mobile-Friendly UI

Dashboard Examples

Dashboard Appearance and Layout

Configuring Dashlets

Accessing the Mobile-Friendly UI

If a mobile browser accesses an eGauge running firmware v4.1 or greater, the mobile interface will be displayed automatically. If using a desktop, or the mobile browser is not recognized, the mobile interface can be accessed through View -> Mobile-friendly in the top right of the main graph page. The interface can also be accessed by appending /ng to the URL used to access the meter (for example, DEVNAME.egauge.es/ng for a device accessed via the proxy server, DEVNAME.local/ng for a device accessed over the local network, IP_ADDR/ng for a device accessed directly or via IP address, etc).

Mobile browsers will default to the NG user interface.


Dashboard Examples

Dashboard with Usage and Generation dials, and summary area.

 

Dashboard with Flow Diagram showing a home's usage with solar and wind back-feeding to utility.

 

image-1603743054630.png

More complex Dashboard with a variety of dashlets monitoring total site usage in different ways.

 


Dashboard Appearance and Layout

The dashboard appearance and layout can be customized by the user. A single dashboard is made up of multiple individual components called "dashlets". Each dashlet can be placed and sized independently of every other dashlet. Dashlets snap to the the dashboard automatically.

To add, delete, resize or move dashlets, click the menu icon in the upper left hand corner and choose "Edit":

A bar will appear at the top:

To add a dashlet, click the + sign on the left. A menu will appear with available dashlets. Click the plus button to add the dashlet, or anywhere else in the row to see more information on the dashlet.

image-1603742931120.png

To delete a dashlet, click on the dashlet so it is selected (entering edit mode), and press the center trashbin icon. To exit edit mode, click the X on the right side.

To resize or move, click the dashlet and a box will appear around it. It can then be dragged to a different location, and clicking and dragging the circles on each side will resize the dashlet.


Configuring Dashlets

In "Edit" mode, clicking the + button to add a dashlet will show available dashlets.

Available dashlets

Charts created in the Dashboard view cannot be opened in the Chart view (and vice versa).

 

For the purposes of this article, dashlets will be split into two categories - simple and complex. Simple dashlets typically have minimal configuration options. Complex dashlets will have many more configuration options (and in some cases, dedicated articles explaining the full functionality of the dashlet).

Simple Dashlets

 

image-1603743407370.png

 

image-1603743596564.png