So, wie versprochen möchte ich auch mal etwas zurückgeben und poste hier ein Skript zur Erzeugung eines JSON für das JSON-Chart-Widget auf Basis von Datenhistorisierung mittels InfluxDB 2.x und der Datenabfrage mittels der neuen Abfragesprache Flux.
Zum Hintergrund:
-
ioBroker ist als vollumfängliche Steuerungs- und Automatisierungslösung für unseren EFH-Neubau im Einsatz.
-
Haus und Autos nutzen als einzige Energiequelle Strom. PV mit 24,5 kWp, Speicher 19,5 kWh, Erdwärmepumpe. Außerdem Beleuchtung komplett über Philips HUE, Fußbodenheizung über HomeMatic und etliches mehr.
-
Insofern dreht sich bei der Visualisierung auch viel um Strom. Etliche Datenpunkte zeichnen die Leistung und den Energieverbrauch bzw. die Energieerzeugung verschiedenster Geräte auf.
-
Aus zwei Gründen habe ich mich für InfluxDB als Historisierungsdatenbank entschieden. (1) Speziell für die effiziente Speicherung von großen Mengen zeitbasierter Daten entwickelt. (2) Implementierte, einfach zu nutzende Aggregationsfunktionen. Gerade bei Stromverbrauch kommt die Aggregation ja zwangsläufig zum Einsatz. Wenn ein Datenpunkt beispielsweise zu jeder vollen Stunde die kWh der letzten Stunde aufzeichnet, möchte man ja in der Lage sein, das zu Stunden, Tagen, Wochen, Monaten oder Jahren zu aggregieren und zu visualisieren. Und ich wollte dies nicht über den Ansatz lösen, skriptbasiert dutzenden von Datenpunkten mit diesen aggregierten Werten zu befüllen.
-
Da das System neu aufgesetzt wurde, habe ich mich gleich für InfluxDB 2.x entschieden. Der Influx-Adapter unterstütz das dankenswerterweise bereits. Die zu InfluxDB 2 zugehörige Browser-GUI erleichtert einem die Sicht auf die Daten und das Erstellen der Abfragen mit Flux. Über die GUI lassen sich auch Daten via csv importieren, so dass ich zwischenzeitlich in SQL aufgezeichnete Daten relativ einfach übernehmen konnte.
Nun stand die Frage nach der besten Visualisierungsmöglichkeit - insbesondere für Charts - aus. Nach intensiven Test mit den verschiedenen Adaptern bin ich am Ende wieder bei VIS angekommen. Zusammen mit dem Material Design Widget aus meiner Sicht die beste Lösung für optisch anspruchsvolle Dashboards und Bedienpanels. Hier kann man @Scrounger nicht genug danken für die tolle Arbeit! Gerade bei den Diagrammen stößt man bei den anderen Lösung umgehend an die Grenzen. An die Gestaltungsfreiheit des JSON-Charts kommt nichts heran, schon gar nicht Grafana.
Ein großer Vorteil des JSON-Charts, der nur einmal am Rande an anderer Stelle erwähnt wurde, ist aus meiner Sicht die Tatsache, dass ich im Dashboard nicht ständig mit Ladekreisel aktualisierende Charts habe, da das JSON serverseitig aktualisiert wird und sich das Widget kaum wahrnehmbar updated, wenn das JSON neu geschrieben wurde.
Allerdings ist die Hürde des JSON-Charts für Nutzer wie mich, die nicht programmieren können und sich die Logik-Schicht im ioBroker nur mit Blockly zusammen klicken, schon ziemlich hoch. Dazu kommt, dass die Anleitungen und Threads dazu meist auf einem für Einsteiger zu hohen Niveau ansetzen.
OK, viel zu lange Vorrede. Ich habe mir das Beispielskripts vom Anfang dieses Threads genommen, versucht es zu verstehen und in unendlich vielen Try & Error Stunden auf mein Bedürfnis angepasst.
Damit es für mich übersichtlich bleibt, habe ich die ganzen Blöcke, in denen es um das Iterieren durch Objektstrukturen für die anzuzeigenden Datenpunkten und das Erzeugen der Zieldatenpunkte geht, weggelassen - keep it simple.
Das Prinzip ist:
-
1 Skript je Chart
-
Zugehörigen Zieldatenpunkt an gewünschter Stelle in der Objektstruktur unter 0_userdata anlegen und im Skript hinterlegen
-
Quelldaten für ein oder mehrere Graphen durch hineinkopieren des kompletten Flux-Querys im Skript angeben
Bitte nicht über die Kommentierungen im Skript lachen. Von einem Nicht-Programmierer für Nicht-Programmierer
// Dieses Skript dient der Erzeugung eines JSON für die Darstellung hoch individualisierbarer Charts
// mittels des JSON-Chart-Widgets aus dem Material-Design-Adapter auf Basis von Datenpunkthistorisierung in InfluxDB 2.x
// Die x-Achse kann im JSON grundsätzlich auf 2 Methoden angegeben werden:
// a) Individuell über die Eigenschaft "axisLabels": ["1h", "2h", "3h", ...] oder
// b) Durch Angabe von Zeitstempeln und Werten "data": [{"t": 1640624405000,"y": 1.4536},{"t": 1640649605000,"y": 1.4665}, ...]
// Dieses Skript verwendet die letztgenannte Methode! Auf der x-Achse wird somit immer die Zeit dargestellt.
// Die Formatierung für alle Zeitaggregationen erfolgt über die Eigenschaft xAxis_timeFormats im JSON (siehe unten in den GlobalSettings).
// Je nach Darstellungswünschen muss man zusätzlich noch mit den Parametern "xAxsisTickSource" und "Versatz der x-Achse" in den Widget-Eigenschaften des x-Achsen Layouts spielen.
// Mit den über das JSON dem Widget zugeführten Daten und Parametern ist dieses in der Lage, verschiedene Datenpunkte gemeinsam in einem Chart darzustellen.
// Dabei können z.B. Balken gestapelt oder gemischte Charts aus Balken und Linien erzeugt werden. Die Skript-Einstellungen unten erezugen ein Bar-Chart mir zwei Line-Charts
// Danke an Scrounger für den tollen MDW-Adapter und das Beispielskript, aus dem ich mir dieses hier "zusammengebastelt" habe.
// #################### Auslöser (Trigger), die das JSON-Objekt neu erzeugen ####################
// Zeitgesteuert
schedule({minute: [01]}, refresh);
// Bei Änderung eines Datenpunktes
// Hier bei Umschaltung zwischen Light/Dark-Mode, falls man im JSON Farben-Properties setzten möchte
on('vis-materialdesign.0.colors.darkTheme', function (obj) {
refresh();
});
// Beim Speichern oder Starten des Skriptes
refresh();
// Gesamter Skriptcode ist in der Funktion refresh() eingebettet. Diese Funktion wird über die Trigger oben aufgerufen
function refresh() {
// #################### Skript-Einstellungen ####################
// History Instanz die verwendet werden soll
let historyInstance = 'influxdb.0';
// Ziel-Datenpunkt in der Objektstruktur für das JSON vom Typ "string", auf den im Widget verwiesen wird. Muss zuvor von Hand angelegt werden
let targetDP = '0_userdata.0.VIS.Charts.HKL.JSON.Heizung_kWh_-7d';
// Debug-Mode (true/false)
// Gibt bei true in der Skript-Console und im ioBroker-Protokoll Inhalte von Verarbeitungsschritten aus (z.B. das Ergebnis der Flux-Abfrage und das fertige JSON)
let debug = true;
// Hier optional Farben, Schriften und Schriftgrößen aus den Material-Design-Widget- oder anderen eigenen Datenpunkten holen, falls solche JSON-Chart-Properties gesetzt werden sollen
// Optional den Datenpunkt abfragen, mit dem zwischen Light/Dark-Theme umgeschaltet wird
let mdw_darkTheme = getState('vis-materialdesign.0.colors.darkTheme').val;
// Variable(n) mit Farbcodes aus Datenpunkten in Abhängigkeit von Light/Dark-Theme füllen, die unten in den Chart-Einstellungen verwendet werden sollen
let mdw_datalabel_color_kWh = (mdw_darkTheme) ? getState('vis-materialdesign.0.colors.dark.charts.value').val : getState('vis-materialdesign.0.colors.light.charts.value').val;
let mdw_line_color_tempOut = (mdw_darkTheme) ? getState('0_userdata.0.VIS.Allgemeine_Farben.dark.Aussentemperatur').val : getState('0_userdata.0.VIS.Allgemeine_Farben.light.Aussentemperatur').val;
let mdw_datalabel_color_tempOut = (mdw_darkTheme) ? getState('0_userdata.0.VIS.Allgemeine_Farben.dark.Aussentemperatur').val : getState('0_userdata.0.VIS.Allgemeine_Farben.light.Aussentemperatur').val;
// Dto. für Schriftart(en) und Schriftgröße(n)
let mdw_datalabel_fontFamily = getState('vis-materialdesign.0.fonts.charts.value').val;
let mdw_datalabel_fontSize = getState('vis-materialdesign.0.fontSizes.charts.value').val;
// Gemeinsam verwendete Chart-Einstellungen, Details siehe https://github.com/Scrounger/ioBroker.vis-materialdesign#json-chart
// Hinweis: Weitere Einstelloptionen zu Legende, x-Achse etc. befinden sich in den Eigenschaften des Widgets!
let globalGraphSettings = {
line_pointSize: 0,
datalabel_fontFamily: mdw_datalabel_fontFamily,
datalabel_fontSize: mdw_datalabel_fontSize,
xAxis_bounds: 'ticks',
xAxis_timeFormats: {
millisecond: "H:mm:ss.SSS",
second: "H:mm:ss",
minute: "H:mm",
hour: "dd.[\\n]H:mm",
day: "dd[\\n]DD.MM",
week: "dd[\\n]DD.MM",
month: "MMM[\\n]YYYY",
quarter: "[Q]Q - YYYY",
year: "YYYY"
}
}
// InfluxDB-Flux-Query(s), die verwendet werden sollen und die zugehörigen individuellen Chart-Einstellungen
// Die hier dargestellten Flux-Querys sind aus einer InfluxDB 2.x mit den Adaptereinstellungen 'Tags anstelle Felder für Metadaten' (Influx-Adapter -> Experteneinstellungen)
// Bitte unbedingt die Infos dazu lesen, bevor die Eigenschaft umgestellt wird: https://github.com/ioBroker/ioBroker.influxdb/blob/master/README.md#Store-metadata-information-as-tags-instead-of-fields
// Die Abfragen können sehr gut mit dem InfluxDB-OSS (GUI) erstellt werden. Wenn die dort angezeigten Daten im 'View Raw Data'-Modus hinsichtlich _value und _time dem Gewünschten entsprechen,
// einfach die Query hierher kopieren und noch hinter jede Zeile ein '\' für den Zeilenumbruch im String setzen.
let datenpunkte = [
{
fluxQuery:
'from(bucket: "iobroker") \
|> range(start: -8d) \
|> filter(fn: (r) => r["_measurement"] == "Strom.Heizung.Energie_in_der_letzten_Stunde") \
|> drop(columns: ["_field", "ack", "from", "q"]) \
|> aggregateWindow(every: 1d, fn: sum, createEmpty: false) \
|> timeShift(duration: -1s) \
|> truncateTimeColumn(unit: 1d) \
|> sort(columns: ["_time"], desc: true) \
|> limit(n:7) \
|> sort(columns: ["_time"], desc: false)'
,
graphSettings: {
type: 'bar',
color: '#44739e',
legendText: 'Energieverbrauch',
yAxis_id: 0,
yAxis_show: false,
yAxis_min: 0,
yAxis_max: 21,
datalabel_show: true,
datalabel_minDigits: 1,
datalabel_maxDigits: 1,
datalable_color: mdw_datalabel_color_kWh,
displayOrder: 2
}
}, // <= Zwischen mehreren Datenpunkten hier das Komma nicht vergessen!
{
fluxQuery:
'from(bucket: "iobroker") \
|> range(start: -8d) \
|> filter(fn: (r) => r["_measurement"] == "Umwelt.Garten_Themperatursensor_L-Steine.Temperatur") \
|> drop(columns: ["_field", "ack", "from", "q"]) \
|> aggregateWindow(every: 1d, fn: max, createEmpty: false) \
|> timeShift(duration: -1s) \
|> truncateTimeColumn(unit: 1d) \
|> sort(columns: ["_time"], desc: true) \
|> limit(n:7) \
|> sort(columns: ["_time"], desc: false)'
,
graphSettings: {
type: 'line',
color: mdw_line_color_tempOut,
legendText: 'Außentemp. (max)',
yAxis_id: 2,
yAxis_show: false,
yAxis_min: -15,
yAxis_max: 30,
datalabel_show: true,
datalabel_align: 'top',
datalabel_minDigits: 1,
datalabel_maxDigits: 1,
datalabel_append: '°',
datalabel_color: mdw_datalabel_color_tempOut,
displayOrder: 1
}
}, // <= Zwischen mehreren Datenpunkten hier das Komma nicht vergessen!
{
fluxQuery:
'from(bucket: "iobroker") \
|> range(start: -8d) \
|> filter(fn: (r) => r["_measurement"] == "Umwelt.Garten_Themperatursensor_L-Steine.Temperatur") \
|> drop(columns: ["_field", "ack", "from", "q"]) \
|> aggregateWindow(every: 1d, fn: min, createEmpty: false) \
|> timeShift(duration: -1s) \
|> truncateTimeColumn(unit: 1d) \
|> sort(columns: ["_time"], desc: true) \
|> limit(n:7) \
|> sort(columns: ["_time"], desc: false)'
,
graphSettings: {
type: 'line',
color: mdw_line_color_tempOut,
legendText: 'Außentemp. (min)',
yAxis_id: 2,
yAxis_show: false,
yAxis_min: -15,
yAxis_max: 30,
datalabel_show: true,
datalabel_align: 'bottom',
datalabel_minDigits: 1,
datalabel_maxDigits: 1,
datalabel_append: '°',
datalabel_color: mdw_datalabel_color_tempOut,
displayOrder: 1
}
} // <= Beim letzten oder einzigen Datenpunkt natürlich kein Komma!
]
// #################### Programmablauf (Erzeugen des JSON) ####################
refreshData();
//Hauptfunktion
function refreshData() {
try {
let graphs = [];
// In dieser Schleife werden alle oben definierten Datenpunkte durchlaufen und die entstehenden JSON-Bausteine der Variable 'graphs' angehangen
for (const datenpunkt of datenpunkte) {
let historyData = getHistoryGraphData(historyInstance, datenpunkt.fluxQuery, datenpunkt.graphSettings);
if (historyData) {
graphs.push(historyData);
}
// Das Result von 'graphs' in den Zieldatenpunkt schreiben
Promise.all(graphs).then((result) => {
if (debug) console.log("[refreshData]: Final JSON " + JSON.stringify({ graphs: result }));
setState(targetDP, JSON.stringify({ graphs: result }), true);
});
}
} catch (err) {
console.error(`[refreshData] error: ${err.message}, stack: ${err.stack}`);
}
}
// Unterfunktion zum Auslesen der Daten aus InfluxDB
function getHistoryGraphData(historyInstance, fluxQuery, graphSettings) {
try {
let graph = Object.assign({ ...graphSettings }, globalGraphSettings);
return new Promise((resolve, reject) => {
// Hier wird für jeden Datenpunkt die Flux-Query ausgeführt und die Rohdaten in das Objekt 'query' geschrieben
sendTo
(historyInstance, 'query',
fluxQuery,
function (query) {
if (debug) console.log('[getHistoryGraphData]: Raw result from fluxQuery (query.result) ' + JSON.stringify(query.result));
// Hier werden aus den Rohdaten der Flux-Query Zeitstempel und Werte extrahiert und in das benötigte Array-Format übergeben
// [{"t": 1640624405000,"y": 1.4536},{"t": 1640649605000,"y": 1.4665}, ...]
graph.data = query.result[0].map(elm => ({
t: (elm.ts !== null && elm.ts !== undefined) ? elm.ts : null,
y: (elm._value !== null && elm._value !== undefined) ? elm._value : null
}));
resolve(graph);
if (debug) console.log("[getHistoryGraphData]: Result after map t: and y: (query.data) " + JSON.stringify(graph.data));
}
);
});
} catch (ex) {
console.error(`[getHistoryGraphData]: error: ${ex.message}, stack: ${ex.stack}`);
}
};
}; // end [refresh]
Im Beispiel stelle ich den Energieverbrauch der Wärmepumpe aggregiert je Tag der letzen 7 Tage inkl. des aktuellen Tages dar. Als Zusatzinformation die Tageshöchst- und -tiefsttemperaturen vom Außentemperatursensor.
Das Ergebnis sieht so aus:
Und hier das vom Skript erzeugte JSON, welches in den Zieldatenpunkt geschrieben wird und auf den man im JSON-Chart-Widget referenzieren muss:
{
"graphs": [
{
"type": "bar",
"color": "#44739e",
"legendText": "Energieverbrauch",
"yAxis_id": 0,
"yAxis_show": false,
"yAxis_min": 0,
"yAxis_max": 21,
"datalabel_show": true,
"datalabel_minDigits": 1,
"datalabel_maxDigits": 1,
"datalable_color": "#44739e",
"displayOrder": 2,
"line_pointSize": 0,
"datalabel_fontFamily": "RobotoCondensed-Regular",
"datalabel_fontSize": "14",
"xAxis_bounds": "ticks",
"xAxis_timeFormats": {
"millisecond": "H:mm:ss.SSS",
"second": "H:mm:ss",
"minute": "H:mm",
"hour": "dd.[\\n]H:mm",
"day": "dd[\\n]DD.MM",
"week": "dd[\\n]DD.MM",
"month": "MMM[\\n]YYYY",
"quarter": "[Q]Q - YYYY",
"year": "YYYY"
},
"data": [
{
"t": 1641686400000,
"y": 18.49740000000014
},
{
"t": 1641772800000,
"y": 17.172599999999747
},
{
"t": 1641859200000,
"y": 15.997500000000114
},
{
"t": 1641945600000,
"y": 18.452199999999955
},
{
"t": 1642032000000,
"y": 16.417500000000235
},
{
"t": 1642118400000,
"y": 19.2448999999999
},
{
"t": 1642204800000,
"y": 11.811599999999745
}
]
},
{
"type": "line",
"color": "#73c6b6",
"legendText": "Außentemp. (max)",
"yAxis_id": 2,
"yAxis_show": false,
"yAxis_min": -15,
"yAxis_max": 30,
"datalabel_show": true,
"datalabel_align": "top",
"datalabel_minDigits": 1,
"datalabel_maxDigits": 1,
"datalabel_append": "°",
"datalabel_color": "#73c6b6",
"displayOrder": 1,
"line_pointSize": 0,
"datalabel_fontFamily": "RobotoCondensed-Regular",
"datalabel_fontSize": "14",
"xAxis_bounds": "ticks",
"xAxis_timeFormats": {
"millisecond": "H:mm:ss.SSS",
"second": "H:mm:ss",
"minute": "H:mm",
"hour": "dd.[\\n]H:mm",
"day": "dd[\\n]DD.MM",
"week": "dd[\\n]DD.MM",
"month": "MMM[\\n]YYYY",
"quarter": "[Q]Q - YYYY",
"year": "YYYY"
},
"data": [
{
"t": 1641686400000,
"y": 5.3
},
{
"t": 1641772800000,
"y": 4.4
},
{
"t": 1641859200000,
"y": 4
},
{
"t": 1641945600000,
"y": 3.3
},
{
"t": 1642032000000,
"y": 5.1
},
{
"t": 1642118400000,
"y": 2.5
},
{
"t": 1642204800000,
"y": 3.5
}
]
},
{
"type": "line",
"color": "#73c6b6",
"legendText": "Außentemp. (min)",
"yAxis_id": 2,
"yAxis_show": false,
"yAxis_min": -15,
"yAxis_max": 30,
"datalabel_show": true,
"datalabel_align": "bottom",
"datalabel_minDigits": 1,
"datalabel_maxDigits": 1,
"datalabel_append": "°",
"datalabel_color": "#73c6b6",
"displayOrder": 1,
"line_pointSize": 0,
"datalabel_fontFamily": "RobotoCondensed-Regular",
"datalabel_fontSize": "14",
"xAxis_bounds": "ticks",
"xAxis_timeFormats": {
"millisecond": "H:mm:ss.SSS",
"second": "H:mm:ss",
"minute": "H:mm",
"hour": "dd.[\\n]H:mm",
"day": "dd[\\n]DD.MM",
"week": "dd[\\n]DD.MM",
"month": "MMM[\\n]YYYY",
"quarter": "[Q]Q - YYYY",
"year": "YYYY"
},
"data": [
{
"t": 1641686400000,
"y": 2.6
},
{
"t": 1641772800000,
"y": 0.4
},
{
"t": 1641859200000,
"y": -1.1
},
{
"t": 1641945600000,
"y": -0.8
},
{
"t": 1642032000000,
"y": -0.6
},
{
"t": 1642118400000,
"y": -2.1
},
{
"t": 1642204800000,
"y": 1.3
}
]
}
]
}
Zur Vervollständigung hier noch meine Objektstruktur für diesen Teilbereich:
Vielleicht hilft das dem einen oder anderen beim Einstieg in das JSON-Chart.
Grüße
Frank