Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- software:controller:vzlogger:vzlogger_conf_parameter [2018/11/16 04:52] – gpio_dir jau
+++ software:controller:vzlogger:vzlogger_conf_parameter [2023/05/31 19:44] (aktuell) – [channels] narc-ontakac2
@@ Zeile 3: / Zeile 3: @@
 Formatiert ist sie nach [[https://de.wikipedia.org/wiki/JavaScript_Object_Notation|JSON]]; kompakt, manuell lesbar und einfach zu parsen. Entgegen dem Standard unterstützt vzlogger auch Kommentare **/*...*/** oder **%%//%%** innerhalb der Konfigurationsdatei.\\
-Korrekte Kommata und Klammerung ist zwingend. Der [[http://volkszaehler.github.io/vzlogger/|vzlogger.conf-Editor]] hilft dabei. Er bietet auch eine meter- und channel-Vorauswahl und blendet dann Schlüssel aus die nicht benötigt werden.\\
+Korrekte Kommata und Klammerung sind zwingend. Der [[http://volkszaehler.github.io/vzlogger/|vzlogger.conf-Editor]] hilft dabei. Er bietet auch eine meter- und channel-Vorauswahl und blendet dann Schlüssel aus die nicht benötigt werden.\\
-Zeichenketten (String) müssen in Klammern gesetzt werden, Ganzzahlen (Integer) und Logische Ausdrücke (Bool) dürfen nicht. Gruppen **{}** und Schlüssel dürfen in root nur einmalig verwendet werden, in Arrays **[]** aber mehrmals.\\
+Zeichenketten (String) müssen in Anführungszeichen gesetzt werden, Ganzzahlen (Integer) und Logische Ausdrücke (Bool) hingegen nicht. Gruppen **{}** und Schlüssel dürfen in root nur einmalig verwendet werden, in Arrays **[]** aber mehrmals.\\
 Bestimmte Schlüssel bekommen, wenn sie nicht explizit genannt werden, bei Bedarf einen Standardwert (Default) zugewiesen.
@@ Zeile 13: / Zeile 13: @@
 {
   "retry": 0,
-  "daemon": true,
   "verbosity": 0,
-  "log": "/var/log/vzlogger.conf",
+  "log": "/var/log/vzlogger/vzlogger.log",
 </code>
@@ Zeile 23: / Zeile 22: @@
 ^ Wert | 0-? |
 ^ Empfehlung | 0 |
-=== daemon ===
-Betreibt vzlogger als Dienst (daemon) in den Hintergrund.
-^ Typ | Bool |
-^ Wert | true/false |
-^ Empfehlung | true |
 === verbosity ===
-Ausführlichkeit des Fehlerlogs.
+Ausführlichkeit des Fehlerlogs.\\
+In der höchsten Detailstufe werden auch alle verfügbaren [[/software/obis|OBIS-Codes]] eines [[/software/sml|SML]]-Telegramms gelistet.
 ^ Typ | Integer |
 ^ Wert | 0 = Alarme |
@@ Zeile 38: / Zeile 32: @@
 ^ ::: | 5 = Informationen |
 ^ ::: | 10 = Diagnose |
-^ ::: | 15 = Dateilinformationen |
+^ ::: | 15 = Detailinformationen |
 ^ Empfehlung | 15 zu Beginn |
 ^ ::: | 0 wenn alles fehlerfrei läuft |
@@ Zeile 47: / Zeile 41: @@
 ^ Typ | String |
 ^ Wert | Muss eine vorhandenes Verzeichnis sein auf dem schreibender Zugriff erlaubt ist. |
-^ Empfehlung | "/var/log/vzlogger.log" im Regelfall |
+^ Empfehlung | "/var/log/vzlogger/vzlogger.log" im Regelfall |
 ^ ::: | "" wenn S0-Impulse in schneller Folge geloggt werden da Schreibzugriffe auf SD-Karte das loggen stören können |
@@ Zeile 54: / Zeile 48: @@
 ====== push ======
 Empfangsort des VZ-[[https://de.wikipedia.org/wiki/Push-Pull-Strategie|Push]]-Servers.\\
-Über den Dienst ist es zum Beispiel möglich Daten an die VZ-Middleware zu schicken die zwar dargestellt, aber nicht gespeichert werden sollen. Es muss parallel dazu der [[software/middleware/push-server|Push-Server der Middleware]] aktiviert werden.
+Über den Dienst ist es zum Beispiel möglich Daten an die VZ-Middleware zu schicken die zwar dargestellt, aber nicht gespeichert werden. Es muss parallel dazu der [[software/middleware/push-server|Push-Server der Middleware]] aktiviert werden.
 <code>
   "push": [
@@ Zeile 81: / Zeile 75: @@
   "local": {
     "enabled": false,
-    "port": 8080,
+    "port": 8081,
     "index": false,
     "timeout": 0,
@@ Zeile 98: / Zeile 92: @@
 === port ===
-Der [[https://de.wikipedia.org/wiki/Port_(Protokoll)|Port]] an dem der Dienst auf Anfragen hört. Wenn auf der selben Maschine bereits ein httpd arbeitet ist darauf zu achten das der Port nicht doppelt verwendet wird! Für HTTP ist der Standard-Port 80.
+Der [[https://de.wikipedia.org/wiki/Port_(Protokoll)|Port]] an dem der Dienst auf Anfragen hört. Wenn auf der selben Maschine bereits ein httpd arbeitet ist darauf zu achten das der Port nicht doppelt verwendet wird! Für HTTP ist der Standard-Port 80, PPM bieten wir üblicherweise auf 8080 an.
 ^ Typ | Integer |
 ^ Wert | ? |
-^ Empfehlung | 8080 |
+^ Empfehlung | 8081 |
 === index ===
-Normal sollte die Anfrage die UUID des gewünschten ''channel'' enthalten, wird der Index aktiviert werden alle ''channel'' dargestellt.
+Normal sollte die Anfrage auch die UUID des gewünschten ''channel'' enthalten, z.B.: ''http://localhost:8081/c673b290-fdac-11e0-a470-1d9351203a00''. Wird der Index aktiviert werden auf Anfrage ''http://localhost:8081/'' alle ''channel'' ausgegeben.
 ^ Typ | Bool |
 ^ Wert | true/false |
@@ Zeile 122: / Zeile 116: @@
 ----
+====== mqtt ======
+Hier kann die Verbindung zum einem MQTT-Broker (Server) eingetragen werden. Die in ''meters''  angegebenen Kanäle werden dann in das entsprechende MQTT-Topic übertragen.
+<note important>Diese Funktion ist standardmäßig nicht im vzlogger enthalten und muss [[/software/controller/vzlogger/installation_cpp-version?s[]=mqtt#build_von_hand|beim Kompilieren aktiviert werden]].</note>
+<code>
+  "mqtt": {
+    "enabled": false,
+    "host": "test.mosquitto.org",
+    "port": 1883,
+    "id": "vzlogger",
+    "cafile": "",
+    "capath": "",
+    "certfile": "",
+    "keyfile": "",
+    "keypass": "",
+    "keepalive": 30,
+    "topic": "vzlogger/data",
+    "id": "",
+    "user": "",
+    "pass": "",
+    "retain": false,
+    "rawAndAgg": false,
+    "qos": 0,
+    "timestamp": false
+  }
+</code>
+=== enabled ===
+MQTT an- oder abstellen.
+^ Typ | Bool |
+^ Wert | true/false |
+^ Standard | false |
+^ Empfehlung | true |
+=== host ===
+Server-Adresse des MQTT-Brokers.
+^ Typ | String |
+^ Wert | eine gültige URL |
+^ Standard | test.mosquitto.org |
+=== port ===
+Port des MQTT-Brokers.
+^ Typ | Integer |
+^ Wert | 1883 (unverschlüsselt), 8883 (verschlüsselt), 8884 (verschlüsselt mit Zertifikat) |
+^ Standard | 1883 |
+=== cafile ===
+Optionaler Dateiname der Server CA
+^ Typ | String |
+^ Wert | Dateiname |
+^ Standard | |
+=== capath ===
+Optionaler Pfad für Server CAs
+^ Typ | String |
+^ Wert | Pfad |
+^ Standard | |
+<note important>Es sollten entweder ''cafile'' oder ''capath'' verwendet werden. Weitere Informationen sind in der Datei ''mosquitto.conf'' des MQTT-Brokers</note>
+=== certfile ===
+Optionaler Dateiname des Client-Zertifikats (z.B. ''client.crt'')
+=== keyfile ===
+Optionaler Pfad zum privaten Schlüssel des Client-Zertifikats (z.B. ''client.key'')
+^ Typ | String |
+^ Wert | Dateiname |
+^ Standard | |
+=== keypass ===
+Optionales Passwort des privaten Schlüssels
+^ Typ | String |
+^ Wert | Passwort |
+^ Standard | |
+=== keepalive ===
+Optionales Angabe der Sekunden zur Aufrechterhaltung der Verbindung (Keepalive)
+^ Typ | Integer |
+^ Wert | 0-? |
+^ Standard | 30 |
+=== topic ===
+Optionale Angabe des MQTT-Topics, in welches die Werte der verschiedenen ''meters'' geschrieben werden sollen. Im angegebenen Topic werden die ''meter'' durch ein Unter-Topic ''chnX'' unterschieden. Der erste ''meter'' ist im Unter-Topic ''chn0'', der zweite ''meter'' im Unter-Topic ''chn1'' usw. zu finden.
+^ Typ | String |
+^ Wert | MQTT-Topic |
+^ Standard | vzlogger/data |
+<note important>Das Topic darf nicht mit ''$'' beginnen und nicht mit ''/'' enden.</note>
+=== id ===
+Optionale statische Client-ID. Bei Nichtangabe wird eine Client-ID nach dem Muster ''vzlogger_<pid>'' verwendet.
+^ Typ | String |
+^ Wert | Client-ID |
+^ Standard | vzlogger_<pid> |
+=== user ===
+Optionaler Benutzername zur Anmeldung an den MQTT-Broker.
+^ Typ | String |
+^ Wert | Benutzername |
+^ Standard | |
+=== password ===
+Optionales Password zur Anmeldung an den MQTT-Broker.
+^ Typ | String |
+^ Wert | Passwort |
+^ Standard | |
+=== retain ===
+Optionale Anweisung zum Zwischenspeichern der MQTT-Nachricht, um bei Neuverbindung sofort darauf zugreifen zu können (Retain-Flag). Bei der Angabe von ''false'' ist der Wert erst sichtbar, wenn der Wert an den MQTT-Broker gesendet wird.
+^ Typ | Boolean |
+^ Wert | true/false |
+^ Standard | false |
+=== rawAndAgg ===
+Optionale Veröffentlichung der Rohdaten selbst wenn der Zusammenfassungs-Modus (''aggmode'') verwendet wird.
+^ Typ | Boolean |
+^ Wert | true/false |
+^ Standard | false |
+=== qos ===
+Optionale Angabe des Quality of Service.
+^ Typ | Integer |
+^ Wert | 0/1 |
+^ Standard | 0 |
+=== timestamp ===
+Optionale Angabe, ob ein Zeitstempel im Payload mit angegeben werden soll.
+^ Typ | Boolean |
+^ Wert | true/false |
+^ Standard | false |
 ====== meters ======
@@ Zeile 137: / Zeile 262: @@
       "aggtime": -1,
       "aggfixedinterval": false,
-      "channels": [],
       "protocol": "s0",
       "device": "",
+      "channels": [],
 </code>
@@ Zeile 157: / Zeile 282: @@
 === aggtime ===
-Vzlogger kann Messwerte sammeln und zusammenfügen (aggregieren) bevor sie an die MW gesendet werden. Hier wird die Sammelzeit in Sekunden definiert. Es ist darauf zu achten das die aggtime nicht kürzer ist als ''interval''.
+Vzlogger kann Messwerte sammeln und zusammenfügen (aggregieren) bevor sie an die MW gesendet werden. Hier wird die Sammelzeit in Sekunden definiert. Es ist darauf zu achten, dass die aggtime nicht kürzer ist als ''interval''.\\
+''aggtime'' arbeitet zusammen mit ''aggmode''.
 ^ Typ | Integer |
 ^ Wert | 0-? |
-^ ::: | -1 deaktiviert die Funktion sicher |
+^ ::: | -1 deaktiviert die Funktion sicher (Bitte auch ''aggmode'' auf "none" setzen, um undefiniertes Verhalten zu vermeiden) |
 ^ Standard | -1 |
 ^ Empfehlung | -1 |
@@ Zeile 170: / Zeile 296: @@
 ^ Standard | false |
 ^ Empfehlung | - |
+=== protocol ===
+Das Protokoll mit dem der Meter sendet. Der [[http://volkszaehler.github.io/vzlogger/|JSON-Editor]] hilft bei der korrekten Wahl.
+^ Typ | String ||
+^ Wert | "s0" | Impulssignale |
+^ ::: | "d0" | Zeilenbasierter Klartext nach DIN EN 62056-21 |
+^ ::: | "sml" | [[software:sml|SML]] wie es bei EDL-21, eHz und SyM2 verwendet wird |
+^ ::: | "random" | Zufallsgenerator |
+^ ::: | "file" | Auswerten einer bestehenden Datei, wird mittels ''format'' weiter parametriert |
+^ ::: | "exec" | Programmausgaben parsen |
+^ ::: | "fluksov2" | Protokoll der [[https://www.flukso.net/about|Flukso]]-Meter |
+^ ::: | "ocr" | Bilderkennung |
+^ ::: | "oms" | Open Metering System, ein Ableger von M-Bus |
+^ ::: | "w1therm" | 1-Wire-Temperatursensoren an Busmaster DS2482 |
+^ Empfehlung | - ||
+=== device ===
+Das Linux-Device über den der Meter angebunden ist.
+^ Typ | String |
+^ Wert | "" oder |
+^ ::: | "/dev/ttyUSB0" und andere gültige Device mit Schreib- und Leserecht. |
+^ Empfehlung | "/dev/ttyUSB0" für einen [[hardware:controllers:ir-schreib-lesekopf-usb-ausgang|IR-Schreib-Lesekopf mit USB-Ausgang]], unnötig bei s0 an GPIO oder d0/sml über TCP/IP. |
 ----
@@ Zeile 214: / Zeile 362: @@
 | ''ocr'' | z.B. "wert" | wie unter ''meter'', ''identifier'' parametriert |
 | ''oms'' | z.B. "1.8.0" | [[software:obis|OBIS-Codes]] |
-| ''1-wire'' | z.B. "28-00000450cbbd" | ID des Sensors |
+| ''w1therm'' | z.B. "28-00000450cbbd" | ID des Sensors |
@@ Zeile 223: / Zeile 371: @@
 ^ ::: | "mysmartgrid" vzlogger kann auch [[https://www.mysmartgrid.de|mySmartGrid]] mit Daten beliefern |
 ^ ::: | "influxdb" vzlogger kann auch [[https://en.wikipedia.org/wiki/InfluxDB|InfluxDB]] mit Daten beliefern |
-^ ::: | "null" wenn die Werte nur über den integrierten ''httpd'' oder ''push'' bereitgestellt werden sollen |
+^ ::: | "null" wenn die Werte nur über den integrierten ''httpd'', ''push'' oder ''mqtt'' bereitgestellt werden sollen |
 ^ Standard| "volkszaehler" |
 ^ Empfehlung | "volkszaehler" |
+Achtung: Der Wert ist ggfs. "null", nicht null.
 === middleware ===
@@ Zeile 257: / Zeile 406: @@
 === scaler ===
 Faktor für die Werte, nur für mySmartGid-''api''
-^ Typ | String |
+^ Typ | Integer |
 ^ Wert | 0-? |
@@ Zeile 266: / Zeile 415: @@
 === aggmode ===
-Mathematische Art der Aggregation die der vzlogger vornehmen soll. Nur wirksam in Verbindung mit ''aggtime'' größer als 0.
+Mathematische Art der Aggregation die der vzlogger vornehmen soll. Nur wirksam in Verbindung mit ''aggtime'' größer als 0.\\
+Wenn ''aggtime'' auf -1 steht (deaktiviert), dann bitte auch ''aggmode'' auf "none" setzen, um undefiniertes Verhalten zu vermeiden.
 ^ Typ | String |
 ^ Wert | "avg" Durchschnitt, zu verwenden bei Aktualwerten wie Strom, Spannung oder Temperatur |
@@ Zeile 280: / Zeile 430: @@
 ^ Wert | 0-? |
 ^ Empfehlung | 0, insbesondere bei ''s0''-Impulsen! |
-=== protocol ===
-Das Protokoll mit dem der Meter sendet. Der [[http://volkszaehler.github.io/vzlogger/|JSON-Editor]] hilft bei der korrekten Wahl.
-^ Typ | String ||
-^ Wert | "s0" | Impulssignale |
-^ ::: | "d0" | Zeilenbasierter Klartext nach DIN EN 62056-21 |
-^ ::: | "sml" | [[software:sml|SML]] wie es bei EDL-21, eHz und SyM2 verwendet wird |
-^ ::: | "random" | Zufallsgenerator |
-^ ::: | "file" | Auswerten einer bestehenden Datei, wird mittels ''format'' weiter parametriert |
-^ ::: | "exec" | Programmausgaben parsen |
-^ ::: | "fluksov2" | Protokoll der [[https://www.flukso.net/about|Flukso]]-Meter |
-^ ::: | "ocr" | Bilderkennung |
-^ ::: | "oms" | Open Metering System, ein Ableger von M-Bus |
-^ ::: | "w1therm" | 1-Wire-Temperatursensoren an Busmaster DS2482 |
-^ Empfehlung | - ||
-=== device ===
-Das Linux-Device über den der Meter angebunden ist.
-^ Typ | String |
-^ Wert | "" oder |
-^ ::: | "/dev/ttyUSB0" und andere gültige Device mit Schreib- und Leserecht. |
-^ Empfehlung | "/dev/ttyUSB0" für einen [[hardware:controllers:ir-schreib-lesekopf-usb-ausgang|IR-Schreib-Lesekopf mit USB-Ausgang]], unnötig bei s0 an GPIO oder d0/sml über TCP/IP. |
 ----
@@ Zeile 349: / Zeile 477: @@
 === resolution ===
-Impulse/kWh, wird bei ''api'':mysmartgrip benötigt.
+Impulse/kWh, wird bei ''api'':mysmartgrip und ''identifier'':Power benötigt.
 ^ Typ | Integer |
 ^ Wert | 1-? |
 ^ Standard | 1000 |
-^ Empfehlung | Entsprechend den Angaben auf dem Zähler |
+^ Empfehlung | Entsprechend der Angabe auf dem Zähler |
 === send_zero ===
@@ Zeile 501: / Zeile 629: @@
 ^ Wert | "" eine gültige URL mit Port |
 ^ Empfehlung | "" |
 === pullseq ===
 Initialisierungssequenz für Pull-Meter.
@@ Zeile 525: / Zeile 653: @@
 === use_local_time ===
-Nutzt zur Erstellung des Timestamp die aktuelle Uhrzeit des Rechners statt des Zählers.\\
+Nutzt zur Erstellung des Timestamp die aktuelle Uhrzeit des Rechners ("true") statt des Zählers ("false").\\
-Wenn ein Zähler im Datenstrom eine Uhrzeit mitliefert wird diese verwendet um Zeitverschiebungen durch FiFo-Puffer auszuschließen. Es sind allerdings Zähler im Umlauf bei denen vergessen wurde die Zeit bei Inbetriebnahme einzustellen, in diesen Fällen sollte der vzlogger die lokale Rechnerzeit verwenden.
+Die meisten Zähler liefern im Datenstrom die Echtzeit mit. Wenn diese bei der Inbetriebnahme korrekt eingestellt wurde, verwenden wir sie um z.B. mögliche Zeitverschiebungen durch FiFo-Puffer auszuschließen. Sind die Timestamp falsch oder fehlen sogar ganz muss der vzlogger die lokale Rechnerzeit heranziehen.
 ^ Typ | Bool |
 ^ Wert | true/false |
+^ Standard | false |
 ^ Empfehlung | false |
 ----
@@ Zeile 540: / Zeile 669: @@
 ----
 ==== exec ====
-Programmausgaben parsen
+In einem exec-Kanal wird für jede Abfrage das im Parameter ''command'' angegebene Shellkommando aufgerufen und die Standard-Ausgabe dieses Kommandos geparst. Dabei kann das erwartete Format mit Hilfe des ''format'' Parameters spezifiziert werden.
+  * exec-Kanäle sind nicht möglich, wenn der vzlogger als ''root'' ausgeführt wird. Durch einen Compiler-Parameter lässt sich diese Sicherheitsmaßnahme ausschalten. Es wird allerdings empfohlen, den vzlogger besser nicht als ''root'' auszuführen. In vielen Standard-Images ist dies nicht der Fall.
+  * Es wird für den Aufruf eine Shell verwendet, damit sind Pipes etc in vollem Umfang möglich
+  * Enthält der Formatstring kein $t, wird die aktuelle Uhrzeit als Timestamp verwendet
+=== command ===
+Dieses Kommando wird ausgeführt; seine Ausgabe geparst
+^ Typ | string |
+^ Wert | Shell-Kommando |
+^ Beispiel | Siehe Wikiseiten zum [[hardware:channels:solar_inverters:kostal_pico|Kostal Piko]] oder zum [[hardware:channels:meters:power:dzg_dvh4013_modbus|DZG DVH 4013 Modbus]] |
+=== format ===
+Jede Zeile der Ausgabe des ''command'' wird mit diesem Formatstring geparst und für jede Zeile ein eigener Datensatz erzeugt. Somit können sowohl mehrere Werte (z.B. verschiedene Register, die mit einem einzigen Aufruf des ''command'' ausgelesen wurden) als auch Werte unterschiedlicher Zeitstempel (z.B. man fragt die Quelle alle 30 Sekunden ab, möchte aber aus Gründen immer Batches von sechs Werten gleichzeitig in die Datenbank schreiben) mit einem einzelnen Aufruf eingetragen werden.
+^ Typ | string |
+^ Wert | Formatstring |
+^ Beispiel | '$t: $i = $v' für Ausgaben wie '1559656949: Gesamtenergie = 23294' |
+  * $t: timestamp (in Sekunden)
+  * $i: identifier (beliebiger String, taucht im Channel unter ''identifier'' wieder auf)
+  * $v: value
+Werte ohne identifier-Angabe landen beim Channel mit '"identifier": ""'.
+Weitere Dokumentation könnte man in den Mailinglistenarchiven, z.B. [[https://demo.volkszaehler.org/pipermail/volkszaehler-dev/2016-March/004933.html|hier ff.]], finden.
 ----