Vorsicht

Dies ist die Dokumentation des aktuellen Entwicklungszweigs der CometVisu. Es besteht daher die Möglichkeit, dass einige der hier beschriebenen Features mit dem aktuellsten Release der CometVisu nicht genutzt werden können.

URL-Parameter

Das Verhalten der CometVisu lässt sich teilweise durch URL-Parameter anpassen. Da sich diese Parameter mit in den Favoriten des Browsers abspeichern lassen, kann so effektiv und schnell auf die entsprechenden Varianten zugegriffen werden.

Verwendung

Diese Parameter werden einfach hinten an die URL gehängt, durch ein ”?” (erster URL Parameter), bzw. durch ein “&” (alle weiteren URL Parameter) getrennt.

Beispiele:

Beschreibung URL
Standard http://server/visu/
Ein Parameter für eine andere Config http://server/visu/?config=demo
Ein Parameter für ein anderes Design http://server/visu/?design=pure
Mehrere Parameter werden mit & verknüpft http://server/visu/?config=demo&design=metal

Parameter

config - Config-Datei

Durch den Parameter config wird eine andere Config-Datei ausgewählt.

Also z.B. config=NAME - Diese Config-Datei muss dann unter dem Namen visu_config_NAME.xml entweder im config-Verzeichnis der Visu oder im config/demo Verzeichnis der Visu liegen.

design - Design

Durch den Parameter design wird das Design in der Config-Datei übersteuert.

forceReload - Cache übersteuern

Durch den Parameter forceReload mit dem Wert true (also zusammen forceReload=true) werden alle Dateien sicher neu geladen.

Dies kann nach einem Anpassen der Config-Datei wichtig sein.

startpage - Startseite

Durch den Parameter startpage kann die Unter-Seite festgelegt werden, die nach dem Laden der Visu als erstes angezeigt wird.

Der Wert für diesen Parameter lässt sich leicht herausfinden, in dem man in einem Browser auf dem PC mit der Maus über den Link zur Unter-Seite fährt und den Inhalt des Links in der Browser-Statuszeile ansieht. Dieser lautet ähnlich wie javascript:templateEngine.scrollToPage('id_0_33'). Hier wäre nun das 0_33 der Wert für den Parameter startpage, d.h. zusammengesetzt müsste an die URL angehängt werden: startpage=0_33

Gerade wenn man Visus an meheren Orten im Haus verteilt hat, kann es Sinn machen bei einer gesammten Config-Datei je nach Visu-Standort die Unter-Seite als erstes anzuzeigen, die dem Raum entspricht.

forceDevice - Ausgabegerät übersteuern

Durch den Parameter forceDevice kann durch den Wert mobile auch an “großen” Geräten die Seite so wie auf einem kleinen, mobilen Gerät (z.B. Smartphone) dargestellt werden. Bei jedem anderen Wert wird die Seite (auch auf Mobilgeräten) wie am PC dargestellt.

Dies wird eigentlich nur für Entwickler benötigt.

maturity - Ausgereiftheit

Durch den Parameter maturity kann man Features freischalten, die noch in Entwicklung sind und somit unbeabsichtigte Querwirkungen haben.

Default: release (maturity=release)
Options: release (maturity=release), development (maturity=development)

Dies sollte nur von Entwicklern benutzt werden!

backend - Backend

Durch den Parameter backend wird das verwendete Backend zur Laufzeit konfiguriert. Es exisitiert auch ein backend Parameter in der Config um dies fest einzustellen.

Default: cgi-bin (backend=cgi-bin)
Options: cgi-bin (backend=cgi-bin), oh (backend=oh), oh2 (backend=oh2)

Der Default-Wert “cgi-bin” (Achtung, inkonsistent mit xml Element, default=”cgi”!) ist normalerweise richtig und braucht nicht geändert werden. “r”, “w” und “l” liegen dabei in /cgi-bin/.

Bei der Option “oh” wird der für OpenHAB notwendige Pfad verwendet.

enableQueue - Queue

Durch den Parameter enableQueue wird beeinflusst ob von der CV alle oder nur die auf der aktuellen Seite benötigten Gruppenadressen abgefragt werden. Dies kann unter Umständen zu Performanceverbesserungen führen.

Default: 0 (enableQueue=0)
Options: 0 (enableQueue=0), 1 (enableQueue=1)

Dies ein experimentelles Feature, welches unter Umständen nicht wie gedacht funktioniert, deswegen ist es derzeit standardmäßig abgeschaltet.

testMode - Testmodus ohne echtes Backend

Durch den Parameter testMode kann man die CometVisu rudimentär testen ohne ein laufendes Backend im Hintergrund zu haben. Normalerweise sendet die CometVisu bei der Betätigung eines Switches den Einschaltwert auf der definierten Adresse zum Backend. Das Backend liefert dann die entsprechende Rückmeldung über die Statusänderung, welche die CometVisu dann wiederum anzeigt. Fehlt ein Backend, kann man die Bedienelemente der CometVisu nicht wirklich testen, weil ohne Rückmeldung die Statusänderung fehlt und man so z.B. eine Switch niemals einschalten kann. Mit dem TestMode wird der zum Backend gesendete Befehl einfach als Statusupdate wieder zurück zur CometVisu geschickt und somit ein einfaches Backend simuliert.

Dieses simulierte Backend bietet aber, wie schon erwähnt, nur rudimentäre Funktionen. Hat man z.B. wie in der KNX-Welt üblich unterschiedliche Sende- und Rückmeldeadressen, wird dies mit dem TestMode nicht funktionieren.

Default: 0 (testMode=0)
Options: 0 (testMode=0), 1 (testMode=1)

enableCache - Caching aktivieren

Durch den Parameter enableCache kann das Caching konfiguriert werden. Dieses bewirkt, dass eine Config nicht bei jeden Laden komplett neu eingelesen wird und daraus eine HTML-Seite generiert wird, sondern dass die gerenderte HTML-Struktur inkl. aller weiterer benötigter Daten lokal im Browser gespeichert werden (im LocalStore). Bei jedem weiteren Laden der Config werden die Daten also aus dem Cache gelesen, was das Laden der Visu auf leistungsschwachen Geräten wie z.B. Smartphones beschleunigt.

Der Cache kann über diesen Parameter aktiviert (=true), deaktivert (=false) oder gelöscht werden (=invalid). Das Löschen bewirkt, dass alle Werte aus dem Cache gelöscht werden und neu angelegt werden.

Default: true (enableCache=true)
Options: false (enableCache=false), true (enableCache=true), invalid (enableCache=invalid)