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 [2021/09/19 15:06] – roaroid
@@ Zeile 124: / Zeile 124: @@
 ----
+====== 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.
+<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 289: @@
 === 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 290: / Zeile 421: @@
 === 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 |