AttrTemplate - Versionsgeschichte

Beta-User: /* Einführung */

2024-06-26T13:56:59Z

Einführung

← Nächstältere Version		Version vom 26. Juni 2024, 15:56 Uhr
Zeile 21:		Zeile 21:
	* in der Detailansicht der Geräte über das Dropdownfeld ein ''template'' ausgewählt werden. Nun erhält man unmittelbar unter dem ''set''-Befehl ebenfalls entsprechende weitere Informationen sowie den Code des ''template'' angezeigt, der bei Drücken auf ''set'' ausgeführt wird.		* in der Detailansicht der Geräte über das Dropdownfeld ein ''template'' ausgewählt werden. Nun erhält man unmittelbar unter dem ''set''-Befehl ebenfalls entsprechende weitere Informationen sowie den Code des ''template'' angezeigt, der bei Drücken auf ''set'' ausgeführt wird.
	Hat man ein passendes ''template'' gefunden, wird mit <code>set <Device-Name> attrTemplate <template_name></code> angewendet, wodurch die entsprechenden, in dem ''template'' hinterlegten Kommandos ausgeführt werden.		Hat man ein passendes ''template'' gefunden, wird mit <code>set <Device-Name> attrTemplate <template_name></code> angewendet, wodurch die entsprechenden, in dem ''template'' hinterlegten Kommandos ausgeführt werden.

			{{Hinweis\|Vor allem, wenn man ''attrTemplate'' für die Konfiguration von [[MQTT2_DEVICE]] verwendet, sollte man die '''default'''-Einstellungen für die Topic-Strukturen etc. nicht am Gerät ändern, da andernfalls die Automatismen ggf. nicht greifen und z.B. passende attrTemplate für das Device gar nicht angezeigt werden.}}

	== Syntax ==		== Syntax ==

Beta-User: /* Syntax */ pardefault ergänzt

2023-01-31T06:38:06Z

Syntax: pardefault ergänzt

← Nächstältere Version		Version vom 31. Januar 2023, 08:38 Uhr
Zeile 33:		Zeile 33:
	** '''option:''' Syntax entspricht prereq, wird jedoch beim Einlesen des template Files ausgeführt. Falls nicht wahr ist, werden die darauffolgenden Zeilen des Template nicht ausgeführt. Ist für sowas wie "setze zusätzlich Attribut XY falls die Installation HomeAssistant kennt" gedacht.		** '''option:''' Syntax entspricht prereq, wird jedoch beim Einlesen des template Files ausgeführt. Falls nicht wahr ist, werden die darauffolgenden Zeilen des Template nicht ausgeführt. Ist für sowas wie "setze zusätzlich Attribut XY falls die Installation HomeAssistant kennt" gedacht.
	** '''par:''' kann mehrfach vorkommen, Syntax: <code>par:<ParameterName>;<Kommentar>;<Perl-Code></code>. ''Perl-Code'' versucht den Wert zu finden, falls nicht möglich (''return undef''), wird ein Dialog mit "Replace" angezeigt (bzw. Usage:... im telnet). ''ParameterName'' wird in jeder Befehlzeile ersetzt mit dem Wert. Zusätzlich: ''DEVICE'' wird mit dem Namen des Gerätes ersetzt, wird ''DEVICE'' (z.B. für Modulnamen) als Text benötigt, muß es ''escaped'' werden (z.B. MQTT2_\DEVICE).		** '''par:''' kann mehrfach vorkommen, Syntax: <code>par:<ParameterName>;<Kommentar>;<Perl-Code></code>. ''Perl-Code'' versucht den Wert zu finden, falls nicht möglich (''return undef''), wird ein Dialog mit "Replace" angezeigt (bzw. Usage:... im telnet). ''ParameterName'' wird in jeder Befehlzeile ersetzt mit dem Wert. Zusätzlich: ''DEVICE'' wird mit dem Namen des Gerätes ersetzt, wird ''DEVICE'' (z.B. für Modulnamen) als Text benötigt, muß es ''escaped'' werden (z.B. MQTT2_\DEVICE).
			** '''pardefault:''' Wie '''par:''', allerdings wird ein ggf. ermittelter Wert nicht automatisch übernommen, sondern als Vorgabe in einem Dialogfeld zur Bestätigung (bzw. Änderung) durch den User angezeigt.
	** '''desc:''' Kommentar fuer <code>set attrTemplate help ?</code>. Die letzte Zeile mit # vor ''name:'' wird als ''desc:'' interpretiert, falls kein ''desc:'' vorhanden ist.		** '''desc:''' Kommentar fuer <code>set attrTemplate help ?</code>. Die letzte Zeile mit # vor ''name:'' wird als ''desc:'' interpretiert, falls kein ''desc:'' vorhanden ist.
	** '''farewell:''' wird zum Schluss als Dialog (oder Text in telnet) angezeigt, falls beim Anwenden der Befehle kein Fehler aufgetreten ist.		** '''farewell:''' wird zum Schluss als Dialog (oder Text in telnet) angezeigt, falls beim Anwenden der Befehle kein Fehler aufgetreten ist.

Beta-User: Linux-Zeilenumbruch

2022-01-22T18:17:41Z

Linux-Zeilenumbruch

← Nächstältere Version		Version vom 22. Januar 2022, 20:17 Uhr
Zeile 40:		Zeile 40:

	==Eigene Templates entwickeln==		==Eigene Templates entwickeln==
	Wer plant, mehrere gleichartige Geräte anzulegen, aber andere Einstellungen zu wählen, als sie in den vorhandenen Templates enthalten sind, kann hierfür ebenfalls die attrTemplate-Funktion mit eigenen Templates nutzen. Hierfür können die vorhandenen Templates der im Unterverzeichnis ''fhem/FHEM/lib/AttrTemplate'' zu findenden Dateien als Basis dienen. Ihre Templates speichern Sie einfach als neue Datei mit der Endung ''.template'' im selben Verzeichnis und lesen diese mit <code>{ AttrTemplate_Initialize() }</code> neu ein. Danach können Sie diese direkt verwenden.		Wer plant, mehrere gleichartige Geräte anzulegen, aber andere Einstellungen zu wählen, als sie in den vorhandenen Templates enthalten sind, kann hierfür ebenfalls die attrTemplate-Funktion mit eigenen Templates nutzen. Hierfür können die vorhandenen Templates der im Unterverzeichnis ''fhem/FHEM/lib/AttrTemplate'' zu findenden Dateien als Basis dienen. Ihre Templates speichern Sie einfach als neue Datei mit der Endung ''.template'' im selben Verzeichnis (auf Linux-konforme Zeilenumbrüche achten) und lesen diese mit <code>{ AttrTemplate_Initialize() }</code> neu ein. Danach können Sie diese direkt verwenden.

	Haben Sie ein Template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag im entsprechenden Forenbereichen, für manche Module existieren auch spezielle Threads (siehe Linkliste unten)		Haben Sie ein Template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag im entsprechenden Forenbereichen, für manche Module existieren auch spezielle Threads (siehe Linkliste unten)

Beta-User: Syntax: loop ergänzt

2022-01-12T08:40:55Z

Syntax: loop ergänzt

← Nächstältere Version		Version vom 12. Januar 2022, 10:40 Uhr
Zeile 36:		Zeile 36:
	** '''farewell:''' wird zum Schluss als Dialog (oder Text in telnet) angezeigt, falls beim Anwenden der Befehle kein Fehler aufgetreten ist.		** '''farewell:''' wird zum Schluss als Dialog (oder Text in telnet) angezeigt, falls beim Anwenden der Befehle kein Fehler aufgetreten ist.
	** '''order:''' bestimmt die Reihenfolge, in der die Templates im [[FHEMWEB\|Webfrontend]] angezeigt werden; falls nicht vorhanden, wird ''name:'' genommen.		** '''order:''' bestimmt die Reihenfolge, in der die Templates im [[FHEMWEB\|Webfrontend]] angezeigt werden; falls nicht vorhanden, wird ''name:'' genommen.
			** '''loop:''' ermöglicht es, die zwischen ''loop:<parameter-name>:<wert1>:<wert2>:....'' und ''loop:END'' stehenden Zeilen wiederholt auszuführen und dabei bei jedem Durchlauf die als ''<parameter-name>'' bezeichnete Variable durch die darauffolgende Werteliste (getrennt per Doppelpunkt) zu ersetzen.
	* alle anderen Zeilen werden als auszuführende Befehle interpretiert, wenn man <code>set <Device-Name> attrTemplate TemplateName</code> ausführt.		* alle anderen Zeilen werden als auszuführende Befehle interpretiert, wenn man <code>set <Device-Name> attrTemplate TemplateName</code> ausführt.

DelMar: Tippfehler ausgebessert, zB wurde Doppelpunkt anstatt Semicolon für 'par' angeführt

2021-02-25T22:02:35Z

Tippfehler ausgebessert, zB wurde Doppelpunkt anstatt Semicolon für 'par' angeführt

← Nächstältere Version		Version vom 26. Februar 2021, 00:02 Uhr
Zeile 32:		Zeile 32:
	** '''prereq:''' ist entweder ein Perl-Ausdruck {}, oder ein ''devspec2array'', was genau ein Gerät spezifiziert. Falls mindestens ein prereq existiert, was nicht zutrifft, wird das betroffene Template aus dem Speicher entfernt. Die Auswertung erfolgt beim FHEM Start oder bei {AttrTemplate_Initialize()}		** '''prereq:''' ist entweder ein Perl-Ausdruck {}, oder ein ''devspec2array'', was genau ein Gerät spezifiziert. Falls mindestens ein prereq existiert, was nicht zutrifft, wird das betroffene Template aus dem Speicher entfernt. Die Auswertung erfolgt beim FHEM Start oder bei {AttrTemplate_Initialize()}
	** '''option:''' Syntax entspricht prereq, wird jedoch beim Einlesen des template Files ausgeführt. Falls nicht wahr ist, werden die darauffolgenden Zeilen des Template nicht ausgeführt. Ist für sowas wie "setze zusätzlich Attribut XY falls die Installation HomeAssistant kennt" gedacht.		** '''option:''' Syntax entspricht prereq, wird jedoch beim Einlesen des template Files ausgeführt. Falls nicht wahr ist, werden die darauffolgenden Zeilen des Template nicht ausgeführt. Ist für sowas wie "setze zusätzlich Attribut XY falls die Installation HomeAssistant kennt" gedacht.
	** '''par:''' kann mehrfach vorkommen, Syntax: <code>par:<~~ParamaterName~~>:<Kommentar>:<Perl-Code></code>. ''Perl-Code'' versucht den Wert zu finden, falls nicht möglich (''return undef''), wird ein Dialog mit "Replace" angezeigt (bzw. Usage:... im telnet). ''ParameterName'' wird in jeder Befehlzeile ersetzt mit dem Wert. Zusätzlich: ''DEVICE'' wird mit dem Namen des Gerätes ersetzt, wird ''DEVICE'' (z.B. für Modulnamen) als Text benötigt, muß es ''escaped'' werden (z.B. MQTT2_\DEVICE).		** '''par:''' kann mehrfach vorkommen, Syntax: <code>par:<ParameterName>;<Kommentar>;<Perl-Code></code>. ''Perl-Code'' versucht den Wert zu finden, falls nicht möglich (''return undef''), wird ein Dialog mit "Replace" angezeigt (bzw. Usage:... im telnet). ''ParameterName'' wird in jeder Befehlzeile ersetzt mit dem Wert. Zusätzlich: ''DEVICE'' wird mit dem Namen des Gerätes ersetzt, wird ''DEVICE'' (z.B. für Modulnamen) als Text benötigt, muß es ''escaped'' werden (z.B. MQTT2_\DEVICE).
	** '''desc:''' Kommentar fuer <code>set attrTemplate help ?</code>. Die letzte Zeile mit # vor ''name:'' wird als ''desc:'' interpretiert, falls kein ''desc:'' vorhanden ist.		** '''desc:''' Kommentar fuer <code>set attrTemplate help ?</code>. Die letzte Zeile mit # vor ''name:'' wird als ''desc:'' interpretiert, falls kein ''desc:'' vorhanden ist.
	** '''farewell:''' wird zum Schluss als Dialog (oder Text in telnet) angezeigt, falls beim Anwenden der Befehle kein Fehler aufgetreten ist.		** '''farewell:''' wird zum Schluss als Dialog (oder Text in telnet) angezeigt, falls beim Anwenden der Befehle kein Fehler aufgetreten ist.

Beta-User: Syntax: Formatierung

2020-07-03T07:28:59Z

Syntax: Formatierung

← Nächstältere Version		Version vom 3. Juli 2020, 09:28 Uhr
Zeile 30:		Zeile 30:
	** '''name:''' Name des Templates, markiert gleichzeitig das Ende des vorherigen Templates		** '''name:''' Name des Templates, markiert gleichzeitig das Ende des vorherigen Templates
	** '''filter:''' devspec2array Ausdruck, der beschreibt, für welche Geräte dieses Template anwendbar ist. Wird erst beim "set ?" ausgeführt.		** '''filter:''' devspec2array Ausdruck, der beschreibt, für welche Geräte dieses Template anwendbar ist. Wird erst beim "set ?" ausgeführt.
	** '''prereq:'''		** '''prereq:''' ist entweder ein Perl-Ausdruck {}, oder ein ''devspec2array'', was genau ein Gerät spezifiziert. Falls mindestens ein prereq existiert, was nicht zutrifft, wird das betroffene Template aus dem Speicher entfernt. Die Auswertung erfolgt beim FHEM Start oder bei {AttrTemplate_Initialize()}
	ist entweder ein Perl-Ausdruck {}, oder ein ''devspec2array'', was genau ein Gerät spezifiziert.		** '''option:''' Syntax entspricht prereq, wird jedoch beim Einlesen des template Files ausgeführt. Falls nicht wahr ist, werden die darauffolgenden Zeilen des Template nicht ausgeführt. Ist für sowas wie "setze zusätzlich Attribut XY falls die Installation HomeAssistant kennt" gedacht.
	Falls mindestens ein prereq existiert, was nicht zutrifft, wird das betroffene Template aus dem Speicher entfernt.
	Die Auswertung erfolgt beim FHEM Start oder bei {AttrTemplate_Initialize()}
	** '''option:'''
	Syntax entspricht prereq, wird jedoch beim Einlesen des template Files ausgeführt. Falls nicht wahr ist, werden die darauffolgenden Zeilen des Template nicht ausgeführt. Ist für sowas wie "setze zusätzlich Attribut XY falls die Installation HomeAssistant kennt" gedacht.
	** '''par:''' kann mehrfach vorkommen, Syntax: <code>par:<ParamaterName>:<Kommentar>:<Perl-Code></code>. ''Perl-Code'' versucht den Wert zu finden, falls nicht möglich (''return undef''), wird ein Dialog mit "Replace" angezeigt (bzw. Usage:... im telnet). ''ParameterName'' wird in jeder Befehlzeile ersetzt mit dem Wert. Zusätzlich: ''DEVICE'' wird mit dem Namen des Gerätes ersetzt, wird ''DEVICE'' (z.B. für Modulnamen) als Text benötigt, muß es ''escaped'' werden (z.B. MQTT2_\DEVICE).		** '''par:''' kann mehrfach vorkommen, Syntax: <code>par:<ParamaterName>:<Kommentar>:<Perl-Code></code>. ''Perl-Code'' versucht den Wert zu finden, falls nicht möglich (''return undef''), wird ein Dialog mit "Replace" angezeigt (bzw. Usage:... im telnet). ''ParameterName'' wird in jeder Befehlzeile ersetzt mit dem Wert. Zusätzlich: ''DEVICE'' wird mit dem Namen des Gerätes ersetzt, wird ''DEVICE'' (z.B. für Modulnamen) als Text benötigt, muß es ''escaped'' werden (z.B. MQTT2_\DEVICE).
	** '''desc:''' Kommentar fuer <code>set attrTemplate help ?</code>. Die letzte Zeile mit # vor ''name:'' wird als ''desc:'' interpretiert, falls kein ''desc:'' vorhanden ist.		** '''desc:''' Kommentar fuer <code>set attrTemplate help ?</code>. Die letzte Zeile mit # vor ''name:'' wird als ''desc:'' interpretiert, falls kein ''desc:'' vorhanden ist.

Beta-User: speechrecogn.template - Hinweise ergänzt

2020-03-11T14:24:19Z

speechrecogn.template - Hinweise ergänzt

← Nächstältere Version		Version vom 11. März 2020, 16:24 Uhr
Zeile 46:		Zeile 46:

	Haben Sie ein Template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag im entsprechenden Forenbereichen, für manche Module existieren auch spezielle Threads (siehe Linkliste unten)		Haben Sie ein Template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag im entsprechenden Forenbereichen, für manche Module existieren auch spezielle Threads (siehe Linkliste unten)

			=== Sprachsteuerung ===
			Zur Einbindung von Sprachsteuerungslösungen ([[Siri\|Siri,]] [[Alexa]] und [[Google Assistant FHEM Connect\|gassistant]]) gibt es eine Reihe zentraler attrTemplates, die meist direkt aus anderen attrTemplates heraus aufgerufen werden. Es ist auch möglich, diese attrTemplate direkt aufzurufen, z.B. wenn man erst später eine Spracherkennungslösung eingebunden hat. Wegen der Namen der templates sollte man dazu direkt die betreffende attrTemplate-file ''[https://svn.fhem.de/trac/browser/trunk/fhem/FHEM/lib/AttrTemplate/speechrecogn.template speechrecogn.template]'' konsultieren, die Beschreibung, welches template für welche Funktionalität gedacht ist sowie eventuelle Parameter sind jeweils hinter dem ''desc:'' zu finden.

	=== Spezielle Fragen zur Entwicklung neuer Templates ===		=== Spezielle Fragen zur Entwicklung neuer Templates ===

Beta-User: Hinweis auf das Escapen von DEVICE aufgenommen

2020-03-05T07:59:00Z

Hinweis auf das Escapen von DEVICE aufgenommen

← Nächstältere Version		Version vom 5. März 2020, 09:59 Uhr
Zeile 46:		Zeile 46:

	Haben Sie ein Template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag im entsprechenden Forenbereichen, für manche Module existieren auch spezielle Threads (siehe Linkliste unten)		Haben Sie ein Template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag im entsprechenden Forenbereichen, für manche Module existieren auch spezielle Threads (siehe Linkliste unten)

			=== Spezielle Fragen zur Entwicklung neuer Templates ===
			* Ersetzungen von Schlüsselbegriffen, die durch den AttrTemplate-Code aufgelöst bzw. durch entsprechende andere Werte ersetzt werden, (insbesondere von ''DEVICE'') kann man verhindern, indem man diese ''escaped''. Beispiel: Um im Ergebnis ein "MQTT2_DEVICE" zu erzielen, muß "MQTT2_\DEVICE" geschrieben werden.

	==Warum finde ich das Template xyz nicht?==		==Warum finde ich das Template xyz nicht?==

Ph1959de: Syntaxhighlight - Aufruf korrigiert

2020-02-04T18:15:06Z

Syntaxhighlight - Aufruf korrigiert

← Nächstältere Version		Version vom 4. Februar 2020, 20:15 Uhr
Zeile 63:		Zeile 63:

	=== Deaktivierung über ''global'' ===		=== Deaktivierung über ''global'' ===
	Darüber hinaus kann das Modul insgesamt über folgende Einstellung deaktiviert werden:<syntaxhighlight>		Darüber hinaus kann das Modul insgesamt über folgende Einstellung deaktiviert werden:
			<syntaxhighlight lang="perl">
	attr global disableFeatures attrTemplate		attr global disableFeatures attrTemplate
	</syntaxhighlight>Dann werden insgesamt keine attrTemplates mehr geladen.		</syntaxhighlight>
			Dann werden insgesamt keine attrTemplates mehr geladen.

	==Links==		==Links==

Beta-User: attr global disableFeatures attrTemplate eingefügt

2020-02-04T12:34:58Z

attr global disableFeatures attrTemplate eingefügt

← Nächstältere Version		Version vom 4. Februar 2020, 14:34 Uhr
Zeile 61:		Zeile 61:
	=== prereq ===		=== prereq ===
	Trifft ein ''prereq'' nicht zu, wird das betreffende Template gar nicht geladen. Es erscheint dann weder bei Aufruf des "?", noch kann es über die Kommandozeile ausgeführt werden. In der Regel macht es auch wenig Sinn, ein template ausführen zu wollen, dessen Voraussetzungen nicht gegeben sind, etwa weil (noch) kein passendes Bridge-Gerät definiert ist.		Trifft ein ''prereq'' nicht zu, wird das betreffende Template gar nicht geladen. Es erscheint dann weder bei Aufruf des "?", noch kann es über die Kommandozeile ausgeführt werden. In der Regel macht es auch wenig Sinn, ein template ausführen zu wollen, dessen Voraussetzungen nicht gegeben sind, etwa weil (noch) kein passendes Bridge-Gerät definiert ist.

			=== Deaktivierung über ''global'' ===
			Darüber hinaus kann das Modul insgesamt über folgende Einstellung deaktiviert werden:<syntaxhighlight>
			attr global disableFeatures attrTemplate
			</syntaxhighlight>Dann werden insgesamt keine attrTemplates mehr geladen.

	==Links==		==Links==