View and manage pending alerts

The Alert viewer dashlet was introduced with Firmware v4.6. It can be added to a dashboard to view and manage the eGauge system alerts without navigating away from the current dashboard view.

System alerts are displayed in the Alert viewer in a list form including the alert condition and the date and time when it last triggered.  Each alert can be expanded out to show additional detail by clicking on the 'down arrow' on that line as shown below.

Once an alert has been expanded it will be marked as 'read' or 'acknowledged' and will be displayed in greyed text. The reported alert may be removed from the log by clicking the 'Delete' button. Deleting the alert entry will only remove the log entry, if the alert is triggered again a new log entry for the alert will show in the list.

The Alert viewer has its own menu, similar to the Main menu, with different items:  

• Save config to meter - Saves option changes to the Alert viewer dashlet to the meter. This currently saves the default 'Recheck' interval for the Alert Viewer.
• Load config from meter - Load option changes to the Alert viewer that may have been saved on another computer or browser.
• Configure alerts - Choose this item to configure user-defined alerts and related options. For more information please read: <link to alert configuration article, yet to be written> 
• Recheck - Use this option to set the interval at which you want your dashlet to automatically refresh with new alerts. Choose 'now' to refresh the list at any time without affecting the set interval.
• Mark all as read - Choose this item to mark all alerts in the list as read.  Alerts marked as read will be greyed, new alerts will show up in black text.
• Delete all - Choose this option to delete all existing system alerts from a meter.  This cannot be undone.

Display the value of a single register over time

The Almanac dashlet has the same functionality as the Almanac view (introduced in firmware v4.7) accessed from the Main menu but can be added to a dashboard layout for convenience.  For details, please see: Almanac View

Display recorded and latest measurements as a graphical chart

The Chart Dashlet has the same functionality as the main Chart View but can be added to a Dashboard layout to display multiple Chart setups on one screen or to display a chart setup alongside other Dashlets.

Each Chart Dashlet has its own menu which can be used to customize the Dashlet chart independently of other Chart setups on the meter, or load Chart setups that have already been saved to the meter via the main Chart View.

For more information on creating and modifying charts, see this article. 

Display the most recent value of a single register as a dial gauge.

The Dial Gauge Dashlet displays the most recent value of a single register as a dial gauge. It can also display markers indicating the minimum and/or maximum values of that register over a certain time period (e.g., over the last 24 hours).

After Edit mode is exited, click on the three dots in the upper-right corner of the Dashlet to enter the configuration settings. If you don't see the three dots immediately, clicking on the Dashlet will cause it to appear.

Settings:

• Register name - This dropdown lists all of the configured registers on the meter.  Choose the one that you want to show in this dial gauge.
• Flip the sign of the value - Enable this checkbox to flip the polarity of the register.
• Preferred unit - If left to 'auto' the instantaneous reading will show in an automatically chosen unit based on the register type.  Alternate units are available in this dropdown are also dependent on the register type chosen in the 'Register name' setting.  For instance, a unit of °F would only be available if the register defining the Dashlet was configured as a temperature register.
• Optional custom title - If you prefer to label the Dashlet with a name other than the register name, add it here. If this field is left blank then the name of the register chosen for the Register name setting will be used.
• Minimum value - Defines the lowest value on the dial.
• Maximum value - Defines the highest value on the dial
• Color-scheme - Choose which color scheme you would like to apply to your dial.  
• Start angle (-180..+180°) - Adjusts the angle of the starting side of the dial.
• End angle (-180..+180°) - Adjusts the angle of the ending side of the dial.

Extremum marker - Enable this option if you would like the dial to display an extremum marker. Enabling this option will add additional options to choose minimum and/or maximum extremum markers as well as some pre-defined timeframes for tracking. Note: enabling extremum markers can negatively impact the interface if there is a large amount of data to process to determine the extremum values. If the dashboard constantly displays the red "Loading registers" dialogue box, try limiting the extremum marker time period to a shorter period or disabling them.

Export eGauge data to a CSV file

The Export Dashlet has the same functionality as the main Export page but can be added to a Dashboard layout to display multiple pre-set data export setups on one screen or to display alongside other Dashlets.

For more information on using the data Export please see this article.

Display a table of the most recent measurements

The Now Table Dashlet displays a table of the most recent instantaneous register readings. It is also possible to display a ratio between two registers. You will have different settings available depending on whether you choose to display a register value or a ratio.

After exiting Edit mode, click the Add button in the upper-right corner to add rows to your table and configure the settings.

Settings:

• Type:
  • Register Value
    • Name - Custom name to apply to the row. This should be something descriptive to clearly identify the displayed value to the viewer.
    • Register to display - Choose the configured register reading that you would like to display.
    • Preferred unit - Leaving this set to 'auto' will choose the unit type for you based on the configured register type. Alternate units appropriate to the register type will also be available to choose.
    • Flip the sign of the value - Enable this option to flip a positive reading to negative, and vice-versa.
  • Ratio of two registers
    • Name - Custom name to apply to the row. This should be something descriptive to clearly identify the displayed value to the viewer.
    • Numerator 
    • Denominator
    • Flip the sign of the value - Enable this option to flip a positive reading to negative, and vice-versa.

Tap the Rearrange button to the left of the Add button on the Now Table and then click and drag rows up or down to reorder, if desired.

Visualizes how resources flow between user-selected icons.

The Resource Flow Diagram is a complex Dashlet that visualizes how resources flow between user selected icons. This Dashlet can be used, for example, to show how power flows from the grid to a house or from a solar panel to the house.

To edit the Resource Flow Diagram dashlet, exit "Edit" mode after adding. Then, hover the mouse or press along the top of the dashlet, shown in the red dashed line below. The pencil icon and plus sign should appear:

Clicking the pencil icon will allow you to edit or delete any existing item in the diagram. Click the icon to edit it, or the X in the lower right-hand corner to remove it from the diagram:

To exit edit mode, hover the mouse back over the top bar and click the pencil icon again.

To add an icon, click the plus button and select a grid location to add an item to. In the image below, the bottom-right corner has been selected:

Then click the blank box to choose an icon:

A list of icons will appear. In this example, the Windmill icon was selected:

Finally select the associated register, in this case "Wind inverter":

Exit the edit mode by clicking the pencil icon, and the dashlet will contain the newly added item. Positive values indicate power is flowing from the item to the center of the diagram (generation), while negative values indicate power is flowing to the item from the center of the diagram (load).  If the polarity is incorrect, either reverse it in the register or create a virtual register to flip the sign to avoid disrupting historical data. Creating a virtual register is recommended.

Show one of two signal icons based upon a comparison of a register value against a constant.

The signal dashlet can be used to tell at a glance if a particular reading is above or below a particular threshold. After exiting Edit mode, click on the Dashlet and click on the three-dots menu in the upper right of the Dashlet to access the configuration settings.

Settings:

• Register name - Choose the configured register to alert on.
• Comparison type - Choose the operator used to compare the chosen register reading to the comparison value setting.
• Comparison value - Set the threshold between the signal icons.
• Unit - Choose the appropriate unit to display the most recent reading.
• True icon/False icon - Choose the icon style from a pre-set list of several options.
• Show register value - Enable this option to display the most recent register reading below the displayed icon. 
• Optional title - Edit this field to add a custom message to the bottom of the Dashlet. 

Display a table of measurement summaries.

The Summary Table Dashlet is used to display a list of summary values relative to an adjustable time period. It is also possible to display a ratio between two registers. You will have different settings available depending on whether you choose to display a register value or a ratio.

After exiting Edit mode, click the Add button in the upper-right corner to add rows to your table and configure the settings for each row.  Choose the time period for the table to reflect by clicking on the 'Time period' area on the Top bar of the Dashlet and choose either a pre-set time frame from the list or set a custom date range.

Settings:

• Type:
  • Register Value
    • Name - Custom name to apply to the row. This should be something descriptive to clearly identify the displayed value to the viewer.
    • Register to display - Choose the configured register reading that you would like to display.
    • Preferred unit - Leaving this set to 'auto' will choose the unit type for you based on the configured register type. Alternate units appropriate to the register type will also be available to choose.
    • Display average value - Enable this option to display the average value over the chosen time period for this row.
    • Flip the sign of the value - Enable this option to flip a positive reading to negative, and vice-versa.
  • Ratio of two registers
    • Name - Custom name to apply to the row. This should be something descriptive to clearly identify the displayed value to the viewer.
    • Numerator 
    • Denominator
    • Flip the sign of the value - Enable this option to flip a positive reading to negative, and vice-versa.

Tap the Rearrange button to the left of the Add button on the Summary Table and then click and drag rows up or down to reorder, if desired. 

On/Off switch that is manually activated

The Switch Dashlet requires the installation of the PRM3 Power Relay Module. The purpose of this Dashlet is to manually control the relays in a PRM3 that is connected to the eGauge meter via USB.

After exiting Edit mode, tap the Dashlet to configure the settings, or use the three-dots menu to edit a previously configured Switch Dashlet:

• Relay to control - Choose the connected PRM3 and relays to control. The PRM3 should be connected to one of the eGauge meter USB ports and will be identifiable based on the PRM3 serial number. If your connected PRM3 is not available in the dropdown, try rebooting your eGauge as an initial troubleshooting step.
• On icon/Off icon - Choose your preferred On/Off switch icon style.
• Optional title - Edit this field to give the Dashlet a custom label below the switch icon. Leaving it set to the predefined value will label the Dashlet with eGauge PRM3 and the serial number.

After configuration, the selected relay(s) can be toggled on and off by clicking the slider button under the icon.

Display the waveforms captured by the device's line and sensor inputs, similar to an oscilloscope

Unlike most other dashlets, the Waveform dashlet requires a significant amount of space to utilize effectively. It is not recommended for users with small or low-resolution screens. A dashlet size of 900x900px is generally adequate, but larger is better in terms of functionality and readability.

Once in place, the Waveform Dashlet is controlled just like the dedicated Waveform View page. Full documentation on the Waveform View page is available here.