Skip to content

Commit

Permalink
document last-update feature
Browse files Browse the repository at this point in the history
  • Loading branch information
peuter committed Mar 25, 2023
1 parent 956d4c0 commit d7bc8d1
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@
"mapping-sensor-alarm-ok": "7c354925d5b6298f4628d224a335d254",
"mapping-sensor-alarm-notok": "f4b589ad7489b2159f2dd8d233c2df0d",
"mapping-oh-datetime": "2480fc1bf2cd1e3803e03a95a3b8185d",
"mapping_oh_time": "84732cf132a0d706aed6ce53b00eab10"
"mapping_oh_time": "84732cf132a0d706aed6ce53b00eab10",
"cv-info-outdated": "064477c93d26f6968ed59c468c617562"
}
36 changes: 36 additions & 0 deletions doc/manual/de/config/structure-tile/elements/address.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,42 @@ nicht mehr auf Interaktionen des Benutzers wie z.B. Mausklicks.
</cv-tile>
</cv-widget>
Widget als veraltet markieren
.............................

Besonders bei Widgets die einen Wert anzeigen ist es wichtig zu wissen, dass dieser Wert aktuell ist.
Sofern man die Möglichkeit hat den Zeitpunkt der letzten Aktualisierung vom Backend zu bekommen, kann man diesen
nutzen um das Widget als veraltet zu markieren, wenn die letzte Aktualisierung zu lange zurückliegt.

.. widget-example::

<settings design="tile" selector="cv-info">
<screenshot name="cv-info-outdated">
<data address="1/4/2">21.5</data>
<data address="1/4/3" type="time">00:00:00</data>
</screenshot>
</settings>
<cv-info format="%.2f">
<cv-address slot="address" mode="read" transform="DPT:9.001">1/4/2</cv-address>
<cv-address slot="tileAddress" transform="DPT:10.001" mode="read" target="last-update:120">1/4/3</cv-address>
<span slot="label">Wohnzimmer</span>
<span slot="unit">°C</span>
</cv-info>

Das ``target="last-update:120"`` gibt an, dass die Zeit nicht länger als 120 Sekunden zurückliegen darf, ansonsten
wird das Widget als veraltet markiert.

Dieses Feature steht in allen vordefinierten Widgets zur Verfügung. In eigenen Widgets kann man es ebenfalls nutzen,
mann muss lediglich das slot-Attribut aus dem Beispiel weglassen.

.. code:: xml
<cv-widget>
<cv-tile>
<cv-address transform="DPT:10.001" mode="read" target="last-update:120">1/4/3</cv-address>
</cv-tile>
</cv-widget>
Transform
---------
Expand Down

0 comments on commit d7bc8d1

Please sign in to comment.