Caution

This is the documentation for the current development branch of the CometVisu. It is possible that some of the described features are not yet available in the current release.

Also there might be lots of errors in this documentation as some parts of the content have been translated by an online translation service.

The gauge plugin

Available since version: 0.8.1
Author: NetFritz [NetFritz at gmx dot de]

Description

This plugins integrates Gauge (in canvas) into the visualization

Settings

For a general understanding of how the configuration files are structured and what elements and attributes are it is recommended to read this section first: visu-config-details.

The behaviour and appearance of the gauge plugins can be influenced by using certain attributes and elements. The following tables show the allowed attributes and elements and their possible values. The screenshots show, how both can be edited in the editor.

Attributes underlined by ..... are mandatory, all the others are optional and be omitted.

Allowed attributes in the gauge-element

Element Attribute
  Name Content Description
gauge type Radial, RadialBargraph, RadialVertical, Linear, LinearBargraph, DisplaySingle, DisplayMulti, Level, Compass, WindDirection, Horizon, Led, Clock, Battery, StopWatch, Altimeter, TrafficLight, LightBulb or Odometer  
subtype type1, type2, type3, type4 or type5  
titleString string  
unitString string  
unitStringVisible true or false  
minValue decimal  
maxValue decimal  
size decimal  
threshold decimal  
thresholdRising true or false  
ledVisible true or false  
lcdVisible true or false  
trendVisible true or false  
autoScroll true or false  
valuesNumeric true or false  
lcdDecimals number > 0  
background DARK_GRAY, SATIN_GRAY, LIGHT_GRAY, WHITE, BLACK, BEIGE, BROWN, RED, GREEN, BLUE, ANTHRACITE, MUD, PUNCHED_SHEET, CARBON, STAINLESS, BRUSHED_METAL, BRUSHED_STAINLESS or TURNED  
framedesign BLACK_METAL, METAL, SHINY_METAL, BRASS, STEEL, CHROME, GOLD, ANTHRACITE, TILTED_GRAY, TILTED_BLACK or GLOSSY_METAL  
width dimenstion (number+unit)  
height dimenstion (number+unit)  
valueColor RED, GREEN, BLUE, ORANGE, YELLOW, CYAN, MAGENTA, WHITE, GRAY, BLACK, RAITH, GREEN_LCD or JUG_GREEN  
mapping string Map the bus value to a different value for displaying.
target string The name of the page, that should be shown.

Allowed child-elements und their attributes

Element Attribute
Structure Name Content Description
gauge
  • layout
colspan decimal Amount of coloumns this widget sould be wide.
colspan-m decimal Overrules the amount of coloumns on a medium screen.
colspan-s decimal Overrules the amount of coloumns on a small screen.
rowspan decimal Amount of rows this widget should be high.
x string Horizontal position of the widget for 2D pages.
y string Vertical position of the widget for 2D pages.
z string Reserved for future use.
width string Width for the widget for 2D pages.
Element Attribute
Structure Name Content Description
gauge
  • label
  • icon
name string  
type string  
flavour string Selection of a display variant. See also :ref:’flavour’.
color string  
styling string  
class string Add this value to the CSS class so that it can be formated by a user provided style sheet.
gauge
  • label
  • #text
  string Text to display a label for the widget.
Element Attribute
Structure Name Content Description
gauge
  • address
transform string  
mode disable, read, write or readwrite  
variant string  
format-pos decimal  
gauge
  • address
  • #text
  string The GA (like: 12/0/7) for KNX-backends or the item name for openHAB-backend
../../../../_images/en_config_widgets_plugins_gauge_index1.png
../../../../_images/en_config_widgets_plugins_gauge_index_editor_elements.png

Examples

It is possible to manually edit the visu_config.xml and add an entry for the gauge plugin.

Caution

Make sure that you only use UTF-8 encoded characters by settings the encoding in your XML-editor to UTF-8 mode!

Footnotes

[1]The simple view might not show everything. To see all elements/attributes use the expert view.