Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- software:controller:vzlogger:vzlogger_conf_parameter [2021/02/02 17:31] – scaler ist Integer, nicht String 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.\\
-Bedingt durch einen Fehler im Code werden bei ''false'' die erfassten Daten nicht versendet, es taugt daher leider nur für Tests.
-^ Typ | Bool |
-^ Wert | true/false |
-^ Empfehlung | true |
 === verbosity ===
@@ Zeile 49: / 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 124: / 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 159: / 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, dass 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 250: / Zeile 374: @@
 ^ Standard| "volkszaehler" |
 ^ Empfehlung | "volkszaehler" |
+Achtung: Der Wert ist ggfs. "null", nicht null.
 === middleware ===
@@ Zeile 290: / 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 566: / Zeile 692: @@
 ^ Beispiel | '$t: $i = $v' für Ausgaben wie '1559656949: Gesamtenergie = 23294' |
-  * $t: timestamp
+  * $t: timestamp (in Sekunden)
   * $i: identifier (beliebiger String, taucht im Channel unter ''identifier'' wieder auf)
   * $v: value