Vorsicht

Dies ist die Dokumentation des aktuellen Entwicklungszweigs der CometVisu. Es besteht daher die Möglichkeit, dass einige der hier beschriebenen Features mit dem aktuellsten Release der CometVisu nicht genutzt werden können.

Das Diagramm_Info Plugin

Autor: Michael Hausl [michael at hausl dot com]

Verfügbar seit: 0.6.0

Zu tun

Inhalt übertragen + openHAB Ergänzungen

Beschreibung

Das Diagram-Plugin bietet die Möglichkeit als Widget einen aktuellen Wert anzuzeigen, der beim Anklicken ein Popup-Diagramm öffnet, dass den zeitlichen Verlauf des Wertes visualisiert. Die Datenquelle muss im rrd-Format oder in einer Influx-Datenbank vorliegen. Genaueres dazu im Abschnitt RRD-Einführung & Beispiele.

Soll das Diagramm selbst als Widget angezeigt werden, muss das diagram-Plugin verwendet werden. Genauere Informationen dazu unter Das Diagram Plugin.

Detaillierte Einstellungen

Das Diagram-Plugin ist eines der Widgets mit den umfangreichsten Konfigurationsmöglichkeiten. Viele der Attribute- bzw. Elemente sind aber optional für verschiedene Sonderanwendungen, so dass bereits mit wenigen Einstellungen sehr ansehnliche Diagramme in der CometVisu dargestellt werden können.

Erlaubte Attribute im Diagramm-Element

Element	Attribut
	Name	Inhalt	Beschreibung
diagram_info	format	Text	Formatierung des Wertes (printf-Syntax).
	styling	Text	Ändert die Farbe des angezeigten Wertes abhängig vom Wert selbst. Siehe auch Styling
	mapping	Text	Ordnet den Werten vom Bus andere Werte, Texte oder Symbole zur Anzeige zu. Siehe auch Mapping
	align	left, right oder center
	bind_click_to_widget	true oder false	Beim Aktivieren dieser Option wird die gesamte Widget Fläche als Schaltfläche genutzt
	series	hour, day, week, month, year, fullday oder custom	Legt die Einheit des period Attributs fest zB. day, hour
	refresh	integer
	period	Text	Zeitraum als Vielfaches von „series“ der im Diagram dargestellt wird
	gridcolor	Text	Farbe der Gitternetzlinien im Diagramm
	legend	both, inline, popup oder none
	legendposition	nw, ne, sw oder se
	title	Text
	tooltip	true oder false
	timeformat	Text
	timeformatTooltip	Text
	zoomYAxis	true oder false
	seriesStart	Text
	seriesEnd	Text
	seriesResolution	integer

Erlaubte Kind-Elemente und deren Attribute

Element	Attribut
Struktur	Name	Inhalt	Beschreibung
diagram_info layout	colspan	Zahl	Spaltenanzahl für dieses Widget.
	colspan-m	Zahl	Übersteuert die Spaltenanzahl auf mittleren (medium) Browser Größen.
	colspan-s	Zahl	Übersteuert die Spaltenanzahl auf kleinen (small) Browser Größen.
	rowspan	Zahl	Zeilenanzahl für dieses Widget.
	x	Text	Horizontale Position des Widgets auf 2D Seiten.
	x-s	Text	Horizontale Position des Widgets auf 2D Seiten auf kleinen (small) Browser Größen.
	x-m	Text	Horizontale Position des Widgets auf 2D Seiten auf mittleren (medium) Browser Größen.
	y	Text	Vertikale Position des Widgets auf 2D Seiten.
	y-s	Text	Vertikale Position des Widgets auf 2D Seiten auf kleinen (small) Browser Größen.
	y-m	Text	Vertikale Position des Widgets auf 2D Seiten auf mittleren (medium) Browser Größen.
	z	Text	Für zukünftige Anwendungen reserviert.
	width	Text	Breite des Widgets auf 2D Seiten.
	width-s	Text	Breite des Widgets auf 2D Seiten auf kleinen (small) Browser Größen.
	width-m	Text	Breite des Widgets auf 2D Seiten auf mittleren (medium) Browser Größen.
	scale	true oder false	Automatische Anpassung der Layout-Werte auf Basis der Skalierung des Backdrops ein/-ausschalten (Standardeinstellung: true).
	scale-s	true oder false	Automatische Anpassung der Layout-Werte auf Basis der Skalierung des Backdrops ein/-ausschalten auf kleinen (small) Browser Größen (Standardeinstellung: true).
	scale-m	true oder false	Automatische Anpassung der Layout-Werte auf Basis der Skalierung des Backdrops ein/-ausschalten auf mittleren (medium) Browser Größen (Standardeinstellung: true).

Element	Attribut
Struktur	Name	Inhalt	Beschreibung
diagram_info label icon	name	Text	Name unter dem das Icon registriert ist.
	type	Text
	flavour	Text	Auswahl der Darstellungsvariante. Siehe auch Flavour.
	color	Text	Farbe des Icon in CSS Notation (z.B. #1188FF).
	styling	Text	Ändert die Farbe des angezeigten Wertes abhängig vom Wert selbst. Siehe auch Styling
	class	Text	Füge dieses Attribut der CSS Klasse hinzu, so dass das Widget durch ein eigenes Stylesheet zusätzlich formatiert werden kann.
diagram_info label #text		Text	Text um bei dem Widget eine Beschreibung darzustellen.

Element	Attribut
Struktur	Name	Inhalt	Beschreibung
diagram_info axis	label	Text	Legt die Achsenbeschriftung fest
	min	Zahl	Definiert das Minimum der y-Achse.
	max	Zahl	Definiert das Maximum der y-Achse.
	position	left oder right
	unit	Text	Legt die Einheit fest, die hinter den Zahlen der y-Achsenbeschriftung bzw. im Tooltip angezeigt werden
	decimals	integer	Legt die Anzahl der Nachkommastellen fest, die in der y-Achsenbeschriftung bzw. im Tooltip angezeigt werden
diagram_info axis #text		Text

Element	Attribut
Struktur	Name	Inhalt	Beschreibung
diagram_info rrd	yaxis	Text	Weist die Daten einer y-Achse zu
	color	Text	Legt die Farbe der Diagrammlinie fest
	label	Text	Definiert den Namen der Datenreihe in der Legende
	scaling	Zahl
	steps	true oder false
	fill	true oder false	Füllt den Bereich unterhalb der Datenreihe bzw. Säule
	style	lines, bars oder points
	barWidth	integer	Breite der Balken in Einheiten der X Achse, im Gegensatz zu anderen Werten die in Pixel angegeben werden. Für Zeitverläufe z.B. ist die Einheit Millisekunden, sodass 24 * 60 * 60 * 1000 Balken in der Breite von einem Tag erzeugt.
	align	left, right oder center
	datasourceIndex	integer	Im Falle mehrerer Datenquellen in einer RRD-Datei kann hier der Index der Datenquelle angegeben werden, die angezeigt werden soll. Um den richtigen Index herauszufinden, kann „rrdtool info“ verwendet werden.
	consolidationFunction	AVERAGE, LAST, MIN oder MAX	Auswählen einer der verfügbaren Consolidation Functions des RRDTools (http://rrdtool.org).
	resolution	integer	Die Standard-Auflösung für die Daten aus der RRD-Datei kann überschrieben werden mit einem eigenen Sekunden-Wert.
	offset	integer	Offset in Sekunden, um die Zeitstempel der Daten aus der RRD-Datei zu modifizieren.
diagram_info rrd #text		Text

Element	Attribut
Struktur	Name	Inhalt	Beschreibung
diagram_info influx	measurement	Text	Auswahl der Datenbank und des Measurement (Beispiel: timeseries_db/KNX_LINE1)
	yaxis	Text	Weist die InfluxDB-Daten einer y-Achse zu
	color	Text	Legt die Farbe der Diagrammlinie fest
	label	Text	Definiert den Namen der Datenreihe in der Legende
	scaling	Zahl
	steps	true oder false
	fill	true oder false	Füllt den Bereich unterhalb der Datenreihe bzw. Säule
	style	lines, bars oder points
	barWidth	integer	Breite der Balken in Einheiten der X Achse, im Gegensatz zu anderen Werten die in Pixel angegeben werden. Für Zeitverläufe z.B. ist die Einheit Millisekunden, sodass 24 * 60 * 60 * 1000 Balken in der Breite von einem Tag erzeugt.
	align	left, right oder center
	authentication	Text	Wenn die InfluxDB Authentifizierung benötigt, dann werden die Anmeldeinformationen aus der Hidden-Konfiguration mit diesem Schlüssel verwendet.
	field	Text	Im Falle mehrerer Felder (Spalten) in einer InfluxDB-Zeitreihe kann hier der Name des Feldes angegeben werden, die angezeigt werden soll. Wenn nicht explizit angegeben, wird „*“ verwendet. Achtung: Es darf nur eine Spalte ausgewählt werden, sonst wird keiner angezeigt.
	resolution	integer	Die zeitliche Auflösung für die Daten aus der InfluxDB kann auf eine eigenes Intervall (Wert in Sekunden) festgesetzt werden. Der Wert „0“ schaltet die Gruppierung aus.
	consolidationFunction	COUNT, DERIVATIVE, DERIVATIVE_COUNT, DERIVATIVE_MEAN, DERIVATIVE_MEDIAN, DERIVATIVE_MODE, DERIVATIVE_SUM, DERIVATIVE_FIRST, DERIVATIVE_LAST, DERIVATIVE_MIN, DERIVATIVE_MAX, DERIVATIVE_PERCENTILE_1, DERIVATIVE_PERCENTILE_5, DERIVATIVE_PERCENTILE_10, DERIVATIVE_PERCENTILE_20, DERIVATIVE_PERCENTILE_25, DERIVATIVE_PERCENTILE_75, DERIVATIVE_PERCENTILE_80, DERIVATIVE_PERCENTILE_90, DERIVATIVE_PERCENTILE_95, DERIVATIVE_PERCENTILE_99, DIFFERENCE, DIFFERENCE_COUNT, DIFFERENCE_MEAN, DIFFERENCE_MEDIAN, DIFFERENCE_MODE, DIFFERENCE_SUM, DIFFERENCE_FIRST, DIFFERENCE_LAST, DIFFERENCE_MIN, DIFFERENCE_MAX, DIFFERENCE_PERCENTILE_1, DIFFERENCE_PERCENTILE_5, DIFFERENCE_PERCENTILE_10, DIFFERENCE_PERCENTILE_20, DIFFERENCE_PERCENTILE_25, DIFFERENCE_PERCENTILE_75, DIFFERENCE_PERCENTILE_80, DIFFERENCE_PERCENTILE_90, DIFFERENCE_PERCENTILE_95, DIFFERENCE_PERCENTILE_99, ELAPSED, INTEGRAL, MAX, MEAN, MEDIAN, MIN, MODE, SPREAD, STDDEV oder SUM	Auswählen einer der verfügbaren Daten Aggregierungs Funktionen - notwendig, wenn das Attribut „resolution“ gesetzt ist.
	fillMissing	Text	Option wenn Attribut „resolution“ gesetzt ist: fülle Zeitpunkte für die keine Daten vorhanden sind mit diesem Wert oder einem aus „linear“, „none“, „null“ oder „previous“.
	offset	integer	Offset in Sekunden, um die angezeigten Zeitstempel der Daten aus der InfluxDB zu modifizieren.
diagram_info influx tag	key	Text
	operator	=, !=, <, <=, >, >=, =~ oder !~
	value	Text
diagram_info influx and tag	key	Text
	operator	=, !=, <, <=, >, >=, =~ oder !~
	value	Text
diagram_info influx or tag	key	Text
	operator	=, !=, <, <=, >, >=, =~ oder !~
	value	Text

Element	Attribut
Struktur	Name	Inhalt	Beschreibung
diagram_info address	transform	Text	Umwandlung des Bus-System Wertes um angezeigt werden zu können.
	mode	disable, read, write oder readwrite	„disable“ deaktiviert die Kommunikation, bei „read“ wird nur vom Backend gelesen, bei „write“ wird nur geschrieben und „readwrite“ wird die Adresse zum Lesen und zum Schreiben verwendet.
	variant	Text
	format-pos	Zahl	Position für Format-String wenn mehrere Adressen gleichzeitig genutzt werden.
	selector	Text	Nur MQTT: JSON Selektor
	qos	Zahl	Nur MQTT: QoS
	retain	true oder false	Nur MQTT: retain Flag
	ignore-error	true oder false	Nur MQTT: ignoriere Dekodierfehler.
diagram_info address #text		Text	Die Gruppenadresse (z.B: 12/0/7) bei KNX-Backends, der Item-Name beim openHAB-Backend oder das Topic bei MQTT.