Quelltext der Seite IoBroker Grafana Diagramme und Werte per Simple-api Adapter

<u>'''Changelog'''</u><br>
* 05.07.2024 erste Version
----
==Vor-Vorwort==
Ja, warum nimmst du nicht die InfluxDB zusammen mit Grafana? Naja, habe ich ausprobiert, hat mir nicht gefallen, alles - im Vergleich - sehr umständlich mit der Datenbank. Ich nutze nun schon seit Jahrzehnten MySQl und MariaDB für SQL-Datenbanken, das funktioniert auch in ioBroker ganz wunderbar (und schnell). Im Prinzip könnte man auch direkt die SQL-Datenbank abfragen, da muss man sich das dann aber auch aus 2 Tabellen zusammensuchen. In der einen stehen die Datenpunkte und deren Index, in der anderen dann die Werte. Hatte ich damals auch nicht auf Anhieb hinbekommen, per Simple-api war es einfacher.<br>
----
==Vorwort==
Da ich meinen ioBroker nicht direkt über das Internet erreichbar machen will, von Unterwegs aber trotzdem auf meine Solarwerte schauen möchte, setze ich Grafana ein.<br>
Grafana holt sich dabei die Werte vom ioBroker und stellt mir die Werte so und als Diagramme da.<br>
Mein Grafana-Server ist dann über einen Apache-Reverse-Proxy über eine https-Seite, mit Benutzer + Passwort und Geoblocking innerhalb von Deutschland erreichbar.<br>
<br>
Ich hatte dazu mal einen Thema im ioBroker-Forum erstellt - und lange Zeit lief das mit einer Nutzung des {{Key|JSON API}} für Einzelwerte und des {{Key|SimpleJSON}} für Diagramme ganz hervorragend.<br>
 https://forum.iobroker.net/topic/62706/gel%C3%B6st-grafana-per-simpleapi-plugin-simplejson-vs-json<br>
<br>
Aber seit ein paar Tagen hatte ich keine Diagramme mehr. Grund ist, das das {{Key|SimpleJSON}} Plugin seit 6 Jahren nicht mehr gepflegt wird und deshalb vom Grafana-Team entfernt wurde - es wird nicht mehr supportet, nach einem Update von Grafana war es zwar noch in der Liste der '''Data sources''', die PlugIn-Dateien selbst fehlten aber, die Datenquelle war somit deaktiviert.
 https://github.com/grafana/simple-json-datasource
:[[Datei:ClipCapIt-240705-205412.PNG]]<br>
Tja, so hatte ich nur noch die Werte und keine Diagramme mehr.<br>
Also habe ich es mit dem '''Infinity data source plugin''' versucht - und das war alles andere als ein Selbstläufer!<br>
Damit ich das auch noch mal hinbekomme, gibt es nun dieses Artikel hier.<br>
----

==Grafana: Datenquelle installieren==
:[[Datei:ClipCapIt-240705-205712.PNG]]<br>
In Grafana fügen wir eine neue Datenquelle hinzu - '''Infinity'''
Ich habe meine Instanz '''Infinity-GET''' genannt.<br>
Und es muss nichts in der Datenquelle konfiguriert werden!<br>
Hinzufügen reicht.<br>
----
==ioBroker Simple-api Adapter installieren==
:[[Datei:ClipCapIt-240705-210120.PNG]]<br>
Den Adapter installieren und ggf. eine Instanz hinzufügen (sollte automatisch passieren).<br>
In den Instanzeinstellungen habe ich meine Datenquelle für die historischen Daten ausgewählt, der Port {{Key|8087}} ist meine ich der Default Wert:<br>
:[[Datei:ClipCapIt-240705-210912.PNG]]<br>
Kleiner Test: Sucht euch einen beliebigen Datenpunkt aus euren Objekten aus, ich nehme mal diesen hier:<br>
 0_userdata.0.Solaranlage.Total.Energy-Power
Darin steht der Wert meiner aktuellen Solarproduktion.<br>
Im Webbrowser kann man nun diesen Wert per API-Aufruf abfragen, egal ob der Wert eine Datenaufzeichnung besitzt oder nicht (SQL, InfluxDB oder History aktiviert wurde):<br>
 <nowiki>http://192.168.1.8:8087/get/0_userdata.0.Solaranlage.Total.Energy-Power</nowiki>
Also wie folgt:
 <nowiki>http://192.168.1.8:8087/get/</nowiki>                   Die IP-Adresse eures ioBroker, Port 8087, gefolgt von einem /get/
 0_userdata.0.Solaranlage.Total.Energy-Power    Die Objekt-ID die abgefragt werden soll
Die Rückgabe ist dann ein JSON:
:[[Datei:ClipCapIt-240705-211545.PNG]]<br>
Ganz schön viel Information, eigentlich wollen wir ja nur den Wert aus Zeile 2.<br>
Das ginge auch, dann müssen wir {{Key|/getPlainValue/}} statt {{Key|/get/}} in der URL verwenden:<br>
 <nowiki>http://192.168.1.8:8087/getPlainValue/0_userdata.0.Solaranlage.Total.Energy-Power</nowiki>
und schon gibt es nur die 83 zurück.<br>
Mehr Details gibt es unter der Beschreibung des Adapters:<br>
 https://github.com/ioBroker/ioBroker.simple-api
----

==Grafana - zum Aufwärmen einen einzelnen Wert abfragen==
In meinem Grafana-Dashboard füge ich eine neue '''''Visualization''''' hinzu, als Datenquelle wähle ich '''''Infinity-GET''''':<br>
:[[Datei:ClipCapIt-240705-212424.PNG]]<br>
Bei der URL (1) fügen wir einfach die Simple-api {{Key|/get/}} URL für den Wert ein, bei Format (2) nehmen wir '''Table''', als Parser (3) '''Backend'''<br>
Oben (4) sollte er uns nun den JSON anzeigen sofern wir die Ansicht auf '''Table''' umgestellt haben (schlägt er mittig vor, ansonsten oben rechts)<br>
Ja, wir hätten hier auch auch per URL gleich den nackten Werten holen können, ist aber eine gute Übung für die Diagramme.<br>
Und wie Ihr sehen könnt habe ich die IP-Adresse durch {{Key|127.0.0.1}} ersetzt, mein Grafana läuft lokal mit auf dem ioBroker-System.<br>
Im oberen Bereich mit den JSON können wir nach rechts scrollen, ganz am Ende steht dort der Eintrag {{Key|val}}:<br>
:[[Datei:ClipCapIt-240705-212901.PNG]]<br>
Unten unterhalb von wo wir die URL eingefügt haben, erweitern wir den Bereich '''Parsing options & Result fields''' und tragen dort {{Key|val}} ein:<br>
:[[Datei:ClipCapIt-240705-213052.PNG]]<br>
Und schon steht oben nur noch unserer Wert:<br>
:[[Datei:ClipCapIt-240705-213149.PNG]]<br>
Ich benenne die Query jetzt noch um:
:[[Datei:ClipCapIt-240705-213252.PNG]]<br>
Und wähle noch einen anderen Diagrammtyp, z.B. Stat:<br>
:[[Datei:ClipCapIt-240705-213508.PNG]]<br>
und schon wird mir das als große Zahl angezeigt:<br>
:[[Datei:ClipCapIt-240705-213724.PNG]]<br>
Wenn ich rechts unter '''Standard options''' noch eine Einheit festlege sogar mit W am dahinter:<br>
 Standard options => Unit => Energy => Watt (W)
:[[Datei:ClipCapIt-240705-213917.PNG]]<br>
<br>
----

==Simple-api historische Werte abfragen==
Wenn bei einem Objekt in ioBroker die Aufzeichnung aktiviert ist, kann man diese Daten ebenfalls per Simple-api abfragen. Man muss dazu aber eine andere URL benutzen:<br>
 <nowiki>http://192.168.1.8:8087/query/0_userdata.0.Solaranlage.Total.Energy-Power/?dateFrom=2024-07-05T12:00:00&dateTo2024-07-05T12:59:59</nowiki>
Erklärung:
 <nowiki>http://192.168.1.8:8087</nowiki>                         URL + Port des Simple-api Adapters
 /query/                                         Wir wollen die historischen Daten haben
 0_userdata.0.Solaranlage.Total.Energy-Power     für diese Objekt-Id
 /?                                              gefolgt von Parametern
 dateFrom=2024-07-05T12:00:00                    Datum + Uhrzeit ab und
 &dateTo2024-07-05T12:59:59                      Datum + Uhrzeit bis zu welchen Zeitpunkt, hier also 59 Minuten und 59 Sekunden
Die Rückgabe ergibt dann so etwas:
:[[Datei:ClipCapIt-240705-214746.PNG]]<br>
Das ist dann immer jeweils der Wert, in der Zeile darunter der UNIXTIME-Stamp in Millisekunden-Format. Also die Millisekunden seit dem 1.1.1970, 00:00:00 Uhr.<br>
Wenn wir das mal in einen JSON-Pathfinder kopieren:
 https://jsonpathfinder.com/
Können wir die Struktur analysieren und sehen den Aufbau:<br>
:[[Datei:ClipCapIt-240705-215110.PNG]]<br>
Im Abschnitt {{Key|datapoints[x]}} gibt es für jeden zurückgegebenen Wert 2 Unterpunkte:
[0] mit dem Wert und [1] mit dem Zeitstempel.<br>
 x[0].datapoints[0][0]    = 1. Wert
 x[0].datapoints[0][1]    = Zeitstempel des 1. Wertes
 ...
 ...
 x[0].datapoints[200][0]  = 201. Wert
 x[0].datapoints[200][1]  = Zeitstempel des 201. Wertes
Die Struktur kennen wir nun also, jetzt das ganze noch in Grafana umsetzen.<br>
----

==Grafana Diagramm mit Werten per Simple-api==
Wir fügen in Grafana im Dashboard wieder eine '''Visualization''' hinzu, in der Mitte könnt Ihr auch gleich '''''Switch to table''''' wählen.<br>
:[[Datei:ClipCapIt-240705-220023.PNG]]<br>
Als URL (1) kommt die {{Key|/query/}} URL hinein, ich habe die IP wieder auf 127.0.0.1 geändert.<br> Die URL endet auf {{Key|/?}}:<br>
 <nowiki>http://127.0.0.1:8087/query/0_userdata.0.Solaranlage.Total.Energy-Power/?</nowiki>
Format (2) ist diesmal '''Time Series''', Parser (3) ist wieder '''Backend'''.<br>
Nun klicken wir noch auf Options (4):<br>
:[[Datei:ClipCapIt-240705-220412.PNG]]<br>
und fügen unten bei '''Add query param''' (2) 2 Felder hinzu:<br>
 dateFrom
 dateTo
Als Value können wir die Zeit einsetzen. Das kann ein fester, ein flexibler oder eine Mischung aus beiden sein.<br>
In Grafana gibt es vordefinierte Variablen:
 https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables
aus denen wir uns das zusammenbauen können.<br>
<u>'''Variante 1: den ganzen aktuellen Tag:'''</u><br>
Ich mag 24h Anzeigen, das geht wie folgt:<br>
 dateFrom          ${__from:date:YYYY-MM-DD}T00:00:00
 dateTo            ${__to:date:YYYY-MM-DD}T23:59:59
Wenn Ihr oben einmal in das URL-Feld klickt und dann mit der Tabulatortaste weiterspringt, sollte er die Werte oben aktualisieren:<br>
:[[Datei:ClipCapIt-240705-221008.PNG]]<br>
Geht auch per Refresh-Button:
:[[Datei:ClipCapIt-240705-222112.PNG]]<br>
<br>
<u>'''Variante 2: den in Grafana eingestellten Zeitraum:'''</u><br>
 dateFrom          ${__from:date:iso}
 dateTo            ${__to:date:iso}
wählt den Zeitraum der gerade für das Dashboard eingestellt ist:<br>
:[[Datei:ClipCapIt-240705-221319.PNG]]<br>
<br>
Wir erweitern wieder den Abschnitt '''Parsing options & Result fields''' und schreiben bei '''Rows/Root''' das Wort
 datapoints
ins das Feld:<br>
:[[Datei:ClipCapIt-240705-221508.PNG]]<br>
Die Anzeige oben sollte sich ändern:<br>
:[[Datei:ClipCapIt-240705-221545.PNG]]<br>
Prima, nur noch <code>[</code> Werte <code>,</code> Zeitstempel <code>]</code>
Die müssen wir nun auch noch trennen:<br>
:[[Datei:ClipCapIt-240705-221820.PNG]]<br>
 1   as     Timestamp          format as      Timestamp ( UNIX ms )
 0   as     Wert               format as      Number
Die beiden mittleren Texte könnte man auch weglassen, die dienen nur der Lesbarkeit.<br>
Wenn ihr wieder oben rechts auf Refresh drückt, sollte sich die Anzeige oben aktualisieren:<br>
:[[Datei:ClipCapIt-240705-222232.PNG]]<br>
Super, wir haben die Werte.<br>
Ändern wir oben rechts den Diagrammtyp auf '''Time series''':<br>
:[[Datei:ClipCapIt-240705-222822.PNG]]<br>
oder als 24h Variante:<br>
:[[Datei:ClipCapIt-240705-222956.PNG]]<br>
Die 24h klappen natürlich nur wenn auch die Dashboard-Ansicht auf 24h steht:<br>
:[[Datei:ClipCapIt-240705-223047.PNG]]<br>
also
 now/1d
in beide Felder eintragen und '''Apply time range''' klicken.<br>
<br>
Das war es aber schon!<br>
Speichern und nach belieben anpassen oder weitere Werte hinzufügen:<br>
:[[Datei:ClipCapIt-240705-223756.PNG]]<br>

----

==Kommentare==
<comments />