In this article you are going to learn how to use the Gauge widget.
Introduction
The Gauge is a widget for Raw Analysis of data. It displays the KPI of a selected parameter from a selected device for the selected period. It also allows you to compare the value obtained with the same value for the previous period.
Available frequencies and periods
- The frequency of the parameter doesn't apply in this widget
- The available periods are all the ones available in the platform: today, yesterday, last 7 days, last 28 days,...
Requirements
- To have data available for the parameter selected
- Any parameter can be selected
- Depending on the parameter type (accumulated or instantaneous) the operations to show are different: sum for the accumulated parameters like the Active Energy, and maximum, minimum or average for the instantaneous ones like the Active Power.
Configuration
To set up this widget, you need to have a dashboard created beforehand.
- Go to the dashboard and click on Edit Dashboard on the top right of the Dashboard.
- Click on "Add widget".
- Select the Raw Analysis - by parameter in the Source of Data section.
- Select the Gauge widget.
- Select a parameter and a device that you want to visualise the indicator from.
- Select the operation that you want to apply to the parameter.
- Select the period of time for which you want to visualise the indicator. (ie: today, last month).
- Select the option you want to compare the KPI with another period.
Now the widget is ready and it will be added to your Dashboard when you save it!
Widget detailing
The widget shows:
- The KPI for the parameter and the device selected in the defined period.
- Hovering the mouse over the indicator will show the exact value of the indicator.
- The value below the indicator shows the comparison between the current period and the period defined in the configuration, and it can be displayed either in absolute value or in %.
- The defined gauge threshold.
- The defined ranges with the previously defined colours. When hovering the mouse, the ranges are also displayed.
- The defined checkpoints with the previously defined colours as well as a black checkpoint indicating the consumption for the previous period in case the comparison is active. When hovering the mouse, the checkpoints are also displayed.
Edit options
From the Edit Options window you can modify many of the visible aspects of the widget such as the gauge threshold, the ranges and the checkpoints:
Define gauge threshold
Defining the gauge threshold is simply a matter of adding a start value and an end value.
The ranges and checkpoints shall be adapted to this threshold and shall always be displayed in the position relative to it.
If this threshold is reset to the default, the minimum will automatically go to 0 and the maximum will go to one unit more than the one set by the indicator.
Add ranges
The indicator widget also allows you to add ranges with customised titles and colours.
To do this, you can follow these steps:
- Go to the Edit Options window
- In the ranges part you can add as many ranges as you want and customise the title, the range and the colours. The first three ranges will come, by default, with the 3 colours you can see in the following image: green, orange and red:
Ranges shall be displayed according to the threshold previously defined. If a range is defined beyond the upper threshold value, this range shall not be displayed.
The size of the ranges will also be defined by the defined threshold.
If you decide to reset the ranges to the default ranges, they will be automatically deleted, and you can recreate them from scratch.
Add checkpoints
The checkpoints allow you to add flags in the main bar as opposed to ranges which are displayed in a secondary bar below the main bar.
You can customise the colour, value and title of the checkpoints, and they will be displayed in the widget according to the previously defined threshold values.
In case you reset the checkpoints to default, they will be automatically deleted, and you can recreate them from scratch.