Skip to content

Commit

Permalink
Deploying to gh-pages from @ smarthomeNG/plugins@ad2765b 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@onkelandy
onkelandy committed May 5, 2024
1 parent bae4b27 commit 50b3d7e
Show file tree
Hide file tree
Showing 9 changed files with 299 additions and 70 deletions.
11 changes: 10 additions & 1 deletion _sources/plugins/uzsu/user_doc.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,14 @@ Ab *smarthomeNG 1.6* ist das Anlegen der nötigen Items via ``struct`` besonders
SmartVISU
=========

Das UZSU Plugin wird durch die smartVISU ab Version 2.9 sowohl in Form eines Popups als auch einer grafischen Darstellung mittels *device.uzsu Widget* unterstützt.
Das UZSU Plugin wird durch die smartVISU ab Version 2.9 sowohl in Form eines Popups als auch einer grafischen Darstellung mittels *device.uzsu Widget* unterstützt. Zeitserien sind ebenfalls über die SmartVISU abbildbar.
Außerdem ist es möglich, die Struct Items "next.value" und "next.time" zu nutzen, um einen Tooltip mit der nächsten Ausführung anzuzeigen.

.. code-block:: html

{{ device.uzsuicon('uzsu1','test.varuzsua.uzsu') }}
{{ basic.print('',['test.varuzsua.uzsu.next.time','test.varuzsua.uzsu .next.value'],'text', '"Nächste Schaltzeit: "+VAR1+" Wert: "+VAR2', '', '', 'uzsu1', 'tooltip') }}

Bei Problemen bitte das entsprechende Supportforum konsultieren. Es wird empfohlen, die Visualisierung für das Einstellen der UZSU zu verwenden.


Expand Down Expand Up @@ -130,6 +137,8 @@ Pluginfunktionen
================

Detaillierte Informationen zu den Funktionen des Plugins sind unter :doc:`/plugins_doc/config/uzsu` zu finden.
Sämtliche Pluginfunktionen funktionieren auch als Itemfunktionen für UZSU Items. Dabei muss beim Funktionsaufruf das Item nicht angegeben werden.
Beispiel: Die Pluginfunktion sh.uzsu.activate(True, sh.test.uzsu) ist identisch mit dem Aufruf sh.test.uzsu.activate(True)


Web Interface
Expand Down
154 changes: 127 additions & 27 deletions _sources/plugins_doc/config/uzsu.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,51 +160,88 @@ Plugin Functions
Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.


activate()
==========

activate(activevalue, item)
===========================

Abfrage oder Setzen, ob die uzsu aktiv ist oder nicht.
- Leer: Abfrage
- True: aktivieren
- False: deaktivieren

Abfrage oder Setzen, ob die UZSU aktiv ist oder nicht.

- Ergebnistyp der Funktion: **bool**


clear()
=======
activevalue
-----------

Abfragen oder Setzen des UZSU Status

- Datentyp: **foo**

- Mögliche Werte:

- **None** |_| - |_| Abfrage
- **True** |_| - |_| Aktivieren
- **False** |_| - |_| Deaktivieren


item
----

Das Item-Objekt

- Datentyp: **foo**


clear(clear, item)
==================


Löschen der UZSU Einträge eines Items.
- Leer: nichts ausführen
- Leer/False: nichts ausführen
- True: löschen


- Ergebnistyp der Funktion: **bool**


interpolation(type= 'none', interval=5, backintime=0)
=====================================================
clear
-----

True, um die UZSU Einträge zu löschen.

- Datentyp: **bool**


item
----

Das Item-Objekt

- Datentyp: **foo**


Abfrage (leerer Parameter) oder Setzen der Interpolationseinstellungen
interpolation(intpl_type=None, interval=5, backintime=0)
========================================================


Abfrage oder Setzen der Interpolationseinstellungen

- Ergebnistyp der Funktion: **dict**


type
----
intpl_type
----------

Interpolationstyp:
- linear: konstant gleiche Zwischenberechnung
- cubic: Spline-Interpolation mit verzögertem Start und sanftem Verlangsamen
- none: keine Interpolation
Interpolationstyp

- Datentyp: **foo**
- Standardwert: **None**

- Datentyp: **str**
- Standardwert: **none**
- Mögliche Werte:

- **None** |_| - |_| Abfrage
- **linear** |_| - |_| konstant gleiche Zwischenberechnung
- **cubic** |_| - |_| Spline-Interpolation mit verzögertem Start und sanftem Verlangsamen
- **none** |_| - |_| keine Interpolation


interval
Expand All @@ -215,6 +252,7 @@ Intervall in Minuten, in dem der interpolierte Wert aktualisiert werden soll
- Datentyp: **int**
- Standardwert: **5**

- Minimalwert: **1**

backintime
----------
Expand All @@ -224,9 +262,39 @@ Maximales Alter eines UZSU Eintrags in Minuten, um beim Plugin-Start versäumte
- Datentyp: **int**
- Standardwert: **0**

- Minimalwert: **0**

itpl(clear=False, item)
=======================


Löschen oder Abrufen der internen Interpolationswerte.
- Leer/False: Internes Dictionary mit Interpolationswerten
- True: löschen


- Ergebnistyp der Funktion: **dict**


lastvalue(by= 'None')
=====================
clear
-----

Löschen oder nicht

- Datentyp: **bool**
- Standardwert: **False**


item
----

Das Item-Objekt

- Datentyp: **foo**


lastvalue(by= 'None', item)
===========================


Abfrage des zuletzt gesetzten Werts. Kann z.B. beim Aktivieren der UZSU genutzt werden, um sofort auf den gewünschten Wert zu schalten.
Expand All @@ -243,22 +311,54 @@ Für eine entsprechende Info im Logfile kann hier z.B. der Itemname, der den Wer
- Standardwert: **None**


planned()
=========
item
----

Das Item-Objekt

- Datentyp: **foo**


planned(item)
=============


Abfrage des nächsten Aktualisierungszeitpunkts. Ist keine Aktualisierung geplant, z.B. weil das UZSU Item nicht aktiviert ist, wird None zurückgegeben, ansonsten ein Dictionary mit den Einträgen Zeit und Wert.

- Ergebnistyp der Funktion: **dict**


resume()
========
item
----

Das Item-Objekt

- Datentyp: **foo**


resume(activevalue, item)
=========================


Fortsetzen der UZSU Evaluierung: Aktivieren des Items und Setzen des zuletzt festgelegten Wertes.

- Ergebnistyp der Funktion: **foo**


activevalue
-----------

True, um die UZSU fortzusetzen; False, um sie zu pausieren

- Datentyp: **bool**


item
----

Das Item-Objekt

- Datentyp: **foo**


.. [#f1] Diese Seite wurde aus den Metadaten des Plugins erzeugt.
2 changes: 1 addition & 1 deletion _sources/plugins_doc/plugins_all.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1245,7 +1245,7 @@
| | | | | |
| | | Plugin Status: **develop** | | |
+-------------------------------------------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------+
| :doc:`uzsu <config/uzsu>` | v2.0.1 | Universelle Zeitschaltuhr | cmalo, bmxp, | Sandman60, |
| :doc:`uzsu <config/uzsu>` | v2.0.2 | Universelle Zeitschaltuhr | cmalo, bmxp, | Sandman60, |
| | | | onkelandy, | cmalo, schuma, |
| | | | andrek, morg42 | morg42 |
| | | - `uzsu Unterstützung <https://knx-user-forum.de/forum/supportforen/smarthome-py/1364692-supportthread-f&uuml;r-uzsu-plugin>`_ | | |
Expand Down
2 changes: 1 addition & 1 deletion _sources/plugins_doc/plugins_system.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
| | | | | |
| | | Plugin Status: **develop** | | |
+-------------------------------------------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------+
| :doc:`uzsu <config/uzsu>` | v2.0.1 | Universelle Zeitschaltuhr | cmalo, bmxp, | Sandman60, |
| :doc:`uzsu <config/uzsu>` | v2.0.2 | Universelle Zeitschaltuhr | cmalo, bmxp, | Sandman60, |
| | | | onkelandy, | cmalo, schuma, |
| | | | andrek, morg42 | morg42 |
| | | - `uzsu Unterstützung <https://knx-user-forum.de/forum/supportforen/smarthome-py/1364692-supportthread-f&uuml;r-uzsu-plugin>`_ | | |
Expand Down
13 changes: 10 additions & 3 deletions plugins/uzsu/user_doc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5713,8 +5713,13 @@ <h2>Konfiguration<a class="headerlink" href="#konfiguration" title="Permalink to
</section>
<section id="smartvisu">
<h2>SmartVISU<a class="headerlink" href="#smartvisu" title="Permalink to this heading"></a></h2>
<p>Das UZSU Plugin wird durch die smartVISU ab Version 2.9 sowohl in Form eines Popups als auch einer grafischen Darstellung mittels <em>device.uzsu Widget</em> unterstützt.
Bei Problemen bitte das entsprechende Supportforum konsultieren. Es wird empfohlen, die Visualisierung für das Einstellen der UZSU zu verwenden.</p>
<p>Das UZSU Plugin wird durch die smartVISU ab Version 2.9 sowohl in Form eines Popups als auch einer grafischen Darstellung mittels <em>device.uzsu Widget</em> unterstützt. Zeitserien sind ebenfalls über die SmartVISU abbildbar.
Außerdem ist es möglich, die Struct Items „next.value“ und „next.time“ zu nutzen, um einen Tooltip mit der nächsten Ausführung anzuzeigen.</p>
<div class="highlight-html notranslate"><div class="highlight"><pre><span></span>{{ device.uzsuicon(&#39;uzsu1&#39;,&#39;test.varuzsua.uzsu&#39;) }}
{{ basic.print(&#39;&#39;,[&#39;test.varuzsua.uzsu.next.time&#39;,&#39;test.varuzsua.uzsu .next.value&#39;],&#39;text&#39;, &#39;&quot;Nächste Schaltzeit: &quot;+VAR1+&quot; Wert: &quot;+VAR2&#39;, &#39;&#39;, &#39;&#39;, &#39;uzsu1&#39;, &#39;tooltip&#39;) }}
</pre></div>
</div>
<p>Bei Problemen bitte das entsprechende Supportforum konsultieren. Es wird empfohlen, die Visualisierung für das Einstellen der UZSU zu verwenden.</p>
<section id="standard-einstellungen">
<h3>Standard Einstellungen<a class="headerlink" href="#standard-einstellungen" title="Permalink to this heading"></a></h3>
<p>Für die universelle Zeitschaltuhr können folgende Einstellungen vorgenommen werden:</p>
Expand Down Expand Up @@ -5755,7 +5760,9 @@ <h2>Interpolation<a class="headerlink" href="#interpolation" title="Permalink to
</section>
<section id="pluginfunktionen">
<h2>Pluginfunktionen<a class="headerlink" href="#pluginfunktionen" title="Permalink to this heading"></a></h2>
<p>Detaillierte Informationen zu den Funktionen des Plugins sind unter <a class="reference internal" href="../../plugins_doc/config/uzsu.html"><span class="doc">Plugin ‚uzsu‘ Konfiguration</span></a> zu finden.</p>
<p>Detaillierte Informationen zu den Funktionen des Plugins sind unter <a class="reference internal" href="../../plugins_doc/config/uzsu.html"><span class="doc">Plugin ‚uzsu‘ Konfiguration</span></a> zu finden.
Sämtliche Pluginfunktionen funktionieren auch als Itemfunktionen für UZSU Items. Dabei muss beim Funktionsaufruf das Item nicht angegeben werden.
Beispiel: Die Pluginfunktion sh.uzsu.activate(True, sh.test.uzsu) ist identisch mit dem Aufruf sh.test.uzsu.activate(True)</p>
</section>
<section id="web-interface">
<h2>Web Interface<a class="headerlink" href="#web-interface" title="Permalink to this heading"></a></h2>
Expand Down
Loading

0 comments on commit 50b3d7e

Please sign in to comment.