software:controller:vzlogger:vzlogger_conf_parameter
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung | ||
software:controller:vzlogger:vzlogger_conf_parameter [2019/02/14 09:19] – Darstellungsfehler 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:// | Formatiert ist sie nach [[https:// | ||
- | Korrekte Kommata und Klammerung | + | Korrekte Kommata und Klammerung |
- | Zeichenketten (String) müssen in Klammern | + | Zeichenketten (String) müssen in Anführungszeichen |
Bestimmte Schlüssel bekommen, wenn sie nicht explizit genannt werden, bei Bedarf einen Standardwert (Default) zugewiesen. | Bestimmte Schlüssel bekommen, wenn sie nicht explizit genannt werden, bei Bedarf einen Standardwert (Default) zugewiesen. | ||
Zeile 13: | Zeile 13: | ||
{ | { | ||
" | " | ||
- | " | ||
" | " | ||
- | " | + | " |
</ | </ | ||
Zeile 23: | Zeile 22: | ||
^ Wert | 0-? | | ^ Wert | 0-? | | ||
^ Empfehlung | 0 | | ^ Empfehlung | 0 | | ||
- | |||
- | === daemon === | ||
- | Betreibt vzlogger als Dienst (daemon) in den Hintergrund.\\ | ||
- | Bedingt durch einen Fehler im Code werden bei '' | ||
- | ^ Typ | Bool | | ||
- | ^ Wert | true/false | | ||
- | ^ Empfehlung | true | | ||
=== verbosity === | === verbosity === | ||
Zeile 49: | Zeile 41: | ||
^ Typ | String | | ^ Typ | String | | ||
^ Wert | Muss eine vorhandenes Verzeichnis sein auf dem schreibender Zugriff erlaubt ist. | | ^ Wert | Muss eine vorhandenes Verzeichnis sein auf dem schreibender Zugriff erlaubt ist. | | ||
- | ^ Empfehlung | "/ | + | ^ Empfehlung | "/ |
^ ::: | "" | ^ ::: | "" | ||
Zeile 83: | Zeile 75: | ||
" | " | ||
" | " | ||
- | " | + | " |
" | " | ||
" | " | ||
Zeile 100: | Zeile 92: | ||
=== port === | === port === | ||
- | Der [[https:// | + | Der [[https:// |
^ Typ | Integer | | ^ Typ | Integer | | ||
^ Wert | ? | | ^ Wert | ? | | ||
- | ^ Empfehlung | 8080 | | + | ^ Empfehlung | 8081 | |
=== index === | === index === | ||
- | Normal sollte die Anfrage die UUID des gewünschten '' | + | Normal sollte die Anfrage |
^ Typ | Bool | | ^ Typ | Bool | | ||
^ Wert | true/false | | ^ Wert | true/false | | ||
Zeile 124: | Zeile 116: | ||
---- | ---- | ||
+ | |||
+ | ====== mqtt ====== | ||
+ | Hier kann die Verbindung zum einem MQTT-Broker (Server) eingetragen werden. Die in '' | ||
+ | <note important> | ||
+ | |||
+ | < | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === 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), | ||
+ | ^ 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> | ||
+ | |||
+ | === certfile === | ||
+ | Optionaler Dateiname des Client-Zertifikats (z.B. '' | ||
+ | |||
+ | === keyfile === | ||
+ | Optionaler Pfad zum privaten Schlüssel des Client-Zertifikats (z.B. '' | ||
+ | ^ 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, | ||
+ | ^ Typ | String | | ||
+ | ^ Wert | MQTT-Topic | | ||
+ | ^ Standard | vzlogger/ | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | === id === | ||
+ | Optionale statische Client-ID. Bei Nichtangabe wird eine Client-ID nach dem Muster '' | ||
+ | ^ Typ | String | | ||
+ | ^ Wert | Client-ID | | ||
+ | ^ Standard | vzlogger_< | ||
+ | |||
+ | === 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, | ||
+ | ^ Typ | Boolean | | ||
+ | ^ Wert | true/false | | ||
+ | ^ Standard | false | | ||
+ | |||
+ | === rawAndAgg === | ||
+ | Optionale Veröffentlichung der Rohdaten selbst wenn der Zusammenfassungs-Modus ('' | ||
+ | ^ 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 ====== | ====== meters ====== | ||
Zeile 139: | Zeile 262: | ||
" | " | ||
" | " | ||
- | " | ||
" | " | ||
" | " | ||
+ | " | ||
</ | </ | ||
Zeile 159: | Zeile 282: | ||
=== aggtime === | === 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 | + | 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 '' |
+ | '' | ||
^ Typ | Integer | | ^ Typ | Integer | | ||
^ Wert | 0-? | | ^ Wert | 0-? | | ||
- | ^ ::: | -1 deaktiviert die Funktion sicher | | + | ^ ::: | -1 deaktiviert die Funktion sicher |
^ Standard | -1 | | ^ Standard | -1 | | ||
^ Empfehlung | -1 | | ^ Empfehlung | -1 | | ||
Zeile 172: | Zeile 296: | ||
^ Standard | false | | ^ Standard | false | | ||
^ Empfehlung | - | | ^ Empfehlung | - | | ||
+ | |||
+ | === protocol === | ||
+ | Das Protokoll mit dem der Meter sendet. Der [[http:// | ||
+ | ^ Typ | String || | ||
+ | ^ Wert | " | ||
+ | ^ ::: | " | ||
+ | ^ ::: | " | ||
+ | ^ ::: | " | ||
+ | ^ ::: | " | ||
+ | ^ ::: | " | ||
+ | ^ ::: | " | ||
+ | ^ ::: | " | ||
+ | ^ ::: | " | ||
+ | ^ ::: | " | ||
+ | ^ Empfehlung | - || | ||
+ | |||
+ | === device === | ||
+ | Das Linux-Device über den der Meter angebunden ist. | ||
+ | ^ Typ | String | | ||
+ | ^ Wert | "" | ||
+ | ^ ::: | "/ | ||
+ | ^ Empfehlung | "/ | ||
---- | ---- | ||
Zeile 216: | Zeile 362: | ||
| '' | | '' | ||
| '' | | '' | ||
- | | '' | + | | '' |
Zeile 225: | Zeile 371: | ||
^ ::: | " | ^ ::: | " | ||
^ ::: | " | ^ ::: | " | ||
- | ^ ::: | " | + | ^ ::: | " |
^ Standard| " | ^ Standard| " | ||
^ Empfehlung | " | ^ Empfehlung | " | ||
+ | Achtung: Der Wert ist ggfs. " | ||
=== middleware === | === middleware === | ||
Zeile 259: | Zeile 406: | ||
=== scaler === | === scaler === | ||
Faktor für die Werte, nur für mySmartGid-'' | Faktor für die Werte, nur für mySmartGid-'' | ||
- | ^ Typ | String | + | ^ Typ | Integer |
^ Wert | 0-? | | ^ Wert | 0-? | | ||
Zeile 268: | Zeile 415: | ||
=== aggmode === | === aggmode === | ||
- | Mathematische Art der Aggregation die der vzlogger vornehmen soll. Nur wirksam in Verbindung mit '' | + | Mathematische Art der Aggregation die der vzlogger vornehmen soll. Nur wirksam in Verbindung mit '' |
+ | Wenn '' | ||
^ Typ | String | | ^ Typ | String | | ||
^ Wert | " | ^ Wert | " | ||
Zeile 282: | Zeile 430: | ||
^ Wert | 0-? | | ^ Wert | 0-? | | ||
^ Empfehlung | 0, insbesondere bei '' | ^ Empfehlung | 0, insbesondere bei '' | ||
- | |||
- | === protocol === | ||
- | Das Protokoll mit dem der Meter sendet. Der [[http:// | ||
- | ^ Typ | String || | ||
- | ^ Wert | " | ||
- | ^ ::: | " | ||
- | ^ ::: | " | ||
- | ^ ::: | " | ||
- | ^ ::: | " | ||
- | ^ ::: | " | ||
- | ^ ::: | " | ||
- | ^ ::: | " | ||
- | ^ ::: | " | ||
- | ^ ::: | " | ||
- | ^ Empfehlung | - || | ||
- | |||
- | === device === | ||
- | Das Linux-Device über den der Meter angebunden ist. | ||
- | ^ Typ | String | | ||
- | ^ Wert | "" | ||
- | ^ ::: | "/ | ||
- | ^ Empfehlung | "/ | ||
---- | ---- | ||
Zeile 351: | Zeile 477: | ||
=== resolution === | === resolution === | ||
- | Impulse/ | + | Impulse/ |
^ Typ | Integer | | ^ Typ | Integer | | ||
^ Wert | 1-? | | ^ Wert | 1-? | | ||
^ Standard | 1000 | | ^ Standard | 1000 | | ||
- | ^ Empfehlung | Entsprechend | + | ^ Empfehlung | Entsprechend |
=== send_zero === | === send_zero === | ||
Zeile 527: | Zeile 653: | ||
=== use_local_time === | === 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 |
- | Wenn ein Zähler im Datenstrom | + | Die meisten |
^ Typ | Bool | | ^ Typ | Bool | | ||
^ Wert | true/false | | ^ Wert | true/false | | ||
+ | ^ Standard | false | | ||
^ Empfehlung | false | | ^ Empfehlung | false | | ||
---- | ---- | ||
Zeile 542: | Zeile 669: | ||
---- | ---- | ||
==== exec ==== | ==== exec ==== | ||
- | Programmausgaben parsen | + | |
+ | In einem exec-Kanal wird für jede Abfrage das im Parameter '' | ||
+ | |||
+ | * exec-Kanäle sind nicht möglich, wenn der vzlogger als '' | ||
+ | * 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; | ||
+ | |||
+ | ^ Typ | string | | ||
+ | ^ Wert | Shell-Kommando | | ||
+ | ^ Beispiel | Siehe Wikiseiten zum [[hardware: | ||
+ | |||
+ | === format === | ||
+ | |||
+ | Jede Zeile der Ausgabe des '' | ||
+ | |||
+ | ^ Typ | string | | ||
+ | ^ Wert | Formatstring | | ||
+ | ^ Beispiel | '$t: $i = $v' für Ausgaben wie ' | ||
+ | |||
+ | * $t: timestamp (in Sekunden) | ||
+ | * $i: identifier (beliebiger String, taucht im Channel unter '' | ||
+ | * $v: value | ||
+ | |||
+ | Werte ohne identifier-Angabe landen beim Channel mit '" | ||
+ | |||
+ | Weitere Dokumentation könnte man in den Mailinglistenarchiven, | ||
---- | ---- |
software/controller/vzlogger/vzlogger_conf_parameter.txt · Zuletzt geändert: 2023/05/31 19:44 von narc-ontakac2