DevelopmentFHEMWEB-API - Versionsgeschichte

Sailor: /* FW_directNotify */ Weiteres Beispiel eingefügt

2026-02-24T12:47:15Z

FW_directNotify: Weiteres Beispiel eingefügt

← Nächstältere Version		Version vom 24. Februar 2026, 14:47 Uhr
Zeile 150:		Zeile 150:
	* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "location.reload('true')", "");</syntaxhighlight>		* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "location.reload('true')", "");</syntaxhighlight>
	* siehe auch {{Link2Forum\|Topic=48736\|Message=404497\|LinkText=diesen Forumbeitrag}} und {{Link2Forum\|Topic=134208\|LinkText=dieses Forumthema}}		* siehe auch {{Link2Forum\|Topic=48736\|Message=404497\|LinkText=diesen Forumbeitrag}} und {{Link2Forum\|Topic=134208\|LinkText=dieses Forumthema}}

			* <syntaxhighlight lang="perl">FW_directNotify("FILTER=".$name, "#FHEMWEB:WEB", "location.reload('true')", "");</syntaxhighlight>
			* Nur den FhemWeb - Browswer Tab refreshen, in welchem dieses Device mit dem Namen <$name> gerade geöffnet ist.

	== FHEMWEB-Client (pgm2) Javascript-Funktionen ==		== FHEMWEB-Client (pgm2) Javascript-Funktionen ==

Torxgewinde: Beispiel ergänzt

2025-11-22T19:11:49Z

Beispiel ergänzt

← Nächstältere Version		Version vom 22. November 2025, 21:11 Uhr
Zeile 64:		Zeile 64:
	Bsp: <code>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36</code>		Bsp: <code>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36</code>
	\|}		\|}
			Will man mit den Variablen zum Beispiel mittels eines Perl-Codes einen Link aufbauen, dann kann dieser wie folgt zusammengesetzt werden: <syntaxhighlight lang="perl" line="1">
			my $cmd = "list";
			my $link = "<a href=\"${FW_ME}?XHR=1${FW_CSRF}&cmd=${cmd}\">Klick mich</a>";
			</syntaxhighlight>

	=== FW_makeImage ===		=== FW_makeImage ===

Ph1959de: Sichtung der letzten Änderungen; kleinere Korrekturen

2025-04-25T17:46:46Z

Sichtung der letzten Änderungen; kleinere Korrekturen

← Nächstältere Version		Version vom 25. April 2025, 19:46 Uhr
Zeile 145:		Zeile 145:
	* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "FW_okDialog('Hello world!')", "");</syntaxhighlight>		* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "FW_okDialog('Hello world!')", "");</syntaxhighlight>
	* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "location.reload('true')", "");</syntaxhighlight>		* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "location.reload('true')", "");</syntaxhighlight>
	* siehe auch {{Link2Forum\|Topic=48736\|Message=404497\|LinkText=~~Forenthread~~}} und ~~https://forum.fhem.de/index.php?topic~~=134208.0		* siehe auch {{Link2Forum\|Topic=48736\|Message=404497\|LinkText=diesen Forumbeitrag}} und {{Link2Forum\|Topic=134208\|LinkText=dieses Forumthema}}

	== FHEMWEB-Client (pgm2) Javascript-Funktionen ==		== FHEMWEB-Client (pgm2) Javascript-Funktionen ==
Zeile 191:		Zeile 191:
	Beispiel:		Beispiel:
	* <syntaxhighlight lang="javascript">FW_cmd(FW_root+'?cmd={FW_makeImage("fts_shutter_10")}&XHR=1', function(data){FW_okDialog(data)});</syntaxhighlight> Das Beispiel holt sich vom Server den HTML-Code des Icon "fts_shutter_10" und zeigt das Icon in einem Popup-Fenster an. Der vom Server auszuführende Befehl lautet <syntaxhighlight lang="perl" inline>{FW_makeImage("fts_shutter_10")}</syntaxhighlight>. An die Callback-Funktion <syntaxhighlight lang="javascript" inline>function(data){FW_okDialog(data)}</syntaxhighlight> wird der Rückgabewert vom Server als Parameter übergeben und steht als Variable <code>data</code> zur Verfügung.		* <syntaxhighlight lang="javascript">FW_cmd(FW_root+'?cmd={FW_makeImage("fts_shutter_10")}&XHR=1', function(data){FW_okDialog(data)});</syntaxhighlight> Das Beispiel holt sich vom Server den HTML-Code des Icon "fts_shutter_10" und zeigt das Icon in einem Popup-Fenster an. Der vom Server auszuführende Befehl lautet <syntaxhighlight lang="perl" inline>{FW_makeImage("fts_shutter_10")}</syntaxhighlight>. An die Callback-Funktion <syntaxhighlight lang="javascript" inline>function(data){FW_okDialog(data)}</syntaxhighlight> wird der Rückgabewert vom Server als Parameter übergeben und steht als Variable <code>data</code> zur Verfügung.
	* Will man mehrere Perl-Kommandos senden, kann es hilfreich sein die Daten vor der Übertragung BASE64 zu codieren. Im Kern nutzt man eine Wrapperfunktion für FW_cmd:<syntaxhighlight lang="javascript">		* Will man mehrere Perl-Kommandos senden, kann es hilfreich sein, die Daten vor der Übertragung BASE64 zu codieren. Im Kern nutzt man eine Wrapperfunktion für FW_cmd:<syntaxhighlight lang="javascript">
	function FW_cmd_perlcode(arg, callback, rep) {		function FW_cmd_perlcode(arg, callback, rep) {
	let perlcode = "eval(MIME::Base64::decode_base64('" +btoa(arg)+ "'))";		let perlcode = "eval(MIME::Base64::decode_base64('" +btoa(arg)+ "'))";
	return FW_cmd(FW_root + '?cmd={' + perlcode + '}&XHR=1', callback, rep);		return FW_cmd(FW_root + '?cmd={' + perlcode + '}&XHR=1', callback, rep);
	}		}
	</syntaxhighlight>Weitere Details findet man ~~im Forumspost: https://forum.fhem.de/index.php?topic~~=141230.0		</syntaxhighlight>
			Weitere Details findet man in {{Link2Forum\|Topic=141230\|diesem Forenthema}}.

	=== FW_errmsg ===		=== FW_errmsg ===

Torxgewinde: /* FW_directNotify */

2025-03-27T13:47:11Z

FW_directNotify

← Nächstältere Version		Version vom 27. März 2025, 15:47 Uhr
Zeile 145:		Zeile 145:
	* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "FW_okDialog('Hello world!')", "");</syntaxhighlight>		* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "FW_okDialog('Hello world!')", "");</syntaxhighlight>
	* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "location.reload('true')", "");</syntaxhighlight>		* <syntaxhighlight lang="perl">FW_directNotify("FILTER=room=XXX", "#FHEMWEB:WEB", "location.reload('true')", "");</syntaxhighlight>
	* siehe auch {{Link2Forum\|Topic=48736\|Message=404497\|LinkText=Forenthread}}		* siehe auch {{Link2Forum\|Topic=48736\|Message=404497\|LinkText=Forenthread}} und https://forum.fhem.de/index.php?topic=134208.0

	== FHEMWEB-Client (pgm2) Javascript-Funktionen ==		== FHEMWEB-Client (pgm2) Javascript-Funktionen ==

Torxgewinde: /* FW_cmd */

2025-03-27T09:22:24Z

FW_cmd

← Nächstältere Version		Version vom 27. März 2025, 11:22 Uhr
Zeile 191:		Zeile 191:
	Beispiel:		Beispiel:
	* <syntaxhighlight lang="javascript">FW_cmd(FW_root+'?cmd={FW_makeImage("fts_shutter_10")}&XHR=1', function(data){FW_okDialog(data)});</syntaxhighlight> Das Beispiel holt sich vom Server den HTML-Code des Icon "fts_shutter_10" und zeigt das Icon in einem Popup-Fenster an. Der vom Server auszuführende Befehl lautet <syntaxhighlight lang="perl" inline>{FW_makeImage("fts_shutter_10")}</syntaxhighlight>. An die Callback-Funktion <syntaxhighlight lang="javascript" inline>function(data){FW_okDialog(data)}</syntaxhighlight> wird der Rückgabewert vom Server als Parameter übergeben und steht als Variable <code>data</code> zur Verfügung.		* <syntaxhighlight lang="javascript">FW_cmd(FW_root+'?cmd={FW_makeImage("fts_shutter_10")}&XHR=1', function(data){FW_okDialog(data)});</syntaxhighlight> Das Beispiel holt sich vom Server den HTML-Code des Icon "fts_shutter_10" und zeigt das Icon in einem Popup-Fenster an. Der vom Server auszuführende Befehl lautet <syntaxhighlight lang="perl" inline>{FW_makeImage("fts_shutter_10")}</syntaxhighlight>. An die Callback-Funktion <syntaxhighlight lang="javascript" inline>function(data){FW_okDialog(data)}</syntaxhighlight> wird der Rückgabewert vom Server als Parameter übergeben und steht als Variable <code>data</code> zur Verfügung.
	* Will man mehrere Perl-Kommandos senden, kann es hilfreich sein die Daten vor der Übertragung BASE64 zu codieren. ~~Wie~~ man ~~dies nutzt behandelt ein~~ Forumspost: https://forum.fhem.de/index.php?topic=141230.0		* Will man mehrere Perl-Kommandos senden, kann es hilfreich sein die Daten vor der Übertragung BASE64 zu codieren. Im Kern nutzt man eine Wrapperfunktion für FW_cmd:<syntaxhighlight lang="javascript">
			function FW_cmd_perlcode(arg, callback, rep) {
			let perlcode = "eval(MIME::Base64::decode_base64('" +btoa(arg)+ "'))";
			return FW_cmd(FW_root + '?cmd={' + perlcode + '}&XHR=1', callback, rep);
			}
			</syntaxhighlight>Weitere Details findet man im Forumspost: https://forum.fhem.de/index.php?topic=141230.0

	=== FW_errmsg ===		=== FW_errmsg ===

Torxgewinde: /* FW_cmd */

2025-03-27T09:19:37Z

FW_cmd

← Nächstältere Version		Version vom 27. März 2025, 11:19 Uhr
Zeile 191:		Zeile 191:
	Beispiel:		Beispiel:
	* <syntaxhighlight lang="javascript">FW_cmd(FW_root+'?cmd={FW_makeImage("fts_shutter_10")}&XHR=1', function(data){FW_okDialog(data)});</syntaxhighlight> Das Beispiel holt sich vom Server den HTML-Code des Icon "fts_shutter_10" und zeigt das Icon in einem Popup-Fenster an. Der vom Server auszuführende Befehl lautet <syntaxhighlight lang="perl" inline>{FW_makeImage("fts_shutter_10")}</syntaxhighlight>. An die Callback-Funktion <syntaxhighlight lang="javascript" inline>function(data){FW_okDialog(data)}</syntaxhighlight> wird der Rückgabewert vom Server als Parameter übergeben und steht als Variable <code>data</code> zur Verfügung.		* <syntaxhighlight lang="javascript">FW_cmd(FW_root+'?cmd={FW_makeImage("fts_shutter_10")}&XHR=1', function(data){FW_okDialog(data)});</syntaxhighlight> Das Beispiel holt sich vom Server den HTML-Code des Icon "fts_shutter_10" und zeigt das Icon in einem Popup-Fenster an. Der vom Server auszuführende Befehl lautet <syntaxhighlight lang="perl" inline>{FW_makeImage("fts_shutter_10")}</syntaxhighlight>. An die Callback-Funktion <syntaxhighlight lang="javascript" inline>function(data){FW_okDialog(data)}</syntaxhighlight> wird der Rückgabewert vom Server als Parameter übergeben und steht als Variable <code>data</code> zur Verfügung.
			* Will man mehrere Perl-Kommandos senden, kann es hilfreich sein die Daten vor der Übertragung BASE64 zu codieren. Wie man dies nutzt behandelt ein Forumspost: https://forum.fhem.de/index.php?topic=141230.0

	=== FW_errmsg ===		=== FW_errmsg ===

Torxgewinde: /* FW_makeImage */

2025-03-24T15:58:18Z

FW_makeImage

← Nächstältere Version		Version vom 24. März 2025, 17:58 Uhr
Zeile 79:		Zeile 79:

	''mandatory''		''mandatory''
	\|\| Eine Zeichenkette, mit optionaler Farbangabe <code>'<iconname>[@~~color~~>]'</code>		\|\| Eine Zeichenkette, mit optionaler Farbangabe <code>'<iconname>[@fillcolor>[@strokecolor>]]'</code>
			Die Farbangaben ersetzen bei SVG Dateien nur die Farbwerte für stroke und fill, sofern diese in der SVG Datei <code>#000000</code> sind. Wird also eine Angabe <code>fill:#000000</code> oder <code>fill=#000000</code> im Quelltext des SVG gefunden, wird dies ersetzt durch <code>fill:fillcolor</code> bzw. <code>fill=fillcolor</code>, je nachdem ob ein Doppelpunkt oder Gleichheitszeichen vorhanden war.
	\|-		\|-
	\| style="vertical-align:top" \| '''<code>$text</code>'''		\| style="vertical-align:top" \| '''<code>$text</code>'''

Torxgewinde: /* FW_makeImage */

2025-03-24T15:53:20Z

FW_makeImage

← Nächstältere Version		Version vom 24. März 2025, 17:53 Uhr
Zeile 91:		Zeile 91:
	''optional''		''optional''
	\|\| Eine Zeichenkette, die eine CSS-Klasse angibt.		\|\| Eine Zeichenkette, die eine CSS-Klasse angibt.
	~~Wir~~ der Parameter angegeben, wird dem <img> oder <svg> <code>class="$class"</code> hinzugefügt. Ist der Parameter <code>undef</code> oder nicht übergeben, so wird kein <code>class</code>-Attribut hinzugefügt.		Wird der Parameter angegeben, wird dem <img> oder <svg> <code>class="$class"</code> hinzugefügt. Ist der Parameter <code>undef</code> oder nicht übergeben, so wird kein <code>class</code>-Attribut hinzugefügt.
	\|}		\|}

Torxgewinde: /* FW_makeImage */

2025-03-24T15:52:56Z

FW_makeImage

← Nächstältere Version		Version vom 24. März 2025, 17:52 Uhr
Zeile 91:		Zeile 91:
	''optional''		''optional''
	\|\| Eine Zeichenkette, die eine CSS-Klasse angibt.		\|\| Eine Zeichenkette, die eine CSS-Klasse angibt.
	Wir der Parameter angegeben, wird dem <img> oder <svg> class="$class" hinzugefügt. Ist der Parameter <code>undef</code> oder nicht übergeben, so wird kein <code>class</code>-Attribut hinzugefügt.		Wir der Parameter angegeben, wird dem <img> oder <svg> <code>class="$class"</code> hinzugefügt. Ist der Parameter <code>undef</code> oder nicht übergeben, so wird kein <code>class</code>-Attribut hinzugefügt.
	\|}		\|}

Torxgewinde: /* FW_makeImage */

2025-03-24T15:52:26Z

FW_makeImage

← Nächstältere Version		Version vom 24. März 2025, 17:52 Uhr
Zeile 84:		Zeile 84:

	''optional''		''optional''
	\|\| Wenn hier ein Text angegeben wird und <code>$icon</code> auf eine SVG-Datei verweist, dann wird <code>$text</code> dem svg-HTML-Tag hinzugefügt. Das Resultat im HTML-Quelltext ist dann in der Art <code><svg ~~class="$class"~~ data-txt="$text" ... ></code>		\|\| Wenn hier ein Text angegeben wird und <code>$icon</code> auf eine SVG-Datei verweist, dann wird <code>$text</code> dem svg-HTML-Tag hinzugefügt. Das Resultat im HTML-Quelltext ist dann in der Art <code><svg ... data-txt="$text" ... ></code>
	Wenn hier ein Text angegeben wird und <code>$icon</code> auf eine Datei verweist die nicht auf ''.svg'' endet, dann wird der Pfad von der Datei hinter <code>$icon</code> als <code><img></code> eingebunden. Das Resultat im HTML-Quelltext ist dann in der Art <code><img ... src="..." alt=\"$text\" title=\"$text\"></code>		Wenn hier ein Text angegeben wird und <code>$icon</code> auf eine Datei verweist die nicht auf ''.svg'' endet, dann wird der Pfad von der Datei hinter <code>$icon</code> als <code><img></code> eingebunden. Das Resultat im HTML-Quelltext ist dann in der Art <code><img ... src="..." alt="$text" title="$text"></code>
	\|-		\|-
	\| style="vertical-align:top" \| '''<code>$class</code>'''		\| style="vertical-align:top" \| '''<code>$class</code>'''