WeekdayTimer: Unterschied zwischen den Versionen

Aus FHEMWiki
(delayedExecutionCond Beispiel hinzugefügt)
(Erweiterung um set-Befehle und cref-Übersetzung zu define)
Zeile 6: Zeile 6:
|ModForumArea=Unterstuetzende Dienste
|ModForumArea=Unterstuetzende Dienste
|ModTechName=98_WeekdayTimer.pm
|ModTechName=98_WeekdayTimer.pm
|ModOwner=igami ({{Link2FU|4106|Forum}} / [[Benutzer_Diskussion:Igami|Wiki]])
|ModOwner={{Link2FU|405|Dietmar63}}
}}
}}


[[WeekdayTimer]] ist ein Hilfsmodul zur Erstellung von (Wochen-)Zeitschaltplänen für Geräte.
[[WeekdayTimer]] ist ein Hilfsmodul zur Erstellung von (Wochen-)Zeitschaltplänen für Geräte. ''WeekdayTimer'' ist eine generische Weiterentwicklung des Moduls ''Heating_Control'' und verfügt dementsprechend über einige features, die speziell auf die Steuerung mittels Temperaturprofilen zugeschnitten sind. Diese sind im Teil 2 der Anwendungsbeispiele dargestellt.


== Voraussetzungen ==
== Voraussetzungen ==
Zeile 17: Zeile 17:
=== Define ===
=== Define ===
Ein WeekdayTimer wird angelegt mittels
Ein WeekdayTimer wird angelegt mittels
:<code>define ''meinWDT'' WeekdayTimer ''meinDevice'' <nowiki><profil></nowiki> ...</code>
:<code>define ''meinWDT'' WeekdayTimer ''Zieldevice'' [Sprache] [Wochentage] <nowiki><profil></nowiki> ...</code>
Details: siehe {{Link2CmdRef|Anker=WeekdayTimer}}
 
Elemente einer Definition können sein:
==== Zieldevice ====
Das Gerät, an das ein Schaltbefehl zur angegebenen Zeit gesendet werden soll
==== Sprache ====
optional) Kann ''de'',''en'',''fr'' oder ''nl'' sein
==== Wochentage ====
Kann (optional) als globale Vorgabe vorangestellt werden; Syntax ist identisch zu ''profil'' (s.u.)
==== profil ====
Das eigentliche Wochenprofil. Die einzelnen Zeiten sind durch Leerzeichen zu trennen, möglich sind "klassische" Profilelemente oder die Angabe eines ''weekprofile''-Geräts (oder mehrerer, Details s.u.)
===== Klassisches Profilelement =====
Ein "klassisches" Profilelement enthält die folgenden Elemente:
    [<Wochentag/e>|]<Zeit>|<Parameter>[|w]
* Wochentag/e
Die Angabe ist optional. Wenn nicht gesetzt, gilt dieses Element für die ganze Woche (bzw. die Tage der globalen Vorgabe, s.o.). Genutzt werden können Tagesnummern oder die Kurzbezeichnungen der jeweils eingestellten Sprache, z.B..
** 0,so Sonntag
** 1,mo Montag
** 2,di Dienstag
** 3,mi Mittwoch
** 4 ...
** 7,$we Wochendende ($we) (unter Beachtung der in ''holiday2we'' bei ''global'' angegebenen Geräte)
** 8,!$we Wochentag (!$we) (s.o. zu ''holiday2we'')
 
Hinweis: $we nutzt für heute und morgen intern die allgemeine IsWe()-Funktion. Für die weiteren Tage können dagegen nur Geräte des Typs [[holiday]] ausgewertet werden, sofern sie in ''holiday2we'' bei ''global'' angegeben sind, einschließlich der besonderen Geräte ''weekEnd'' und ''noWeekEnd'' (beachten Sie hierzu die Beschreibung des Attributes ''holiday2we'' bei ''global'').
 
* Zeit
Die eigentliche Schaltzeit. Kann im Format HH:MM:[SS](HH im 24-Stunden-Format) angeegeben werden oder als Perl-Funktion wie <code>{sunrise_abs()}</code>. Innerhalb der Perl-Funktion {} kann die Variable ''$date'' (epoch) genutzt werden, um die genaue Schaltzeit im Wochenverlauf zu ermitteln. Beispiel: <code>{sunrise_abs_dat($date)}</code>
 
* Parameter
Der eigentliche Schaltparameter. Kann beliebiger Text oder Zahl sein, z.B ''on'', ''off'', ''dim30%'', ''eco'' oder ''comfort'', je nachdem, welche Schaltanweisungen im zu schaltenden Gerät möglich sind.
Um Leerzeichen zu ersetzen, ist ":" zu verwenden, wird ein Doppelpunkt in der Schaltanweisung benötigt, muss dieser escaped werden. Möglich wäre daher z.B. <code>on-till:06\:00</code>.
 
* "w"
Die letzte (optionale) Angabe "w" dient der Priorisierung des $we-Parameters. An Tagen, die für IsWe() ''wahr'' liefern, wird das Profilelement dann nicht berücksichtigt, sondern nur, wenn es sich (ggf. erst durch Verwendung von noWeekEnd) um einen normalen Wochentag handelt!
Beispiele:
** 06:35|22.5 
** 7|23:35|25
** 45|23:35|25|w
** 20:35|on|w
 
===== weekprofile Profilelement =====
Über [[weekprofile]] können (ausschließlich) Temperaturlisten dynamisch und unter Nutzung der Topic-Optionen in diesem Modul verändert werden, um so z.B. einfach zwischen Urlaubs- und Normalmodus (oder Heimarbeitstagen) wechseln zu können. Auch für Schichtgruppen kann dies hilfreich sein.
Beispiel einer [[weekprofile]] Definition:
weekprofile:<weekprofile-device-name>
 
Beispiel einer [[weekprofile]] Definition, bei der das Sonntags-Profil für alle $we-Tage gelten soll (mit Priorisierung des $we):
weekprofile:<weekprofile-device-name>:true
 
Um zwischen verschiedenen Profilen zu wechseln, die weekprofile bereitstellt, nutzen Sie den entsprechenden set-Befehl
 
==== Schaltbefehl/Bedingung ====
Den letzten (optionalen) Parameter bilden entweder ein Schaltbefehl oder eine Bedingung. Ist keines von beidem angegeben, wird die im ''commandTemplate''-Attribut angegebene Schaltanweisung verwendet.
===== Schaltbefehl =====
Ist keine Bedingung gesetzt, werden die verbliebenen Elemente als Schaltbefehl interpretiert. Perl-Code kann angegeben werden und ist wie sonst auch üblich in {} zu setzen. Wird ein Schaltbefehl angegeben, wird auch nur dieser wie angegeben ausgeführt, commandTemplate hat dann keine Auswirkungen. Es können die $NAME und $EVENT als Parameter verwendet werden, wobei $NAME der Name des Zieldevices ist und $EVENT dem Parameter aus dem Profilelement entspricht.
==== Bedingung ====
Eine Schaltbedingung muß in runden Klammern angegeben werden ("()") und gültigen Perl-Code enthalten. Dieser muß einen Bool-schen Wert zurückliefern, die Parameter $NAME und $EVENT können auch hier verwendet werden.
 
=== Set ===
 
==== disable und enable ====
Diese Befehle dienen dazu, einen WeekdayTimer zu (de-)aktivieren. Das entsprechende Attribut wird gesetzt, wobei ein ''enable'' zusätzlich genutzt werden kann, um eine Neuberechnung aller anstehenden Timer des Tages zu veranlassen. Dies ist z.B. hilfreich, wenn sich der Zustand einer Bedingung ändert, die zur Verzögerung oder dem Überspringen eines in der Vergangenheit liegenden Schaltzeitpunkt geführt hat oder man ein ''weekprofile''-Profil geändert hat und dieses neu eingelesen werden soll.
 
==== WDT_Params ====
Wirkt ähnlich wie das beschriebene ''enable'', wobei man hier die Wahl zwischen
* ''single''
* ''WDT_Group''
* ''all'' hat.
Im Unterschied zu ''enable'' werden die Schaltzeitpunkte jedoch nicht neu ermittelt, sondern nur die letzten Schaltungen ausgeführt (sofern die Bedingungen hierfür gegeben sind). Mit ''single'' wird lediglich der aufgerufene WeekdayTimer aktiviert, mit ''WDT_Group'' alle zur selben Gruppe gehörenden WeekdayTimer-Devices, und mit ''all'' werden schließlich alle Geräte des TPYEs WeekdayTimer.
==== weekprofile ====
Dieser set-Befehl kann ausschließlich dann genutzt werden, wenn in der Definition ein weekprofile-Device angegeben wurde. Die Syntax ist
weekprofile <weekprofile-device:topic:profile>
Dies bewirkt, dass die Daten des angegebenen Profil-Topics von dem weekprofile-Device abgerufen und unmittelbar als neues Profil genutzt werden. Nutzt man das ''Topic''-feature bei weekprofile nicht, ist ''default'' als Topic anzugeben. Liefert weekprofile keine Daten zurück (Device oder Profile oder Topic existiert nicht), wird das bisherige Profil verwendet. Solange noch kein Profil angegeben wurde, wird "default:default" beim weekprofile-Device abgerufen und verwendet.


=== Attribute ===
=== Attribute ===
Siehe {{Link2CmdRef|Anker=WeekdayTimer}}.
Siehe commandref.


== Anwendungsbeispiele ==
== Anwendungsbeispiele ==
=== Einfache Timer===
=== Generischer Modus ===  
* Rolladensteuerung mit HomeMatic-Rolläden
* Rollläden schließen nach Zeitplan aber mit Zusatzbedingungen: siehe {{Link2Forum|Topic=27247|LinkText=dieses Forenthema}}
define Timer_Rolladen_Automode_1 WeekdayTimer TYPE=CUL_HM:FILTER=model=HM-LC-Bl1PBU-FM:FILTER=automode=1 !$we|{sunrise("CIVIL",0,"06:45","08:00")}|on $we|{sunrise("CIVIL",0,"08:40","09:00")}|on {sunset("CIVIL",0,"20:45","22:20")}|off {fhem ("set $NAME:FILTER=STATE!=$EVENT $EVENT")}  
* ''disable'' Attribut setzen für WeekdayTimer: siehe {{Link2Forum|Topic=23655|LinkText=dieses Forenthema}}
Es werden bestimmte Rolläden, die ein ''userattr'' namens automode mit 1 gesetzt haben, zu unterschiedlichen Zeiten am Wochendende bzw. Feiertag und unter der Woche geöffnet bzw. bei Sonnenuntergang geschlossen.
* Schalten einer Umwälzpumpe für Warmwasser (HM-Aktor)
define Timer_Umwaelzpumpe WeekdayTimer AktorPumpe !$we|05:50|600 $we|06:55|600 12:30|600 set $NAME on-for-timer $EVENT


=== Timer mit Zusatzbedingungen ===
=== Nutzung zur Heizungskontrolle ===
* Rollladen schließen, aber nur, wenn die zugehörige Ausgangstür geschlossen ist<ref>{{Link2Forum|Topic=27247|Message=201711|LinkText=Forenthread}}</ref>:
Das unter [[Heating_Control]] aufgeführte Anwendungsbeispiel funktioniert 1:1 auch unter WeekdayTimer
define Innen.EG.Kueche.RolladenTuer.WT WeekdayTimer Innen.EG.Kueche.RolladenTuer Mo-So|{sunrise_abs(0,"06:30","10:00")}|on Mo-So|23:30|off (Value("Innen.EG.Kueche.RolladenTuer") eq "closed")
* Umwälzpumpe für einen Brunnen einschalten, aber nur, wenn der Aktor nicht im Heizbetrieb verwendet wird und die Außentemperatur über einer Mindesttemperatur liegt
define Timer_Brunnen_Schildkroeten WeekdayTimer Wasser_Schildkroeten 10:45|1800 12:30|1800 14:00|1800 15:30|1800 17:00|1800 19:00|1800 { if (ReadingsVal("Aussentemperatur_Nord", "state", "no") > 8 && ReadingsVal("Heizung_Schildkroeten","state","active") eq "disabled") { fhem ("set $NAME on-for-timer $EVENT")}}


=== Verzögerte bedingungsabhängige Auslösung ===
* Abbildung eines Anwesenheitstimers, der zusätzlich prüft, ob am zu schaltenden Gerät (hier: ein Dummy) ein Reading namens ''smartphone'' (noch) eine gegenläufige Info<ref>Hierfür wird ein [[Notify]] verwendet, das ähnlich wie das in [[FRITZBOX#Anwesenheitserkennung per Notify|FRITZBOX]] beschrieben ist.</ref> gegeben ist.
Die eigentliche Auslöseverzögerung für die Abwesenheit erfolgt dann über die Auswertung des Attributs ''delayedExecutionCond''.
define rr_Mann_Presence_Timer WeekdayTimer rr_Mann !$we|06:30|awoken !$we|06:40|home $we|08:00|awoken $we|08:30|home !$we|07:30|absent !$we|19:00|home 01234|21:45|gotosleep 01234|22:00|asleep 56|22:40|gotosleep 56|23:00|asleep
attr rr_Mann_Presence_Timer commandTemplate set $NAME  $EVENT
attr rr_Mann_Presence_Timer delayedExecutionCond {ReadingsVal($NAME,'smartphone','absent') eq 'present' and $EVENT eq 'absent'?1:0}
=== zeitweise Deaktivieren ===
* ''disable'' Attribut setzen für WeekdayTimer über eine [[ReadingsGroup]]: siehe {{Link2Forum|Topic=23655|LinkText=dieses Forenthema}}


== Links ==
== Links ==
 
*
==Hinweise==
<references />

Version vom 9. Dezember 2019, 18:25 Uhr

Todo: Der Commandref-Abschnitt zu diesem Modul enthält noch einige Fehler und Ungenauigkeiten, die im Zusammenhang mit der Ausarbeitung dieser Wiki-Seite korrigiert werden sollten. Auf dieser Seite fehlen insbesondere noch Anwendungsbeispiele mit Screenshots sowie die Beschreibung von Besonderheiten wie die vereinfachte/integrierte Unterstützung von enable/disable.


WeekdayTimer
Zweck / Funktion
Definition von Wochen-Zeitschaltplänen
Allgemein
Typ Hilfsmodul
Details
Dokumentation EN / DE
Support (Forum) Unterstuetzende Dienste
Modulname 98_WeekdayTimer.pm
Ersteller Dietmar63
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!


WeekdayTimer ist ein Hilfsmodul zur Erstellung von (Wochen-)Zeitschaltplänen für Geräte. WeekdayTimer ist eine generische Weiterentwicklung des Moduls Heating_Control und verfügt dementsprechend über einige features, die speziell auf die Steuerung mittels Temperaturprofilen zugeschnitten sind. Diese sind im Teil 2 der Anwendungsbeispiele dargestellt.

Voraussetzungen

Keine.

Anwendung

Define

Ein WeekdayTimer wird angelegt mittels

define meinWDT WeekdayTimer Zieldevice [Sprache] [Wochentage] <profil> ...

Elemente einer Definition können sein:

Zieldevice

Das Gerät, an das ein Schaltbefehl zur angegebenen Zeit gesendet werden soll

Sprache

optional) Kann de,en,fr oder nl sein

Wochentage

Kann (optional) als globale Vorgabe vorangestellt werden; Syntax ist identisch zu profil (s.u.)

profil

Das eigentliche Wochenprofil. Die einzelnen Zeiten sind durch Leerzeichen zu trennen, möglich sind "klassische" Profilelemente oder die Angabe eines weekprofile-Geräts (oder mehrerer, Details s.u.)

Klassisches Profilelement

Ein "klassisches" Profilelement enthält die folgenden Elemente: 

   [<Wochentag/e>|]<Zeit>|<Parameter>[|w]
  • Wochentag/e

Die Angabe ist optional. Wenn nicht gesetzt, gilt dieses Element für die ganze Woche (bzw. die Tage der globalen Vorgabe, s.o.). Genutzt werden können Tagesnummern oder die Kurzbezeichnungen der jeweils eingestellten Sprache, z.B..

    • 0,so Sonntag
    • 1,mo Montag
    • 2,di Dienstag
    • 3,mi Mittwoch
    • 4 ...
    • 7,$we Wochendende ($we) (unter Beachtung der in holiday2we bei global angegebenen Geräte)
    • 8,!$we Wochentag (!$we) (s.o. zu holiday2we)

Hinweis: $we nutzt für heute und morgen intern die allgemeine IsWe()-Funktion. Für die weiteren Tage können dagegen nur Geräte des Typs holiday ausgewertet werden, sofern sie in holiday2we bei global angegeben sind, einschließlich der besonderen Geräte weekEnd und noWeekEnd (beachten Sie hierzu die Beschreibung des Attributes holiday2we bei global).

  • Zeit

Die eigentliche Schaltzeit. Kann im Format HH:MM:[SS](HH im 24-Stunden-Format) angeegeben werden oder als Perl-Funktion wie {sunrise_abs()}. Innerhalb der Perl-Funktion {} kann die Variable $date (epoch) genutzt werden, um die genaue Schaltzeit im Wochenverlauf zu ermitteln. Beispiel: {sunrise_abs_dat($date)}

  • Parameter

Der eigentliche Schaltparameter. Kann beliebiger Text oder Zahl sein, z.B on, off, dim30%, eco oder comfort, je nachdem, welche Schaltanweisungen im zu schaltenden Gerät möglich sind. Um Leerzeichen zu ersetzen, ist ":" zu verwenden, wird ein Doppelpunkt in der Schaltanweisung benötigt, muss dieser escaped werden. Möglich wäre daher z.B. on-till:06\:00.

  • "w"

Die letzte (optionale) Angabe "w" dient der Priorisierung des $we-Parameters. An Tagen, die für IsWe() wahr liefern, wird das Profilelement dann nicht berücksichtigt, sondern nur, wenn es sich (ggf. erst durch Verwendung von noWeekEnd) um einen normalen Wochentag handelt! Beispiele:

    • 06:35|22.5
    • 7|23:35|25
    • 45|23:35|25|w
    • 20:35|on|w
weekprofile Profilelement

Über weekprofile können (ausschließlich) Temperaturlisten dynamisch und unter Nutzung der Topic-Optionen in diesem Modul verändert werden, um so z.B. einfach zwischen Urlaubs- und Normalmodus (oder Heimarbeitstagen) wechseln zu können. Auch für Schichtgruppen kann dies hilfreich sein. Beispiel einer weekprofile Definition: 

weekprofile:<weekprofile-device-name>

Beispiel einer weekprofile Definition, bei der das Sonntags-Profil für alle $we-Tage gelten soll (mit Priorisierung des $we): 

weekprofile:<weekprofile-device-name>:true

Um zwischen verschiedenen Profilen zu wechseln, die weekprofile bereitstellt, nutzen Sie den entsprechenden set-Befehl

Schaltbefehl/Bedingung

Den letzten (optionalen) Parameter bilden entweder ein Schaltbefehl oder eine Bedingung. Ist keines von beidem angegeben, wird die im commandTemplate-Attribut angegebene Schaltanweisung verwendet.

Schaltbefehl

Ist keine Bedingung gesetzt, werden die verbliebenen Elemente als Schaltbefehl interpretiert. Perl-Code kann angegeben werden und ist wie sonst auch üblich in {} zu setzen. Wird ein Schaltbefehl angegeben, wird auch nur dieser wie angegeben ausgeführt, commandTemplate hat dann keine Auswirkungen. Es können die $NAME und $EVENT als Parameter verwendet werden, wobei $NAME der Name des Zieldevices ist und $EVENT dem Parameter aus dem Profilelement entspricht.

Bedingung

Eine Schaltbedingung muß in runden Klammern angegeben werden ("()") und gültigen Perl-Code enthalten. Dieser muß einen Bool-schen Wert zurückliefern, die Parameter $NAME und $EVENT können auch hier verwendet werden.

Set

disable und enable

Diese Befehle dienen dazu, einen WeekdayTimer zu (de-)aktivieren. Das entsprechende Attribut wird gesetzt, wobei ein enable zusätzlich genutzt werden kann, um eine Neuberechnung aller anstehenden Timer des Tages zu veranlassen. Dies ist z.B. hilfreich, wenn sich der Zustand einer Bedingung ändert, die zur Verzögerung oder dem Überspringen eines in der Vergangenheit liegenden Schaltzeitpunkt geführt hat oder man ein weekprofile-Profil geändert hat und dieses neu eingelesen werden soll.

WDT_Params

Wirkt ähnlich wie das beschriebene enable, wobei man hier die Wahl zwischen

  • single
  • WDT_Group
  • all hat.

Im Unterschied zu enable werden die Schaltzeitpunkte jedoch nicht neu ermittelt, sondern nur die letzten Schaltungen ausgeführt (sofern die Bedingungen hierfür gegeben sind). Mit single wird lediglich der aufgerufene WeekdayTimer aktiviert, mit WDT_Group alle zur selben Gruppe gehörenden WeekdayTimer-Devices, und mit all werden schließlich alle Geräte des TPYEs WeekdayTimer.

weekprofile

Dieser set-Befehl kann ausschließlich dann genutzt werden, wenn in der Definition ein weekprofile-Device angegeben wurde. Die Syntax ist 

weekprofile <weekprofile-device:topic:profile>

Dies bewirkt, dass die Daten des angegebenen Profil-Topics von dem weekprofile-Device abgerufen und unmittelbar als neues Profil genutzt werden. Nutzt man das Topic-feature bei weekprofile nicht, ist default als Topic anzugeben. Liefert weekprofile keine Daten zurück (Device oder Profile oder Topic existiert nicht), wird das bisherige Profil verwendet. Solange noch kein Profil angegeben wurde, wird "default:default" beim weekprofile-Device abgerufen und verwendet.

Attribute

Siehe commandref.

Anwendungsbeispiele

Generischer Modus

Nutzung zur Heizungskontrolle

Das unter Heating_Control aufgeführte Anwendungsbeispiel funktioniert 1:1 auch unter WeekdayTimer


Links

Abgerufen von „http://wiki.fhem.de/w/index.php?title=WeekdayTimer&oldid=31903“