Configuration of the CometVisu

CometVisu is configured by editing the XML-formatted configuration file “visu_config.xml” in the respective subdirectory ”./config” of the CometVisu installation. This can be done either with a text-based editor or with the integrated graphical editor. However, the use of the graphical editor assumes that the CometVisu is delivered by a PHP-enabled web server (e.g. Apache or Lighttpd) and that the configuration file is writable by it.

The easiest way to access the various configuration files is via Manager.

Depending on the backend used and the installation procedures, the CometVisu tree is located in different places:

  • If the CometVisu should be connected directly to the KNX bus telegram traffic with the help of the knxd daemon (KNX is then the backend), the CometVisu is manually added to the directory tree “/var/www/visu...” of the web server (e.g. Apache or Lighttpd) The web server usually listens on port 80 in the default setting.
  • If openHAB is used as the backend for the CometVisu, the CometVisu files must be in the openHAB directory tree. The openHAB own web server is addressed in the default setting via port 8080 and is not php-capable. In this case you have to be satisfied with a text-based editor or “divert” the probably parallel running web server (for example Apache or Lighttpd).
  • If openHAB was automatically installed via apt-get, the CometVisu will be installed manually in “/usr/share/openhab/webapps/visu...”.
  • If openHAB was manually installed in e.g. “/opt/openHAB”, the CometVisu is installed manually in “/opt/openhab/www/visu...”.

Hint

For further Information on the location of the CometVisu see the Install Section

If the XML-formatted configuration file “visu_config.xml” is to be edited directly by the (advanced) user, it is advisable to use an XML-compatible editor for this, which i.a. coloring syntax for better readability (e.g., Textwrangler on MacOSX, WordPad ++, Notepad ++ or MS XML Editor 2007 on Windows, and on Linux, for example, vi with ”: syntax on”).

General information about the CometVisu XML format can be found here, information on the individual widgets in the respective sub-pages.

Some widgets and plugins require additional information that should not be included in the config file, as it is freely readable to the web browser (depending on the environment installed, the transport can be encrypted using HTTPS, but the content is handled by the Users on the browser with appropriate tricks readable). By using the Hidden Configurations this information can remain on the better protected server.

After saving, no process reboot is necessary, but you should reload the page and clear the browser cache.

If the XML file is invalid, an error message is displayed when loading the Visu in the web browser. This usually gives exact information about where in the file the error lies. You can also force the check with the link “Check Config” in the footer or by appending check_config.php to the URL.

Exact descriptions of the available URL parameters can be found under URL Parameters.

Pages and structure of CometVisu

Basics

For visualization and triggering of actions such as Switching or blinds up/down uses the CometVisu so-called widgets. Widgets can be understood as graphical building blocks arranged on a page to be displayed. A widget consists of the actual visible area that receives and redirects mouse or touch events, and invisible objects that specify how the widget works in more detail.

A distinction is made between the following widgets:

  • Operation (here, for example, the switch widget for switching)
  • Presentation (these have only informative function)
  • Arrangement or grouping of other widgets or navigation within the different pages of the visualization (other widgets)

A small exception are the plugin widgets. These must be included in the “meta section” of the configuration file before use.

Working with the configuration file

The structure of the xml-formatted configuration file is divided into several sections, within which all other entries are nested and enclosed by tags:

The available designs

  • Metal-> probably the most popular design
  • Pure -> Standard-Design
  • Diskreet
  • Diskreet Sand
  • Diskreet Slim
  • Alaska
  • Alaska Slim

Todo

More example pages for the other designs

Basic elements for designing the layout

In the CometVisu the size and arrangement of the widgets can be controlled with the child element Layout. Thus, a responsive design can be realized, that adapts to the display size of the terminal from which the CometVisu is viewed. This happens not only at the time of the URL call, but dynamically e.g. also when turning the terminal from landscape to portrait or when changing the window size on the PC.

Within the widgets there are different attributes like width, height, etc. available. This can be used to control the size of the widget content (e.g. image and diagram size, etc.).

Detailed descriptions of formatting the widget size and content:

Elements for conversion and formatting in the CometVisu

In the CometVisu values can be displayed in many different ways. For this purpose can be used:

  • Format of values e.g. on number of decimal places, units etc.
  • Mapping allows the replacement of numerical values with texts (e.g. on/off instead of 1/0) and icons (e.g. for window contacts)
  • Styling allows value-dependent coloring of values (for example, on in red and off in green)
  • Flavour allow additional options for some widgets in some designs.

Widgets in the CometVisu

Widgets are the individual elements that make up a CometVisu site. These can either be permanently installed in the CometVisu or integrated via plug-in interface.

The description of the widgets can be read here:

CometVisu - Examples

Here are several examples of visualizations that are in productive use.