======= vzlogger.conf ======= Eine Beschreibung der Konfigurationsdatei von [[software:controller:vzlogger|vzlogger]], der Übersichtlichkeit halber in Abschnitte aufgeteilt.\\ 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/|JSON-Editor]] hilft dabei. Er bietet auch eine Meter-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.\\ ====== root ====== Im Wurzelverzeichnis haben wir die allgemeinen Einstellungen.


{
  "retry": 0,
  "daemon": true,
  "verbosity": 0,
  "log": "/tmp/vzlogger.conf",

=== retry === Wartezeit in Sekunden nach einer fehlgeschlagenen Anfrage. ^ Typ | Integer | ^ Wert | 0-? | ^ Empfehlung | 0 | === deamon === Verschiebt vzlogger als Dienst (deamon) in den Hintergrund. ^ Typ | Bool | ^ Wert | true/false | ^ Empfehlung | true | === verbosity === Auführlichkeit des Fehlerlogs. ^ Typ | Integer | ^ Wert | 0 = Fehler und Warnungen | ^ ::: | 5 = Informationen | ^ ::: | 10 = Diagnose | ^ ::: | 15 = Dateilinformationen | ^ Empfehlung | 15 zu Beginn | ^ ::: | 0 wenn alles fehlerfrei läuft | === log === Speicherort des Fehlerlogs. ^ Typ | String | ^ Wert | Muss eine vorhandenes Verzeichnis sein auf dem schreibender Zugriff erlaubt ist. | ^ Empfehlung | "/tmp/vzlogger.log" auf Systemen mit SD-Karte | ^ ::: | "/var/log/vzlogger.log" auf HDD oder SSD | ---- ====== push ====== Konfiguration des [[https://de.wikipedia.org/wiki/Push-Pull-Strategie|Push]]-Dienstes.\\ Damit ist es möglich Daten an die VZ-Middleware zu schicken die zwar dargestellt, aber nicht gespeichert werden sollen.


  "push": [
    {
      "url": "http://localhost/push/data.json"
    }

=== push === ^ Typ | Array | ^ Empfehlung | [] - nicht aktiv | === url === Zielort an dem die Daten in Empfang genommen werden. ^ Typ | String | ^ Wert | eine gültige URL | ^ Empfehlung | http://localhost/push/data.json für VZ | ---- ====== local ====== HTTP-Dienst (httpd) für Daten-[[https://de.wikipedia.org/wiki/Push-Pull-Strategie|Pull]]. Stellt die Daten der konfigurierten //meter// zu manuellen Kontrolle oder für andere Anwendungen bereit. Erspart einem z.B einen das Parsen des SML-Telegramms von einem eHz.


  "local": {
    "enabled": false,
    "port": 8080,
    "index": false,
    "timeout": 0,
    "buffer": 0
  },

=== local === ^ Typ | Gruppe | === enabled === Aktiviert den httpd. ^ Typ | Bool | ^ Wert | true/false | ^ Empfehlung | false | === 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. ^ Typ | Integer | ^ Wert | ? | ^ Empfehlung | 8080 | === index === Normal sollte die Anfrage die UUID des gewünschten channel enthalten, wird der Index aktiviert werden alle //channel// dargestellt. ^ Typ | Bool | ^ Wert | true/false | ^ Empfehlung | false bei Systemen die von öffentlichen Netzwerken aus verfügbar sind | === timeout === ? ^ Typ | Integer | ^ Wert | 0-? | ^ Empfehlung | 0 | === buffer === ? ^ Typ | Integer | ^ Wert | 0-? | ^ Empfehlung | 0 | ---- ====== meters ====== Hier werden die Datenquellen (Zähler, Sensoren) definiert mit denen der vzlogger kommunizieren soll. Jede Quelle ist eine Gruppe von Schlüsseln, es sind also mehrere Meter möglich.\\ Nicht alle Paramter sind in allen Konfigurationen erforderlich oder sinnvoll. Erst werden die Allgemeinen, dann die speziellen Parameter, in Abhängigkeit von //protocol//, beschrieben. ^ Typ | Array | ===== Allgemein =====


  "meters": [
    {
      "enabled": false,
      "allowskip": false,
      "aggtime": -1,
      "aggfixedinterval": false,
      "channels": [],
      "protocol": "s0",
      "device": "",

=== enabled === Den betreffenden Meter (z.B. für Diagnosezwecke) an- oder abstellen. ^ Typ | Bool | ^ Wert | true/false | ^ Empfehlung | true | === allowskip === Schlägt das öffnen des Meter fehl bricht vzlogger ab oder ignoriert ihn und setzt mit dem nächsten konfigurierten Meter fort. ^ Typ | Bool | ^ Wert | true/false | ^ Empfehlung | true - der Meter wird im Fehlerfall übersprungen | === 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//. ^ Typ | Integer | ^ Wert | 0-? | ^ ::: | -1 deaktiviert die Funktion sicher | ^ Empfehlung | -1 | === aggfixedinterval === Für eine optisch schönere Darstellung im Frontend ist es möglich alle aggregierten Kanäle dieses Meters mit identischem Timestamp an die Middleware zu senden. ^ Typ | Bool | ^ Wert | true/false | ^ Empfehlung | - | ---- ===== channels ===== So ziemlich die wichtigste Gruppe. Hier erfolgt die Zuordnung der von vzlogger gelesenen Daten zu den Kanälen der Middleware. Es sind mehrere //channels// in jedem //meter// möglich. Bei Inbetriebnahme kann man die //channels// erstmal leer lassen, //verbositiy// = 15 setzen und im //log// schauen was für Daten und unter welchen //identifier// die //meter// zur Verfügung stellen.


      "channels": [
        {
          "uuid": "",
          "identifier": "",
          "api": "volkszaehler",
          "middleware": "http://localhost/middleware.php",
          "secretKey": "",
          "type": "device",
          "scaler": 1,
          "aggmode": "none",
          "duplicates": 0
        }

=== uuid === Über die [[https://de.wikipedia.org/wiki/Universally_Unique_Identifier|UUID]] werden die Kanäle der Middleware identifiziert. Sie wird beim [[software:middleware:einrichtung#kanaele_im_frontend_anlegen|Erstellen eines Kanals]] von der Middleware generiert. ^ Typ | String | ^ Wert | z.B. "57acbef0-88a9-11e4-934f-6b0f9ecd95a8" | === identifier === Über diesen String werden die Werte zu diesem //channel// aus den Daten des //meter// identifiziert. Wie der String aussieht hängt vom //protocol// ab. ^ Typ | String | ^ //protocol// ^ Wert ^ Hinweise | //s0// | "Impulse" oder "Impulse_neg" | für Impulse | | //s0// | "Power" oder "Power_neg" | dabei werden die Impulse auf Basis von //resolution// in Leistung umgerechnet | | //d0// |z.B. "1-0:1.8.0" | [[software:obis|OBIS-Codes]] | | //sml// |z.B. "1-0:1.8.0" | [[software:obis|OBIS-Codes]] | | //random// | "" | bleibt immer leer | | //file// | "" oder per $i definiert | z.B. $i = $v => Temperatur = 10 => Identifier "Temperatur", Value = 10 | | //exec// | "" oder per $i definiert | z.B. $i = $v => Temperatur = 10 => Identifier "Temperatur", Value = 10 | | //fluksov2// | z.B. "Consumption" oder "Power" | wie bei FlukSo zu -ChannelId und +ChannelId zugewiesen | | //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 | === api === Hier wird die [[https://de.wikipedia.org/wiki/Programmierschnittstelle|Programmierschnittstelle]] definiert über die der vzlogger Kontakt aufnehmen soll. ^ Typ | String | ^ Wert | "volkszaehler" für die VZ-Middleware | ^ ::: | "mysmartgrid" vzlogger kann auch [[https://www.mysmartgrid.de|mySmartGrid]] mit Daten beliefern | ^ ::: | "none" wenn die Werte nur über den integrierte //httpd// bereitgestellt werden sollen | ^ Empfehlung | "volkszaehler" | === middleware === Die [[https://de.wikipedia.org/wiki/Uniform_Resource_Locator|URL]] über welche die //api// zu erreichen ist. ^ Typ | String | ^ Wert | z.B. "http://localhost/middleware.php" für eine VZ-Middleware auf der selben Maschine (Raspberry Image) | ^ ::: | z.B. "https://demo.volkszaehler.org/middleware.php" für den VZ Demo Server | ^ Empfehlung | "http://localhost/middleware.php" | === secretKey === Schlüssel für die Kommunikation mit der mySmartGrid-//api// ^ Typ | String | ^ Wert | ? | ^ Empfehlung | "" | === type === Art des //meter//, nur für mySmartGid-//api// ^ Typ | String | ^ Wert | "device" | ^ ::: | "sensor" | ^ Empfehlung | "" | === scaler === Faktor für die Werte, nur für mySmartGid-//api// ^ Typ | String | ^ Wert | 0-? | === aggmode === Mathematische Art der Aggregation die der vzlogger vornehmen soll. Nur wirksam in Verbindung mit //aggtime// größer als 0. ^ Typ | String | ^ Wert | "avg" Durchschnitt, zu verwenden bei Aktualwerte wie Strom, Spannung oder Temperatur | ^ ::: | "max" Maximal, zu verwenden bei Zählerständen | ^ ::: | "sum" Summe, zu verwenden bei Impulsen | ^ ::: | "none" keine Aggreagtion vornehmen | ^ Empfehlung | "none" | === duplicates === Zeit in Sekunden in denen wiederholende, identische Werte (z.B. unveränderte Zählerstände) nicht an die //api// weitergeleitet werden sollen. ^ Typ | Integer | ^ 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. | ---- ===== protocol-spezifische Schlüssel ===== Jedes //protocol// hat eine eigene Reihe erforderlicher und optionaler Schlüssel. ==== s0 ====


      "gpio": -1,
      "mmap": "",
      "gpio_dir": -1,
      "configureGPIO": true,
      "resolution": 1000,
      "send_zero": false,
      "debounce_delay": 30,
      "nonblocking_delay": 100000,


      "interval": -1,
	  "host": "",
	  "dump_file": "",
      "pullseq": "",
      "ackseq": "auto",
      "baudrate": 300,
      "baudrate_read": 300,
      "parity": "7e1",
      "wait_sync": "off",
      "read_timeout": 10,
      "baudrate_change_delay": 0


      "interval": -1,
      "host": "",
      "pullseq": "",
      "baudrate": 9600,
      "parity": "8n1"


     }
  ]
}