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.

SVG text value

Available since: 2023
Author: Tobias Bräutigam

Description

The SVG text value component consists of an icon or a title and a value. It forms the technical basis for the Energy Entity component and is used in the Energy Widget.

With icon

With icon

<cv-svg-text-value format="%d%%" icon="knxuf-measure_battery_100" column="1">
    <cv-address transform="DPT:5.001" mode="read">1/4/2</cv-address>
</cv-svg-text-value>
With title

With title

<cv-svg-text-value format="%d%%" title="Battery" column="1">
    <cv-address transform="DPT:5.001" mode="read">1/4/2</cv-address>
</cv-svg-text-value>

Allowed attributes

Element

Attribute

Name

Content

Description

cv-svg-text-value

id

string

ID of this element.

title

string

Title of this element.

icon

string

Defines the icon, usually the icon is pre-defined by the type, but can be overridden by this attribute.

styling

string

Change the color of the displayed value depending on its value. See also styling

mapping

string

Map the bus value to a different value, text or symbol for displaying. See also mapping

format

string

Formatting of the value (printf syntax).

x

integer

Position of this element on the x-axis.

y

integer

Position of this element on the y-axis.

row

decimal

Row this element is placed in.

column

decimal

Column this element is placed in.

rowspan

decimal

Number of rows this element spans

colspan

decimal

Number of columns this element spans

Allowed child elements and their attributes

Element

Attribute

Structure

Name

Content

Description

cv-svg-text-value
  • cv-address

transform

string

Defines the datatype in the backend, e.g. DPT:1.001 for KNX datapoint type 1.001.

mode

disable, read, write or readwrite

Defines if this address is only used to read, write, both readwrite or none of them ``disable`.

value

string

Fixed value sent to this address.

on

click, down or up

Event on which a value should be sent to this address (only useful in mode=``write or readwrite`), also needs ``value.

target

string

Target in the parent widget the value if this address should be use for. The possible values depend on the parent widget.

format-pos

decimal

Position for format string when multiple addresses are used.

qos

decimal

Only MQTT: QoS

retain

true or false

Only MQTT: retain flag

selector

string

Only MQTT: JSON selector

backend

string

Optional name of the backend this address belongs to.

mapping

string

Map the bus value to a different value, text or symbol for displaying. See also mapping

format

string

Formatting of the value (printf syntax).

delay

positiveInteger

Optional delay in milliseconds that a write-request to this address is delayed.

send-mode

on-change or always

Usually the elements that are using this address receive an update-event only when that value hast changed (on-change). This check can be disabled always to send the update-event every time when a new value has been received from the backend.

cv-svg-text-value
  • cv-address

    • #text

string

The GA (like: 12/0/7) for KNX-backends, the item name for openHAB-backend or the MQTT topic

Element

Attribute

Structure

Name

Content

Description

cv-svg-text-value
  • cv-address-group

operator

+, -, * or /

Math operator used for calculation.

round

true or false

Round the result.

factor

float

Multiply the result with this value.

cv-svg-text-value
  • cv-address-group

  • cv-address

transform

string

Transformation of the bus system value to be shown.

mode

disable, read, write or readwrite

“disable” deactivates the communication, “read” will only fetch data from the backend, “write” will only write to it and an address with “readwrite” will be both, read from and written to.

variant

string

format-pos

decimal

Position for format string when multiple addresses are used.

selector

string

Only MQTT: JSON selector

qos

decimal

Only MQTT: QoS

retain

true or false

Only MQTT: retain flag

ignore-error

true or false

Only MQTT: ignore decode errors.

cv-svg-text-value
  • cv-address-group

  • cv-address

    • #text

string

The GA (like: 12/0/7) for KNX-backends, the item name for openHAB-backend or the MQTT topic