diff --git a/_sources/plugins/uzsu/user_doc.rst.txt b/_sources/plugins/uzsu/user_doc.rst.txt index ed1bc86f9a..1b42ca28c7 100644 --- a/_sources/plugins/uzsu/user_doc.rst.txt +++ b/_sources/plugins/uzsu/user_doc.rst.txt @@ -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. @@ -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 diff --git a/_sources/plugins_doc/config/uzsu.rst.txt b/_sources/plugins_doc/config/uzsu.rst.txt index 155423c906..8e7f67dedc 100644 --- a/_sources/plugins_doc/config/uzsu.rst.txt +++ b/_sources/plugins_doc/config/uzsu.rst.txt @@ -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 @@ -215,6 +252,7 @@ Intervall in Minuten, in dem der interpolierte Wert aktualisiert werden soll - Datentyp: **int** - Standardwert: **5** + - Minimalwert: **1** backintime ---------- @@ -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. @@ -243,8 +311,16 @@ 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. @@ -252,8 +328,16 @@ Abfrage des nächsten Aktualisierungszeitpunkts. Ist keine Aktualisierung geplan - 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. @@ -261,4 +345,20 @@ Fortsetzen der UZSU Evaluierung: Aktivieren des Items und Setzen des zuletzt fes - 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. diff --git a/_sources/plugins_doc/plugins_all.rst.txt b/_sources/plugins_doc/plugins_all.rst.txt index 94f6cf03d8..0d6eaf07dd 100644 --- a/_sources/plugins_doc/plugins_all.rst.txt +++ b/_sources/plugins_doc/plugins_all.rst.txt @@ -1245,7 +1245,7 @@ | | | | | | | | | Plugin Status: **develop** | | | +-------------------------------------------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------+ - | :doc:`uzsu ` | v2.0.1 | Universelle Zeitschaltuhr | cmalo, bmxp, | Sandman60, | + | :doc:`uzsu ` | v2.0.2 | Universelle Zeitschaltuhr | cmalo, bmxp, | Sandman60, | | | | | onkelandy, | cmalo, schuma, | | | | | andrek, morg42 | morg42 | | | | - `uzsu Unterstützung `_ | | | diff --git a/_sources/plugins_doc/plugins_system.rst.txt b/_sources/plugins_doc/plugins_system.rst.txt index 5050f2578c..1994cf278c 100644 --- a/_sources/plugins_doc/plugins_system.rst.txt +++ b/_sources/plugins_doc/plugins_system.rst.txt @@ -165,7 +165,7 @@ | | | | | | | | | Plugin Status: **develop** | | | +-------------------------------------------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------+ - | :doc:`uzsu ` | v2.0.1 | Universelle Zeitschaltuhr | cmalo, bmxp, | Sandman60, | + | :doc:`uzsu ` | v2.0.2 | Universelle Zeitschaltuhr | cmalo, bmxp, | Sandman60, | | | | | onkelandy, | cmalo, schuma, | | | | | andrek, morg42 | morg42 | | | | - `uzsu Unterstützung `_ | | | diff --git a/plugins/uzsu/user_doc.html b/plugins/uzsu/user_doc.html index 4a45f6d5c0..ef7a1ae8af 100644 --- a/plugins/uzsu/user_doc.html +++ b/plugins/uzsu/user_doc.html @@ -5713,8 +5713,13 @@

Konfiguration

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. -Bei Problemen bitte das entsprechende Supportforum konsultieren. Es wird empfohlen, die Visualisierung für das Einstellen der UZSU zu verwenden.

+

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.

+
{{ 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.

Standard Einstellungen

Für die universelle Zeitschaltuhr können folgende Einstellungen vorgenommen werden:

@@ -5755,7 +5760,9 @@

Interpolation

Pluginfunktionen

-

Detaillierte Informationen zu den Funktionen des Plugins sind unter Plugin ‚uzsu‘ Konfiguration zu finden.

+

Detaillierte Informationen zu den Funktionen des Plugins sind unter Plugin ‚uzsu‘ Konfiguration 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

diff --git a/plugins_doc/config/uzsu.html b/plugins_doc/config/uzsu.html index c782fc0147..4d8e32fdac 100644 --- a/plugins_doc/config/uzsu.html +++ b/plugins_doc/config/uzsu.html @@ -5775,49 +5775,94 @@

Logik Parameter

Plugin Functions

Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.

-
-

activate()

-
-
Abfrage oder Setzen, ob die uzsu aktiv ist oder nicht.
    -

  • Leer: Abfrage

    • -

  • True: aktivieren

    • -

  • False: deaktivieren

    • +
    +

    activate(activevalue, item)

    +

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

    +
    +

    • Ergebnistyp der Funktion: bool

    -
-
+ +
+

activevalue

+

Abfragen oder Setzen des UZSU Status

+
+
    +

  • Datentyp: foo

    • +

  • Mögliche Werte:

    +
      +

    • None   -   Abfrage

      • +

    • True   -   Aktivieren

      • +

    • False   -   Deaktivieren

      • +
    +
    • +
+
-
-

clear()

+
+

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

+
+

clear

+

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

+
+
    +

  • Datentyp: bool

    • +
+
+
+
+

item

+

Das Item-Objekt

+
+
    +

  • Datentyp: foo

    • +
+
-
-

interpolation(type= ‚none‘, interval=5, backintime=0)

-

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

-
-
Interpolationstyp:
    -

  • linear: konstant gleiche Zwischenberechnung

    • -

  • cubic: Spline-Interpolation mit verzögertem Start und sanftem Verlangsamen

    • -

  • none: keine Interpolation

    • -

  • Datentyp: str

    • -

  • Standardwert: none

    • +
    +

    intpl_type

    +

    Interpolationstyp

    +
    +
      +

    • Datentyp: foo

      • +

    • 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

@@ -5826,22 +5871,54 @@

interval

  • Datentyp: int

  • Standardwert: 5

    • +

  • Minimalwert: 1

    • -
    -

    backintime

    +
    +

    backintime

    Maximales Alter eines UZSU Eintrags in Minuten, um beim Plugin-Start versäumte Einträge nachzuholen.

    • 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

      • +
    +
    +
    +
    +

    clear

    +

    Löschen oder nicht

    +
    +
      +

    • Datentyp: bool

      • +

    • Standardwert: False

      • +
    +
    +
    +
    +

    item

    +

    Das Item-Objekt

    +
    +
      +

    • Datentyp: foo

    -
    -

    lastvalue(by= ‚None‘)

    +
    +

    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.

      @@ -5858,24 +5935,59 @@

      by

    +
    +

    item

    +

    Das Item-Objekt

    +
    +
      +

    • Datentyp: foo

      • +
    +
    +
    -
    -

    planned()

    +
    +

    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

    +
    +

    item

    +

    Das Item-Objekt

    +
    +
      +

    • Datentyp: foo

      • +
    +
    +
    -
    -

    resume()

    +
    +

    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

      • +
    +