Xplot-Konfiguration: Unterschied zwischen den Versionen
Keine Bearbeitungszusammenfassung |
|||
| (15 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 7: | Zeile 7: | ||
Xplot files:'/opt/fhem/www/xplot':^.*xplot$ | Xplot files:'/opt/fhem/www/xplot':^.*xplot$ | ||
Styles:$FW_cssdir:^.*(css|svg)$ | Styles:$FW_cssdir:^.*(css|svg)$ | ||
haben. Darin sind erste, zweite und vierte Zeile der Default-Wert, die dritte Zeile erlaubt das Editieren der .xplot-Dateien. | haben. Darin sind erste, zweite und vierte Zeile der bisherige Default-Wert, die dritte Zeile erlaubt das Editieren der .xplot-Dateien. | ||
'''Achtung''': Datei-Eigentümer auf fhem:dialout setzen ! | '''Achtung''': Datei-Eigentümer auf fhem:dialout setzen ! | ||
= Konfigurationsbeispiel = | = Konfigurationsbeispiel = | ||
Mit der folgenden Datei werden vier Kurven gezeichnet, bei zwei Koordinatensystemen und zwei Achsen | Mit der folgenden Datei werden vier Kurven gezeichnet, bei zwei Koordinatensystemen und zwei Achsen | ||
| Zeile 106: | Zeile 107: | ||
x: x | x: x | ||
= Xplot – Konfigurationsreferenz (Version | = Xplot – Konfigurationsreferenz (Version 16) = | ||
Referenz für <code>*.xplot</code>-Dateien | Referenz für <code>*.xplot</code>-Dateien | ||
| Zeile 115: | Zeile 116: | ||
! Schlüssel !! Mögliche Werte !! Erläuterung | ! Schlüssel !! Mögliche Werte !! Erläuterung | ||
|- | |- | ||
| api_version || <code>1</code> || | | api_version || <code>1</code> || Pflichtangabe; Version des Konfigurationsformats. | ||
|} | |} | ||
| Zeile 126: | Zeile 127: | ||
| height || Zahl ≥ 150 || SVG-Höhe; Standard 400. | | height || Zahl ≥ 150 || SVG-Höhe; Standard 400. | ||
|- | |- | ||
| title || Text || Plotüberschrift; Standard leer. | | title || Text mit Datums- und Statistikvariablen || Plotüberschrift; Standard leer. Variablen werden bei jedem Rendern aufgelöst, z. B. <code>Gas ${date}: $max{energy:2}</code>. | ||
|- | |- | ||
| frame || <code>rect</code> / <code>rounded</code> || Rechteckiger bzw. abgerundeter Rahmen; Standard <code>rect</code>. | | frame || <code>rect</code> / <code>rounded</code> || Rechteckiger bzw. abgerundeter Rahmen; Standard <code>rect</code>. | ||
| Zeile 132: | Zeile 133: | ||
| theme || <code>default</code> / <code>dark</code> / <code><name></code> || Globales Theme aus <code>themes.yaml</code>. | | theme || <code>default</code> / <code>dark</code> / <code><name></code> || Globales Theme aus <code>themes.yaml</code>. | ||
|- | |- | ||
| background || RGB-Wert / Theme-Farbname || | | background || RGB-Wert (<code>#RGB</code>, <code>#RRGGBB</code>) / Theme-Farbname || Füllfarbe außerhalb des Plotrahmens, auch bei <code>frame: rounded</code>. Überschreibt den Wert aus Theme. | ||
|- | |||
| plot_background || RGB-Wert (<code>#RGB</code>, <code>#RRGGBB</code>) / Theme-Farbname || Füllfarbe innerhalb des Plotrahmens, auch bei <code>frame: rounded</code>. Überschreibt den Wert aus Theme. Ohne Angabe identisch mit <code>background</code>. | |||
|- | |||
| foreground || RGB-Wert (<code>#RGB</code>, <code>#RRGGBB</code>) / Theme-Farbname || Text- und Achsenfarbe. Überschreibt den Wert aus Theme. | |||
|- | |||
| grid_color || RGB-Wert (<code>#RGB</code>, <code>#RRGGBB</code>) / Theme-Farbname || Gitternetzfarbe. Überschreibt den Wert aus Theme. | |||
|- | |||
| frame_color || RGB-Wert (<code>#RGB</code>, <code>#RRGGBB</code>) / Theme-Farbname || Rahmenfarbe. Überschreibt den Wert aus Theme. | |||
|} | |||
== Dynamische Variablen in canvas.title und axes.<name>.label == | |||
{| class="wikitable" | |||
! Schlüssel / Variable !! Mögliche Werte !! Erläuterung | |||
|- | |||
| <code>${date}</code> || TT.MM.JJJJ || Heutiges Datum nach lokaler Serverzeit. | |||
|- | |||
| <code>${day}</code>, <code>${month}</code>, <code>${year}</code> || Tag / Monat / Jahr || Aktuelles Kalenderdatum als Einzelwerte. | |||
|- | |||
| <code>${month_name}</code>, <code>${weekday}</code> || Monats- / Wochentagsname || Sprache entsprechend der Locale des FHEM-Servers. | |||
|- | |||
| <code>${time}</code>, <code>${datetime}</code>, <code>${date_iso}</code> || HH:MM / Datum und Uhrzeit / JJJJ-MM-TT || Weitere aktuelle Zeitangaben. | |||
|- | |||
| <code>${range_start}</code>, <code>${range_end}</code> || TT.MM.JJJJ || Beginn und Ende der dargestellten Zeitachse; benötigt einen eindeutigen Zeitbereich. | |||
|- | |||
| <code>${range_start:%d.%m.%Y}</code> || strftime-Format || Individuelle Formatierung von Bereichsbeginn oder -ende; analog für <code>range_end</code>. | |||
|- | |||
| <code>$min{<source>}</code>, <code>$max{<source>}</code> || Zahl || Minimum bzw. Maximum der Y-Werte der benannten Datenquelle. | |||
|- | |||
| <code>$sum{<source>}</code>, <code>$avg{<source>}</code> || Zahl || Summe bzw. arithmetischer Mittelwert der gültigen Y-Werte (keine zeitliche Integration). | |||
|- | |||
| <code>$cnt{<source>}</code> || Ganzzahl || Anzahl gültiger Y-Werte. | |||
|- | |||
| <code>$firstval{<source>}</code>, <code>$currval{<source>}</code> || Zahl || Erster bzw. letzter gültiger Wert in X-Reihenfolge. | |||
|- | |||
| <code>$firstdate{<source>}</code>, <code>$currdate{<source>}</code> || X-Wert || X-Koordinate des ersten bzw. letzten gültigen Wertes. | |||
|- | |||
| <code>$mindate{<source>}</code>, <code>$maxdate{<source>}</code> || X-Wert || X-Koordinate des Minimums bzw. Maximums. | |||
|- | |||
| <code>$lastraw{<source>}</code> || Rohwert / <code>-</code> || Nur verfügbar, wenn die Quelle einen Rohwert bereitstellt; bei den derzeitigen Standardquellen <code>-</code>. | |||
|- | |||
| <code>$curr{<source>}</code>, <code>$current{<source>}</code> || Zahl || Aliase für <code>$currval</code>. | |||
|- | |- | ||
| | | <code>$minAll</code>, <code>$maxAll</code> || Zahl || Kleinstes Minimum bzw. größtes Maximum der Standardwertspalten aller Datenquellen. | ||
|- | |- | ||
| | | <code>$max{<source>:2}</code> || 0–12 Nachkommastellen || Numerische Formatierung; funktioniert analog für andere Statistikvariablen. | ||
|- | |- | ||
| | | <code>$max{<source>.<spalte>}</code> || Quell- und Spaltenname || Explizite Spaltenwahl für Array-Daten, z. B. <code>$max{messung.strom:2}</code>. | ||
|} | |} | ||
| Zeile 148: | Zeile 189: | ||
|- | |- | ||
| type || <code>filelog</code> || Werte aus einem FHEM-FileLog. | | type || <code>filelog</code> || Werte aus einem FHEM-FileLog. | ||
|- | |||
| || <code>array</code> || Inline-Datenreihe, unabhängig von FileLog und FHEM. | |||
|- | |||
| || <code>columns</code> || Liste eindeutiger Spaltennamen. Pflicht für <code>array</code>; z. B. <code>[spannung, strom]</code>. Mindestens zwei Spalten. | |||
|- | |||
| || <code>rows</code> || Liste numerischer Zeilen. Pflicht für <code>array</code>; jede Zeile muss genau so viele Werte wie <code>columns</code> enthalten. Beispiel: <code>- [1.0, 2.5]</code>. | |||
|- | |- | ||
| || <code>consty</code> || Konstanter Y-Wert: horizontale Linie. | | || <code>consty</code> || Konstanter Y-Wert: horizontale Linie. | ||
| Zeile 205: | Zeile 252: | ||
|- | |- | ||
| range.max || Zahl || Obere Grenze einer numerischen Achse. | | range.max || Zahl || Obere Grenze einer numerischen Achse. | ||
|- | |||
| <code>padding</code> || Nichtnegative Zahl in Pixeln (optional) || Zusätzlicher Abstand zwischen den äußersten Achsenwerten und dem Plotrahmen, jeweils an beiden Enden der Achse. Der numerische Achsenbereich bleibt unverändert. Beeinflusst Datenpunkte, Kurven, Gitterlinien und Tickpositionen. | |||
Bei automatischem Wertebereich und <code>points</code>-Objekten wird ein Abstand entsprechend Symbolgröße plus 2 Pixel verwendet. Bei expliziten Achsengrenzen erfolgt ohne <code>padding</code> keine automatische Einrückung. | |||
|} | |||
== legend == | |||
{| class="wikitable" | |||
! Schlüssel !! Mögliche Werte !! Erläuterung | |||
|- | |||
| <code>legend.layout</code> || <code>horizontal</code> (Standard), <code>vertical</code> || Einträge nebeneinander mit Zeilenumbruch oder linksbündig untereinander. Bei <code>side: auto</code> bilden linke und rechte Y-Achsen getrennte Spalten. | |||
|- | |||
| <code>legend.position</code> || <code>none</code> (Standard), <code>top</code>, <code>bottom</code>, <code>outside</code> || Keine Legende; innerhalb des Rahmens oben/unten; oder unterhalb des Rahmens. | |||
|- | |||
| <code>legend.side</code> || <code>auto</code> (Standard), <code>left</code>, <code>right</code> || Automatische Zuordnung zur Y-Achse oder erzwungene Anordnung links/rechts. | |||
|- | |||
| <code>legend.symbols</code> || <code>false</code> (Standard), <code>true</code> || Nur farbiger Text oder zusätzlich grafische Typsymbole. | |||
|} | |} | ||
Bei <code>top</code> und <code>bottom</code> reserviert das Layout Platz innerhalb des Rahmens; <code>outside</code> reserviert Platz darunter. Legendeneinträge werden bei Bedarf umgebrochen. | |||
== viewports == | == viewports == | ||
| Zeile 265: | Zeile 329: | ||
| || <code>hline</code> / <code>vline</code> || Feste horizontale bzw. vertikale Referenzlinie. | | || <code>hline</code> / <code>vline</code> || Feste horizontale bzw. vertikale Referenzlinie. | ||
|- | |- | ||
| dataset || Quellenname || Zu zeichnender Datensatz. | | <code>dataset</code> || Quellenname || Zu zeichnender Datensatz. | ||
|- | |||
| <code>coordinates</code> || Koordinatensystemname || Zielkoordinatensystem; Standard <code>main</code>. | |||
|- | |- | ||
| | | <code>x</code> || Spaltenname || X-Spalte der Datenquelle; bei numerischen X/Y-Plots frei wählbar, Standard <code>x</code>. | ||
|- | |- | ||
| | | <code>y</code> || Spaltenname || Y-Spalte der Datenquelle; Standard <code>y</code>. | ||
|- | |- | ||
| | | <code>label</code> || Text (optional) || Legendenbeschriftung. Ohne Label kein Eintrag. Variablen wie <code>$max{series1:1}</code> werden ausgewertet. | ||
|- | |- | ||
| autoscale || <code>true</code> / <code>false</code> bzw. <code>1</code> / <code>0</code> || Objekt bei automatischer Skalierung berücksichtigen; Standard aktiv. | | <code>autoscale</code> || <code>true</code> / <code>false</code> bzw. <code>1</code> / <code>0</code> || Objekt bei automatischer Skalierung berücksichtigen; Standard aktiv. | ||
|- | |- | ||
| size || Zahl ≥ 0 || Größe einer Punktmarkierung. | | <code>size</code> || Zahl ≥ 0 || Größe einer Punktmarkierung. | ||
|- | |- | ||
| bar_width || Zahl > 0 || Balkenbreite in X-Einheiten. | | <code>bar_width</code> || Zahl > 0 || Balkenbreite in X-Einheiten. | ||
|- | |- | ||
| baseline || Zahl || Basiswert für Balken; Standard 0. | | <code>baseline</code> || Zahl || Basiswert für Balken; Standard 0. | ||
|- | |- | ||
| from || Zahl || Optionaler Anfang einer <code>hline</code> bzw. <code>vline</code>. | | <code>from</code> || Zahl || Optionaler Anfang einer <code>hline</code> bzw. <code>vline</code>. | ||
|- | |- | ||
| to || Zahl || Optionales Ende einer <code>hline</code> bzw. <code>vline</code>. | | <code>to</code> || Zahl || Optionales Ende einer <code>hline</code> bzw. <code>vline</code>. | ||
|} | |||
== Datenverarbeitung und X/Y-Diagramme === | |||
{| class="wikitable" | |||
! Schlüssel !! Zulässige Werte !! Beschreibung | |||
|- | |||
| <code>objects[].function</code> || Arithmetischer Ausdruck || Berechnet den Y-Wert jedes Datenpunktes neu. Erlaubt sind Zahlen, <code>+ - * /</code>, Klammern und Referenzen <code>$current{dataset}</code>. Der Name des primären Datasets liefert dessen Y-Wert am aktuellen X-Wert. Division durch Null erzeugt eine Datenlücke. | |||
|- | |||
| <code>objects[].x_dataset</code> || Name eines zweiten Datasets || Bei <code>lines</code> und <code>points</code> liefert dieses Dataset die X-Werte; das primäre Dataset liefert die Y-Werte. Die zeitlichen bzw. ursprünglichen X-Koordinaten werden zur Zuordnung benutzt. Die Darstellungs-X-Achse muss linear sein. | |||
|- | |||
| <code>objects[].x_values</code> || <code>same</code> (Standard), <code>interpolate</code> || <code>same</code>: Nur exakt übereinstimmende X-Koordinaten. <code>interpolate</code>: Lineare Interpolation im zusätzlich referenzierten Dataset. Keine Extrapolation außerhalb seines Wertebereichs. | |||
|- | |||
| <code>objects[].shift_dataset</code> || Name eines zweiten Datasets || Nur für <code>bars</code>. Verschiebt den gesamten Balken um den Y-Wert des zweiten Datasets; seine Höhe bleibt unverändert. Die Verschiebung wird bei der Achsenskalierung berücksichtigt | |||
|} | |} | ||
| Zeile 290: | Zeile 369: | ||
! Schlüssel !! Mögliche Werte !! Erläuterung | ! Schlüssel !! Mögliche Werte !! Erläuterung | ||
|- | |- | ||
| stroke || <code> | | <code>width</code> || Zahl ≥ 0 || Strichbreite; Standard 2. | ||
|- | |||
| <code>stroke</code> || Theme-Farbname oder Hex-Farbe || Explizite Linienfarbe, bei Balken Konturfarbe unabhängig von der Füllfarbe | |||
|- | |||
| <code>fill</code> || || Füllfarbe von <code>bars</code> und <code>ibars</code>; Standard ist <code>style.stroke</code>. | |||
|- | |||
| <code>fill_opacity</code> || Zahl von <code>0</code> bis <code>1</code> || Deckkraft der Balkenfüllung; Standard <code>1</code>. | |||
|- | |||
| <code>dash</code> || <code>solid</code> || Durchgezogene Linie (Standard; kein <code>stroke-dasharray</code>). | |||
|- | |||
| || <code>dashed</code> || Gestrichelt; SVG-Muster <code>6 4</code>. | |||
|- | |||
| || <code>dotted</code> || Gepunktet; SVG-Muster <code>2 4</code>. | |||
|- | |- | ||
| || | | || <code>longdash</code> || Lange Striche; SVG-Muster <code>12 5</code>. | ||
|- | |- | ||
| | | || <code>shortdash</code> || Kurze Striche; SVG-Muster <code>3 3</code>. | ||
|- | |- | ||
| | | || <code>dashdot</code> || Strich-Punkt; SVG-Muster <code>8 3 2 3</code>. | ||
|- | |- | ||
| || <code> | | || <code>longdashdot</code> || Langer Strich-Punkt; SVG-Muster <code>12 4 2 4</code>. | ||
|- | |- | ||
| || <code> | | || <code>dashdotdot</code> || Strich-Punkt-Punkt; SVG-Muster <code>8 3 2 3 2 3</code>. | ||
|} | |} | ||
Die Zahlenfolgen bezeichnen abwechselnd Strich- und Lückenlängen in SVG-Einheiten. | |||
== layout == | == layout == | ||
Aktuelle Version vom 22. November 2026, 12:33 Uhr
Allgemeines
Die Konfigurationsdateien für das Xplot-System müssen in /opt/fhem/www/xplot stehen, sie haben die Endung .xplot
Damit diese Konfigurationsdateien mit dem FHEM-internen Editor bearbeitet werden können, muss in der zugehörigen Instanz des FHEMWEB-Devices das Attribut editFileList richtig gesetzt werden. Derzeit (21.11.2026) muss es den Wert
Own modules and helper files:$MW_dir:^(.*sh|[0-9][0-9].*Util.*pm|.*cfg|.*holiday|myUtilsTemplate.pm|.*layout)$ Gplot files:$FW_gplotdir:^.*gplot$ Xplot files:'/opt/fhem/www/xplot':^.*xplot$ Styles:$FW_cssdir:^.*(css|svg)$
haben. Darin sind erste, zweite und vierte Zeile der bisherige Default-Wert, die dritte Zeile erlaubt das Editieren der .xplot-Dateien.
Achtung: Datei-Eigentümer auf fhem:dialout setzen !
Konfigurationsbeispiel
Mit der folgenden Datei werden vier Kurven gezeichnet, bei zwei Koordinatensystemen und zwei Achsen
#-- Xplot v15: GasD, four FileLog data series
api_version: 1
#-- Allgemeine Informationen, Titel etc.
canvas:
width: 600
height: 300
title: 'Gas'
frame: rounded
theme: default
#--- Datenquellen für vier Kurven, benannt als power, power.av, energy und energy.ac
sources:
power:
type: filelog
device: GasD
spec:
regex: 'G.Verb.energy:'
column: 7
range: day
power.av:
type: filelog
device: GasD
spec:
regex: 'G.Verb.power.av:'
column: 4
range: day
energy:
type: filelog
device: GasD
spec:
regex: 'G.Verb.energy:'
column: 4
range: day
energy_ac:
type: filelog
device: GasD
spec:
regex: 'G.Verb.energy_AC:'
column: 4
range: day
#--- Definition einer horizontalen und zweier vertikaler Achsen
axes:
time:
type: time
position: bottom
label: Uhrzeit
range: day
energy:
type: linear
position: right
label: 'V [m³]'
range:
min: 0
max: 20
power:
type: linear
position: left
label: 'P [m³/h]'
range:
min: 0
max: 3
#--- Definition von zwei Koordinatensystemen
coordinates:
energy:
type: cartesian
viewport: main
x_axis: time
y_axis: energy
power:
type: cartesian
viewport: main
x_axis: time
y_axis: power
#--- Definition von vier grafischen Objekten vom Typ line
objects:
- type: line
dataset: power
x: x
y: y
coordinates: power
style:
stroke: red
width: 0.3
- type: line
dataset: power.av
x: x
y: y
coordinates: power
style:
stroke: red
width: 1.6
- type: line
dataset: energy
x: x
Xplot – Konfigurationsreferenz (Version 16)
Referenz für *.xplot-Dateien
<name> bezeichnet einen frei wählbaren Schlüssel; - type einen Eintrag der YAML-Liste. „—“ bedeutet: kein fester Wert vorgegeben.
api_version
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| api_version | 1 |
Pflichtangabe; Version des Konfigurationsformats. |
canvas
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| width | Zahl ≥ 200 | SVG-Breite; Standard 800. |
| height | Zahl ≥ 150 | SVG-Höhe; Standard 400. |
| title | Text mit Datums- und Statistikvariablen | Plotüberschrift; Standard leer. Variablen werden bei jedem Rendern aufgelöst, z. B. Gas ${date}: $max{energy:2}.
|
| frame | rect / rounded |
Rechteckiger bzw. abgerundeter Rahmen; Standard rect.
|
| theme | default / dark / <name> |
Globales Theme aus themes.yaml.
|
| background | RGB-Wert (#RGB, #RRGGBB) / Theme-Farbname |
Füllfarbe außerhalb des Plotrahmens, auch bei frame: rounded. Überschreibt den Wert aus Theme.
|
| plot_background | RGB-Wert (#RGB, #RRGGBB) / Theme-Farbname |
Füllfarbe innerhalb des Plotrahmens, auch bei frame: rounded. Überschreibt den Wert aus Theme. Ohne Angabe identisch mit background.
|
| foreground | RGB-Wert (#RGB, #RRGGBB) / Theme-Farbname |
Text- und Achsenfarbe. Überschreibt den Wert aus Theme. |
| grid_color | RGB-Wert (#RGB, #RRGGBB) / Theme-Farbname |
Gitternetzfarbe. Überschreibt den Wert aus Theme. |
| frame_color | RGB-Wert (#RGB, #RRGGBB) / Theme-Farbname |
Rahmenfarbe. Überschreibt den Wert aus Theme. |
Dynamische Variablen in canvas.title und axes.<name>.label
| Schlüssel / Variable | Mögliche Werte | Erläuterung |
|---|---|---|
${date} |
TT.MM.JJJJ | Heutiges Datum nach lokaler Serverzeit. |
${day}, ${month}, ${year} |
Tag / Monat / Jahr | Aktuelles Kalenderdatum als Einzelwerte. |
${month_name}, ${weekday} |
Monats- / Wochentagsname | Sprache entsprechend der Locale des FHEM-Servers. |
${time}, ${datetime}, ${date_iso} |
HH:MM / Datum und Uhrzeit / JJJJ-MM-TT | Weitere aktuelle Zeitangaben. |
${range_start}, ${range_end} |
TT.MM.JJJJ | Beginn und Ende der dargestellten Zeitachse; benötigt einen eindeutigen Zeitbereich. |
${range_start:%d.%m.%Y} |
strftime-Format | Individuelle Formatierung von Bereichsbeginn oder -ende; analog für range_end.
|
$min{<source>}, $max{<source>} |
Zahl | Minimum bzw. Maximum der Y-Werte der benannten Datenquelle. |
$sum{<source>}, $avg{<source>} |
Zahl | Summe bzw. arithmetischer Mittelwert der gültigen Y-Werte (keine zeitliche Integration). |
$cnt{<source>} |
Ganzzahl | Anzahl gültiger Y-Werte. |
$firstval{<source>}, $currval{<source>} |
Zahl | Erster bzw. letzter gültiger Wert in X-Reihenfolge. |
$firstdate{<source>}, $currdate{<source>} |
X-Wert | X-Koordinate des ersten bzw. letzten gültigen Wertes. |
$mindate{<source>}, $maxdate{<source>} |
X-Wert | X-Koordinate des Minimums bzw. Maximums. |
$lastraw{<source>} |
Rohwert / - |
Nur verfügbar, wenn die Quelle einen Rohwert bereitstellt; bei den derzeitigen Standardquellen -.
|
$curr{<source>}, $current{<source>} |
Zahl | Aliase für $currval.
|
$minAll, $maxAll |
Zahl | Kleinstes Minimum bzw. größtes Maximum der Standardwertspalten aller Datenquellen. |
$max{<source>:2} |
0–12 Nachkommastellen | Numerische Formatierung; funktioniert analog für andere Statistikvariablen. |
$max{<source>.<spalte>} |
Quell- und Spaltenname | Explizite Spaltenwahl für Array-Daten, z. B. $max{messung.strom:2}.
|
sources
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| <name> | frei wählbar | Kennung einer Datenquelle; Referenz über objects[].dataset.
|
| type | filelog |
Werte aus einem FHEM-FileLog. |
array |
Inline-Datenreihe, unabhängig von FileLog und FHEM. | |
columns |
Liste eindeutiger Spaltennamen. Pflicht für array; z. B. [spannung, strom]. Mindestens zwei Spalten.
| |
rows |
Liste numerischer Zeilen. Pflicht für array; jede Zeile muss genau so viele Werte wie columns enthalten. Beispiel: - [1.0, 2.5].
| |
consty |
Konstanter Y-Wert: horizontale Linie. | |
constx |
Konstanter X-Wert: vertikale Linie oder Punkt. | |
| device | FHEM-Devicename | Bei filelog: FileLog-Device.
|
| spec | Mapping / Legacy-String | Bei filelog: Auswahl der Daten.
|
| spec.regex | regulärer Ausdruck | Suchmuster für FileLog-Einträge. |
| spec.column | positive Ganzzahl | Spalte des Messwerts (ab 1). |
| range | hour / 6hours / day / 3days / week / month / year / 5years |
Kalenderbezogener Zeitbereich; bei filelog ohne Angabe last_24h.
|
day -1 / week -2 / … |
Verschobener Zeitraum mit ganzzahligem Offset. | |
last_24h |
Gleitende letzte 24 Stunden. | |
| value | Zahl | Bei consty: konstanter Y-Wert.
|
| from | Zeitstempel / Zahl | Bei consty: optionaler X-Anfang.
|
| to | Zeitstempel / Zahl | Bei consty: optionales X-Ende.
|
| time | Zeitstempel / Zahl | Bei constx: X-Position.
|
| x | Zeitstempel / Zahl | Bei constx: Alias für time.
|
| y | Zahl | Bei constx: erster Y-Wert.
|
| y2 | Zahl | Bei constx: zweiter Y-Wert; ohne y2 nur ein Punkt.
|
axes
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| <name> | frei wählbar | Kennung der Achse. |
| type | linear |
Lineare Zahlenachse. |
time |
Zeitachse. | |
| position | left / right |
Position einer Y-Achse. |
bottom / top |
Position einer X-Achse. | |
| label | Text | Achsenbeschriftung, auch Unicode (z. B. m³).
|
| range | Mapping mit min, max |
Expliziter Zahlenbereich; Grenzen einzeln optional. |
Zeitraum, z. B. day -1 |
Bei Zeitachsen: Kalenderbereich mit optionalem Offset. | |
| range.min | Zahl | Untere Grenze einer numerischen Achse. |
| range.max | Zahl | Obere Grenze einer numerischen Achse. |
padding |
Nichtnegative Zahl in Pixeln (optional) | Zusätzlicher Abstand zwischen den äußersten Achsenwerten und dem Plotrahmen, jeweils an beiden Enden der Achse. Der numerische Achsenbereich bleibt unverändert. Beeinflusst Datenpunkte, Kurven, Gitterlinien und Tickpositionen.
Bei automatischem Wertebereich und |
legend
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
legend.layout |
horizontal (Standard), vertical |
Einträge nebeneinander mit Zeilenumbruch oder linksbündig untereinander. Bei side: auto bilden linke und rechte Y-Achsen getrennte Spalten.
|
legend.position |
none (Standard), top, bottom, outside |
Keine Legende; innerhalb des Rahmens oben/unten; oder unterhalb des Rahmens. |
legend.side |
auto (Standard), left, right |
Automatische Zuordnung zur Y-Achse oder erzwungene Anordnung links/rechts. |
legend.symbols |
false (Standard), true |
Nur farbiger Text oder zusätzlich grafische Typsymbole. |
Bei top und bottom reserviert das Layout Platz innerhalb des Rahmens; outside reserviert Platz darunter. Legendeneinträge werden bei Bedarf umgebrochen.
viewports
Optional seit v14; ohne Angabe wird main automatisch angelegt.
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| <name> | frei wählbar | Viewport-Kennung, z. B. main.
|
| layout | auto |
Automatisches Layout des Standardviewports. |
| row | Ganzzahl 0–19 | Zeile im Viewport-Raster. |
| column | Ganzzahl 0–19 | Spalte im Viewport-Raster. |
| show_axes | Liste von Achsennamen | Auswahl sichtbarer Achsen; aktuelle Einschränkungen beachten. |
coordinates
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| <name> | frei wählbar | Kennung eines Koordinatensystems. |
| type | cartesian |
Kartesisches Koordinatensystem. |
| viewport | main / Viewport-Name |
Zielviewport; Standard main.
|
| x_axis | Achsenname | X-Achse; Standard x.
|
| y_axis | Achsenname | Y-Achse; Standard y.
|
objects
Liste von Grafikobjekten; jeder Eintrag beginnt mit - type:.
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| - type | line / lines |
Linienzug; beide Schreibweisen unterstützt. |
steps / fsteps / histeps |
Varianten von Treppenlinien. | |
bars / ibars / needles |
Balken, Intervallbalken bzw. Nadeln. | |
points |
Datenpunkte. | |
points:diamond / points:circle / points:square |
Punktform: Raute, Kreis, Quadrat. | |
points:triangleup / points:triangledown |
Dreieck nach oben/unten. | |
points:plus / points:cross / points:minus |
Plus, Kreuz, waagerechter Strich. | |
points:circle:4 usw. |
Punktform mit Größenangabe als drittem Typsegment. | |
horizontalLineFrom / horizontalLineTo |
Horizontale Verbindungen. | |
cubic / quadratic / quadraticSmooth |
Geglättete Kurven. | |
hline / vline |
Feste horizontale bzw. vertikale Referenzlinie. | |
dataset |
Quellenname | Zu zeichnender Datensatz. |
coordinates |
Koordinatensystemname | Zielkoordinatensystem; Standard main.
|
x |
Spaltenname | X-Spalte der Datenquelle; bei numerischen X/Y-Plots frei wählbar, Standard x.
|
y |
Spaltenname | Y-Spalte der Datenquelle; Standard y.
|
label |
Text (optional) | Legendenbeschriftung. Ohne Label kein Eintrag. Variablen wie $max{series1:1} werden ausgewertet.
|
autoscale |
true / false bzw. 1 / 0 |
Objekt bei automatischer Skalierung berücksichtigen; Standard aktiv. |
size |
Zahl ≥ 0 | Größe einer Punktmarkierung. |
bar_width |
Zahl > 0 | Balkenbreite in X-Einheiten. |
baseline |
Zahl | Basiswert für Balken; Standard 0. |
from |
Zahl | Optionaler Anfang einer hline bzw. vline.
|
to |
Zahl | Optionales Ende einer hline bzw. vline.
|
Datenverarbeitung und X/Y-Diagramme =
| Schlüssel | Zulässige Werte | Beschreibung |
|---|---|---|
objects[].function |
Arithmetischer Ausdruck | Berechnet den Y-Wert jedes Datenpunktes neu. Erlaubt sind Zahlen, + - * /, Klammern und Referenzen $current{dataset}. Der Name des primären Datasets liefert dessen Y-Wert am aktuellen X-Wert. Division durch Null erzeugt eine Datenlücke.
|
objects[].x_dataset |
Name eines zweiten Datasets | Bei lines und points liefert dieses Dataset die X-Werte; das primäre Dataset liefert die Y-Werte. Die zeitlichen bzw. ursprünglichen X-Koordinaten werden zur Zuordnung benutzt. Die Darstellungs-X-Achse muss linear sein.
|
objects[].x_values |
same (Standard), interpolate |
same: Nur exakt übereinstimmende X-Koordinaten. interpolate: Lineare Interpolation im zusätzlich referenzierten Dataset. Keine Extrapolation außerhalb seines Wertebereichs.
|
objects[].shift_dataset |
Name eines zweiten Datasets | Nur für bars. Verschiebt den gesamten Balken um den Y-Wert des zweiten Datasets; seine Höhe bleibt unverändert. Die Verschiebung wird bei der Achsenskalierung berücksichtigt
|
objects[].style
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
width |
Zahl ≥ 0 | Strichbreite; Standard 2. |
stroke |
Theme-Farbname oder Hex-Farbe | Explizite Linienfarbe, bei Balken Konturfarbe unabhängig von der Füllfarbe |
fill |
Füllfarbe von bars und ibars; Standard ist style.stroke.
| |
fill_opacity |
Zahl von 0 bis 1 |
Deckkraft der Balkenfüllung; Standard 1.
|
dash |
solid |
Durchgezogene Linie (Standard; kein stroke-dasharray).
|
dashed |
Gestrichelt; SVG-Muster 6 4.
| |
dotted |
Gepunktet; SVG-Muster 2 4.
| |
longdash |
Lange Striche; SVG-Muster 12 5.
| |
shortdash |
Kurze Striche; SVG-Muster 3 3.
| |
dashdot |
Strich-Punkt; SVG-Muster 8 3 2 3.
| |
longdashdot |
Langer Strich-Punkt; SVG-Muster 12 4 2 4.
| |
dashdotdot |
Strich-Punkt-Punkt; SVG-Muster 8 3 2 3 2 3.
|
Die Zahlenfolgen bezeichnen abwechselnd Strich- und Lückenlängen in SVG-Einheiten.
layout
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| viewport_gap | Zahl ≥ 0 | Abstand zwischen Viewports; Standard 12. |
| axis_spacing.tick_labels | Zahl ≥ 0 | Abstand der Tick-Beschriftungen; Standard 5. |
| axis_spacing.titles | Zahl ≥ 0 | Abstand der Achsentitel; Standard 12. |
| margins.left | Zahl ≥ 0 | Mindestabstand links. |
| margins.right | Zahl ≥ 0 | Mindestabstand rechts. |
| margins.top | Zahl ≥ 0 | Mindestabstand oben. |
| margins.bottom | Zahl ≥ 0 | Mindestabstand unten. |
themes.yaml (globale Theme-Datei)
Nicht Bestandteil der einzelnen .xplot-Datei; Ablage unter /opt/fhem/lib/Xplot/themes.yaml.
| Schlüssel | Mögliche Werte | Erläuterung |
|---|---|---|
| themes.<name> | default / dark / eigener Name |
Theme-Definition. |
| background | RGB-Farbe | Hintergrund. |
| foreground | RGB-Farbe | Schrift und Achsen. |
| grid | RGB-Farbe | Gitternetz. |
| frame | RGB-Farbe | Plotrahmen. |
| colors.<name> | RGB-Farbe | Benannter Paletteneintrag, z. B. blue, red, green, purple, orange, gray, solar, grid, battery, gas, water.
|
Stand: Xplot v15. Die Übersicht ist als eigenständige Wiki-Datei gedacht, nicht als README-Ergänzung.