FHEMWiki - Benutzerbeiträge [de]

UBus

2022-02-19T14:51:16Z

Xenos1984: /* UBUS_CALL - Modul zur Ausführung von uBus-Anfragen */ system added

{{Baustelle}}

Die Module UBUS_CLIENT und UBUS_CALL dienen der Kommunikation mit Geräten, die über eine [http://openwrt.org/docs/techref/ubus uBus-Schnittstelle] verfügen. Mittels UBUS_CLIENT wird die Verbindung zu einem solchen Gerät hergestellt. Über UBUS_CALL wird ein Funktionsaufruf (bzw. eine Reihe von Funktionsaufrufen) an das Gerät gesendet und die Antwort in Readings ausgewertet.

== UBUS_CLIENT - Modul zur Kommunikation mit uBus ==

{{Infobox Modul
|ModPurpose=Einbinden von Geräten, die über die uBus Schnittstelle kommunizieren
|ModType=d
|ModCmdRef=UBUS_CLIENT
|ModForumArea=Sonstige Systeme
|ModTechName=72_UBUS_CLIENT.pm
|ModOwner=xenos1984 ({{Link2FU|43783|Forum}} / [[Benutzer Diskussion:Xenos1984|Wiki]])}}

Je nach Gerät kann die uBus-Schnittstelle über Websocket oder über HTTP freigegeben sein.

=== Kommunikation über Websocket ===

Beispiel:

define <name> UBUS_CLIENT ws://192.168.1.1

=== Kommunikation über HTTP ===

Beispiel:

define <name> UBUS_CLIENT http://192.168.1.1/ubus

== UBUS_CALL - Modul zur Ausführung von uBus-Anfragen ==

{{Infobox Modul
|ModPurpose=Senden von "call" Anfragen an Geräte, die über die uBus Schnittstelle kommunizieren
|ModType=d
|ModCmdRef=UBUS_CALL
|ModForumArea=Sonstige Systeme
|ModTechName=72_UBUS_CALL.pm
|ModOwner=xenos1984 ({{Link2FU|43783|Forum}} / [[Benutzer Diskussion:Xenos1984|Wiki]])}}

Die folgenden Beispiele basieren auf der [http://openwrt.org/docs/guide-developer/ubus OpenWRT Dokumentation]. '''Je nach Gerät können andere Funktionsaufrufe implementiert sein.''' Welche dies sind, zeigen die Readings des UBUS_CLIENT.

=== network ===

Siehe [http://openwrt.org/docs/guide-developer/ubus/network network] Referenz.

==== network.device status ====

Mittels

define <name> UBUS_CALL network.device status

wird der Status aller vorhandenen Netzwerk-Schnittstellen zurückgegeben. Soll nur eine Schnittstelle abgefragt werden, kann der Parameter <code>name</code> übergeben werden:

define <name> UBUS_CALL network.device status name=eth0

Es können auch mehrere Namen angegeben werden:

define <name> UBUS_CALL network.device status name=eth0,eth1

In diesem Fall wird für jede Schnittstelle eine Abfrage durchgeführt. Alternativ kann eine Perl-Funktion benutzt werden:

define <name> UBUS_CALL network.device status name={GetNetworkNames()}

Hierfür sollte die Funktion (im Beispiel <code>GetNetworkNames()</code>) z.B. in der 99_myUtils.pm definiert sein.

Wenn das angesprochene Gerät eine Reihe von *_statistics_* Readings zurückgibt, die angeben, wie viele Bytes über eine Schnittstelle übertragen wurde etc., kann es hilfreich sein, dies in eine Anzahl Bytes seit dem letzten Aufruf umzurechnen. Das kann mit einer eigenen Funktion im Attribut <code>readings</code> erreicht werden:

attr <name> readings {\
my $r = FHEM::UBUS_CALL::DefaultReadings($RAW);;\
foreach my $k (grep(/_statistics_/, keys %{$r}))\
{\
my $kt = $k . '_total';;\
my $kr = $k . '_rate';;\
my $d = $r->{$k} - ReadingsNum($NAME, $kt, 0);;\
my $t = ReadingsAge($NAME, $kt, 1);;\
$r->{$kt} = $r->{$k};;\
$r->{$kr} = $d / $t;;\
delete $r->{$k};;\
}\
$r\
}

Hier werden zuerst mit <code>FHEM::UBUS_CALL::DefaultReadings($RAW)</code> die Standard-Readings erzeugt. Jedes Reading, das _statistics_ enthält, wird dann durch zwei andere Readings ersetzt, eines für den Gesamtwert, eines für die Änderung seit dem letzten Aufruf.

==== network.interface.<name> status ====

Um z.B. den Status des Interface <code>lan</code> abzufragen, dient der Aufruf

define <name> UBUS_CALL network.interface.lan status

Es können auch mehrere Interfaces abgefragt werden:

define <name> UBUS_CALL network.interface.lan,network.interface.wan status

Damit bei dieser Form der Abfrage die Readings von den verschiedenen Interfaces nicht gegenseitig überschrieben werden, bietet es sich an, den Namen des Interface als Präfix zu übergeben. Das Attribut <code>readings</code> sähe dann wie folgt aus:

attr <name> readings {\
my $p = $MODULE =~ s/network.interface.//r;;\
return FHEM::UBUS_CALL::DefaultReadings($RAW, $p . '_');;\
}

=== system ===

Siehe [http://openwrt.org/docs/guide-developer/ubus/system system] Referenz.

==== system board ====

Informationen zur verwendeten Hardware können über

define <name> UBUS_CALL system board

abgefragt werden. Da sich die Hardware im laufenden Betrieb üblicherweise nicht ändert, kann man außerdem

attr <name> interval 0

setzen, damit die Informationen nur beim Neustart oder <code>update</code> aufgerufen werden.

==== system info ====

Liefert allgemeine Systeminformationen, z.B. aktuelle Speichernutzung:

define <name> UBUS_CALL system info

UBus

2022-02-19T14:37:04Z

Xenos1984: /* network */ network.interface.<name> status

UBus

2022-02-19T14:10:47Z

Xenos1984: Example: network.device status

UBus

2022-02-19T13:34:40Z

Xenos1984: Extended documentation

UBus

2022-02-19T12:44:04Z

Xenos1984: Created page (to be filled with examples)

{{Baustelle}}

{{Infobox Modul
|ModPurpose=Einbinden von Geräten, die über die uBus Schnittstelle kommunizieren
|ModType=d
|ModCmdRef=UBUS_CLIENT
|ModForumArea=Sonstige Systeme
|ModTechName=72_UBUS_CLIENT.pm
|ModOwner=xenos1984 ({{Link2FU|43783|Forum}} / [[Benutzer Diskussion:Xenos1984|Wiki]])}}

{{Infobox Modul
|ModPurpose=Senden von "call" Anfragen an Geräte, die über die uBus Schnittstelle kommunizieren
|ModType=d
|ModCmdRef=UBUS_CALL
|ModForumArea=Sonstige Systeme
|ModTechName=72_UBUS_CALL.pm
|ModOwner=xenos1984 ({{Link2FU|43783|Forum}} / [[Benutzer Diskussion:Xenos1984|Wiki]])}}

DOIF/Zeitschaltuhr mit Calendar

2021-08-28T05:33:35Z

Xenos1984: Corrected get syntax (added missing "events").

Das [[DOIF]] Modul erlaubt es, durch Ereignisse oder zeitgesteuert, wenn bestimmte Bedingungen erfüllt sind, bestimmte Aktionen auszuführen. Eine mögliche Quelle für solche Ereignisse oder Bedingungen ist das [[Calendar]] Modul, das einen Kalender repräsentiert. Die folgenden Beispiele zeigen, wie man innerhalb von DOIF auf Ereignisse, die von Calendar erzeugt werden, reagieren kann, und wie man aus Calendar Bedingungen ableiten kann, in Abhängigkeit derer sich Aktionen auslösen lassen.

Im folgenden soll angenommen werden, dass es ein Gerät von Typ [[Calendar]] namens '''calendar''' gibt, auf das reagiert werden soll. Alle Beispiele benutzen den FHEM Modus des [[DOIF]], können aber auch auf den Perl-Modus umgeschrieben werden.

== Schalten mit Calendar Ereignissen ==

Die folgenden Beispiele zeigen, wie man mittels [[DOIF]] auf Ereignisse eines [[Calendar]] Gerätes reagieren kann. Diese werden ausgelöst, wenn ein Kalendereintrag seinen Status ändert.

=== Calendar Ereignisse ===

Wenn ein Eintrag im Kalender seinen Status ändert, werden zwei Ereignisse erzeugt:

changed: <UID> <mode>
<mode>: <UID>

Hier ist '''<UID>''' die UID des Kalendereintrags und '''<mode>''' der neue Status (''upcoming'', ''alarm'', ''start'' oder ''end'').

=== Triggern auf alle Kalendereinträge ===

Soll auf alle Statuswechsel von Kalendereinträgen getriggert werden, so geht dies mit

([calendar:"^changed:"])

Soll dagegen z.B. nur auf startende Kalendereinträge getriggert werden, geht dies mit

([calendar:"^start:"])

Innerhalb des Ausführungsteils lässt sich dann '''$EVENT''' auswerten, wie dies in [[Google-Kalender zur Steuerung von Dummies]] mittels [[Notify]] dargestellt ist.

=== Triggern auf eine bestimmte UID ===

Soll dagegen nur auf einen Eintrag mit einer bestimmten, bekannten UID getriggert werden, geht dies z.B. mit

([calendar:"^end: event123xyz$"])

Ist die UID dagegen nicht bekannt, wenn das [[DOIF]] programmiert wird, sondern wird z.B. in einem Reading namens '''uid''' des [[DOIF]] abgelegt, lässt sich wie folgt auf das Ende des Kalendereintrags triggern:

(["^calendar$":"^end: (.*)$":$1,""] eq [$SELF:uid])

Hier wird mittels Rückgabewert die UID des Kalendereintrags ermittelt und mit dem gespeicherten Reading verglichen.

=== Triggern auf Einträge mit bestimmten Eigenschaften ===

Soll nicht die UID überprüft werden, sondern der Inhalt eines Kalendereintrags, so lässt sich dafür die Ausgabeformatierung des DOIF Moduls nutzen, um den Inhalt abzufragen. Um z.B. zu triggern, wenn ein Event beginnt, dass in Feld '''summary''' das Wort "Erna" enthält:

(["^calendar$":"^start: (.*) end$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$S\""),""] =~ "Erna")

Triggern beim Ende aller Einträge, die als "PUBLIC" klassifiziert sind:

(["^calendar$":"^end: (.*) end$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$CL\""),""] eq "PUBLIC")

== Schalten in Abhängigkeit des Calendar Status ==

Soll nicht zum Zeitpunkt eines Statuswechsels reagiert werden, sondern durch einen anderen Auslöser, aber in Abhängigkeit von Kalendereinträgen, so kann dies wie folgt realisiert werden.

=== Abfragen von Kalendereinträgen ===

Das [[Calendar]] Modul bietet den folgenden, sehr umfangreichen Befehl zum Abruf von Kalendereinträgen:

get <name> events [format:<formatSpec>] [timeFormat:<timeFormatSpec>] [filter:<filterSpecs>] [series:next[=<max>]] [limit:<limitSpecs>] [include:<names>] [returnType:<returnTypeSpec>]

Diese lässt sich mittels der Perl-Funktion '''fhem()''' auch innerhalb von [[DOIF]] nutzen. Hier ist zu beachten, dass die Funktion ''undef'' zurückgibt, wenn keine Einträge vorhanden sind, die auf die gefragten Kriterien passen, was sich mittels '''defined''' überprüfen lässt.

=== Triggern auf Einträge heute oder morgen ===

Um jeden Tag um 6:00 zu triggern, wenn an diesem Tag "Schule" (zu einer beliebigen Uhrzeit) im Kalender steht:

([06:00] and defined fhem('get calendar events filter:field(summary)=="Schule" limit:when=today'))

Um jeden Tag um 21:00 zu triggern, wenn am nächsten Tag etwas mit "Tonne" im Kalender steht:

([21:00] and defined fhem('get calendar events filter:field(summary)=~"Tonne" limit:when=tomorrow'))

=== Triggern, wenn Kalendereintrag aktiv ist ===

Um jeden Tag um 7:00 zu triggern, wenn der Kalender einen Eintrag "Arbeitstag" enthält (als ganztägigen Eintrag, mit Anfang und Ende jeweils im Mitternacht, sodass sich das Ereignis den ganzen Tag im Status ''start'' befindet):

([07:00] and defined fhem('get calendar events filter:mode=="start",field(summary)=="Arbeitstag"'))

Soll dagegen an markierten Tagen nicht getriggert werden, z.B. von 7:00-8:00, aber nicht an Ferientagen:

([07:00-08:00] and !defined fhem('get calendar events filter:mode=="start",field(summary)=="Ferientag"'))

Trigger zur vollen Stunde, außer zu Ruhezeiten:

([:00] and !defined fhem('get calendar events filter:mode=="start",field(summary)=="Ruhezeit"'))

Trigger auf Frost, aber nur, wenn zu dieser Zeit geheizt werden soll:

([temperature < 0] and defined fhem('get calendar events filter:mode=="start",field(summary)=="Heizung"'))

=== Triggern, wenn Ereignis bevorsteht oder stattgefunden hat ===

Wenn ein Trigger ausgelöst werden soll, bevor ein Kalendereintrag aktiv wird, oder nachdem das Ereignis vorbei ist (z.B. um vor einer Party die Heizung einzuschalten, und danach den Staubsauger) kann man den Zeitfilter benutzen. Um zu jeder vollen Stunde zu testen, ob innerhalb der nächsten 6 Stunden eine Party beginnt:

([:00] and defined fhem('get calendar events filter:mode=~"alarm|upcoming",field(summary)=~"Party" limit:from=05:00,to=06:00'))

Entsprechendes, wenn die Party seit 4 Stunden vorbei ist:

([:00] and defined fhem('get calendar events filter:mode=="end",field(summary)=~"Party" limit:from=-04:00,to=0'))

== Komplexere Beispiele ==

Die folgenden Beispiele zeigen ein paar Anwendungen.

=== Heizung einschalten 6 Stunden bevor Besuch kommt, ausschalten wenn Besuch geht ===

([:00] and defined fhem('get calendar events filter:mode=~"alarm|upcoming",field(summary)=~"Besuch" limit:from=0,to=06:00'))
(set heating on)
DOELSEIF (["^calendar$":"^end: (.*)$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$S\""),""] =~ "Besuch")
(set heating off)

=== uiTable: Anzahl der Tage bis zur Abfall-Entsorgung ===

Siehe [[DOIF/uiTable Schnelleinstieg#Anzahl der Tage bis zur Abfall-Entsorgung]]

== Links ==

* [[DOIF]]
* [[DOIF/Zeitgeber]]
* [[DOIF/Zeitspanne zwischen zwei Terminen schalten]]
* [[DOIF/Zeitspanne im DOIF und disabledForIntervals im Vergleich]]
* [[Calendar]]

[[Kategorie:Code Snippets]]

DOIF/Zeitschaltuhr mit Calendar

2020-12-05T18:55:09Z

Xenos1984: /* Komplexere Beispiele */ Link zur uiTable Abfall-Entsorgung

Das [[DOIF]] Modul erlaubt es, durch Ereignisse oder zeitgesteuert, wenn bestimmte Bedingungen erfüllt sind, bestimmte Aktionen auszuführen. Eine mögliche Quelle für solche Ereignisse oder Bedingungen ist das [[Calendar]] Modul, das einen Kalender repräsentiert. Die folgenden Beispiele zeigen, wie man innerhalb von DOIF auf Ereignisse, die von Calendar erzeugt werden, reagieren kann, und wie man aus Calendar Bedingungen ableiten kann, in Abhängigkeit derer sich Aktionen auslösen lassen.

Im folgenden soll angenommen werden, dass es ein Gerät von Typ [[Calendar]] namens '''calendar''' gibt, auf das reagiert werden soll. Alle Beispiele benutzen den FHEM Modus des [[DOIF]], können aber auch auf den Perl-Modus umgeschrieben werden.

== Schalten mit Calendar Ereignissen ==

Die folgenden Beispiele zeigen, wie man mittels [[DOIF]] auf Ereignisse eines [[Calendar]] Gerätes reagieren kann. Diese werden ausgelöst, wenn ein Kalendereintrag seinen Status ändert.

=== Calendar Ereignisse ===

Wenn ein Eintrag im Kalender seinen Status ändert, werden zwei Ereignisse erzeugt:

changed: <UID> <mode>
<mode>: <UID>

Hier ist '''<UID>''' die UID des Kalendereintrags und '''<mode>''' der neue Status (''upcoming'', ''alarm'', ''start'' oder ''end'').

=== Triggern auf alle Kalendereinträge ===

Soll auf alle Statuswechsel von Kalendereinträgen getriggert werden, so geht dies mit

([calendar:"^changed:"])

Soll dagegen z.B. nur auf startende Kalendereinträge getriggert werden, geht dies mit

([calendar:"^start:"])

Innerhalb des Ausführungsteils lässt sich dann '''$EVENT''' auswerten, wie dies in [[Google-Kalender zur Steuerung von Dummies]] mittels [[Notify]] dargestellt ist.

=== Triggern auf eine bestimmte UID ===

Soll dagegen nur auf einen Eintrag mit einer bestimmten, bekannten UID getriggert werden, geht dies z.B. mit

([calendar:"^end: event123xyz$"])

Ist die UID dagegen nicht bekannt, wenn das [[DOIF]] programmiert wird, sondern wird z.B. in einem Reading namens '''uid''' des [[DOIF]] abgelegt, lässt sich wie folgt auf das Ende des Kalendereintrags triggern:

(["^calendar$":"^end: (.*)$":$1,""] eq [$SELF:uid])

Hier wird mittels Rückgabewert die UID des Kalendereintrags ermittelt und mit dem gespeicherten Reading verglichen.

=== Triggern auf Einträge mit bestimmten Eigenschaften ===

Soll nicht die UID überprüft werden, sondern der Inhalt eines Kalendereintrags, so lässt sich dafür die Ausgabeformatierung des DOIF Moduls nutzen, um den Inhalt abzufragen. Um z.B. zu triggern, wenn ein Event beginnt, dass in Feld '''summary''' das Wort "Erna" enthält:

(["^calendar$":"^start: (.*) end$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$S\""),""] =~ "Erna")

Triggern beim Ende aller Einträge, die als "PUBLIC" klassifiziert sind:

(["^calendar$":"^end: (.*) end$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$CL\""),""] eq "PUBLIC")

== Schalten in Abhängigkeit des Calendar Status ==

Soll nicht zum Zeitpunkt eines Statuswechsels reagiert werden, sondern durch einen anderen Auslöser, aber in Abhängigkeit von Kalendereinträgen, so kann dies wie folgt realisiert werden.

=== Abfragen von Kalendereinträgen ===

Das [[Calendar]] Modul bietet den folgenden, sehr umfangreichen Befehl zum Abruf von Kalendereinträgen:

get <name> events [format:<formatSpec>] [timeFormat:<timeFormatSpec>] [filter:<filterSpecs>] [series:next[=<max>]] [limit:<limitSpecs>] [include:<names>] [returnType:<returnTypeSpec>]

Diese lässt sich mittels der Perl-Funktion '''fhem()''' auch innerhalb von [[DOIF]] nutzen. Hier ist zu beachten, dass die Funktion ''undef'' zurückgibt, wenn keine Einträge vorhanden sind, die auf die gefragten Kriterien passen, was sich mittels '''defined''' überprüfen lässt.

=== Triggern auf Einträge heute oder morgen ===

Um jeden Tag um 6:00 zu triggern, wenn an diesem Tag "Schule" (zu einer beliebigen Uhrzeit) im Kalender steht:

([06:00] and defined fhem('get calendar filter:field(summary)=="Schule" limit:when=today'))

Um jeden Tag um 21:00 zu triggern, wenn am nächsten Tag etwas mit "Tonne" im Kalender steht:

([21:00] and defined fhem('get calendar filter:field(summary)=~"Tonne" limit:when=tomorrow'))

=== Triggern, wenn Kalendereintrag aktiv ist ===

Um jeden Tag um 7:00 zu triggern, wenn der Kalender einen Eintrag "Arbeitstag" enthält (als ganztägigen Eintrag, mit Anfang und Ende jeweils im Mitternacht, sodass sich das Ereignis den ganzen Tag im Status ''start'' befindet):

([07:00] and defined fhem('get calendar filter:mode=="start",field(summary)=="Arbeitstag"'))

Soll dagegen an markierten Tagen nicht getriggert werden, z.B. von 7:00-8:00, aber nicht an Ferientagen:

([07:00-08:00] and !defined fhem('get calendar filter:mode=="start",field(summary)=="Ferientag"'))

Trigger zur vollen Stunde, außer zu Ruhezeiten:

([:00] and !defined fhem('get calendar filter:mode=="start",field(summary)=="Ruhezeit"'))

Trigger auf Frost, aber nur, wenn zu dieser Zeit geheizt werden soll:

([temperature < 0] and defined fhem('get calendar filter:mode=="start",field(summary)=="Heizung"'))

=== Triggern, wenn Ereignis bevorsteht oder stattgefunden hat ===

Wenn ein Trigger ausgelöst werden soll, bevor ein Kalendereintrag aktiv wird, oder nachdem das Ereignis vorbei ist (z.B. um vor einer Party die Heizung einzuschalten, und danach den Staubsauger) kann man den Zeitfilter benutzen. Um zu jeder vollen Stunde zu testen, ob innerhalb der nächsten 6 Stunden eine Party beginnt:

([:00] and defined fhem('get calendar events filter:mode=~"alarm|upcoming",field(summary)=~"Party" limit:from=05:00,to=06:00'))

Entsprechendes, wenn die Party seit 4 Stunden vorbei ist:

([:00] and defined fhem('get calendar events filter:mode=="end",field(summary)=~"Party" limit:from=-04:00,to=0'))

== Komplexere Beispiele ==

Die folgenden Beispiele zeigen ein paar Anwendungen.

=== Heizung einschalten 6 Stunden bevor Besuch kommt, ausschalten wenn Besuch geht ===

([:00] and defined fhem('get calendar events filter:mode=~"alarm|upcoming",field(summary)=~"Besuch" limit:from=0,to=06:00'))
(set heating on)
DOELSEIF (["^calendar$":"^end: (.*)$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$S\""),""] =~ "Besuch")
(set heating off)

=== uiTable: Anzahl der Tage bis zur Abfall-Entsorgung ===

Siehe [[DOIF/uiTable Schnelleinstieg#Anzahl der Tage bis zur Abfall-Entsorgung]]

== Links ==

* [[DOIF]]
* [[DOIF/Zeitgeber]]
* [[DOIF/Zeitspanne zwischen zwei Terminen schalten]]
* [[DOIF/Zeitspanne im DOIF und disabledForIntervals im Vergleich]]
* [[Calendar]]

[[Kategorie:Code Snippets]]

DOIF/Zeitschaltuhr mit Calendar

2020-09-12T13:40:12Z

Xenos1984: Links

Das [[DOIF]] Modul erlaubt es, durch Ereignisse oder zeitgesteuert, wenn bestimmte Bedingungen erfüllt sind, bestimmte Aktionen auszuführen. Eine mögliche Quelle für solche Ereignisse oder Bedingungen ist das [[Calendar]] Modul, das einen Kalender repräsentiert. Die folgenden Beispiele zeigen, wie man innerhalb von DOIF auf Ereignisse, die von Calendar erzeugt werden, reagieren kann, und wie man aus Calendar Bedingungen ableiten kann, in Abhängigkeit derer sich Aktionen auslösen lassen.

Im folgenden soll angenommen werden, dass es ein Gerät von Typ [[Calendar]] namens '''calendar''' gibt, auf das reagiert werden soll. Alle Beispiele benutzen den FHEM Modus des [[DOIF]], können aber auch auf den Perl-Modus umgeschrieben werden.

== Schalten mit Calendar Ereignissen ==

Die folgenden Beispiele zeigen, wie man mittels [[DOIF]] auf Ereignisse eines [[Calendar]] Gerätes reagieren kann. Diese werden ausgelöst, wenn ein Kalendereintrag seinen Status ändert.

=== Calendar Ereignisse ===

Wenn ein Eintrag im Kalender seinen Status ändert, werden zwei Ereignisse erzeugt:

changed: <UID> <mode>
<mode>: <UID>

Hier ist '''<UID>''' die UID des Kalendereintrags und '''<mode>''' der neue Status (''upcoming'', ''alarm'', ''start'' oder ''end'').

=== Triggern auf alle Kalendereinträge ===

Soll auf alle Statuswechsel von Kalendereinträgen getriggert werden, so geht dies mit

([calendar:"^changed:"])

Soll dagegen z.B. nur auf startende Kalendereinträge getriggert werden, geht dies mit

([calendar:"^start:"])

Innerhalb des Ausführungsteils lässt sich dann '''$EVENT''' auswerten, wie dies in [[Google-Kalender zur Steuerung von Dummies]] mittels [[Notify]] dargestellt ist.

=== Triggern auf eine bestimmte UID ===

Soll dagegen nur auf einen Eintrag mit einer bestimmten, bekannten UID getriggert werden, geht dies z.B. mit

([calendar:"^end: event123xyz$"])

Ist die UID dagegen nicht bekannt, wenn das [[DOIF]] programmiert wird, sondern wird z.B. in einem Reading namens '''uid''' des [[DOIF]] abgelegt, lässt sich wie folgt auf das Ende des Kalendereintrags triggern:

(["^calendar$":"^end: (.*)$":$1,""] eq [$SELF:uid])

Hier wird mittels Rückgabewert die UID des Kalendereintrags ermittelt und mit dem gespeicherten Reading verglichen.

=== Triggern auf Einträge mit bestimmten Eigenschaften ===

Soll nicht die UID überprüft werden, sondern der Inhalt eines Kalendereintrags, so lässt sich dafür die Ausgabeformatierung des DOIF Moduls nutzen, um den Inhalt abzufragen. Um z.B. zu triggern, wenn ein Event beginnt, dass in Feld '''summary''' das Wort "Erna" enthält:

(["^calendar$":"^start: (.*) end$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$S\""),""] =~ "Erna")

Triggern beim Ende aller Einträge, die als "PUBLIC" klassifiziert sind:

(["^calendar$":"^end: (.*) end$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$CL\""),""] eq "PUBLIC")

== Schalten in Abhängigkeit des Calendar Status ==

Soll nicht zum Zeitpunkt eines Statuswechsels reagiert werden, sondern durch einen anderen Auslöser, aber in Abhängigkeit von Kalendereinträgen, so kann dies wie folgt realisiert werden.

=== Abfragen von Kalendereinträgen ===

Das [[Calendar]] Modul bietet den folgenden, sehr umfangreichen Befehl zum Abruf von Kalendereinträgen:

get <name> events [format:<formatSpec>] [timeFormat:<timeFormatSpec>] [filter:<filterSpecs>] [series:next[=<max>]] [limit:<limitSpecs>] [include:<names>] [returnType:<returnTypeSpec>]

Diese lässt sich mittels der Perl-Funktion '''fhem()''' auch innerhalb von [[DOIF]] nutzen. Hier ist zu beachten, dass die Funktion ''undef'' zurückgibt, wenn keine Einträge vorhanden sind, die auf die gefragten Kriterien passen, was sich mittels '''defined''' überprüfen lässt.

=== Triggern auf Einträge heute oder morgen ===

Um jeden Tag um 6:00 zu triggern, wenn an diesem Tag "Schule" (zu einer beliebigen Uhrzeit) im Kalender steht:

([06:00] and defined fhem('get calendar filter:field(summary)=="Schule" limit:when=today'))

Um jeden Tag um 21:00 zu triggern, wenn am nächsten Tag etwas mit "Tonne" im Kalender steht:

([21:00] and defined fhem('get calendar filter:field(summary)=~"Tonne" limit:when=tomorrow'))

=== Triggern, wenn Kalendereintrag aktiv ist ===

Um jeden Tag um 7:00 zu triggern, wenn der Kalender einen Eintrag "Arbeitstag" enthält (als ganztägigen Eintrag, mit Anfang und Ende jeweils im Mitternacht, sodass sich das Ereignis den ganzen Tag im Status ''start'' befindet):

([07:00] and defined fhem('get calendar filter:mode=="start",field(summary)=="Arbeitstag"'))

Soll dagegen an markierten Tagen nicht getriggert werden, z.B. von 7:00-8:00, aber nicht an Ferientagen:

([07:00-08:00] and !defined fhem('get calendar filter:mode=="start",field(summary)=="Ferientag"'))

Trigger zur vollen Stunde, außer zu Ruhezeiten:

([:00] and !defined fhem('get calendar filter:mode=="start",field(summary)=="Ruhezeit"'))

Trigger auf Frost, aber nur, wenn zu dieser Zeit geheizt werden soll:

([temperature < 0] and defined fhem('get calendar filter:mode=="start",field(summary)=="Heizung"'))

=== Triggern, wenn Ereignis bevorsteht oder stattgefunden hat ===

Wenn ein Trigger ausgelöst werden soll, bevor ein Kalendereintrag aktiv wird, oder nachdem das Ereignis vorbei ist (z.B. um vor einer Party die Heizung einzuschalten, und danach den Staubsauger) kann man den Zeitfilter benutzen. Um zu jeder vollen Stunde zu testen, ob innerhalb der nächsten 6 Stunden eine Party beginnt:

([:00] and defined fhem('get calendar events filter:mode=~"alarm|upcoming",field(summary)=~"Party" limit:from=05:00,to=06:00'))

Entsprechendes, wenn die Party seit 4 Stunden vorbei ist:

([:00] and defined fhem('get calendar events filter:mode=="end",field(summary)=~"Party" limit:from=-04:00,to=0'))

== Komplexere Beispiele ==

Die folgenden Beispiele zeigen ein paar Anwendungen.

=== Heizung einschalten 6 Stunden bevor Besuch kommt, ausschalten wenn Besuch geht ===

([:00] and defined fhem('get calendar events filter:mode=~"alarm|upcoming",field(summary)=~"Besuch" limit:from=0,to=06:00'))
(set heating on)
DOELSEIF (["^calendar$":"^end: (.*)$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$S\""),""] =~ "Besuch")
(set heating off)

== Links ==

* [[DOIF]]
* [[DOIF/Zeitgeber]]
* [[DOIF/Zeitspanne zwischen zwei Terminen schalten]]
* [[DOIF/Zeitspanne im DOIF und disabledForIntervals im Vergleich]]
* [[Calendar]]

[[Kategorie:Code Snippets]]

DOIF/Zeitschaltuhr mit Calendar

2020-09-12T13:37:03Z

Xenos1984: Beispiele

{{Baustelle}}

Das [[DOIF]] Modul erlaubt es, durch Ereignisse oder zeitgesteuert, wenn bestimmte Bedingungen erfüllt sind, bestimmte Aktionen auszuführen. Eine mögliche Quelle für solche Ereignisse oder Bedingungen ist das [[Calendar]] Modul, das einen Kalender repräsentiert. Die folgenden Beispiele zeigen, wie man innerhalb von DOIF auf Ereignisse, die von Calendar erzeugt werden, reagieren kann, und wie man aus Calendar Bedingungen ableiten kann, in Abhängigkeit derer sich Aktionen auslösen lassen.

Im folgenden soll angenommen werden, dass es ein Gerät von Typ [[Calendar]] namens '''calendar''' gibt, auf das reagiert werden soll. Alle Beispiele benutzen den FHEM Modus des [[DOIF]], können aber auch auf den Perl-Modus umgeschrieben werden.

== Schalten mit Calendar Ereignissen ==

Die folgenden Beispiele zeigen, wie man mittels [[DOIF]] auf Ereignisse eines [[Calendar]] Gerätes reagieren kann. Diese werden ausgelöst, wenn ein Kalendereintrag seinen Status ändert.

=== Calendar Ereignisse ===

Wenn ein Eintrag im Kalender seinen Status ändert, werden zwei Ereignisse erzeugt:

changed: <UID> <mode>
<mode>: <UID>

Hier ist '''<UID>''' die UID des Kalendereintrags und '''<mode>''' der neue Status (''upcoming'', ''alarm'', ''start'' oder ''end'').

=== Triggern auf alle Kalendereinträge ===

Soll auf alle Statuswechsel von Kalendereinträgen getriggert werden, so geht dies mit

([calendar:"^changed:"])

Soll dagegen z.B. nur auf startende Kalendereinträge getriggert werden, geht dies mit

([calendar:"^start:"])

Innerhalb des Ausführungsteils lässt sich dann '''$EVENT''' auswerten, wie dies in [[Google-Kalender zur Steuerung von Dummies]] mittels [[Notify]] dargestellt ist.

=== Triggern auf eine bestimmte UID ===

Soll dagegen nur auf einen Eintrag mit einer bestimmten, bekannten UID getriggert werden, geht dies z.B. mit

([calendar:"^end: event123xyz$"])

Ist die UID dagegen nicht bekannt, wenn das [[DOIF]] programmiert wird, sondern wird z.B. in einem Reading namens '''uid''' des [[DOIF]] abgelegt, lässt sich wie folgt auf das Ende des Kalendereintrags triggern:

(["^calendar$":"^end: (.*)$":$1,""] eq [$SELF:uid])

Hier wird mittels Rückgabewert die UID des Kalendereintrags ermittelt und mit dem gespeicherten Reading verglichen.

=== Triggern auf Einträge mit bestimmten Eigenschaften ===

Soll nicht die UID überprüft werden, sondern der Inhalt eines Kalendereintrags, so lässt sich dafür die Ausgabeformatierung des DOIF Moduls nutzen, um den Inhalt abzufragen. Um z.B. zu triggern, wenn ein Event beginnt, dass in Feld '''summary''' das Wort "Erna" enthält:

(["^calendar$":"^start: (.*) end$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$S\""),""] =~ "Erna")

Triggern beim Ende aller Einträge, die als "PUBLIC" klassifiziert sind:

(["^calendar$":"^end: (.*) end$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$CL\""),""] eq "PUBLIC")

== Schalten in Abhängigkeit des Calendar Status ==

Soll nicht zum Zeitpunkt eines Statuswechsels reagiert werden, sondern durch einen anderen Auslöser, aber in Abhängigkeit von Kalendereinträgen, so kann dies wie folgt realisiert werden.

=== Abfragen von Kalendereinträgen ===

Das [[Calendar]] Modul bietet den folgenden, sehr umfangreichen Befehl zum Abruf von Kalendereinträgen:

get <name> events [format:<formatSpec>] [timeFormat:<timeFormatSpec>] [filter:<filterSpecs>] [series:next[=<max>]] [limit:<limitSpecs>] [include:<names>] [returnType:<returnTypeSpec>]

Diese lässt sich mittels der Perl-Funktion '''fhem()''' auch innerhalb von [[DOIF]] nutzen. Hier ist zu beachten, dass die Funktion ''undef'' zurückgibt, wenn keine Einträge vorhanden sind, die auf die gefragten Kriterien passen, was sich mittels '''defined''' überprüfen lässt.

=== Triggern auf Einträge heute oder morgen ===

Um jeden Tag um 6:00 zu triggern, wenn an diesem Tag "Schule" (zu einer beliebigen Uhrzeit) im Kalender steht:

([06:00] and defined fhem('get calendar filter:field(summary)=="Schule" limit:when=today'))

Um jeden Tag um 21:00 zu triggern, wenn am nächsten Tag etwas mit "Tonne" im Kalender steht:

([21:00] and defined fhem('get calendar filter:field(summary)=~"Tonne" limit:when=tomorrow'))

=== Triggern, wenn Kalendereintrag aktiv ist ===

Um jeden Tag um 7:00 zu triggern, wenn der Kalender einen Eintrag "Arbeitstag" enthält (als ganztägigen Eintrag, mit Anfang und Ende jeweils im Mitternacht, sodass sich das Ereignis den ganzen Tag im Status ''start'' befindet):

([07:00] and defined fhem('get calendar filter:mode=="start",field(summary)=="Arbeitstag"'))

Soll dagegen an markierten Tagen nicht getriggert werden, z.B. von 7:00-8:00, aber nicht an Ferientagen:

([07:00-08:00] and !defined fhem('get calendar filter:mode=="start",field(summary)=="Ferientag"'))

Trigger zur vollen Stunde, außer zu Ruhezeiten:

([:00] and !defined fhem('get calendar filter:mode=="start",field(summary)=="Ruhezeit"'))

Trigger auf Frost, aber nur, wenn zu dieser Zeit geheizt werden soll:

([temperature < 0] and defined fhem('get calendar filter:mode=="start",field(summary)=="Heizung"'))

=== Triggern, wenn Ereignis bevorsteht oder stattgefunden hat ===

Wenn ein Trigger ausgelöst werden soll, bevor ein Kalendereintrag aktiv wird, oder nachdem das Ereignis vorbei ist (z.B. um vor einer Party die Heizung einzuschalten, und danach den Staubsauger) kann man den Zeitfilter benutzen. Um zu jeder vollen Stunde zu testen, ob innerhalb der nächsten 6 Stunden eine Party beginnt:

([:00] and defined fhem('get calendar events filter:mode=~"alarm|upcoming",field(summary)=~"Party" limit:from=05:00,to=06:00'))

Entsprechendes, wenn die Party seit 4 Stunden vorbei ist:

([:00] and defined fhem('get calendar events filter:mode=="end",field(summary)=~"Party" limit:from=-04:00,to=0'))

== Komplexere Beispiele ==

Die folgenden Beispiele zeigen ein paar Anwendungen.

=== Heizung einschalten 6 Stunden bevor Besuch kommt, ausschalten wenn Besuch geht ===

([:00] and defined fhem('get calendar events filter:mode=~"alarm|upcoming",field(summary)=~"Besuch" limit:from=0,to=06:00'))
(set heating on)
DOELSEIF (["^calendar$":"^end: (.*)$":fhem("get calendar events filter:uid==\"$1\" format:custom=\"\$S\""),""] =~ "Besuch")
(set heating off)

DOIF/Zeitschaltuhr mit Calendar

2020-09-12T13:32:31Z

Xenos1984: Triggern auf Calendar Status

DOIF/Zeitschaltuhr mit Calendar

2020-09-12T12:44:09Z

Xenos1984: Triggern auf Calendar Ereignisse

DOIF/Zeitschaltuhr mit Calendar

2020-09-12T08:36:53Z

Xenos1984: Seite angelegt.

VLC Media Player mit HTTPMOD

2020-01-05T00:07:17Z

Xenos1984: /* Readings und Befehle */ random, loop, repeat hinzugefügt,

{{Baustelle}}

Der [http://www.videolan.org/vlc/ VLC Media Player] besitzt ein HTTP Interface, das eine Fernsteuerung mittels FHEM möglich macht. Dieses HOWTO beschreibt, wie VLC über das Modul [[HTTPMOD]] eingebunden und Kontrollelemente eingerichtet werden können.

== VLC als Server starten ==

== Device erstellen ==

Das VLC Device wird mittels des Moduls [[HTTPMOD]] angelegt. Dafür ist eine URL in der folgenden Form anzugeben:

define vlc HTTPMOD http://<host>:<port>/requests/status.xml 5

Dabei sind <code><host></code> und <code><port></code> die Angaben für den Hostnamen und Ports des wie im Abschnitt [[#VLC_als_Server_starten]] beschrieben eingerichteten VLC Servers. Die Zahl am Ende gibt das Intervall (in Sekunden) an, nach dem der Server automatisch abgefragt und die Readings aktualisiert werden. Dieser Wert kann bei Bedarf angepasst werden.

Um später Befehle an den Server absetzen zu können, muss noch eine Vorlage für die dafür aufgerufene angegebene URL angegeben werden. Dies lässt sich wie folgt realisieren:

attr vlc setURL http://<host>:<port>/requests/status.xml?command=%%cmd%%

Der Befehl wird beim Aufruf durch einen regulären Ausdruck ersetzt. Dafür dient folgende Angabe:

attr vlc replacement01Regex %%cmd%%

Als letztes muss noch der Login am Server mit dem wie in Abschnitt [[#VLC_als_Server_starten]] beschrieben eingerichteten Passwort erlaubt werden. Dies ist etwas Trickreich, da VLC nur ein Passwort, aber einen leeren Benutzernamen erwartet. Um diese zu übergeben, muss die [http://de.wikipedia.org/wiki/HTTP-Authentifizierung#Basic_Authentication HTTP Authentifizierung] manuell eingerichtet werden. Dafür muss zunächst der String <code>:<password></code> als [http://de.wikipedia.org/wiki/Base64 Base64] codiert werden. Dies kann z.B. mit einem Online-Converter geschehen, oder unter Linux mit dem Befehl

echo -n ":<password>" | base64

Das Ergebnis wird dann in das VLC Device eingetragen:

attr vlc requestHeader1 Authorization: Basic <base64>
attr vlc getHeader1 Authorization: Basic <base64>
attr vlc setHeader1 Authorization: Basic <base64>

Alternativ kann auch die HTTP URL des VLC Servers über einen Browser und einen Proxy wie [http://portswigger.net/burp/ BurpSuite] aufgerufen werden, und dann beobachtet werden, welchen Header der Browser für die Anmeldung an den Server schickt.

== Readings und Befehle ==

Der VLC Media Player stellt über das HTTP Interface eine Reihe von Statusmeldungen und Steuerbefehlen bereit. Die folgende Liste zeigt, wie diese in FHEM eingebunden werden können. Dafür müssen die genannten Attribute gesetzt werden, und es werden die darunter gelisteten Readings und Set-Befehle erstellt.

=== Zufällige Wiedergabe ===

Zeigt an bzw. legt fest, ob zufällige Wiedergabe aktiv ist.

==== Attribute ====

attr vlc reading01Name random
attr vlc reading01XPath-Strict /root/random/text()
attr vlc set01Name random
attr vlc set01NoArg 1
attr vlc set01Replacement01Value pl_random

==== Readings ====

* '''random''' - ''true'' wenn zufällige Wiedergabe aktiv ist, anderenfalls ''false''.

==== Set-Befehle ====

Umschalten (negieren der aktuellen Einstellung) der zufälligen Wiedergabe:

set vlc random

=== Endloswiedergabe ===

Zeigt an bzw. legt fest, ob Endloswiedergabe aktiv ist.

==== Attribute ====

attr vlc reading02Name loop
attr vlc reading02XPath-Strict /root/loop/text()
attr vlc set02Name loop
attr vlc set02NoArg 1
attr vlc set02Replacement01Value pl_loop

==== Readings ====

* '''loop''' - ''true'' wenn Endloswiedergabe aktiv ist, anderenfalls ''false''.

==== Set-Befehle ====

Umschalten (negieren der aktuellen Einstellung) der Endloswiedergabe:

set vlc loop

=== Dauerschleife ===

Zeigt an bzw. legt fest, ob eine Dauerschleife (Wiederholung eines bestimmten Titels) aktiv ist.

==== Attribute ====

attr vlc reading03Name repeat
attr vlc reading03XPath-Strict /root/repeat/text()
attr vlc set03Name repeat
attr vlc set03NoArg 1
attr vlc set03Replacement01Value pl_repeat

==== Readings ====

* '''repeat''' - ''true'' wenn Dauerschleife aktiv ist, anderenfalls ''false''.

==== Set-Befehle ====

Umschalten (negieren der aktuellen Einstellung) der Dauerschleife:

set vlc repeat

== Playliste ==

{{Todo|Auslesen der Attribute der Playliste - fortlaufende Nummer und Titel}}

== Dateibrowser ==

== Links ==

* [http://wiki.videolan.org/Documentation:Modules/http_intf VLC HTTP Interface Dokumentation]
* [http://wiki.videolan.org/Control_VLC_via_a_browser VLC Browser Interface Dokumentation]
* [https://github.com/videolan/vlc/tree/master/share/lua/http/requests Liste der VLC HTTP Befehle]

[[Kategorie:HOWTOS]]
[[Kategorie:Unterhaltungselektronik]]

VLC Media Player mit HTTPMOD

2019-12-16T00:01:39Z

Xenos1984: /* Device erstellen */ Inhalt erstellt

VLC Media Player mit HTTPMOD

2019-12-15T23:27:47Z

Xenos1984: Seite erstellt und Struktur angelegt