From 649a9c706c9a9867b68de09b712efc881ba75efe Mon Sep 17 00:00:00 2001
From: rudolfkoenig <>
Date: Mon, 7 Apr 2014 08:32:35 +0000
Subject: [PATCH] notify: german doc
git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@5470 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
FHEM/91_notify.pm | 186 +++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 182 insertions(+), 4 deletions(-)
diff --git a/FHEM/91_notify.pm b/FHEM/91_notify.pm
index d4c94b0e7..f8cf1223c 100755
--- a/FHEM/91_notify.pm
+++ b/FHEM/91_notify.pm
@@ -139,7 +139,6 @@ notify_Attr(@)
define b3lampV3 notify btn3 "/usr/local/bin/setlamp "$EVENT""
define b3lampV3 notify btn3 set lamp1 $EVENT;;set lamp2 $EVENT
define wzMessLg notify wz:measured.* "/usr/local/bin/logfht $NAME "$EVENT""
-
define LogUndef notify global:UNDEFINED.* "send-me-mail.sh "$EVENT""
@@ -191,12 +190,12 @@ notify_Attr(@)
definition.
- To use database logging, define a dblog instance and change the
- $dbconn parameter in the file.
-
Following special events will be generated for the device "global"
- INITIALIZED after initialization is finished.
+ - REREADCFG after the configuration is reread.
+ - SAVE before the configuration is saved.
+ - SHUTDOWN before FHEM is shut down.
- DEFINED <devname> after a device is defined.
- DELETED <devname> after a device was deleted.
- RENAMED <old> <new> after a device was renamed.
@@ -261,4 +260,183 @@ notify_Attr(@)
=end html
+
+=begin html_DE
+
+
+notify
+
+
+
+
+ Define
+
+ define <name> notify <Suchmuster> <Anweisung>
+
+ Führt eine oder mehrere Anweisungen aus, wenn ein Event generiert
+ wurde, was dem <Suchmuster> (Gerätename oder
+ Gerätename:Event) entspricht.
+
+ Die Anweisung ist einer der FHEM Befehlstypen.
+ Zum Test dient das trigger-Kommando.
+
+
+ Beispiele:
+
+ define b3lampV1 notify btn3 set lamp $EVENT
+ define b3lampV2 notify btn3 { fhem "set lamp $EVENT" }
+ define b3lampV3 notify btn3 "/usr/local/bin/setlamp
+ "$EVENT""
+
+ define b3lampV3 notify btn3 set lamp1 $EVENT;;set lamp2
+ $EVENT
+
+ define wzMessLg notify wz:measured.* "/usr/local/bin/logfht $NAME
+ "$EVENT""
+
+ define LogUndef notify global:UNDEFINED.* "send-me-mail.sh
+ "$EVENT""
+
+
+
+
+ Hinweise:
+
+ <Suchmuster> ist entweder der Name des
+ auslösenden ("triggernden") Gerätes oder die Kombination aus
+ Gerät und auslösendem Ereignis (Event)
+ Gerätename:Event.- Das
<Suchmuster> muss exakt (!)
+ entweder dem Gerätenamen entsprechen oder der Zusammenfügung
+ aus Gerätename:Event. Events lassen sich mit "inform" in Telnet
+ oder durch Beobachtung des "Event-Monitors" in FHEMWEB ermitteln.
+
+ - In der Anweisung von Notify kann das auslösende Ereignis (Event)
+ genutzt werden:
+
+
+ - Die Anweisung $EVENT wird das komplette Ereignis (Event)
+ beinhalten, z.B.
measured-temp: 21.7 (Celsius)
+
+ - $EVTPART0,$EVTPART1,$EVTPART2,etc enthalten die durch Leerzeichen
+ getrennten Teile des Events der Reihe nach (im Beispiel also
+
$EVTPART0="measured-temp:", $EVTPART1="21.7",
+ $EVTPART2="(Celsius)".
Diese Daten sind verfügbar
+ als lokale Variablen in Perl, als Umgebungs-Variablen für
+ Shell-Scripts, und werden als Text ausgetauscht in
+ FHEM-Kommandos.
+
+ - $NAME enthält den Namen des Ereignis auslösenden
+ Gerätes, z.B.
myFht
+
+
+ - Achtung: Folgende Vorgehensweise ist abgekündigt und wird in
+ einem zukünftigen Release von FHEM nicht mehr unterstützt.
+ Wenn keine der oben genannten Variablen ($NAME/$EVENT/usw.) in der
+ Anweisung gefunden wird, werden Platzhalter ersetzt.
+
+
+ - Das Zeichen
% wird ersetzt mit dem empfangenen
+ Ereignis (Event), z.B. mit on oder off oder
+ measured-temp: 21.7 (Celsius).
+
+
+ - Das Zeichen
@ wird ersetzt durch den
+ Gerätenamen.
+
+ - Um % oder @ im Text selbst benutzen zu können, müssen
+ sie verdoppelt werden (%% oder @@).
+
+ - Anstelle von
% und @, können die
+ Parameter %EVENT (funktionsgleich mit %),
+ %NAME (funktionsgleich mit @) und
+ %TYPE (enthält den Typ des Gerätes, z.B.
+ FHT) benutzt werden. Die von Leerzeichen unterbrochenen
+ Teile eines Ereignisses (Event) sind verfügbar als %EVTPART0,
+ %EVTPART1, usw. Ein einzeln stehendes % verliert seine
+ %oben beschriebene Bedeutung, falls auch nur einer dieser Parameter
+ %in der Definition auftaucht.
+
+
+
+ - Folgende spezielle Ereignisse werden für das Gerät "global"
+ erzeugt:
+
+ - INITIALIZED sobald die Initialization vollständig ist.
+ - REREADCFG nachdem die Konfiguration erneut eingelesen wurde.
+ - SAVE bevor die Konfiguration gespeichert wird.
+ - SHUTDOWN bevor FHEM heruntergefahren wird.
+ - DEFINED <devname> nach dem Definieren eines
+ Gerätes.
+ - DELETED <devname> nach dem Löschen eines
+ Gerätes.
+ - RENAMED <old> <new> nach dem Umbenennen eines
+ Gerätes.
+ - UNDEFINED <defspec> beim Auftreten einer Nachricht für
+ ein undefiniertes Gerät.
+
+
+ - Notify kann dazu benutzt werden, um Makros für eine manuelle
+ Ausführung zu speichern. Mit einem trigger Kommando können solche Makros dann
+ ausgeführt werden. Z.B.
fhem> define MyMacro notify
+ MyMacro { Log 1, "Hello"}
fhem> trigger
+ MyMacro
+
+
+
+
+
+
+
+ Set
+
+
+ Get
+
+
+ Attribute
+
+ - disable
+
+ - forwardReturnValue
+ Rückgabe der Werte eines ausgeführten Kommandos an den
+ Aufrufer. Die Voreinstellung ist 0 (ausgeschaltet), um weniger
+ Meldungen im Log zu haben.
+
+
+ - showTriggerTime
+ Zeigt den Zeitstempel der letzten Ausführung als Status an.
+ Voreinstellung ist 1 (an).
+
+
+
+ - addStateEvent
+ Das mit dem state Reading verknüpfte Event ist speziell, da das
+ dazugehörige Prefix "state: " entfernt wird, d.h. $EVENT ist nicht
+ "state: on", sondern nur "on". In manchen Fällen ist es aber
+ erwünscht ein zusätzliches Event zu bekommen, wo "state: " nicht
+ entfernt ist. Für diese Fälle sollte addStateEvent auf 1
+ gesetzt werden, die Voreinstellung ist 0 (deaktiviert).
+
+ Achtung:
+
+ - dieses Attribut muss beim Empfänger (notify, FileLog, etc)
+ gesetzt werden.
+
+ - dieses Attribut zeigt nur für solche Geräte-Events eine
+ Wirkung, die readingFnAttributes
+ unterstützen.
+
+
+
+
+
+
+
+
+
+=end html_DE
+
=cut