Caution

This is the documentation for the current development branch of the CometVisu. It is possible that some of the described features are not yet available in the current release.

Also there might be lots of errors in this documentation as some parts of the content have been translated by an online translation service.

The ImageTrigger widget

Available since version: 0.8.0 (2012)
Author: Christian Mayer

Description

Adds an image like the {@link cv.ui.structure.pure.Image} widget, but additionally the image can be changed by incoming data and can send data to the backend by clicking on it. There are two modes to react on incoming data:

type=”show”: Hides the image when incoming data === 0 type=”select”: Changes the image by appending the incoming data to the initial configured image source,

or hide it when incoming data === 0

Example:

<imagetrigger src="icon/comet" suffix="svg" sendValue="clicked" type="select">
 <address transform="DPT:16.001" mode="readwrite">0/0/0</address>
</imagetrigger>

initially shows nothing. When the CometVisu receives the string _icon in address 0/0/0, the image icon/comet_opt_icon.svg is shown. When the CometVisu receives ‘0’ on address 0/0/0, this image is hidden.

Settings

For a general understanding of how the configuration files are structured and what elements and attributes are it is recommended to read this section first: visu-config-details.

The behaviour and appearance of the ImageTrigger widget can be influenced by using certain attributes and elements. The following tables show the allowed attributes and elements and their possible values. The screenshots show, how both can be edited in the editor.

Attributes underlined by ..... are mandatory, all the others are optional and be omitted.

Allowed attributes in the ImageTrigger-element

Element Attribute
  Name Content Description
imagetrigger src URI Complete path (URI) to the picture
suffix string  
type string  
width dimenstion (number+unit) Sets the width of the image. Format must be CSS (e.g. px, em, %).
height dimenstion (number+unit) Sets the height of the image. Format must be CSS (e.g. px, em, %).
refresh decimal Sets the update rate for the picture in seconds
mapping string Map the bus value to a different value for displaying.
sendValue string Defines the value which is sent when pressing the picture/icon
flavour string Selection of a display variant. See also flavour.
bind_click_to_widget true or false use the whole widget area to react on click events

Allowed child-elements und their attributes

Element Attribute
Structure Name Content Description
imagetrigger
  • layout
colspan decimal Amount of coloumns this widget sould be wide.
colspan-m decimal Overrules the amount of coloumns on a medium screen.
colspan-s decimal Overrules the amount of coloumns on a small screen.
rowspan decimal Amount of rows this widget should be high.
x string Horizontal position of the widget for 2D pages.
y string Vertical position of the widget for 2D pages.
z string Reserved for future use.
width string Width for the widget for 2D pages.
Element Attribute
Structure Name Content Description
imagetrigger
  • label
  • icon
name string  
type string  
flavour string Selection of a display variant. See also flavour.
color string  
styling string  
class string Add this value to the CSS class so that it can be formated by a user provided style sheet.
imagetrigger
  • label
  • #text
  string Text to display a label for the widget.
Element Attribute
Structure Name Content Description
imagetrigger
  • address
transform string  
mode disable, read, write or readwrite  
variant string  
format-pos decimal  
imagetrigger
  • address
  • #text
  string The GA (like: 12/0/7) for KNX-backends or the item name for openHAB-backend

Examples

It is possible to manually edit the visu_config.xml and add an entry for the ImageTrigger widget.

Caution

Make sure that you only use UTF-8 encoded characters by settings the encoding in your XML-editor to UTF-8 mode!

<imagetrigger src="icon/CometVisu_" suffix="png" sendValue="clicked" type="select" width="45px" height="32px">
  <layout colspan="1"/>
  <address transform="DPT:16.001" mode="readwrite">0/0/0</address>
</imagetrigger>
<imagetrigger src="icon/CometVisu_orange" suffix="png" sendValue="clicked" type="show" width="45px" height="32px">
  <layout colspan="0"/>
  <address transform="DPT:1.001" mode="readwrite">0/0/0</address>
</imagetrigger>

Footnotes

[1]The simple view might not show everything. To see all elements/attributes use the expert view.