HTTPMOD - Versionsgeschichte

Ph1959de: Sichtung der letzten Änderungen; kleinere Korrekturen

2025-04-25T17:53:47Z

Sichtung der letzten Änderungen; kleinere Korrekturen

← Nächstältere Version		Version vom 25. April 2025, 19:53 Uhr
Zeile 1.357:		Zeile 1.357:

	== Links ==		== Links ==
	* Example: This example uses many features of HTTPMOD, universally useful is the access to other readings just like what [[Set magic\|set-magic]] (<code>[device:reading]</code>) does ~~[https~~:~~//forum.fhem.de/index.php?topic~~=135666.0 🎸 Owntone (Musik-Player) mit FHEM steuern]		* Example: This example uses many features of HTTPMOD, universally useful is the access to other readings just like what [[Set magic\|set-magic]] (<code>[device:reading]</code>) does: see thread {{Link2Forum\|Topic=135666\|LinkText=🎸 Owntone (Musik-Player) mit FHEM steuern}} in forum
	* Example: [https://www.goingelectric.de/forum/viewtopic.php?f=57&t=21462\|Abfrage Akkustand einer Zoe und mehr von Renault ZE Services]		* Example: [https://www.goingelectric.de/forum/viewtopic.php?f=57&t=21462\|Abfrage Akkustand einer Zoe und mehr von Renault ZE Services]
	* Example: [[Wetter_und_Wettervorhersagen#Wetter_von_Weather_Underground\|Extract weather information from WeatherUnderground]]		* Example: [[Wetter_und_Wettervorhersagen#Wetter_von_Weather_Underground\|Extract weather information from WeatherUnderground]]

Torxgewinde: Moved the code to more suitable location

2025-04-14T19:32:42Z

Moved the code to more suitable location

@@ Zeile 363: / Zeile 363: @@
 The usual way to define readings is however to have an individual regular expression with just one capture group per reading as shown in the above example.
 == Parsing JSON ==
@@ Zeile 618: / Zeile 610: @@
 In this case the internal <code>$hash->{value}</code> will contain the value passed to the set command.
 <code>$hash->{value}</code> might even be a string containing several values that could be put into several different positions in a request by using user defined replacements.
 '''Other example : steering a pellet stove from Rika'''

Torxgewinde: /* Some help with Regular Expressions */

2025-04-05T09:20:51Z

Some help with Regular Expressions

← Nächstältere Version		Version vom 5. April 2025, 11:20 Uhr
Zeile 363:		Zeile 363:

	The usual way to define readings is however to have an individual regular expression with just one capture group per reading as shown in the above example.		The usual way to define readings is however to have an individual regular expression with just one capture group per reading as shown in the above example.

			=== Example: set-magic in HTTPMOD ===
			To achieve the same just like [[set magic]] the following can be added to a HTTPMOD device:<syntaxhighlight lang="perl">
			attr Owntone.device replacement02Mode expression
			attr Owntone.device replacement02Regex \[([^:]+):([^\]]+)\]
			attr Owntone.device replacement02Value my $device = $name if ($1 eq "\$name") // $1;;\
			ReadingsVal($device, $2, undef) or AttrVal($device, $2, "???");;
			</syntaxhighlight>With that definition you can just write <code>[$name:state]</code> to get the state-reading of your own HTTPMOD device there. It also accepts other devicenames and first searches for a reading and if no reading is found it searches for an attrbibute with a matching name. This neat trick is used throughout in the Owntone-HTTPMOD-device (see links section below) to keep it easily adoptable to different server names without editing many places in the listing.

	== Parsing JSON ==		== Parsing JSON ==

Torxgewinde: /* Links */

2025-04-05T08:57:16Z

Links

← Nächstältere Version		Version vom 5. April 2025, 10:57 Uhr
Zeile 1.348:		Zeile 1.348:

	== Links ==		== Links ==
	* Example: This example uses many features of HTTPMOD [https://forum.fhem.de/index.php?topic=135666.0 🎸 Owntone (Musik-Player) mit FHEM steuern]		* Example: This example uses many features of HTTPMOD, universally useful is the access to other readings just like what [[Set magic\|set-magic]] (<code>[device:reading]</code>) does [https://forum.fhem.de/index.php?topic=135666.0 🎸 Owntone (Musik-Player) mit FHEM steuern]
	* Example: [https://www.goingelectric.de/forum/viewtopic.php?f=57&t=21462\|Abfrage Akkustand einer Zoe und mehr von Renault ZE Services]		* Example: [https://www.goingelectric.de/forum/viewtopic.php?f=57&t=21462\|Abfrage Akkustand einer Zoe und mehr von Renault ZE Services]
	* Example: [[Wetter_und_Wettervorhersagen#Wetter_von_Weather_Underground\|Extract weather information from WeatherUnderground]]		* Example: [[Wetter_und_Wettervorhersagen#Wetter_von_Weather_Underground\|Extract weather information from WeatherUnderground]]

Torxgewinde: /* Links */

2025-04-05T08:53:56Z

Links

← Nächstältere Version		Version vom 5. April 2025, 10:53 Uhr
Zeile 1.348:		Zeile 1.348:

	== Links ==		== Links ==
			* Example: This example uses many features of HTTPMOD [https://forum.fhem.de/index.php?topic=135666.0 🎸 Owntone (Musik-Player) mit FHEM steuern]
	* Example: [https://www.goingelectric.de/forum/viewtopic.php?f=57&t=21462\|Abfrage Akkustand einer Zoe und mehr von Renault ZE Services]		* Example: [https://www.goingelectric.de/forum/viewtopic.php?f=57&t=21462\|Abfrage Akkustand einer Zoe und mehr von Renault ZE Services]
	* Example: [[Wetter_und_Wettervorhersagen#Wetter_von_Weather_Underground\|Extract weather information from WeatherUnderground]]		* Example: [[Wetter_und_Wettervorhersagen#Wetter_von_Weather_Underground\|Extract weather information from WeatherUnderground]]

Ph1959de: Sichtung/Korrektur der letzen Änderung (syntaxhighlight korrigiert)

2024-01-31T09:04:51Z

Sichtung/Korrektur der letzen Änderung (syntaxhighlight korrigiert)

← Nächstältere Version		Version vom 31. Januar 2024, 11:04 Uhr
Zeile 7:		Zeile 7:
	\|ModOwner=StefanStrobel ({{Link2FU\|3960\|Forum}} / [[Benutzer:StefanStrobel\|Wiki]])		\|ModOwner=StefanStrobel ({{Link2FU\|3960\|Forum}} / [[Benutzer:StefanStrobel\|Wiki]])
	}}		}}
			[[HTTPMOD]] provides a generic way to retrieve information from devices with an HTTP Interface and store them in Readings or send information to such devices. It queries a given URL with Headers and data defined by attributes.
	HTTPMOD provides a generic way to retrieve information from devices with an HTTP Interface and store them in Readings or send information to such devices. It queries a given URL with Headers and data defined by attributes.

	From the HTTP response it extracts readings named in attributes using Regexes, JSON or XPath parsing also defined by attributes.		From the HTTP response it extracts readings named in attributes using Regexes, JSON or XPath parsing also defined by attributes.
Zeile 878:		Zeile 877:
	</syntaxhighlight>		</syntaxhighlight>

			This example defines the set of parameters for Wiesemann&Theiss Web-IO Analog 4.0 #57761. The current limit is set to 16mA (setxxMax)
	This example defines the set of parameters for Wiesemann&Theiss Web-IO Analog 4.0 #57761. The current limit is set to 16mA (setxxMax)<syntaxhighlight>		<syntaxhighlight lang="Perl">
	defmod WuT_Analog1 HTTPMOD none 30		defmod WuT_Analog1 HTTPMOD none 30
	attr WuT_Analog1 room W&T		attr WuT_Analog1 room W&T

Jophb: Rechtschreibfehler korrigiert Wiesemann&Theis

2024-01-28T20:58:05Z

Rechtschreibfehler korrigiert Wiesemann&Theis

← Nächstältere Version		Version vom 28. Januar 2024, 22:58 Uhr
Zeile 879:		Zeile 879:


	~~Here are~~ the parameters for Wiesemann&Theiss Web-IO Analog 4.0 #57761. The current limit is set to 16mA (setxxMax)<syntaxhighlight>		This example defines the set of parameters for Wiesemann&Theiss Web-IO Analog 4.0 #57761. The current limit is set to 16mA (setxxMax)<syntaxhighlight>
	defmod WuT_Analog1 HTTPMOD none 30		defmod WuT_Analog1 HTTPMOD none 30
	attr WuT_Analog1 room W&T		attr WuT_Analog1 room W&T

Jophb: Added set parametrs for Wiesemann&Theis Web.IO Analog 4.0

2024-01-28T20:47:34Z

Added set parametrs for Wiesemann&Theis Web.IO Analog 4.0

@@ Zeile 876: / Zeile 876: @@
 attr PM set03Name On
 attr PM set03NoArg
 </syntaxhighlight>

Drhirn: veraltete "source"-Angaben in "syntaxhighlight" geändert

2023-11-09T10:49:22Z

veraltete "source"-Angaben in "syntaxhighlight" geändert

← Nächstältere Version		Version vom 9. November 2023, 12:49 Uhr
Zeile 17:		Zeile 17:
	With the help of HTTPMOD you can automatically access websites, retrieve information and send data. In the simplest case, an http call is started regularly and the content of a page, for example, is read and processed further. The URL and the time interval in which the call is to be made must then be specified when the call is made. In order to read information from the called web pages, readings are required. In this readings one specifies Regex, which reads the necessary information. Here is an example.		With the help of HTTPMOD you can automatically access websites, retrieve information and send data. In the simplest case, an http call is started regularly and the content of a page, for example, is read and processed further. The URL and the time interval in which the call is to be made must then be specified when the call is made. In order to read information from the called web pages, readings are required. In this readings one specifies Regex, which reads the necessary information. Here is an example.

	<~~source~~ lang="perl">		<syntaxhighlight lang="perl">
	define PM HTTPMOD http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html 20000		define PM HTTPMOD http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html 20000
	</~~source~~>		</syntaxhighlight>

	This creates a device that accesses the http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html website with the TV program every 20000 seconds. If neither readings nor other attributes are defined, then only the call of the website takes place and FHEM receives no further data from the web access.		This creates a device that accesses the http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html website with the TV program every 20000 seconds. If neither readings nor other attributes are defined, then only the call of the website takes place and FHEM receives no further data from the web access.

	But now a television program is returned when you call the website, which you might want to read out. In order to save the contents in FHEM, which are related to the ARD, you need a reading. This reading must contain a name (so that FHEM knows under which name the information is stored) and a regex (so that you know where the information is stored on the website). Since usually not one, but many readings are defined, these readings are numbered consecutively. This is done by numbers that are given immediately after the word reading. In our example this would be for example		But now a television program is returned when you call the website, which you might want to read out. In order to save the contents in FHEM, which are related to the ARD, you need a reading. This reading must contain a name (so that FHEM knows under which name the information is stored) and a regex (so that you know where the information is stored on the website). Since usually not one, but many readings are defined, these readings are numbered consecutively. This is done by numbers that are given immediately after the word reading. In our example this would be for example
	<~~source~~ lang="perl">		<syntaxhighlight lang="perl">
	attr PM reading1Name ARD		attr PM reading1Name ARD
	attr PM reading1Regex <span class="stationName">ARD<\/span>[\w\W]?<div class="content">\s<a[\w\W]?>\s(.?)\s<\/a>		attr PM reading1Regex <span class="stationName">ARD<\/span>[\w\W]?<div class="content">\s<a[\w\W]?>\s(.?)\s<\/a>
Zeile 31:		Zeile 31:
	attr PM reading3Name ARD_details		attr PM reading3Name ARD_details
	attr PM reading3Regex <span class="stationName">ARD<\/span>[\w\W]?<div class="content">\s<a[\w\W]?>[\w\W]?<\/a>\s<br\/>\s(.*?)(<img\|<\/div)		attr PM reading3Regex <span class="stationName">ARD<\/span>[\w\W]?<div class="content">\s<a[\w\W]?>[\w\W]?<\/a>\s<br\/>\s(.*?)(<img\|<\/div)
	</~~source~~>		</syntaxhighlight>

	Reading1 contains the programme, reading2 the time and reading3 further details. The Regex result from the structure of the website and may have to be designed in painstaking detail.		Reading1 contains the programme, reading2 the time and reading3 further details. The Regex result from the structure of the website and may have to be designed in painstaking detail.
Zeile 38:		Zeile 38:

	Again, it is possible to create not one but several get-commands. Therefore, get is always followed by (at least) one number with which the get commands are numbered. Here is another example. The TV program should be called manually and not time-controlled. To do this we first change the definition to		Again, it is possible to create not one but several get-commands. Therefore, get is always followed by (at least) one number with which the get commands are numbered. Here is another example. The TV program should be called manually and not time-controlled. To do this we first change the definition to
	<~~source~~ lang="perl">		<syntaxhighlight lang="perl">
	define PM HTTPMOD http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html 0		define PM HTTPMOD http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html 0
	</~~source~~>		</syntaxhighlight>
	and add the following to the attributes		and add the following to the attributes
	<~~source~~ lang="perl">		<syntaxhighlight lang="perl">
	attr PM get1Name ARDHolen		attr PM get1Name ARDHolen
	</~~source~~>		</syntaxhighlight>
	With the command "get PM ARDHolen" the above readings are filled. In order for FHEM to know that the other reading2, reading3, etc. are to be read as well as reading1, the (user) attribute		With the command "get PM ARDHolen" the above readings are filled. In order for FHEM to know that the other reading2, reading3, etc. are to be read as well as reading1, the (user) attribute
	<~~source~~ lang="perl">		<syntaxhighlight lang="perl">
	attr PM get1CheckAllReadings 1		attr PM get1CheckAllReadings 1
	</~~source~~>		</syntaxhighlight>
	needs to be defined.		needs to be defined.

GunterB: Ergänzungen und kleine Verbesserungen

2022-05-04T14:33:58Z

Ergänzungen und kleine Verbesserungen

← Nächstältere Version		Version vom 4. Mai 2022, 16:33 Uhr
Zeile 556:		Zeile 556:
	Example:		Example:

	<syntaxhighlight lang="perl">		<syntaxhighlight lang="perl" line="1">
	attr mydevice getData {"get" :["%%value%%.value"]}		attr mydevice getData {"get" :["%%value%%.value"]}
	attr mydevice replacement01Mode text		attr mydevice replacement01Mode text
Zeile 571:		Zeile 571:
	attr mydevice replacement02Mode key		attr mydevice replacement02Mode key
	attr mydevice replacement02Regex %%password%%		attr mydevice replacement02Regex %%password%%
	attr mydevice ~~get05Replacement02Value~~ password		attr mydevice replacement02Value password
	</syntaxhighlight>		</syntaxhighlight>

Zeile 581:		Zeile 581:
	A second get will look the same except a different name and replacement value.		A second get will look the same except a different name and replacement value.

	With the command <code>set storeKeyValue password geheim</code> you can store the password geheim in an obfuscated form in the file system.		With the command <code>set mydevice storeKeyValue password geheim</code> you can store the password geheim in an obfuscated form in the file system.
	To use this password and send it in a request you can use the above replacement with mode key. The value password will then refer to the ofuscated string stored with the key password.		To use this password and send it in a request you can use the above replacement with mode key. The value password will then refer to the ofuscated string stored with the key password.