Aktuelle Änderungen - Suchen:

CCU-BackDoc

Empfohlene Links

Impressum & Haftungsausschluss

Spendenhinweise

Einleitung

Das Werkzeug CCU-BackDoc dient zur Rückdokumentation des in der Hausautomationszentrale (CCU) gespeicherten Projektes. Das interne Datenmodell der CCU wird erkundet. Dabei werden Eigenschaften von Objekten und deren Beziehungen untereinander ausgelesen. Die Informationen werden dann verwendet, um automatisiert Diagramme zu erstellen.

Die Diagramme können z.B. zur Dokumentation des Projektes genutzt werden. Auch sind in den generierten Grafiken Projektierungsfehler sofort erkennbar. Gerade bei größeren Automationsprojekten sind Wirkzusammenhänge über die von der CCU zur Verfügung stellte WebUI nur schwer ersichtlich.

Zur Zeit werden die Objekttypen Programm, Systemvariable, Gerät und Kanal und deren Beziehungen untereinander unterstützt. Ein einfaches Programm wird z.B. wie folgt visualisiert:

Legende: Programme - olivfarben; Systemvariablen - türkis; Kanäle - hellgrün; Geräte - hellblau

Installation

Zum Ausführen des CCU-BackDocs wird eine Java Laufzeit Umgebung benötigt. Diese muss vorhanden sein oder installiert werden.

Für die Generierung der Diagramme wird das Werkzeug Graphviz verwendet. Installationspakete für verschiedene Betriebssysteme sind auf der Seite Download zu finden, nachdem die Lizenz akzeptiert wurde. Die Installation sollte mit den Standardeinstellungen durchgeführt werden. Wenn auf der Kommandozeile dot -V ausgeführt werden kann, und eine Ausgabe in der Form dot - graphviz version 2.28.0 erfolgt, so war die Installation erfolgreich.

Das Installationspaket (V0.1.3) des CCU-BackDocs kann in ein beliebiges leeres Verzeichnis entpackt werden.

Konfiguration

Die mitgelieferte Beispielkonfigurationsdatei ccu-backdoc-sample.config muss in ccu-backdoc.config umbenannt werden. Für den ersten Start reicht es, die Konfigurationsoption ccu.address zu setzen. Wenn die IP-Adresse der CCU 192.168.0.2 ist, dann muss die Option wie folgt angegeben werden: ccu.address='192.168.0.2'

Start

Gestartet wird der CCU-BackDoc unter Windows mit der Datei ccu-backdoc.exe. Auf anderen Betriebssystemen ist auf der Kommandozeile java -jar ccu-backdoc.jar einzugeben.

Als erstes wird vom CCU-BackDoc der Datenhaushalt der CCU erkundet. Mit der Standardkonfiguration ccu.scriptDelay=500 werden etwa 80 Objekte pro Minute erkundet.

Nach Abschluss der Erkundung werden die Diagramme erstellt. Diese werden in einzelnen Dateien mit den Namen program-0.png, program-1.png, usw. abgespeichert. Diese können mit jedem Bildbetrachter angeschaut werden.

Anpassung der Ausgabe

Mehrere Programme auf einem Blatt

Häufig kommt es vor, dass für eine Automatisierungsaufgabe mehrere Programme im Verbund eingesetzt werden. Die zusammengehörigen Programme und deren abhängige Objekte können auf einem Blatt zusammengefasst werden. Dies erfolgt mit der Konfigurationsoption graph.sameSheet.

Um alle Programme, deren Namen Rollladen oder Sonnenschutz beinhalten, auf ein Blatt zu setzen, wird die Option wie folgt gesetzt:

graph.sameSheet=[
 ['Rollladen', 'Sonnenschutz']
]

Das generierte Diagramm sieht dann z.B. wie folgt aus:

Mehrere Programme auf einem Blatt

Mehrere Programme auf einem Blatt

Um ein zweites Blatt zu erhalten, auf dem sich alle Programme befinden, deren Namen Alarm beinhalten, ist die Konfiguration zu erweitern:

graph.sameSheet=[
 ['Rollladen', 'Sonnenschutz'],
 ['Alarm']
]

Anderes Layout

Die Layout-Engine von Graphviz kann mit der Konfigurationsoption graph.engine geändert werden. Normalerweise wird die Layout-Engine dot verwendet. Durch Setzen der Option graph.engine='neato' verändert sich z.B. das in der Einleitung gezeigte Diagramm wie folgt:

neato Layout

Fehlersuche

Zur Fehlersuche ist es hilfreich vom CCU-BackDoc Log-Dateien erstellen zu lassen. Dies wird durch das Setzen der Konfigurationsoption logSystem.fileLevel=Level.FINEST erreicht. Daraufhin werden Log-Dateien mit den Namen ccu-backdoc-0.log, ccu-backdoc-1.log, usw. erstellt. Diese können mit jedem Texteditor geöffnet werden.

CCU-BackDoc / Startseite - Zuletzt geändert am 30.06.2012 09:20 Uhr