DevelopmentModuleAPI - Versionsgeschichte

Sailor: /* readingsDelete */ Beispiel für das Löschen aller Readings

2026-01-14T21:14:41Z

readingsDelete: Beispiel für das Löschen aller Readings

@@ Zeile 684: / Zeile 684: @@
 || Name des Readings, welches gelöscht werden soll
 |}
 === DoTrigger ===

Torxgewinde: /* Timer */ Ergänzt, dass Lambda-Funktionen auch übergeben werden können

2025-01-23T05:30:06Z

Timer: Ergänzt, dass Lambda-Funktionen auch übergeben werden können

← Nächstältere Version		Version vom 23. Januar 2025, 07:30 Uhr
Zeile 1.070:		Zeile 1.070:
	''mandatory''		''mandatory''
	\|\| Der Name der Funktion als Zeichenkette, welche ausgeführt werden soll zum angegebenen Zeitpunkt (bspw: "MODULNAME_GetStatus")		\|\| Der Name der Funktion als Zeichenkette, welche ausgeführt werden soll zum angegebenen Zeitpunkt (bspw: "MODULNAME_GetStatus")
			Alternativ kann auch eine '''Funktionsreferenz''' übergeben werden – entweder der Funktionsname ohne Anführungszeichen oder eine Referenz auf eine anonyme Funktion.
	\|-		\|-
	\| '''<code>$arg</code>'''		\| '''<code>$arg</code>'''

Beta-User: setDisableNotifyFn ergänzt

2022-01-26T11:29:39Z

setDisableNotifyFn ergänzt

@@ Zeile 833: / Zeile 833: @@
 ''mandatory''
 || Die ''devspec'' zur Ermittlung der zu überwachenden Geräte, welche für <code>$hash</code> gesetzt werden soll (i.d.R via [[DevelopmentModuleIntro#X_Define|Define-Funktion]])
 |}

Beta-User: setNotifyDev ergänzt

2022-01-24T11:05:06Z

setNotifyDev ergänzt

@@ Zeile 781: / Zeile 781: @@
 <ul><syntaxhighlight lang="perl">
-notifyRegexpChanged($hash, $event_regexp);
+notifyRegexpChanged($hash, $event_regexp, $disableNotifyFn);
 </syntaxhighlight></ul>
 Die Funktion notifyRegexpChanged() setzt für <code>$hash</code> einen passenden Eintrag in <code>$hash->{NOTIFYDEV}</code> basierend auf dem regulären Ausdruck <code>$event_regexp</code>, welcher üblicherweise in der [[DevelopmentModuleIntro#X_Define|Define-Funktion]] als Argument übergeben wird. Dadurch wird die [[DevelopmentModuleIntro#X_Notify|Notify-Funktion]] nur für Events der entsprechenden Gerätedefinition aufgerufen.
@@ Zeile 787: / Zeile 787: @@
 Je nach dem, wie <code>$event_regexp</code> formuliert ist, setzt notifyRegexpChanged() einen Eintrag in <code>$hash->{NOTIFYDEV}</code>. Es kann durchaus vorkommen, dass kein Eintrag in NOTIFYDEV gesetzt wird, da nicht zweifelsfrei zwischen Definitionsnamen und Event unterschieden werden kann.
-'''Diese Funktion kann nur verwendet werden, wenn '''<code>$event_regexp</code>''' auf '''<code>&lt;Definitionsnamen&gt;</code>''' bzw. '''<code>&lt;Definitionsnamen&gt;:&lt;Event&gt;</code>''' matcht (Event Regexp-Syntax aus [[notify]]).'''
+'''Diese Funktion kann nur verwendet werden, wenn '''<code>$event_regexp</code>''' auf '''<code>&lt;Definitionsnamen&gt;</code>''' bzw. '''<code>&lt;Definitionsnamen&gt;:&lt;Event&gt;</code>''' matcht (Event Regexp-Syntax aus [[notify]]).''' Ansonsten kann der Eintrag in <code>$hash->{NOTIFYDEV}</code> über ''setNotifyDev()'' erfolgen.
 Parameter:
@@ Zeile 803: / Zeile 803: @@
 ''mandatory''
 || Die Regexp, welche für <code>$hash</code> gesetzt wurde (i.d.R via [[DevelopmentModuleIntro#X_Define|Define-Funktion]])
 |}

Sidey am 12. Januar 2022 um 21:25 Uhr

2022-01-12T21:25:43Z

@@ Zeile 2.182: / Zeile 2.182: @@
 Der Wert {ClientsKeepOrder}=0 bewirkt, dass eine Sortierung gemäß der Modulreihenfolge vorgenommen wird und dass Module auch über die Angabe einer Regex ausgewählt werden können.
 {| class="wikitable"
 |-

Sidey: computeClientArray und Einflussnahme in Dokumentation aufgenommen

2022-01-12T21:22:28Z

computeClientArray und Einflussnahme in Dokumentation aufgenommen

@@ Zeile 2.173: / Zeile 2.173: @@
 - configDB wird nicht verwendet<br>
 - configDB wird  verwendet
 |}

F Klee am 22. Dezember 2021 um 15:01 Uhr

2021-12-22T15:01:49Z

← Nächstältere Version		Version vom 22. Dezember 2021, 17:01 Uhr
Zeile 3:		Zeile 3:
	Please note: This list of functions is not officially maintained by all developers. So there is no guarantee for completeness and correctness. In the end it is always the Perl code itself that is relevant; please report errors and omissions in the [https://forum.fhem.de/index.php/board,80.0.html FHEM forum]!		Please note: This list of functions is not officially maintained by all developers. So there is no guarantee for completeness and correctness. In the end it is always the Perl code itself that is relevant; please report errors and omissions in the [https://forum.fhem.de/index.php/board,80.0.html FHEM forum]!
	}}		}}
	~~Dieses~~ Seite soll eine Beschreibung der für Moduleentwickler verfügbaren Funktionen enthalten, um für Modulentwickler		Diese Seite soll eine Beschreibung der für Moduleentwickler verfügbaren Funktionen enthalten, um für Modulentwickler
	* Wiederverwendbare Routinen leichter identifizieren zu können		* Wiederverwendbare Routinen leichter identifizieren zu können
	* Durch Wiederverwendung mehr Einheitlichkeit zu erzeugen		* Durch Wiederverwendung mehr Einheitlichkeit zu erzeugen

ChristophMorrison: /* ReadingsNum */

2021-10-24T19:48:05Z

ReadingsNum

← Nächstältere Version		Version vom 24. Oktober 2021, 21:48 Uhr
Zeile 1.298:		Zeile 1.298:
	$value = ReadingsNum($name, $reading, $default, $round);		$value = ReadingsNum($name, $reading, $default, $round);
	</syntaxhighlight>		</syntaxhighlight>
	Die Funktion <code>ReadingsNum</code> extrahiert den numerischen Teil des Readings <code>$reading</code> der Definition <code>$name</code> und gibt diesen zurück, wenn er existiert. Dabei werden Zeichenketten wie z.B. Einheiten eliminiert und nur die eigentliche Zahl (Ganzzahl- oder Fließkommazahl) zurückgegeben. Sollte das gewünschte Reading nicht existieren, wird <code>$default</code> zurückgegeben. Sollte das gewünschte Reading existieren, jedoch keinen numerischen Wert enthalten, wird ebenfalls <code>$default</code> zurückgegeben. Es ist möglich, den ~~Rückgabe wert~~ durch Angabe von <code>$round</code> auf <code>$round</code> Stellen zu runden. Verwendet wird hierzu die FHEM-eigene Funktion <code>[https://svn.fhem.de/trac/browser/trunk/fhem/FHEM/99_Utils.pm#L239 round]</code>; überzählige Stellen werden mit 0 aufgefüllt - round ist daher kein round im strikt mathematischen Sinne, sondern bietet zusätzlich eine Formatierung.		Die Funktion <code>ReadingsNum</code> extrahiert den numerischen Teil des Readings <code>$reading</code> der Definition <code>$name</code> und gibt diesen zurück, wenn er existiert. Dabei werden Zeichenketten wie z.B. Einheiten eliminiert und nur die eigentliche Zahl (Ganzzahl- oder Fließkommazahl) zurückgegeben. Sollte das gewünschte Reading nicht existieren, wird <code>$default</code> zurückgegeben. Sollte das gewünschte Reading existieren, jedoch keinen numerischen Wert enthalten, wird ebenfalls <code>$default</code> zurückgegeben. Es ist möglich, den Rückgabewert durch Angabe von <code>$round</code> auf <code>$round</code> Stellen zu runden. Verwendet wird hierzu die FHEM-eigene Funktion <code>[https://svn.fhem.de/trac/browser/trunk/fhem/FHEM/99_Utils.pm#L239 round]</code>; überzählige Stellen werden mit 0 aufgefüllt - round ist daher kein round im strikt mathematischen Sinne, sondern bietet zusätzlich eine Formatierung.

	==== Beispiele ====		==== Beispiele ====

Ph1959de: "source" Tag auf "syntaxhighlight" umgestellt.

2021-09-30T10:35:31Z

"source" Tag auf "syntaxhighlight" umgestellt.

← Nächstältere Version		Version vom 30. September 2021, 12:35 Uhr
Zeile 50:		Zeile 50:
	=== AnalyzeCommandChain ===		=== AnalyzeCommandChain ===
	AnalyzeCommandChain() ermöglicht die Ausführung von FHEM-Befehlsketten. Dabei werden mehrere FHEM-Kommandos durch ein Semikolon getrennt und nacheinander mittels AnalyzeCommand() ausgeführt.		AnalyzeCommandChain() ermöglicht die Ausführung von FHEM-Befehlsketten. Dabei werden mehrere FHEM-Kommandos durch ein Semikolon getrennt und nacheinander mittels AnalyzeCommand() ausgeführt.
	:<~~source~~ lang="perl">$errors = AnalyzeCommandChain ($client_hash, $cmds)</~~source~~>		:<syntaxhighlight lang="perl">$errors = AnalyzeCommandChain ($client_hash, $cmds)</syntaxhighlight>

	Parameter:		Parameter:
Zeile 121:		Zeile 121:

	=== EvalSpecials ===		=== EvalSpecials ===

	:<syntaxhighlight lang="perl">$final_cmd = EvalSpecials($cmd, %specials);</syntaxhighlight>		:<syntaxhighlight lang="perl">$final_cmd = EvalSpecials($cmd, %specials);</syntaxhighlight>
	EvalSpecials() ermöglicht die Ersetzung von Platzhaltern in FHEM-Befehlen, welche durch AnalyzeCommandChain() zur Ausführung gebracht werden sollen. Dabei werden alle Schlüssel von <code>%specials</code> in <code>$cmd</code> gesucht und durch die entsprechenden Werte aus <code>%specials</code> ersetzt.		EvalSpecials() ermöglicht die Ersetzung von Platzhaltern in FHEM-Befehlen, welche durch AnalyzeCommandChain() zur Ausführung gebracht werden sollen. Dabei werden alle Schlüssel von <code>%specials</code> in <code>$cmd</code> gesucht und durch die entsprechenden Werte aus <code>%specials</code> ersetzt.

ChristophMorrison: /* Fallstricke */ Weiteres Beispiel für Fallstrick hinzugefügt

2021-07-30T15:24:21Z

Fallstricke: Weiteres Beispiel für Fallstrick hinzugefügt

← Nächstältere Version		Version vom 30. Juli 2021, 17:24 Uhr
Zeile 1.369:		Zeile 1.369:

	# Argument "Kein Wert" isn't numeric in numeric eq (==)		# Argument "Kein Wert" isn't numeric in numeric eq (==)
	</syntaxhighlight><code>$round</code> wird direkt in den [https://perldoc.perl.org/functions/sprintf format string] in <code>[https://svn.fhem.de/trac/browser/trunk/fhem/FHEM/99_Utils.pm#L239 round]</code> übernommen und ausgewertet.<syntaxhighlight>		</syntaxhighlight><code>$round</code> wird direkt, d.h. ohne Validierung, in den [https://perldoc.perl.org/functions/sprintf format string] in <code>[https://svn.fhem.de/trac/browser/trunk/fhem/FHEM/99_Utils.pm#L239 round]</code> übernommen und ausgewertet.<syntaxhighlight lang="perl" line="1">
	# Device foo, Reading bar, Wert "123.45 °C"		# Device foo, Reading bar, Wert "123.45 °C"

	~~# Lese aus dem Reading baz, nicht bar, wird fehlschlagen~~
	ReadingsNum(q(foo), q(bar), q(Kein Wert), q{%%p});		ReadingsNum(q(foo), q(bar), q(Kein Wert), q{%%p});
			# Evaluiert %p zu einer Speicheradresse, z.B. 7fa1fb03d738f

	# ~~Evaluiert %p zu einer Speicheradresse, z.B. 7fa1fb03d738f~~		ReadingsNum(q(foo), q(bar), q(Kein Wert), q(foo));
			# = 123oof
	</syntaxhighlight>		</syntaxhighlight>