From f66f2a1787f41754cbaefc743d6c116a4ee5c022 Mon Sep 17 00:00:00 2001
From: rudolfkoenig <>
Date: Fri, 2 Apr 2021 16:56:29 +0000
Subject: [PATCH] 91_notify.pm: move perlSyntaxCheck doc to commandref_frame
(Forum #119999)
git-svn-id: https://svn.fhem.de/fhem/trunk@24129 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
fhem/FHEM/90_at.pm | 105 +++++++++--------------------
fhem/FHEM/91_notify.pm | 25 +++----
fhem/docs/commandref_frame.html | 41 +++++++++--
fhem/docs/commandref_frame_DE.html | 43 ++++++++++--
4 files changed, 110 insertions(+), 104 deletions(-)
diff --git a/fhem/FHEM/90_at.pm b/fhem/FHEM/90_at.pm
index 930a6f772..50a9b6ce5 100644
--- a/fhem/FHEM/90_at.pm
+++ b/fhem/FHEM/90_at.pm
@@ -438,14 +438,14 @@ at_ultimo(;$$$)
=item helper
=begin html
-
+
at
Start an arbitrary FHEM command at a later time.
-
+
Define
define <name> at [<timespec>|<datespec>]
@@ -540,15 +540,16 @@ at_ultimo(;$$$)
-
+
Set
-
+
- modifyTimeSpec <timespec>
Change the execution time. Note: the N-times repetition is ignored.
It is intended to be used in combination with
webCmd, for an easier modification from the room
overview in FHEMWEB.
+
- inactive
Inactivates the current device. Note the slight difference to the
disable attribute: using set inactive the state is automatically saved
@@ -557,11 +558,14 @@ at_ultimo(;$$$)
deactivate the at.
The concurrent setting of the disable attribute is not recommended.
+
- active
Activates the current device (see inactive).
+
- execNow
Execute the command associated with the at. The execution of a relative
at is not affected by this command.
+
- skip_next
skip the next execution. Just like the attribute with the same name,
but better suited for webCmd.
@@ -569,15 +573,13 @@ at_ultimo(;$$$)
-
-
-
+
Get
-
+
Attributes
-
+
- alignTime
Applies only to relative at definitions: adjust the time of the next
command execution so, that it will also be executed at the desired
@@ -591,7 +593,7 @@ at_ultimo(;$$$)
-
+
- computeAfterInit
If perlfunc() in the timespec relies on some other/dummy readings, then
it will return a wrong time upon FHEM start, as the at define is
@@ -599,34 +601,10 @@ at_ultimo(;$$$)
FHEM will recompute timespec after the initialization is finished.
-
- - disable
- Can be applied to at/watchdog/notify/FileLog devices.
- Disables the corresponding at/notify or FileLog device. Note:
- If applied to an at, the command will not be executed,
- but the next time will be computed.
+ - disable
+ - disabledForIntervals
-
- - disabledForIntervals HH:MM-HH:MM HH:MM-HH:MM ...
- Space separated list of HH:MM or D@HH:MM tupels. If the current time is
- between the two time specifications, the current device is disabled.
- Instead of HH:MM you can also specify HH or HH:MM:SS. D is the day of
- the week, with 0 indicating Sunday and 3 indicating Wednesday.
- Specifying the day for the "from" part does _not_ specify it for the
- "to" part, i.e. 1@00-24 will disable from monday to the end of the
- week, but not on sunday (as 1@00 is greater than any time on sunday).
- To specify an interval spawning midnight, you have to specify two
- intervals, e.g.:
-
- 23:00-24:00 00:00-01:00
-
- If parts of the attribute value are enclosed in {}, they are evaluated:
-
- {sunset_abs()}-24 {sunrise_abs()}-08
-
-
-
-
+
- skip_next
Used for at commands: skip the execution of the command the next
time.
@@ -641,14 +619,14 @@ at_ultimo(;$$$)
=begin html_DE
-
+
at
Startet einen beliebigen FHEM Befehl zu einem späteren Zeitpunkt.
-
+
Define
define <name> at [<timespec>|<datespec>]
@@ -746,16 +724,17 @@ at_ultimo(;$$$)
-
+
Set
-
+
- modifyTimeSpec <timespec>
Ändert die Ausführungszeit. Achtung: die N-malige
Wiederholungseinstellung wird ignoriert. Gedacht zur einfacheren
Modifikation im FHEMWEB Raumübersicht, dazu muss man
modifyTimeSpec in webCmd spezifizieren.
+
- inactive
Deaktiviert das entsprechende Gerät. Beachte den leichten
semantischen Unterschied zum disable Attribut: "set inactive"
@@ -765,13 +744,16 @@ at_ultimo(;$$$)
deaktivieren.
Das gleichzeitige Verwenden des disable Attributes wird nicht empfohlen.
+
- active
Aktiviert das entsprechende Gerät, siehe inactive.
+
- execNow
Führt das mit dem at spezifizierte Befehl aus. Beeinflußt
nicht die Ausführungszeiten relativer Spezifikationen.
+
- skip_next
genau wie der gleichnamige Attribut, verhindert die nächste
Ausführung. Als set Befehl, eignet sich besser für webCmd.
@@ -779,13 +761,13 @@ at_ultimo(;$$$)
-
+
Get
-
+
Attribute
-
+
- alignTime
Nur für relative Definitionen: Stellt den Zeitpunkt der
Ausführung des Befehls so, dass er auch zur alignTime
@@ -800,7 +782,7 @@ at_ultimo(;$$$)
-
+
- computeAfterInit
Falls perlfunc() im timespec Readings or Statusinformationen
benögt, dann wird sie eine falsche Zeit beim FHEM-Start
@@ -809,37 +791,10 @@ at_ultimo(;$$$)
Readings erneut ausgeführt. (Siehe Forum #56706)
-
- - disable
- Deaktiviert das entsprechende Gerät.
- Hinweis: Wenn angewendet auf ein at, dann wird der
- Befehl nicht ausgeführt, jedoch die nächste
- Ausführungszeit berechnet.
+ - disable
+ - disabledForIntervals
-
- - disabledForIntervals HH:MM-HH:MM HH:MM-HH:MM ...
- Das Argument ist eine Leerzeichengetrennte Liste von Minuszeichen-
- getrennten HH:MM oder D@HH:MM Paaren. Falls die aktuelle Uhrzeit
- zwischen diesen Werten fällt, dann wird die Ausführung, wie
- beim disable, ausgesetzt. Statt HH:MM kann man auch HH oder HH:MM:SS
- angeben. D ist der Tag der Woche, mit 0 als Sonntag and 3 als
- Mittwoch. Die Angabe des Wochentags für den "von" Wert impliziert
- _nicht_ den gleichen Tag für den "bis" Wert, z.Bsp. deaktiviert
- 1@00-24 die Asführung von Montag bis Ende der Woche, aber nicht
- Sonntag (da alle Zeitangaben am Montag vor 1@00 liegen).
- Um einen Intervall um Mitternacht zu spezifizieren, muss man
- zwei einzelne angeben, z.Bsp.:
-
- 23:00-24:00 00:00-01:00
-
- Falls Teile des Wertes in {} eingeschlossen sind, dann werden sie als
- ein Perl Ausdruck ausgewertet:
-
- {sunset_abs()}-24 {sunrise_abs()}-08
-
-
-
-
+
- skip_next
Wird bei at Befehlen verwendet um die nächste Ausführung zu
überspringen
diff --git a/fhem/FHEM/91_notify.pm b/fhem/FHEM/91_notify.pm
index f9fbe60de..ca6bc22a3 100644
--- a/fhem/FHEM/91_notify.pm
+++ b/fhem/FHEM/91_notify.pm
@@ -561,23 +561,19 @@ END
argument. The syntax is the same as for the original regexp.
+ - perlSyntaxCheck
+
- readLog
Execute the notify for messages appearing in the FHEM Log. The device
- in this case is set to the notify itself, e.g. checking for the startup
- message looks like:
+ in this case is set to the notify itself, e.g. checking for the
+ startup message looks like:
define n notify n:.*Server.started.* { Log 1, "Really" }
attr n readLog
-
- - perlSyntaxCheck
- by setting the global attribute perlSyntaxCheck, a syntax check
- will be executed upon definition or modification, if the command is
- perl and FHEM is already started.
-
@@ -792,10 +788,12 @@ END
- ignoreRegexp regexp
Es ist nicht immer einfach ein Regexp zu bauen, was etwas _nicht_
matcht. Dieses Attribut hilft in diesen Fällen: das Event wird
- ignoriert, falls es den angegebenen Regexp matcht. Syntax ist gleich wie
- in der Definition.
+ ignoriert, falls es den angegebenen Regexp matcht. Syntax ist gleich
+ wie in der Definition.
+ - perlSyntaxCheck
+
- readLog
Das notify wird für Meldungen, die im FHEM-Log erscheinen,
@@ -808,13 +806,6 @@ END
-
- perlSyntaxCheck
- nach setzen des global Attributes perlSyntaxCheck wird eine
- Syntax-Prüfung der Anweisung durchgeführt bei jeder
- Änderung (define oder modify), falls die Anweisung Perl ist, und
- FHEM bereits gestartet ist.
-
diff --git a/fhem/docs/commandref_frame.html b/fhem/docs/commandref_frame.html
index cf520064a..97eb60e3a 100644
--- a/fhem/docs/commandref_frame.html
+++ b/fhem/docs/commandref_frame.html
@@ -679,12 +679,34 @@ The following local attributes are used by a wider range of devices:
for this type of device. The attribute IODev needs to be used only if
you attached more than one physical device capable of receiving signals
for this logical device.
- Special: attribute disable can be toggled
- Attribute "disable" can be toggled by issuing the following command:
-
- attr <device> disable toggle
-
- Attribute "disable" must be offered by the corresponding module
+
+
+ disable
+ Disables the corresponding device. Note: it can be toggled by issuing the following command:
+
+ attr <device> disable toggle
+
+
+
+ disabledForIntervals HH:MM-HH:MM HH:MM-HH:MM ...
+ Space separated list of HH:MM or D@HH:MM tupels. If the current time is
+ between the two time specifications, the current device is disabled.
+ Instead of HH:MM you can also specify HH or HH:MM:SS. D is the day of
+ the week, with 0 indicating Sunday and 3 indicating Wednesday.
+ Specifying the day for the "from" part does _not_ specify it for the
+ "to" part, i.e. 1@00-24 will disable from monday to the end of the
+ week, but not on sunday (as 1@00 is greater than any time on sunday).
+ To specify an interval spawning midnight, you have to specify two
+ intervals, e.g.:
+
+ 23:00-24:00 00:00-01:00
+
+ If parts of the attribute value are enclosed in {}, they are evaluated:
+
+ {sunset_abs()}-24 {sunrise_abs()}-08
+
+
+
@@ -1700,6 +1722,13 @@ The following local attributes are used by a wider range of devices:
Windows.
+
+ perlSyntaxCheck
+ by setting the global attribute perlSyntaxCheck, a syntax check
+ will be executed upon definition or modification, if the command is
+ perl and FHEM is already started.
+
+
pidfilename
Write the process id of the perl process to the specified file. The
diff --git a/fhem/docs/commandref_frame_DE.html b/fhem/docs/commandref_frame_DE.html
index 63df936fe..b80c5eaec 100644
--- a/fhem/docs/commandref_frame_DE.html
+++ b/fhem/docs/commandref_frame_DE.html
@@ -688,12 +688,36 @@ Die folgenden lokalen Attribute werden von mehreren Geräten verwendet:
Device fähig ist, Signale von diesem logischen Device zu empfangen.
- Attribut "disable" umschalten
- Das Attribut "disable" kann, sofern vom Gerätemodul bereitgestellt,
- mit folgendem Befehl einfach umgeschaltet werden:
-
- attr <device> disable toggle
-
+
+ disable
+ Deaktiviert das entsprechende Gerät.
+ Sie mit folgendem Befehl einfach umgeschaltet werden:
+ attr <device> disable toggle
+
+
+
+ disabledForIntervals HH:MM-HH:MM HH:MM-HH:MM ...
+ Das Argument ist eine Leerzeichengetrennte Liste von Minuszeichen-
+ getrennten HH:MM oder D@HH:MM Paaren. Falls die aktuelle Uhrzeit
+ zwischen diesen Werten fällt, dann wird die Ausführung, wie
+ beim disable, ausgesetzt. Statt HH:MM kann man auch HH oder HH:MM:SS
+ angeben. D ist der Tag der Woche, mit 0 als Sonntag and 3 als
+ Mittwoch. Die Angabe des Wochentags für den "von" Wert impliziert
+ _nicht_ den gleichen Tag für den "bis" Wert, z.Bsp. deaktiviert
+ 1@00-24 die Asführung von Montag bis Ende der Woche, aber nicht
+ Sonntag (da alle Zeitangaben am Montag vor 1@00 liegen).
+ Um einen Intervall um Mitternacht zu spezifizieren, muss man
+ zwei einzelne angeben, z.Bsp.:
+
+ 23:00-24:00 00:00-01:00
+
+ Falls Teile des Wertes in {} eingeschlossen sind, dann werden sie als
+ ein Perl Ausdruck ausgewertet:
+
+ {sunset_abs()}-24 {sunrise_abs()}-08
+
+
+
@@ -1812,6 +1836,13 @@ Die folgenden lokalen Attribute werden von mehreren Geräten verwendet:
notwendig, und wid fuer Windows automatisch gesetzt.
+
+ perlSyntaxCheck
+ nach setzen des global Attributes perlSyntaxCheck wird eine
+ Syntax-Prüfung der Anweisung durchgeführt bei jeder
+ Änderung (define oder modify), falls die Anweisung Perl ist, und
+ FHEM bereits gestartet ist.
+
pidfilename
Schreibt die PERL Prozess-ID in die angegebene Datei. Der Server