Konfiguration der CometVisu¶

Die Konfiguration der CometVisu erfolgt durch Bearbeiten der XML-formatierten Konfigurationsdatei „visu_config.xml“ im jeweiligen Unterverzeichnis ”./config” der CometVisu-Installation. Dies kann entweder mit einem textbasierten Editor oder mit dem integrierten grafischen Editor erfolgen. Die Verwendung des grafischen Editors setzt jedoch voraus, dass die CometVisu von einem PHP-fähigen Webserver (z.B Apache oder Lighttpd) ausgeliefert wird und die Konfigurationsdatei durch diesen beschreibbar ist.

Am einfachsten greift man auf die verschiedenen Konfigurationsdateien über den Manager zu.

Je nach verwendetem Backend und der Vorgehensweisen bei der Installation befindet sich der CometVisu-Verzeichnisbaum an unterschiedlichen Stellen:

Soll die CometVisu mit Hilfe des knxd-daemons unmittelbar an den KNX-Bus-Telegrammverkehr angebunden werden (KNX ist dann das Backend), wird die CometVisu manuell in den Vezeichnisbaum “/var/www/visu…” des Webservers (z.B. Apache oder Lighttpd) installiert. Der Webserver lauscht in der default-Einstellung in der Regel am Port 80.
Wird openHAB als Backend für die CometVisu eingesetzt, müssen sich die CometVisu-Dateien im openHAB-Verzeichnisbaum befinden. Der openHAB-eigene Webserver wird in der default-Einstellung über Port 8080 angesprochen und ist nicht php-fähig. In diesem Fall muß man sich mit einem textbasierten Editor begnügen oder den wohlmöglich parallel laufenden Webserver (z.B. Apache oder Lighttpd) “umlenken“.
Wurde openHAB automatisiert via apt-get installiert, wird die CometVisu manuell in “/usr/share/openhab/webapps/visu…” installiert.
Wurde openHAB manuell z.B. in “/opt/openHAB” installiert, wird die CometVisu manuell in “/opt/openhab/www/visu...” installiert.

Zu tun

Wird openHAB2 als backend für die CometVisu eingesetzt, ...

Soll die XML-formatierte Konfigurationsdatei „visu_config.xml“ durch den (fortgeschrittenen) Anwender direkt bearbeitet werden, ist es sehr ratsam, hierzu einen XML-fähigen Editor zu verwenden, welcher u.a. die Syntax der besseren Lesbarkeit einfärbt (z.B. Textwrangler auf MacOSX, WordPad++, Notepad++ oder MS XML Editor 2007 unter Windows und unter Linux z.B. vi mit ”:syntax on”).

Allgemeine Informationen über das CometVisu XML Format findet man hier, Informationen zu den einzelnen Widgets in den jeweiligen Unterseiten.

Manche Widgets und Plugins benötigen noch zusätzliche Informationen, die nicht in der Config-Datei enthalten sein sollen, da diese frei lesbar an den Web-Browser übertragen wird (je nach installierter Umgebung kann der Transport verschlüsselt mit HTTPS erfolgen, jedoch ist der Inhalt durch den Benutzer am Browser mit entsprechenden Tricks lesbar). Durch die Verwendung der Versteckten Konfigurationen können diese Informationen auf dem besser geschützten Server verbleiben.

Nach dem Speichern ist keinerlei Neustart von Prozessen nötig, jedoch sollte man die Seite neu laden und den Browser-Cache löschen.

Wenn die XML Datei ungültig ist wird beim Laden der Visu im Webbrowser eine Fehlermeldung angezeigt. Diese gibt im Normalfall schon genaue Hinweise wo in der Datei der Fehler liegt. Man kann die Überprüfung (und Darstellung) auch mit dem Link “Check Config” in der Fusszeile oder durch Anhängen von check_config.php an den URL erzwingen.

Genaue Beschreibungen zu den verfügbaren URL-Parameter sind unter URL-Parameter zu finden.

Seiten und Struktur der CometVisu¶

Grundsätzliches¶

Zur Visualisierung und zum Auslösen von Aktionen wie z.B. Schalten oder Jalousien verfahren bedient sich CometVisu sogenannter Widgets. Widgets können als grafische Bausteine verstanden werden, die auf einer darzustellenden Seite (= page) angeordnet werden. Ein Widget besteht aus dem eigentlichen sichtbaren Bereich, der Maus- oder Tastereignisse empfängt und weiterleitet und aus nicht sichtbaren Objekten, durch welche die Funktionsweise des Widget detaillierter festgelegt werden.

Es wird zwischen Widgets zur

Bedienung (hier z.B. das switch-Widget zum Schalten),
Darstellung (diese haben ausschließlich informative Funktion),
Anordnung oder Gruppierung anderer Widgets oder zur Navigation innerhalb der verschiednen Seiten der Visualisierung (Sonstige Widgets)

unterschieden.

Eine kleine Ausnahme stellen die Plugin-Widgets dar. Diese müssen vor Verwendung in der “meta-Sektion” der Konfigurationsdatei eingebunden sein.

Arbeiten mit der Konfigurationsdatei¶

Der strukturierte Aufbau der xml-formatierte Konfigurationsdatei ist in mehrere Sektionen unterteilt, innerhalb derer alle weiteren Einträge verschachtelt und durch Tags umschlossen aufgenommen werden:

Navigationselemente in der CometVisu¶

Zur Navigation stehen in der Cometvisu zahlreiche Möglichkeiten für die Navigation durch den Benutzer zur Verfügung:

Das Page-Widget ruft die zugehörige Unterseite auf.
Die Top-Navigation Anzeige: zeigt den aktuellen Pfad und erlaubt auf übergeordnete Seiten zurück zu navigieren .
Der Zurück-Button des Browsers bzw. des Betriebssystems (zB. iOS, Android)
Das Navbar-Widget in Verbingung mit Pagejump-Widgets
Das Pagejump-Widget erlaubt den Aufruf einer beliebigen Unterseite.
Das Group-Widget kann mit der Option target= ebenfalls eine beliebige Unterseite aufrufen.
Eine Besonderheit ist der Statusbar am unteren Bilschirmrand. Von dort können zB. externe URL aufgerufen werden.

../_images/Navigation_withDescription.png

Übersicht der wichtigsten Navigationselemente.

Ebenso sind verschiedene Funktionalitäten implementiert, die eine Navigation ohne Benutzereingriff bewirken:

Per KNX Gruppenadresse kann auf eine Unterseite gesprungen werden, wenn das Attribut ga=x/y/z in der zugehörigen Page Definition eingetragen ist.
Die Optionen screensave_time und screensave_page. Damit wird nach Ablauf einer definierten Zeit eine festgelegte Seite aufgerufen.
Das timeout-Plugin funktioniert ähnlich der screensave-Funktion, wird aber auch ausgeführt, wenn die Unterseite per GA aufgerufen wurde.

Die verfügbaren Designs¶

Metal - das wohl beliebteste Design
Pure - Standard-Design
Diskreet
Diskreet Sand
Diskreet Slim
Alaska
Alaska Slim

Zu tun

Weitere Beispielseiten für die anderen Designs

Grundlegende Elemente zum Gestalten des Layouts¶

In der CometVisu kann die Größe und Anordnung der Widgets mit dem Kind-Element Layout gesteuert werden. Damit kann ein “Responsive Design” realisiert werden, dass sich an die Displaygröße des Endgerätes anpasst, vom dem aus die CometVisu betrachtet wird. Dies erfolgt nicht nur zum Zeitpunkt des URL-Aufrufes, sondern dynamisch zB. auch beim Drehen des Endgerätes vom Quer- ins Hochformat bzw. beim Ändern der Fenstergröße am PC.

Innerhalb der Widgets stehen noch verschiedene Attribute wie width, height, etc. zur Verfügung. Damit kann die Größe des Widgetinhaltes (zB. Bild- und Diagrammgröße, etc.) gesteuert werden.

Detaillierte Beschreibungen zur Formatierung der Widgetgrößen- und -inhalte:

Layout legt die Größe und Anordnung der Widgets fest
Width und Height beeinflusst die Größe des Widgetinhaltes

Elemente für Konvertierung und Formatierung in der CometVisu¶

In der CometVisu können Werte auf verschiedenste Art und Weisen dargestellt werden. Hierfür können genutzt werden:

Format von Werten z.B. auf Anzahl der Nachkommastellen, Einheiten etc.
Mapping erlaubt das Ersetzen von Zahlenwerten durch Texte (z.B. An/Aus statt 1/0) und Icons. (z.B. für Fensterkontakte)
Styling erlaubt das wertabhängige Färben von Werten (z.B. An in rot und Aus in Grün)
Flavour ermöglich in einigen Designs für einige Widgets noch zusätzliche Optionen.

Widgets in der CometVisu¶

Widgets sind die einzelnen Elemente aus denen eine CometVisu-Site zusammengebaut wird. Diese können entweder fest in der CometVisu eingebaut sein oder per Plugin-Schnittstelle integriert.

Die Beschreibung der Widgets kann man hier nachlesen:

CometVisu - Beispiele¶

Hier befindes sich mehrere Beispiele von Visualisierungen die sich im produktiven Einsatz befinden.