DevelopmentModuleIntro - Versionsgeschichte

Sailor: /* Readings */

2024-01-03T11:26:53Z

Readings

@@ Zeile 223: / Zeile 223: @@
 <code>CommandDeleteReading()</code> bzw. <code>deletereading</code> ist eher fuer den Endbenutzer und seine userReadings gedacht, und macht bei den Modulen die unnoetige Schleife ueber [[DevelopmentModuleAPI#devspec2array|devspec2array()]]. Wenn der Modulautor beim Aufruf auch <code>$cl</code> weitergibt, und der Anwender meint, dieses Geraet auf blacklist setzen zu muessen, dann kann das Modul sein eigenes Reading nicht entfernen, und das ist kontraproduktiv.
 }}
 == Events ==

Siggi: Copy&Paste Fehler: Argumentnamen Statt Kommandoname in entsprechenden Meldungen

2023-01-12T22:14:50Z

Copy&Paste Fehler: Argumentnamen Statt Kommandoname in entsprechenden Meldungen

← Nächstältere Version		Version vom 13. Januar 2023, 00:14 Uhr
Zeile 685:		Zeile 685:
	else		else
	{		{
	return "Unknown value $args[0] for $cmd, choose one of ~~status power~~";		return "Unknown value $args[0] for $cmd, choose one of up down";
	}		}
	}		}
Zeile 700:		Zeile 700:
	else		else
	{		{
	return "Unknown value $args[0] for $cmd, choose one of ~~status power~~";		return "Unknown value $args[0] for $cmd, choose one of on off";
	}		}
	}		}

Sidey: 98_Hello aktualisiert, Referenz auf Template Repository auf Github hinterlegt

2023-01-04T18:18:03Z

98_Hello aktualisiert, Referenz auf Template Repository auf Github hinterlegt

Änderungen zeigen

Sidey: Initalize Funktion überarbeitet (coderefs anstelle von Funktionsnamen)

2023-01-04T18:09:49Z

Initalize Funktion überarbeitet (coderefs anstelle von Funktionsnamen)

← Nächstältere Version		Version vom 4. Januar 2023, 20:09 Uhr
Zeile 2.018:		Zeile 2.018:
	98_Hello.pm		98_Hello.pm

	<syntaxhighlight lang="perl">		<syntaxhighlight lang="perl" line="1">
	package main;		package main;
	use strict;		use strict;
Zeile 2.029:		Zeile 2.029:
	);		);

	sub Hello_Initialize~~($)~~ {		sub Hello_Initialize {
	my ($hash) = @_;		my ($hash) = @_;

	$hash->{DefFn} = 'Hello_Define';		$hash->{DefFn} = \&Hello_Define;
	$hash->{UndefFn} = 'Hello_Undef';		$hash->{UndefFn} = \&Hello_Undef;
	$hash->{SetFn} = 'Hello_Set';		$hash->{SetFn} = \&Hello_Set;
	$hash->{GetFn} = 'Hello_Get';		$hash->{GetFn} = \&Hello_Get;
	$hash->{AttrFn} = ~~'Hello_Attr'~~;		$hash->{AttrFn} = \&ello_Attr;
	$hash->{ReadFn} = 'Hello_Read';		$hash->{ReadFn} = \&Hello_Read;

	$hash->{AttrList} =		$hash->{AttrList} =

Wivisk: /* X_Attr */ Code Beispiel Konsistente Variablen

2022-02-04T19:01:19Z

X_Attr: Code Beispiel Konsistente Variablen

← Nächstältere Version		Version vom 4. Februar 2022, 21:01 Uhr
Zeile 880:		Zeile 880:
	sub X_Attr($$$$)		sub X_Attr($$$$)
	{		{
	my ( $cmd, $name, $~~attrName~~, $~~attrValue~~ ) = @_;		my ( $cmd, $name, $aName, $aValue ) = @_;

	# $cmd - Vorgangsart - kann die Werte "del" (löschen) oder "set" (setzen) annehmen		# $cmd - Vorgangsart - kann die Werte "del" (löschen) oder "set" (setzen) annehmen
	# $name - Gerätename		# $name - Gerätename
	# $~~attrName~~/$~~attrValue~~ sind Attribut-Name und Attribut-Wert		# $aName/$aValue sind Attribut-Name und Attribut-Wert

	if ($cmd eq "set") {		if ($cmd eq "set") {
	if ($aName eq "Regex") {		if ($aName eq "Regex") {
	eval { qr/$~~aVal~~/ };		eval { qr/$aValue/ };
	if ($@) {		if ($@) {
	Log3 $name, 3, "X ($name) - Invalid regex in attr $name $aName $~~aVal~~: $@";		Log3 $name, 3, "X ($name) - Invalid regex in attr $name $aName $aValue: $@";
	return "Invalid Regex $~~aVal~~: $@";		return "Invalid Regex $aValue: $@";
	}		}
	}		}
Zeile 923:		Zeile 923:
	addToDevAttrList($name, $aName);		addToDevAttrList($name, $aName);
	</syntaxhighlight>		</syntaxhighlight>


	==== X_Read ====		==== X_Read ====

Beta-User: setNotifyDev ergänzt

2022-01-24T14:21:04Z

setNotifyDev ergänzt

← Nächstältere Version		Version vom 24. Januar 2022, 16:21 Uhr
Zeile 1.056:		Zeile 1.056:
	</syntaxhighlight>		</syntaxhighlight>

	Dies schont insbesondere bei grossen Installationen Ressourcen, da die Notify-Funktion nicht sämtliche Events, sondern nur noch Events der gewünschten Definitionen erhält. Dadurch erfolgen deutlich weniger Aufrufe der Notify-Funktion, was Systemressourcen schont.		Dies schont insbesondere bei grossen Installationen Ressourcen, da die Notify-Funktion nicht sämtliche Events, sondern nur noch Events der gewünschten Definitionen erhält. Dadurch erfolgen deutlich weniger Aufrufe der Notify-Funktion, was Systemressourcen schont. Statt den Filter ''NOTIFYDEV'' direkt zu setzen, kann auch [[DevelopmentModuleAPI#setNotifyDev\|setNotifyDev()]] aufgerufen werden. Letzteres ist v.a. dann zu empfehlen, wenn Änderungen zur Laufzeit erfolgen sollen.

	Sofern in der [[#X_Define\|Define-Funktion]] eine Regexp als Argument übergeben wird, die ähnlich wie beim Modul [[notify]] auf Events wie <code><Definitionsname></code> bzw. <code><Definitionsname>:<Event></code> reagiert, so sollte man in der Define-Funktion die Funktion [[DevelopmentModuleAPI#notifyRegexpChanged\|notifyRegexpChanged()]] verwenden. Diese versucht einen passenden Eintrag für <code>$hash->{NOTIFYDEV}</code> basierend auf der übergebenen Regexp zu setzen, sofern dies möglich ist.		Sofern in der [[#X_Define\|Define-Funktion]] eine Regexp als Argument übergeben wird, die ähnlich wie beim Modul [[notify]] auf Events wie <code><Definitionsname></code> bzw. <code><Definitionsname>:<Event></code> reagiert, so sollte man in der Define-Funktion die Funktion [[DevelopmentModuleAPI#notifyRegexpChanged\|notifyRegexpChanged()]] verwenden. Diese versucht einen passenden Eintrag für <code>$hash->{NOTIFYDEV}</code> basierend auf der übergebenen Regexp zu setzen, sofern dies möglich ist.

Sidey: /* Die Client-Liste */ Internal ClientsKeepOrder ergänzt

2022-01-12T21:34:12Z

Die Client-Liste: Internal ClientsKeepOrder ergänzt

← Nächstältere Version		Version vom 12. Januar 2022, 23:34 Uhr
Zeile 1.768:		Zeile 1.768:
	...		...
	$hash->{Clients} = "CUL_HM";		$hash->{Clients} = "CUL_HM";

			# ggf.
			$hash->{ClientsKeepOrder} = 1
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	In vielen Modulen, welche nach dem zweistufigem Konzept arbeiten, beginnt und endet die Client-Liste mit einem Doppelpunkt. Dies ist ein historisches Überbleibsel, da der Prüfmechanismus die Client-Liste früher auf das Vorhandensein von <code>'''<u><font color="red">:</font></u>'''<Modulname>'''<u><font color="red">:</font></u>'''</code> prüfte. Dies ist nun nicht mehr notwendig. Die einzelnen Modulnamen müssen lediglich durch einen Doppelpunkt getrennt werden.		In vielen Modulen, welche nach dem zweistufigem Konzept arbeiten, beginnt und endet die Client-Liste mit einem Doppelpunkt. Dies ist ein historisches Überbleibsel, da der Prüfmechanismus die Client-Liste früher auf das Vorhandensein von <code>'''<u><font color="red">:</font></u>'''<Modulname>'''<u><font color="red">:</font></u>'''</code> prüfte. Dies ist nun nicht mehr notwendig. Die einzelnen Modulnamen müssen lediglich durch einen Doppelpunkt getrennt werden.

			Wird das Internal "ClientsKeepOrder" auf 1 gesetzt, können in "Clients" keine regulären Ausdrücke mehr angegeben werden. Dies hat einen erheblichen Einfluss, auf die Verarbeitungsdauer und sollte in Betracht gezogen werden.

	=== Die Match-Liste ===		=== Die Match-Liste ===

Beta-User: "id"-Syntax

2021-07-12T13:09:41Z

"id"-Syntax

← Nächstältere Version		Version vom 12. Juli 2021, 15:09 Uhr
Zeile 2.116:		Zeile 2.116:
	=begin html		=begin html

	<a ~~name~~="Hello"></a>		<a id="Hello"></a>
	<h3>Hello</h3>		<h3>Hello</h3>
	<ul>		<ul>
Zeile 2.124:		Zeile 2.124:
	in-depth instruction to your first module.		in-depth instruction to your first module.
	<br><br>		<br><br>
	<a ~~name~~="~~Hellodefine~~"></a>		<a id="Hello-define"></a>
	<b>Define</b>		<b>Define</b>
	<ul>		<ul>
Zeile 2.137:		Zeile 2.137:
	<br>		<br>

	<a ~~name~~="~~Helloset~~"></a>		<a id="Hello-set"></a>
	<b>Set</b><br>		<b>Set</b><br>
	<ul>		<ul>
Zeile 2.158:		Zeile 2.158:
	<br>		<br>

	<a ~~name~~="~~Helloget~~"></a>		<a id="Hello-get"></a>
	<b>Get</b><br>		<b>Get</b><br>
	<ul>		<ul>
Zeile 2.170:		Zeile 2.170:
	<br>		<br>

	<a ~~name~~="~~Helloattr~~"></a>		<a id="Hello-attr"></a>
	<b>Attributes</b>		<b>Attributes</b>
	<ul>		<ul>

Ph1959de: ohne "lang=" auf

 umgestellt

2021-03-16T11:07:50Z

<syntaxhighlight> ohne "lang=" auf <pre> umgestellt

← Nächstältere Version		Version vom 16. März 2021, 13:07 Uhr
Zeile 1:		Zeile 1:
	{{Hinweis\|Dieser Text ist in Arbeit und muss noch an einigen Stellen ergänzt werden. }}		{{Hinweis\|Dieser Text ist in Arbeit und muss noch an einigen Stellen ergänzt werden. }}


	== Einleitung ==		== Einleitung ==

	Um neue Geräte, Dienste, o.ä. in FHEM verfügbar zu machen, kann man ein eigenes Modul in Perl schreiben. Ein Modul wird in FHEM automatisch geladen, wenn ein entsprechendes Device in FHEM definiert wird. Das Modul ermöglicht eine spezifische Kommunikation mit einem physikalischen Gerät, stellt Ergebnisse ("Readings") und Events innerhalb von FHEM zur Verfügung und erlaubt es, das Gerät mit "Set"-/"Get"-Befehlen zu beeinflussen. Dieser Artikel soll den Einstieg in die Entwicklung eigener Module erleichtern.		Um neue Geräte, Dienste, o.ä. in FHEM verfügbar zu machen, kann man ein eigenes Modul in Perl schreiben. Ein Modul wird in FHEM automatisch geladen, wenn ein entsprechendes Device in FHEM definiert wird. Das Modul ermöglicht eine spezifische Kommunikation mit einem physikalischen Gerät, stellt Ergebnisse ("Readings") und Events innerhalb von FHEM zur Verfügung und erlaubt es, das Gerät mit "Set"-/"Get"-Befehlen zu beeinflussen. Dieser Artikel soll den Einstieg in die Entwicklung eigener Module erleichtern.

Zeile 1.742:		Zeile 1.739:
	Eine Client-Liste ist eine Zeichenkette, welche aus allen logischen Modulnamen besteht. Die einzelnen Namen werden durch einen Doppelpunkt getrennt. Anstatt kompletter Modulnamen können auch reguläre Ausdrücke verwendet werden, die auf mehrere Modulnamen passen (z.B. <code>CUL_.*</code> um die logischen Module CUL_HM, CUL_MAX, etc. zu verwenden).		Eine Client-Liste ist eine Zeichenkette, welche aus allen logischen Modulnamen besteht. Die einzelnen Namen werden durch einen Doppelpunkt getrennt. Anstatt kompletter Modulnamen können auch reguläre Ausdrücke verwendet werden, die auf mehrere Modulnamen passen (z.B. <code>CUL_.*</code> um die logischen Module CUL_HM, CUL_MAX, etc. zu verwenden).

	Bsp.: Die Client-Liste von dem Modul CUL lautet daher wie folgt:<~~syntaxhighlight~~>		Bsp.: Die Client-Liste von dem Modul CUL lautet daher wie folgt:
			<pre>
	FS20:FHT.*:KS300:USF1000:BS:HMS:CUL_EM:CUL_WS:CUL_FHTTK:CUL_HOERMANN:ESA2000:CUL_IR:CUL_TX:Revolt:IT:UNIRoll:SOMFY:STACKABLE_CC:CUL_RFR:CUL_TCM97001:CUL_REDIRECT		FS20:FHT.*:KS300:USF1000:BS:HMS:CUL_EM:CUL_WS:CUL_FHTTK:CUL_HOERMANN:ESA2000:CUL_IR:CUL_TX:Revolt:IT:UNIRoll:SOMFY:STACKABLE_CC:CUL_RFR:CUL_TCM97001:CUL_REDIRECT
	</~~syntaxhighlight~~>Alle hier aufgelisteten Module können über das Modul CUL Daten empfangen bzw. senden.		</pre>
			Alle hier aufgelisteten Module können über das Modul CUL Daten empfangen bzw. senden.

	Die Client-Liste hat generell folgende Funktion:		Die Client-Liste hat generell folgende Funktion:

Pahenning: /* X_Rename */

2020-11-30T16:17:37Z

X_Rename

← Nächstältere Version		Version vom 30. November 2020, 18:17 Uhr
Zeile 1.111:		Zeile 1.111:
	my $new_index = "Module_X_".$new_name."_data";		my $new_index = "Module_X_".$new_name."_data";

	my ($err, $~~data~~) = getKeyValue($old_index);		my ($err, $old_pwd) = getKeyValue($old_index);
	return undef unless(defined($old_pwd));		return undef unless(defined($old_pwd));

	setKeyValue($new_index, $~~data~~);		setKeyValue($new_index, $old_pwd);
	setKeyValue($old_index, undef);		setKeyValue($old_index, undef);
	}		}