Gauge Node

Gauge charts display data that represents a single key value within a predefined range, often resembling the dashboard of a car. They're useful for understanding where a current value sits within a spectrum, such as performance against a target.

What is a gauge?

Gauge visualization, akin to a speedometer, is a graphical representation designed to succinctly display a single data point within a predefined range or target value. Typically featuring a circular dial divided into sections representing various performance levels, a needle or pointer indicates the value being measured. These visualizations commonly include markers denoting thresholds or targets, aiding in quick assessment of whether the current value meets desired objectives. Customizable in terms of color, style, and labels, gauge charts find application across diverse domains such as performance monitoring, goal tracking, health metrics, and quality control, offering a straightforward and intuitive means to convey critical information within a broader context, thus facilitating informed decision-making and efficient monitoring.

Inputs

The value node has a mandatory input:

Input	Requirement	Comments
Input Data Field	Mandatory	This is the field name within the incoming JSON payload that contains the data value to be displayed on the widget.

Functionality

The node will take the value from the input data field and display it on a gauge widget. The widget will also display a dial, which will point to the relevant position on the gauge as the data value changes.

How to Use

Implementation

In the Rayven Workflow Builder:

Select Visualizations.
Drag the gauge node to the canvas.
Provide an input to the gauge node by connecting it to another node.
Double click on the gauge node to open the configuration window.

Configuration

Section: General
This section contains basic configuration elements required for any gauge implementation
Field	Requirement	Comments
Widget Name	Mandatory	Enter a name for this node. This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose.
Widget Subtitle	Optional	Additional text that can be used to explain the data presented by the node. This will appear directly under the Widget Name, in a smaller text size.
Input Data Field	Mandatory	This is the field name within the incoming JSON payload that contains the data value to be displayed on the widget. The widget will display the latest value received.
Device/Device Label Name	Optional	Select this checkbox to display the device or label name on the widget.
Lower Limit Value	Mandatory	Enter the minimum value that will be displayed on the left end of the gauge This parameter also accepts dynamic value from the JSON payload by taking [[]] notation (eg. [[min]] where the JSON key min holds the minimum gauge limit)
Upper Limit Value	Mandatory	Enter the maximum value that will be displayed on the right end of the gauge This parameter also accepts dynamic value from the JSON payload by taking [[]] notation (eg. [[max]] where the JSON key max holds the maximum gauge limit)
Symbol	Optional	Enter a symbol that will be displayed at the end of the value (e.g. °C or °F)
Decimal Precision	Optional	Enter the number of decimal places to display on the dashboard
Comma Separators at Thousand Mark	Optional	When checked, there will be comma separators at the thousand mark.
Range 1	Mandatory	Use each multi-row to configure a colored range that will appear inside the gauge. In the first textbox enter the lower value and in the second textbox enter the higher value. Select the color of this range using the color picker. To add additional ranges, click the ⊕ Add Value button and repeat the above process. To change the order of the ranges in the node, click and hold the arrow handles on the left of the row and drag to the required position. To delete a range, click the ‘X’ at end of each row Ranges can also be set dynamically by providing a variable name in place of a numeric value. The dynamic variable must be provided using the format [[variableName]]. A dynamic variable and a static variable can also be used together to define a range. For example from 0 to [[max]] or from [[min]] to 100.

Section: Tooltip Info
Field	Requirement	Comments
Show Tooltip	Optional	When checked, it allows users to display their tooltip text on the widget.
Tooltip Text	Optional	This section only exists when “Show Tooltip” is checked. Users are able to write any tooltip message they desire which will be display on the widget.

Section: Group by Device Label
Field	Requirement	Comments
Device label name	Optional	There are no labels available in this box until you have saved at least one in the Device Labels section of the Workspace. Select a Label to use to filter devices.
Grouped	Optional	Select a method for grouping the widget on the dashboard from the dropdown: No Grouping (widget per device): one widget will appear for each device Group by device label value (Widget per label value): One widget will appear for each value of a label. For example, if the Label is ‘Color’ and there are the values ‘Green’ and ‘Gold’, then two widgets will be displayed, one with devices with Color Label equal to “Green” and one with devices with Color Label equal to “Gold” Group by device label name (One widget): Only one widget will be displayed and this will contain data from all devices.
Function	Mandatory	Select a function from a dropdown menu Last value received Sum Average Maximum Minimum Last value from each device with common device label This is important when multiple devices are sending data to a value node. In this situation, select the function that you wish to apply.
Calculation interval	Mandatory (Only if Function is set to Sum, Average, Maximum, Minimum or Accumulated)	Enter an integer to determine how often the function should be performed.
Units of Measurement	Mandatory (Only if Function is set to Sum, Average, Maximum, Minimum or Accumulated)	Select a unit of measure to determine how often the function should be performed. Select from a dropdown menu: Seconds Minutes Hours Weeks Months (Starts on Monday) Months (Starts on Sunday) Years
Subfunction	Mandatory (Only if Function is set to Last value from each device with common device label)	Select from a dropdown menu Sum Average Maximum Minimum