Xplot – Konfigurationsreferenz (Version 15)
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 |
Pflicht; 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 |
Plotüberschrift; Standard leer.
|
| frame |
rect / rounded |
Rechteckiger bzw. abgerundeter Rahmen; Standard rect.
|
| theme |
default / dark / <name> |
Globales Theme aus themes.yaml.
|
| background |
RGB-Wert / Theme-Farbname |
Hintergrundfarbe.
|
| foreground |
RGB-Wert / Theme-Farbname |
Text- und Achsenfarbe.
|
| grid_color |
RGB-Wert / Theme-Farbname |
Gitternetzfarbe.
|
| frame_color |
RGB-Wert / Theme-Farbname |
Rahmenfarbe.
|
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.
|
|
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.
|
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 / Zahl |
X-Datenspalte; bei vline feste X-Position.
|
| y |
Spaltenname / Zahl |
Y-Datenspalte; bei hline feste Y-Position.
|
| 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.
|
objects[].style
| Schlüssel |
Mögliche Werte |
Erläuterung
|
| stroke |
#RGB / #RRGGBB |
Explizite Linienfarbe.
|
|
Theme-Farbname |
Z. B. red, blue, gas.
|
| width |
Zahl ≥ 0 |
Strichbreite; Standard 2.
|
| dash |
solid |
Durchgezogene Linie; Standard.
|
|
dashed |
Gestrichelte Linie.
|
|
dotted |
Gepunktete Linie.
|
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.