DevelopmentModuleAPI: Unterschied zwischen den Versionen

Version vom 15. Februar 2016, 22:02 Uhr

Bitte beachten: letztendlich entscheidend ist immer der Perl-Code, Unstimmigkeiten sollten im Fhem-Forum angemerkt (oder hier berichtigt) werden!

Please note: in the end it is always the Perl code itself that is relevant; please report errors and omissions in the fhem forum (or correct them here)!

Dieses Seite soll eine Beschreibung der für Moduleentwickler verfügbaren Funktionen enthalten, um für Modulentwickler

Wiederverwendbare Routinen leichter identifizieren zu können
Durch Wiederverwendung mehr Einheitlichkeit zu erzeugen
Aufwand zu verringern
Bei Änderungen auch betroffene Module leichter identifiziern zu können

Natürlich hat diese Seite keinen Anspruch auf Vollständigkeit und jeder ist aufgefordert mitzuarbeiten, sobald er beim Stöbern über einen Funktion stolpert, die auch andere interessieren könnte.

Command handling

AnalyzeCommand

AnalyzeCommand ermöglicht das Parsen und die Ausführung eines FHEM-Befehls, wie in FHEMWEB im Kommandoeingabefeld enthalten.

AnalyzeCommand ($cl, $cmd)

Parameter	Bedeutung
`$cl` might be undef	Devicehash für die Ausführung des Kommandos in einem spezifischen Kontext eines Devices (Quelle des Befehles z.B. für Berechtigungsprüfung)
`$cmd` mandatory	Kommandos, die ausgeführt werden sollen. Beispiel: define dummy1 dummy { Log3(undef, 1, "Hallo");}

AnalyzeCommandChain

AnalyzeCommandChain ermöglicht das Parsen und die Ausführung von FHEM-Befehlen, wie in FHEMWeb im Kommandoeingabefeld enthalten.

AnalyzeCommandChain ($cl, $cmds)

Parameter	Bedeutung
`$cl` might be undef	Devicehash für die Ausführung des Kommandos in einem spezifischen Kontext eines Devices (Quelle des Befehles z.B. für Berechtigungsprüfung)
`$cmds` mandatory	Kommandos, das ausgeführt werden soll, durch ; getrennt. Beispiel: define dummy1 dummy; list dummy1

Diverse

ReplaceSetMagic

($err, @result) = ReplaceSetMagic($hash, $nsplit, @elements)

Parameter	Bedeutung
`$hash` might be undef	Devicehash für die Ausführung des Kommandos in einem spezifischen Kontext eines Devices (Quelle des Befehles z.B. für Berechtigungsprüfung)
`$nsplit` Zahl	Begrenzung für den Split des Ergebnisstrings nach erfolgter Ersetzung (siehe elements)
`@elements` mandatory	Parameterarray mit Strings Die Elemente des übergebenen Arrays werden in einem String getrennt duch Leerzeichen zusammengefasst.

Rückgabe	Bedeutung
`$err`	Im Fehlerfall: Fehlermeldung sonst undef
`@result`	Ergebnis der Ersetzung von Readings und Perl Aufrufen im Parameterarray. Die Elemente des übergebenen Arrays werden in einem String, getrennt durch Leerzeichen, zusammengefasst und im Rückgabewert wieder in ein Array (unter Berücksichtigung von nsplit als Begrenzung für den perl-Split-Aufruf) zerlegt.

Time / Timestamp

FmtDateTimeRFC1123

$timestampGMT = FmtDateTimeRFC1123($time)

Parameter	Bedeutung
`$time` might be undef	Zeitangabe wie sie von der `time` Funktion zurückgegeben wird `Mon, 15 Feb 2016 20:52:20 GMT`

Rückgabe	Bedeutung
`$timestampGMT`	Zeitstempel GMT (Greenwich Mean Time) wie er in RFC1123 beschrieben wird. Diese werden zum Beispiel bei http verwendet. `Mon, 15 Feb 2016 20:52:20 GMT`

FmtDateTime

$timestamp = FmtDateTime($time)

Parameter	Bedeutung
`$time`	Zeitangabe wie sie von der `time` Funktion zurückgegeben wird

Rückgabe	Bedeutung
`$timestamp`	Zeitstempel in lokaler Zeitzone im Format `2016-02-16 19:34:24`

TimeNow

$timestamp = TimeNow( )

Rückgabe	Bedeutung
`$timestamp`	Zeitstempel der aktuellen Uhrzeit in lokaler Zeitzone im Format `2016-02-16 19:34:24` Benutzt FmtDateTime

Readings

Die verschiedenen Funktionen zu Readings sind hier beschrieben:

DevelopmentIntroduction und DevelopmentModuleIntro

Fehlt noch

Log3
IsDisabled
IsDummy
IsIgnored
IsIoDummy
InternalTimer
RemoveInternalTimer
configDBUsed
devspec2array
FmtTime
EvalSpecials
DoTrigger
InternalVal
ReadingsVal
ReadingsNum
ReadingsTimestamp
Value
OldValue
OldTimestamp
AttrVal
readingsBeginUpdate
readingsBulkUpdate
readingsEndUpdate
readingsSingleUpdate
computeClientArray
FileRead
FileWrite
getUniqueId
getKeyValue
setKeyValue
Debug

@@ Zeile 93: / Zeile 93: @@
 || Ergebnis der Ersetzung von Readings und Perl Aufrufen im Parameterarray. Die Elemente des übergebenen Arrays werden in einem String, getrennt durch Leerzeichen, zusammengefasst und im Rückgabewert wieder in ein Array (unter Berücksichtigung von nsplit als Begrenzung für den perl-Split-Aufruf) zerlegt.
 |}
+== Time / Timestamp ==
+=== FmtDateTimeRFC1123===
+:<code>$timestampGMT = FmtDateTimeRFC1123($time)</code>
+{| class="wikitable"
+|-
+! Parameter!! Bedeutung
+|-
+|  style="vertical-align:top" | '''<code>$time</code>'''
+''might be undef''
+|| Zeitangabe wie sie von der <code>time</code> Funktion zurückgegeben wird<br>
+<code>Mon, 15 Feb 2016 20:52:20 GMT</code>
+|}
+{| class="wikitable"
+|-
+! Rückgabe!! Bedeutung
+|-
+|  style="vertical-align:top" | '''<code>$timestampGMT </code>'''
+|| Zeitstempel GMT (Greenwich Mean Time) wie er in RFC1123 beschrieben wird. Diese werden zum Beispiel bei http verwendet.<br>
+<code>Mon, 15 Feb 2016 20:52:20 GMT</code>
+|}
+=== FmtDateTime===
+:<code>$timestamp = FmtDateTime($time)</code>
+{| class="wikitable"
+|-
+! Parameter!! Bedeutung
+|-
+|  style="vertical-align:top" | '''<code>$time</code>'''
+|| Zeitangabe wie sie von der <code>time</code> Funktion zurückgegeben wird
+|}
+{| class="wikitable"
+|-
+! Rückgabe!! Bedeutung
+|-
+|  style="vertical-align:top" | '''<code>$timestamp </code>'''
+|| Zeitstempel in lokaler Zeitzone im Format<br>
+<code>2016-02-16 19:34:24</code>
+|}
+=== TimeNow ===
+:<code>$timestamp = TimeNow( )</code>
+{| class="wikitable"
+|-
+! Rückgabe!! Bedeutung
+|-
+|  style="vertical-align:top" | '''<code>$timestamp </code>'''
+|| Zeitstempel der aktuellen Uhrzeit in lokaler Zeitzone im Format<br>
+<code>2016-02-16 19:34:24</code><br>
+Benutzt FmtDateTime
+|}
 == Readings ==
@@ Zeile 109: / Zeile 173: @@
 * configDBUsed
 * devspec2array
-* TimeNow
-* FmtDateTime
 * FmtTime
-* FmtDateTimeRFC1123
 * EvalSpecials
 * DoTrigger