FHEMWiki - Benutzerbeiträge [de]

HTTPMOD

2024-01-28T20:58:05Z

Jophb: Rechtschreibfehler korrigiert Wiesemann&Theis

{{Infobox Modul
|ModPurpose=Extract information from devices with an HTTP interface (or, more generic, from any URL) or send information to such devices
|ModType=d
|ModCmdRef=HTTPMOD
|ModForumArea=Sonstiges
|ModTechName=98_HTTPMOD.pm
|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.

From the HTTP response it extracts readings named in attributes using Regexes, JSON or XPath parsing also defined by attributes.

In an advanced [[Konfiguration|configuration]] the module can also send information to devices. To do this, a generic <code>set</code> option can be configured using attributes.

== Introduction ==
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.

<syntaxhighlight lang="perl">
define PM HTTPMOD http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html 20000
</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.

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
<syntaxhighlight lang="perl">
attr PM reading1Name ARD
attr PM reading1Regex ARD<\/span>[\w\W]*?<div class="content">\s*<a[\w\W]*?>\s*(.*?)\s*<\/a>
attr PM reading2Name ARD_time
attr PM reading2Regex ARD<\/span>[\w\W]*?<td class="time">\s*(.*?)\s*<
attr PM reading3Name ARD_details
attr PM reading3Regex ARD<\/span>[\w\W]*?<div class="content">\s*<a[\w\W]*?>[\w\W]*?<\/a>\s*<br\/>\s*(.*?)(<img|<\/div)
</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.

There are cases where this is not enough. For example, it could be the case that the information from the web access is not automated, but manually received. Then a 0 must first be entered at the top of the duration. But how does HTTPMOD then know when the data should be retrieved? This is done with get-commands. If a get-command is executed, HTTPMOD accesses the website, fetches the information and fills the corresponding readings.

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
<syntaxhighlight lang="perl">
define PM HTTPMOD http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html 0
</syntaxhighlight>
and add the following to the attributes
<syntaxhighlight lang="perl">
attr PM get1Name ARDHolen
</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
<syntaxhighlight lang="perl">
attr PM get1CheckAllReadings 1
</syntaxhighlight>
needs to be defined.

If the URL is not sufficient when the web page is called, but a special header is to be sent with it, this can be done with the get1Header attribute. If the header is multiline, the individual lines can be entered with get1Header1, get1Header2, and so on.

If you want to evaluate or control different URLs, you can define several get commands (get1, get2, etc.) and provide them with your own URLs. get1 usually reads only the reading1, get2 reads only the reading2 and so on. With CheckAllReadings all readings are evaluated simultaneously.

If only data is to be sent on the web page, but not read, the set command is recommended. It has the same structure as the get-command.

It becomes a bit more complex if the website requires a login check. The sid attributes are used for this purpose.

== Availability, prerequisites and definition ==
This module is part of the regular FHEM distribution and uses the non blocking HTTP function <code>HttpUtils_NonblockingGet</code> provided by FHEM's [[HttpUtils]] in a new version published in December 2013.
If not already installed in your environment, please [[update]] FHEM or install it manually using appropriate commands from your environment.
Please also note that FHEM HttpUtils need the global attribute dnsServer to be set in order to work really non blocking even when dns requests can not be answered.

The device is defined as follows
<syntaxhighlight lang="perl">
define <name> HTTPMOD <URL> <Interval>
</syntaxhighlight>
The module connects to the given <code>URL</code> every <code>Interval</code> seconds, sends optional headers and data and then parses the response with regular expressions, xpath or json to set readings.

URL can be "none" and Interval can be 0 if you prefer to only query data with a get command and not in a defined interval.

Example:
<syntaxhighlight lang="perl">
define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60
</syntaxhighlight>

== Set-Commands ==
can be defined using attributes, see advanced configuration

If you set the attribute enableControlSet to 1, the following additional built in set commands are available:
;interval
:set new interval time in seconds and restart the timer
;reread
:request the defined URL and try to parse it just like the automatic update would do it every Interval seconds without modifying the running timer.
;stop
:stop interval timer.
;start
:restart interval timer to call GetUpdate after interval seconds
;upgradeAttributes
:convert outdated attributes for older HTTPMOD-Versions that are still defined for this device from the old syntax to the new one.
:attributes with the description "this attribute should not be used anymore" or similar will be translated to the new syntax, e.g. readingsName1 to reading01Name.
;storeKeyValue
:stores a key value pair in an obfuscated form in the file system. Such values can then be used in replacements where the mode is "key" e.g. to avoid storing passwords in the configuration in clear text

== Get-Commands ==
can be defined using attributes, see advanced configuration

== simple Attributes ==
;enableControlSet
:enables the built in set commands ''interval'', ''stop'', ''start'', ''reread'', ''upgradeAttributes'', ''storeKeyValue''

;enableCookies
:enables the cookie handling inside HTTPMOD. It is advisable to always set this attribute and allow HTTPMOD to track the state of cookies and set them for following HTTP-requests

;enforceGoodReadingNames
:makes sure that HTTPMOD only creates readings that are allowd for Fhem (especially if reading names are dynamically created from JSON object names with extractAllJSON. It is advisable to always set this attribute.

;handleRedirects
:enables the redirect handling inside HTTPMOD which should be used together with the cookie handling of HTTPMOD. HTTPMOD will then automatically follow redirects from a web server and keep track of cookies at the same time. It is advisable to always set this attribute.

;requestHeader.*
:Define an additional HTTP Header to set in the HTTP request

;requestData
:POST Data to be sent in the request. If not defined, it will be a GET request as defined in HttpUtils used by this module

;reading[0-9]+(-[0-9]+)?Name
:the name of a reading to extract with the corresponding readingRegex

;reading[0-9]*(-[0-9]+)?OExpr
:defines an expression that is used in an eval to compute the readings value. The raw value will be in the variable $val.

;reading[0-9]*(-[0-9]+)?OMap
:Output Map. Defines a mapping from raw to visible values like "0:mittig, 1:oberhalb, 2:unterhalb". If specified as readingOMap then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*OMap.

;reading[0-9]*(-[0-9]+)?Format
:Defines a format string that will be used in sprintf to format a reading value. If specified as readingFormat then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Format.

;reading[0-9]*(-[0-9]+)?Decode
:defines an encoding to be used in a call to the perl function decode to convert the raw data string read from the device to a reading. This can be used if the device delivers strings in an encoding like cp850 instead of utf8.

;reading[0-9]*(-[0-9]+)?Encode
:defines an encoding to be used in a call to the perl function encode to convert the raw data string read from the device to a reading. This can be used if the device delivers strings in an encoding like cp850 and after decoding it you want to reencode it to e.g. utf8.

;reading[0-9]+Regex
:defines the regex to be used for extracting the reading. The value to extract should be in a capture group / sub expression
:e.g. ([\d\.]+) in the above example. Multiple capture groups will create multiple readings (see explanation above)

;reading[0-9]+XPath
:defines an xpath to one or more readings when parsing HTML data (see examples below)

;reading[0-9]+XPath-Strict
:defines an xpath to one or more readings when parsing XML data (see examples below)

;reading[0-9]+JSON
:defines a path to the JSON object wanted by concatenating the object names with an underscore as delimiter (see the example below)

;noShutdown
:pass the noshutdown flag to HTTPUtils for webservers that need it (some embedded webservers only deliver empty pages otherwise)

;disable
:stop doing automatic HTTP requests while this attribute is set to 1

;timeout
:time in seconds to wait for an answer. Default value is 2

;do_not_notify

;readingFnAttributes

== Simple Configuration of HTTP Devices ==
If your device expects special HTTP-headers then specify them as <code>attr requestHeader1</code> to <code>attr requestHeaderX</code>.
If your Device expects an HTTP POST instead of HTTP GET then the POST-data can be specified as <code>attr requestData</code>.
To get the readings, specify pairs of <code>attr readingXName</code> and <code>attr readingXRegex</code>, <code>attr readingXXPath</code>, <code>attr readingXXPath-Strict</code> or <code>attr readingXJSON</code> to define which readings you want to extract from the HTTP response and how to extract them. (The old syntax <code>attr readingsNameX</code> and <code>attr readingsRegexX</code> is still supported but the new one with <code>attr readingXName</code> and <code>attr readingXRegex</code> should be preferred. The actual values to be extracted have to be sub expressions within () in the regex (see example below)

=== Example for a PoolManager 5: ===
The PoolManager Web GUI can be queried with HTTP POST Requests like this one:

<syntaxhighlight lang="perl">
POST /cgi-bin/webgui.fcgi HTTP/1.1
Host: 192.168.70.90
Accept: */*
Content-Type: application/json;charset=UTF-8
Content-Length: 60

{"get" :["34.4001.value" ,"34.4008.value" ,"34.4033.value"]}
</syntaxhighlight>

The resulting HTTP Response would look like this:

<syntaxhighlight lang="perl">
HTTP/1.1 200 OK
Content-type: application/json; charset=UTF-8
Expires: 0
Cache-Control: no-cache
Date: Sun, 12 Jan 2014 12:23:11 GMT
Server: lighttpd/1.4.26
Content-Length: 179

{
"data": {
"34.4001.value": "7.00",
"34.4008.value": "0.52",
"34.4033.value": "24.8"
},
"status": {
"code": 0
},
"event": {
"type": 1,
"data": "48.30000.0"
}
}
</syntaxhighlight>

To configure HTTPMOD for a PoolManager one would first define a PoolManager device with e.g. the name PM, the URL and an interval of e.g. 60 seconds.

Then the data to be sent in the request needs to be defined because in this example the device expects a POST request so the query is not contained in the URL but in the request data.

Also as seen above the device expects special HTTP headers in the request so these headers also need to be defined as <code>attr PM requestHeader1</code> and <code>attr PM requestHeader2</code>

Then the names of the readings to be extracted would be set with attributes

Then for each reading value to be extracted a regular expression needs to be set that will match the value in question within ().

Example:
<syntaxhighlight lang="perl">
define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60

attr PM enableControlSet 1
attr PM enableCookies 1
attr PM enforceGoodReadingNames 1
attr PM handleRedirects 1

attr PM reading01Name PH
attr PM reading01Regex 34.4001.value":[ \t]+"([\d\.]+)"

attr PM reading02Name CL
attr PM reading02Regex 34.4008.value":[ \t]+"([\d\.]+)"

attr PM reading03Name3TEMP
attr PM reading03Regex 34.4033.value":[ \t]+"([\d\.]+)"

attr PM requestData {"get" :["34.4001.value" ,"34.4008.value" ,"34.4033.value", "14.16601.value", "14.16602.value"]}
attr PM requestHeader1 Content-Type: application/json
attr PM requestHeader2 Accept: */*
attr PM stateFormat {sprintf("%.1f Grad, PH %.1f, %.1f mg/l Chlor", ReadingsVal($name,"TEMP",0), ReadingsVal($name,"PH",0), ReadingsVal($name,"CL",0))}
</syntaxhighlight>

=== Example for AmbientMonitor ===
AmbientMonitor is a webbased visualisation for sensors connected to an Arduino device. Its web interface can also be queried with HTTMOD to grab the data into readings.

This example was provided by locutus. The hardware configuration is an Arduino + Ethercard with ENC28J60 Controller + DHT22 Sensor and software can be downloaded from https://github.com/lucadentella/AmbientMonitor

In this example an HTTP GET is sufficent, so no <code>requestData</code> is needed. The device provides temperature and humidity readings in an HTTP response that looks like:
<syntaxhighlight lang="perl">
HTTP/1.0 200 OK
Content-Type: text/html

myCB({'temperature':22.00,'humidity':46.00})
</syntaxhighlight>

the definition could be:
<syntaxhighlight lang="perl">
define AmbientMonitor HTTPMOD http://192.168.1.221/?callback=? 300

attr AmbientMonitor enableControlSet 1
attr AmbientMonitor enableCookies 1
attr AmbientMonitor enforceGoodReadingNames 1
attr AmbientMonitor handleRedirects 1

attr AmbientMonitor requestHeader Content-Type: application/json
attr AmbientMonitor reading1Name Temperatur
attr AmbientMonitor reading1Regex temperature':([\d\.]+)
attr AmbientMonitor reading2Name Feuchtigkeit
attr AmbientMonitor reading2Regex humidity':([\d\.]+)
attr AmbientMonitor stateFormat {sprintf("Temperatur %.1f C, Feuchtigkeit %.1f %", ReadingsVal($name,"Temperatur",0), ReadingsVal($name,"Feuchtigkeit",0))}
</syntaxhighlight>

== formatting and manipulating values / readings ==
Values that are parsed from an HTTP response can be further treated or formatted with the following attributes:

* <code>(reading|get)[0-9]*(-[0-9]+)?OExpr</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?OMap</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?Format</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?Decode</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?Encode</code>

They can all be specified for an individual reading, for all readings in one match (e.g. if a regular expression has several capture groups) or for all readings in a get command (defined by getXX) or for all readings in the main reading list (defined by readingXX):
<syntaxhighlight lang="perl">
reading01Format %.1f
</syntaxhighlight>

will format the reading with the name specified by the attribute reading01Name to be numerical with one digit after the decimal point.
If the attribute reading01Regex is used and contains several capture groups then the format will be applied to all readings parsed by this regex unless these readings have their own format specified by reading01-1Format, reading01-2Format and so on.

<syntaxhighlight lang="perl">
reading01-2Format %.1f
</syntaxhighlight>

Can be used in cases where a regular expression specified as reading01regex contains several capture groups or an xpath specified as reading01XPath creates several readings.
In this case reading01-2Format specifies the format to be applied to the second match.

<syntaxhighlight lang="perl">
readingFormat %.1f
</syntaxhighlight>

applies to all readings defined by a reading-Attribute that have no more specific format.

If you need to do some calculation on a raw value before it is used as a reading, you can define the attribute <code>readingOExpr</code>.
It defines a Perl expression that is used in an eval to compute the readings value. The raw value will be in the variable $val.

Example for an expression:
<syntaxhighlight lang="perl">
attr PM reading03OExpr $val * 10
</syntaxhighlight>
Just like in the above example of the readingFormat attributes, readingOExpr and the other following attributes can be applied on several levels.

To map a numerical value to a name, you can use the readingOMap attribute.
It defines a mapping from raw to visible values like "0:mittig, 1:oberhalb, 2:unterhalb".

Example for a map:
<syntaxhighlight lang="perl">
attr PM reading02-3OMap 0:kalt, 1:warm, 2:sehr warm
</syntaxhighlight>

To convert character sets, the module can first decode a string read from the device and then encode it again. For example:
<syntaxhighlight lang="perl">
attr PM getDecode UTF-8
</syntaxhighlight>

This applies to all readings defined for Get-Commands.

== Some help with Regular Expressions ==
{{Randnotiz|RNTyp=y|RNText=Starting with version ''2018-02-10'' the internal that holds the HTTP response is no longer called '''''buf''''' but rather '''''httpbody''''', and it is only displayed when attribute '''''showBody''''' is set to "1".}}
If HTTPMOD seems not to work and the FHEM Logfile contains a message like
:<code>HTTPMOD: Response didn't match Reading ...</code>
then you should check if the value you want to extract is read into the internal with the name buf. Internals are visible when you click on the defined HTTPMOD Device. buf is an internal variable that contains the HTTP Response read. If the value is there and you get the mentioned message then probably something is wrong with your regular expression. Please note that buf might contain special characters like newlines but they are not shown in fhemweb. If you are new to regular expressions then the introduction at http://perldoc.perl.org/perlretut.html might be helpful.

For a typical HTTPMOD use case where you want to extract a number out of a HTTP-Response you can use something like <code>[\d\.]+</code> to match the number itself. The expression matches the number characters (<code>\d</code>) or a <code>.</code> if one of these characters occurs at least once.

To tell HTTPMOD that the number is what you want to use for the reading, you have to put the expression in between <code>()</code>. A <code>([\d\.]+)</code> alone would match the longest number in the HTTP Response which is very likely not the number you are looking for so you need to add something to the expression to give it a context and define how to find the number that you are looking for.

If there is a title text before the number or a special text after the number you can put this in the regex. In one of the examples above <code>humidity':([\d\.]+)</code> is looking for the number that immediately follows the text <code>humidity':</code> without any blanks in between.
Be careful if the text you are getting from your device contains special characters like newline. You don't see such special characters in the fhem webinterface as contents of the internal buf but they might cause your regular expression to fail.

If you have trouble defining a regular expression that matches a certain name, then many complicated characters and then a number, it might be helpful to use a negation in matching like <code>temp[^\d]+([\d\.]).*</code>. In this examle <code>[^\d]+</code> means any character that is not a numerical digit, more than once.

=== Regular Expressions with multiple capture Groups ===
The regular expressions used in the above example for a Poolmanager will take the value that matches one capture group. This is the part of the regular expression inside (). In the above example "([\d\.]+)" refers to numerical digits or points between double quotation marks. Only the string consiting of digits and points will match inside (). This piece is assigned to the reading.

You can also use regular expressions that have several capture groups which might be helpful when parsing tables. In this case an attribute like

<syntaxhighlight lang="perl">
reading02Regex something[ \t]+([\d\.]+)[ \t]+([\d\.]+)
</syntaxhighlight>

could match two numbers. When you specify only one reading02Name like
<syntaxhighlight lang="perl">
reading02Name Temp
</syntaxhighlight>

the name Temp will be used with the extension -1 and -2 thus giving a reading Temp-1 for the first number and Temp-2 for the second. You can also specify individual names for several readings that get parsed from one regular expression with several capture groups by defining attributes

<syntaxhighlight lang="perl">
reading02-1Name
reading02-2Name
...
</syntaxhighlight>
The same notation can be used for formatting attributes like readingXOMap, readingXFormat and so on.

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 ==

If a webservice delivers data in JSON format, HTTPMOD can directly parse JSON which might be easier in this case than definig regular expressions.
The next example shows the data that can be requested from a Poolmanager with the following partial configuration:

<syntaxhighlight lang="perl">
define test2 HTTPMOD none 0
attr test2 get01Name Chlor
attr test2 getURL http://192.168.70.90/cgi-bin/webgui.fcgi
attr test2 getHeader1 Content-Type: application/json
attr test2 getHeader2 Accept: */*
attr test2 getData {"get" :["34.4008.value"]}
</syntaxhighlight>

The data in the HTTP response looks like this:

<syntaxhighlight lang="perl">
{
"data": {
"34.4008.value": "0.25"
},
"status": {
"code": 0
},
"event": {
"type": 1,
"data": "48.30000.0"
}
}
</syntaxhighlight>

the classic way to extract the value 0.25 into a reading with the name Chlor with a regex would have been
<syntaxhighlight lang="perl">
attr test2 get01Regex 34.4008.value":[ \t]+"([\d\.]+)"
</syntaxhighlight>

with JSON you can write
<syntaxhighlight lang="perl">
attr test2 get01JSON data_34.4008.value
</syntaxhighlight>
which will create a reading with the Name "Chlor" (as shown above) and take the value 0.25 from the JSON string.

or if you don't care about the naming of your readings, you can simply extract all JSON data with
<syntaxhighlight lang="perl">
attr test2 extractAllJSON
</syntaxhighlight>

which would apply to all data read from this device and create the following readings out of the HTTP response shown above:

{| class="wikitable"
| data_34.4008.value || 0.25
|-
| event_data || 48.30000.0
|-
| event_type || 1
|-
| status_code || 0
|}

or you can specify
<syntaxhighlight lang="perl">
attr test2 get01ExtractAllJSON
</syntaxhighlight>
which would only apply to all data read as response to the get command defined as get01.

It might seem very simple at first sight to use extractAllJSON but if you prefer readings with a meaningful name you should instead define these readings with readingXXName and readingXXJSON or getXXName and getXXJSON individually. Of Course it would be possible to create additional user readings outside HTTPMOD but doing calculations, naming and formatting inside HTTPMOD is more efficient.

=== JSON Lists ===

imagine the HTTP Response contains:

<syntaxhighlight lang="perl">
{ "power":"0",
"modes":["Off","SimpleColor","RainbowChase"],
"code1":3,
"code2":4
}
</syntaxhighlight>

then a configuration like

<syntaxhighlight lang="perl">
attr device reading01JSON modes
attr device reading01Name Mode
</syntaxhighlight>

will create a list of Subreadings just like a regex with multiple matches can create multiple subreadings:

{| class="wikitable"
| Mode-1 || Off
|-
| Mode-2 || SimpleColor
|-
| Mode-3 || RainbowChase
|}

if you don't want several subreadings but one reading that contains the list of modes, you can specify a recombine expression:

<syntaxhighlight lang="perl">
attr device reading01Name Modes
attr device reading01RecombineExpr join ",", @matchlist
</syntaxhighlight>

which will create one reading containing a list:

{| class="wikitable"
| Modes || Off,SimpleColor,RainbowChase
|}

JSON parsing specifications also don't Need to match exactly. If there is no exact match for a defined reading, the HTTPMOD will try to Interpret the specification as a regex and look for json object paths that match the specification as a regex. For example:

<syntaxhighlight lang="perl">
attr device reading01Name CodeElem
attr device reading01JSON code
</syntaxhighlight>

which will create a list of readings:

{| class="wikitable"
| CodeElem-1|| 3
|-
| CodeElem-2 || 4
|}

and of course they could also be recombined into one reading with a RecombineExpr Attribute.

== Parsing http / XML using xpath ==
Another alternative to regex parsing is the use of XPath to extract values from HTTP responses.
The following example shows how XML data can be parsed with XPath-Strict or HTML Data can be parsed with XPath.
Both work similar and the example uses XML Data parsed with the XPath-Strict option:

If The XML data in the HTTP response looks like this:

<syntaxhighlight lang="xml">
<root xmlns:foo="http://www.foo.org/" xmlns:bar="http://www.bar.org">
<actors>
<actor id="1">Peter X</actor>
<actor id="2">Charles Y</actor>
<actor id="3">John Doe</actor>
</actor>
</root>
</syntaxhighlight>

with XPath you can write
<syntaxhighlight lang="perl">
attr htest reading01Name Actor
attr htest reading01XPath-Strict //actor[2]/text()
</syntaxhighlight>

This will create a reading with the Name "Actor" and the value "Charles Y".

Since XPath specifications can define several values / matches, HTTPMOD can also interpret these and store them in multiple readings:
<syntaxhighlight lang="perl">
attr htest reading01Name Actor
attr htest reading01XPath-Strict //actor/text()
</syntaxhighlight>

will create the readings

{| class="wikitable"
| Actor-1 || Peter X
|-
| Actor-2 || Charles Y
|-
| Actor-3 || John Doe
|}

== Further replacements of URL, header or post data ==
sometimes it might be helpful to dynamically change parts of a URL, HTTP header or post data depending on existing readings, internals or
perl expressions at runtime. This might be needed to pass further variables to a server, a current date or other things.

To support this HTTPMOD offers generic replacements that are applied to a request before it is sent to the server. A replacement can be defined with the attributes

* <code>replacement[0-9]*Regex</code>
* <code>replacement[0-9]*Mode</code>
* <code>replacement[0-9]*Value</code>
* <code>[gs]et[0-9]*Replacement[0-9]*Value</code>

a replacement always replaces a match of a regular expression.

'''replacement[0-9]*Mode:'''
The way the replacement value is defined can be specified with the replacement mode.
* If the <code>replacement[0-9]*Mode</code> is <code>reading</code>, then the corresponding <code>replacement[0-9]*Value</code> is interpreted as the name of a ''reading'' of the same device or as ''device:reading'' to refer to another device.
* If the <code>replacement[0-9]*Mode</code> is <code>internal</code>, then the corresponding <code>replacement[0-9]*Value</code> is interpreted as the name of an ''internal'' of the same device or as ''device:internal'' to refer to another device.
* If the <code>replacement[0-9]*Mode</code> is <code>text</code>, then the corresponding <code>replacement[0-9]*Value</code> is interpreted as a static text
* If the <code>replacement[0-9]*Mode</code> is <code>expression</code>, then the corresponding <code>replacement[0-9]*Value</code> is evaluated as a perl expression to compute the replacement. Inside such a replacement expression it is possible to refer to capture groups of the replacement regex.
* If the <code>replacement[0-9]*Mode</code> is <code>key</code>, then the module will use a value from a key / value pair that is stored in an obfuscated form in the file system with the set storeKeyValue command. This might be useful for storing passwords.

Example:

<syntaxhighlight lang="perl" line="1">
attr mydevice getData {"get" :["%%value%%.value"]}
attr mydevice replacement01Mode text
attr mydevice replacement01Regex %%value%%

attr mydevice get01Name Chlor
attr mydevice get01Replacement01Value 34.4008

attr mydevice get02Name Something
attr mydevice get02Replacement01Value 31.4024

attr mydevice get05Name profile
attr mydevice get05URL http://www.mydevice.local/getprofile?password=%%password%%
attr mydevice replacement02Mode key
attr mydevice replacement02Regex %%password%%
attr mydevice replacement02Value password
</syntaxhighlight>

defines that <code>%%value%%</code> will be replaced by a static text.

All Get commands will be HTTP post requests of a similar form. Only the <code>%%value%%</code> will be different from get to get.
The first get will set the reading named Chlor and for the request it will take the generic getData and replace %%value%% with 34.4008.

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

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.

The mode <code>expression</code> allows you to define your own replacement syntax:
<syntaxhighlight lang="perl">
attr mydevice replacement01Mode expression
attr mydevice replacement01Regex {{([^}]+)}}
attr mydevice replacement01Value ReadingsVal("mydevice", $1, "")
attr mydevice getData {"get" :["{{temp}}.value"]}
</syntaxhighlight>

In this example any <code><nowiki>{{name}}</nowiki></code> in a URL, header or post data will be passed on to the perl function ReadingsVal
which uses the string between <code><nowiki>{{}}</nowiki></code> as second parameter. This way one defined replacement can be used for many different
readings.

HTTPMOD has two built in replacements: One for session Ids and another one for the input value in a set command.
The placeholder $sid is always replaced with the internal <code>$hash->{sid}</code> which contains the session id after it is extracted from a previous HTTP response.
If you don't like to use the placeholder $sid then you can define your own replacement for example like:

<syntaxhighlight lang="perl">
attr mydevice replacement01Mode internal
attr mydevice replacement01Regex %session%
attr mydevice replacement01Value sid
</syntaxhighlight>

Now the internal <code>$hash->{sid}</code> will be used as a replacement for the placeholder %session%.

In the same way a value that is passed to a set-command can be put into a request with a user defined replacement.
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'''

The stove API of Rika on https://www.rika-firenet.com/web/ delivers a JSON string with all settings and values, and can be piloted with a data string containing all the "set" values at once.

Delivered JSON on get https://www.rika-firenet.com/api/client/xxxxxxxx/status : (xxxxxxxx must be replaced with the unique stove ID)
<syntaxhighlight lang="perl">
{
"name": "Vorzimmer",
"stoveID": "xxxxxxxxx",
"lastSeenMinutes": 1,
"lastConfirmedRevision": 1504385700,
"controls": {
"revision": 1504385700,
"onOff": true,
"operatingMode": 2,
"heatingPower": 65,
"targetTemperature": 24,
"heatingTimesActive": false,
"heatingTimesActiveForComfort": true,
"setBackTemperature": 18,
"convectionFan1Active": false,
"convectionFan1Level": 0,
"convectionFan1Area": 0,
"convectionFan2Active": false,
"convectionFan2Level": 0,
"convectionFan2Area": 0,
"frostProtectionActive": false,
"frostProtectionTemperature": 5
},
"sensors": {
"statusError": 0,
"statusWarning": 0,
"statusService": 0,
"statusMainState": 1,
"statusSubState": 3,
"statusFrostStarted": false,
"inputFlameTemperature": 21,
"inputRoomTemperature": 21,
"inputExternalRequest": true,
"outputDischargeMotor": 0,
"outputInsertionMotor": 0,
"outputIDFan": 0,
"outputAirFlaps": 0,
"outputIgnition": false,
"parameterStoveTypeNumber": 13,
"parameterVersionMainBoard": 223,
"parameterVersionTFT": 223,
"parameterRuntimePellets": 11,
"parameterRuntimeLogs": 0,
"parameterFeedRateTotal": 17,
"parameterFeedRateService": 683,
"parameterOnOffCycles": 2
},
"stoveType": "DOMO MultiAir",
"stoveFeatures": {
"multiAir1": true,
"multiAir2": true,
"insertionMotor": false,
"airFlaps": false,
"logRuntime": false
}
}
</syntaxhighlight>

Data string to send to https://www.rika-firenet.com/api/client/xxxxxxxx/controls in order to set values:
<syntaxhighlight lang="perl">
heatingTimesActiveForComfort=true&frostProtectionTemperature=3&setBackTemperature=18&targetTemperature=24&convectionFan2Level=0&convectionFan2Active=false&convectionFan1Level=0&onOff=true&convectionFan1Active=false&convectionFan2Area=0&revision=1505550101&heatingTimesActive=false&convectionFan1Area=0&frostProtectionActive=false&operatingMode=2&heatingPower=65
</syntaxhighlight>

Code in 99_myUtils.pm:
<syntaxhighlight lang="perl">
use JSON;
...
sub
replaceJSON ($$) {
my ($valToReplace, $value) = @_;

#$value in the parameters is a default value
#It has to be replaced through the real value nnn passed in the set command "set <device> valToset nnn"
$value = InternalVal("Ofen", "value", $value);
Log3 ("Ofen", 3, "replaceJSON Internalvalue: $value");

#Force an update to avoid outdated revision number
fhem ("get Ofen revision");

#Get all the controls as json
my $json = ReadingsVal("Ofen", "controlsJSON","");
Log3 ("Ofen", 3, "replaceJSON configsJSON: $json");

# When starting FHEM or rereading config, the reading controlsJSON is empty
return if ($json eq "");

my $decoded = decode_json($json);
my $result;
for my $key ( keys %$decoded ) {
$result .= "$key=";
if ($key eq $valToReplace) {
$result .= $value."&";
} else {
$result .= $decoded->{$key}."&";
}
}
chop($result); #remove last &
Log3("Ofen", 3, "replaceJSON Result: $result");
return $result;
}
</syntaxhighlight>

Define stove in fhem:
<syntaxhighlight lang="perl">
defmod Ofen HTTPMOD https://www.rika-firenet.com/api/client/xxxxxxxx/status 60

attr Ofen enableCookies 1
attr Ofen reAuthRegex id="login"|Unauthorized
attr Ofen sid01Data email=xx@xx&password=xx
attr Ofen sid01URL https://www.rika-firenet.com/web/login

attr Ofen reading01JSON sensors_inputRoomTemperature
attr Ofen reading01Name RaumTemp
attr Ofen reading02JSON controls_setBackTemperature
attr Ofen reading02Name Absenkung
attr Ofen reading03JSON controls_frostProtectionTemperature
attr Ofen reading03Name Frostschutz
attr Ofen reading10Name controlsJSON
attr Ofen reading10Regex (?s)controls.*?({.*?})

attr Ofen get09Name revision
attr Ofen get09URL https://www.rika-firenet.com/api/client/xxxxxxxx/status

attr Ofen setURL https://www.rika-firenet.com/api/client/xxxxxxxx/controls
attr Ofen setData {{data}}
attr Ofen replacement01Mode expression
attr Ofen replacement01Regex {{data}}

attr Ofen set11Name frostProtectionTemperature
attr Ofen set11Replacement01Value replaceJSON("frostProtectionTemperature", 2)

attr Ofen set12Name targetTemperature
attr Ofen set12Replacement01Value replaceJSON("targetTemperature", 24)
</syntaxhighlight>

A detailed explanation (in german) of the login process can be found here: [https://forum.fhem.de/index.php/topic,76220.msg682514.html#msg682514]
and the explanation of the other parameters here: [https://forum.fhem.de/index.php/topic,76220.msg685710.html#msg685710]

== replacing reading values when they have not been updated / the device did not respond ==
If a device does not respond then the values stored in readings will keep the same and only their timestamp shows that they are outdated.
If you want to modify reading values that have not been updated for a number of seconds, you can use the attributes

* <code>(reading|get)[0-9]*(-[0-9]+)?MaxAge</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacementMode</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacement</code>

Every time the module tries to read from a device, it will also check if readings have not been updated
for longer than the <code>MaxAge</code> attributes allow. If readings are outdated, the <code>MaxAgeReplacementMode</code> defines how the affected
reading values should be replaced. <code>MaxAgeReplacementMode</code> can be <code>text</code>, <code>reading</code>, <code>internal</code>, <code>expression</code> or <code>delete</code>.

<code>MaxAge</code> specifies the number of seconds that a reading should remain untouched before it is replaced.

<code>MaxAgeReplacement</code> contains either a static text that is used as replacement value or a Perl expression that is evaluated to
give the replacement value. This can be used for example to replace a temperature that has not bee updated for more than 5 minutes
with the string "outdated - was 12":
<syntaxhighlight lang="perl">
attr PM readingMaxAge 300
attr PM readingMaxAgeReplacement "outdated - was " . $val
attr PM readingMaxAgeReplacementMode expression
</syntaxhighlight>
The variable <code>$val</code> contains the value of the reading before it became outdated.

Or to show that a device was offline:
<syntaxhighlight lang="perl">
attr MyLight reading01Name color
attr MyLight reading01JSON result_02_color
attr MyLight reading01MaxAge 300
attr MyLight reading01MaxAgeReplacement "offline"
attr MyLight reading01MaxAgeReplacementMode text
</syntaxhighlight>

== Note on determining how to send requests to a special device ==
If you don't know which URLs, headers or POST data your web GUI uses, you might try a local proxy like BurpSuite [http://portswigger.net/burp/ BurpSuite] to track requests and responses. This is a tedious task but probably the best way to achieve a successful result.

Let us consider an example. The Telekom Speedport W724V has a login-site that is famous for being cumbersome. Burp allows to monitor each step in the login procedure. In the case of a speedport the following steps occur:

First burp shows that a get command is issued
##################################################################################################
GET / HTTP/1.1
Host: speedport.ip
Cache-Control: max-age=0
Upgrade-Insecure-Requests: 1
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.133 Safari/537.36
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
Accept-Language: de-DE,de;q=0.8,en-US;q=0.6,en;q=0.4
Cookie: lang=de
Connection: close
In order to mimic the behavior of a real person calling the website HTTPMOD should copy all necessary steps. Host, Cookie and the GET-command are usually necessary. The same cannot be said of the User-Agent because the website can be called from any mobile or desktop computer.

Then, the speedport will answer with a command that consists of several lines. By going through every line for every step in the login procedure one will finally arrive at the information that is necessary to successfully enter the login of the speedport (in case of the W724V, for example, it is necessary to copy a token called _httoken and to include the referer).

== Advanced configuration to define a <code>set</code> command and send data to a device ==

When a set option is defined by attributes, the module will use the value given to the set command and integrate it into an HTTP-Request that sends the value to the device. The definitions for URL, headers and post data can contain the placeholder $val which will be replaced by the (numerical) value given to the set command.

This can be as simple as:
<syntaxhighlight lang="perl">
# No cyclic requests and no main URL needed in this example
define MyDevice HTTPMOD none 0

attr MyDevice set01Name Licht
attr MyDevice set01URL http://192.168.1.22/switch=$val
</syntaxhighlight>

A user command
<syntaxhighlight lang="perl">
set MyDevice Licht 1
</syntaxhighlight>

will be translated into the http GET request
<syntaxhighlight lang="perl">
http://192.168.1.22/switch=1
</syntaxhighlight>

In this example a map would also be helpful, that translates on / off to 0 or 1 and allows the user to select on/of in fhemweb:
<syntaxhighlight lang="perl">
attr MyDevive set01IMap 0:off, 1:on
</syntaxhighlight>
This also provides input validation to make sure that only on and off can be used with the set command.

In more complex Scenarios you might need to login before sending a command and the Login might create a session id that has to be part of further requests either in the URL, in headers or in the post data.

Extension to the above example for a PoolManager 5 where a set needs a session id in the URL and the values have to be passed in JSON strings as post data:
<syntaxhighlight lang="perl">
attr PM set01Name HeizungSoll
attr PM set01URL http://MyPoolManager/cgi-bin/webgui.fcgi?sid=$sid
attr PM set01Hint 6,10,20,30
attr PM set01Min 6
attr PM set01Max 30
attr PM setHeader1 Content-Type: application/json
attr PM set01Data {"set" :{"34.3118.value" :"$val" }}
</syntaxhighlight>

This example defines a set option with the name HeizungSoll.
By issuing <code>set PM HeizungSoll 10</code> in FHEM, the value 10 will be sent in the defined HTTP
Post to URL <code>http://MyPoolManager/cgi-bin/webgui.fcgi</code> in the Post Data as

<syntaxhighlight lang="html">
{"set" :{"34.3118.value" :"10" }}
</syntaxhighlight>

The optional attributes set01Min and set01Max define input validations that will be checked in the set function.
The optional attribute set01Hint will define a selection list for the FHEMweb GUI.

The HTTP response to such a request will be ignored unless you specify the attribute <code>setParseResponse</code>
for all set commands or <code>set01ParseResponse</code> for the set command with number 01.
If the HTTP response to a set command is parsed then this is done like the parsing of responses to get commands and you can use the attributes ending e.g. on Format, Encode, Decode, OMap and OExpr to manipulate / format the values read.

If a parameter to a set command is not numeric but should be passed on to the device as text, then you can specify the attribute setTextArg. For example:
<syntaxhighlight lang="perl">
attr PM set01TextArg
</syntaxhighlight>

If a set command should not require a parameter at all, then you can specify the attribute NoArg. For example:
<syntaxhighlight lang="perl">
attr PM set03Name On
attr PM set03NoArg
</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
attr WuT_Analog1 room W&T
attr WuT_Analog1 set01Max 16
attr WuT_Analog1 set01Min 0
attr WuT_Analog1 set01Name Output1
attr WuT_Analog1 set01URL http://192.xx.My_IP/outputaccess1?PW=MyPassword&State=$val&
attr WuT_Analog1 set02Max 16
attr WuT_Analog1 set02Min 0
attr WuT_Analog1 set02Name Output2
attr WuT_Analog1 set02URL http://192.xx.My_IP/outputaccess2?PW=MyPassword&State=$val&
</syntaxhighlight>

== Advanced configuration to create a valid session id that might be necessary ==
In simple cases logging in works with basic authentication. In the case HTTPMOD accepts a username and password as part of the URL in the form
<syntaxhighlight lang="perl">
http://User:Password@192.168.1.18/something
</syntaxhighlight>

However basic auth is seldom used. If you need to fill in a username and password in a HTML form and the session is then managed by a session id, here is how to configure this:

when sending data to an HTTP-Device in a set, HTTPMOD will replace any <code>$sid</code> in the URL, Headers and Post data with the internal <code>$hash->{sid}</code>. To authenticate towards the device and give this internal a value, you can use an optional multi step login procedure defined by the following attributes:

* <code>sid[0-9]*URL</code>
* <code>sid[0-9]*Data.*</code>
* <code>sid[0-9]*Header.*</code>
* <code>sid[0-9]*IgnoreRedirects</code>
* <code>idRegex</code>
* <code>idJSON</code>
* <code>idXPath</code>
* <code>idXPath-Strict</code>
* <code>(get|set|sid)[0-9]*IdRegex</code>
* <code>(get|set|sid)[0-9]*IdJSON</code>
* <code>(get|set|sid)[0-9]*IdXPath</code>
* <code>(get|set|sid)[0-9]*IdXPath-Strict</code>

Each step can have a URL, Headers, Post Data pieces and a Regex to extract a resulting Session ID into <code>$hash->{sid}</code>.
HTTPMOD will create a sorted list of steps (the numbers between sid and URL / Data / Header) and the loop through these steps and send the corresponding requests to the device. For each step a $sid in a Header or Post Data will be replaced with the current content of <code>$hash->{sid}</code>.

Using this feature, HTTPMOD can perform a forms based authentication and send user name, password or other necessary data to the device and save the session id for further requests.

To determine when this login procedure is necessary, HTTPMOD will first try to send a request without
doing the login procedure. If the result contains an error that authentication is necessary, then a login is performed.
To detect such an error in the HTTP response, you can again use a regular expression, JSON or XPath, this time with the attributes

* <code>reAuthRegex</code>
* <code>reAuthJSON</code>
* <code>reAuthXPath</code>
* <code>reAuthXPath-Strict</code>
* <code>(get|set)[0-9]*ReAuthRegex</code>
* <code>(get|set)[0-9]*ReAuthJSON</code>
* <code>(get|set)[0-9]*ReAuthXPath</code>
* <code>(get|set)[0-9]*ReAuthXPath-Strict</code>

reAuthJSON or reAuthXPath typically only extract one piece of data from a response.
If the existence of the specified piece of data is sufficent to start a login procedure, then nothing more needs to be defined to detect this situation.
If however the indicator is a status code that contains different values depending on a successful request and a failed request if a new authentication is needed,
then you can combine things like reAuthJSON with reAuthRegex. In this case the regex is only matched to the data extracted by JSON (or XPath).
This way you can easily extract the status code using JSON parsing and then specify the code that means "authentication needed" as a regular expression.

If for one step not all of the URL, Data or Header Attributes are set, then HTTPMOD tries to use a
<code>sidURL</code>, <code>sidData.*</code> or <code>sidHeader.*</code> Attribute (without the step number after sid). This way parts that are the same for all steps don't need to be defined redundantly.

=== Example for a multi step login procedure: ===
<syntaxhighlight lang="perl">
attr PM reAuthRegex /html/dummy_login.htm
attr PM sidURL http://192.168.70.90/cgi-bin/webgui.fcgi?sid=$sid
attr PM sidHeader1 Content-Type: application/json
attr PM sid1IDRegex wui.init\('([^']+)'
attr PM sid2Data {"set" :{"9.17401.user" :"fhem" ,"9.17401.pass" :"password" }}
attr PM sid3Data {"set" :{"35.5062.value" :"128" }}
attr PM sid4Data {"set" :{"42.8026.code" :"pincode" }}
</syntaxhighlight>

In this case HTTPMOD detects that a login is necessary by looking for the pattern /html/dummy_login.htm in the HTTP response.
If it matches, it starts a login sequence. In the above example all steps request the same URL. In step 1 only the defined Header is sent in an HTTP get request. The response will contain a session id that is extraced with the regex wui.init\('([^']+)'.

In the next step this session id is sent in a post request to the same URL where tha post data contains a username and password. The a third and a fourth request follow that set a value and a code. The result will be a valid and authorized session id that can be used in other requests where $sid is part of a URL, header or post data and will be replaced with the session id extracted above.

===Another Practical Example reading the SOC from a Renault Zoe===
<syntaxhighlight lang="perl">
define myZoe HTTPMOD https://www.services.renault-ze.com/api/vehicle/VINVINVIN/battery 7000
attr myZoe userattr reading01JSON reading01Name reading02JSON reading02Name reading03JSON reading03Nam\
e reading04JSON reading04Name reading05JSON reading05Name requestHeader02 sid1Data sid1Header01 sid1Id\
JSON sid1IgnoreRedirects:0,1 sid1URL
attr myZoe reAuthJSON message
attr myZoe reading01JSON charge_level
attr myZoe reading01Name SOC
attr myZoe reading02JSON charging
attr myZoe reading02Name charging
attr myZoe reading03JSON plugged
attr myZoe reading03Name plugged
attr myZoe reading04JSON remaining_range
attr myZoe reading04Name remaining_range
attr myZoe reading05JSON last_update
attr myZoe reading05Name last_update
attr myZoe requestHeader02 Authorization: Bearer $sid
attr myZoe sid1Data {"username":"ZEUSERNAME","password":"ZEPASSWORD"}
attr myZoe sid1Header01 Content-Type: application/json
attr myZoe sid1IdJSON token
attr myZoe sid1IgnoreRedirects 1
attr myZoe sid1URL https://www.services.renault-ze.com/api/user/login
attr myZoe timeout 10
#attr myZoe verbose 7
</syntaxhighlight>

The $sid is read by logging in with username and password from JSON {"token": ..} after detecting an error {"message": ..} from a failed request. This example offers no solution for the reading of the VIN from the login request, which in turn is part of the reading URL. It should be possible to read more than just the $sid from the login sequence.

In the special case where a session id is set as a HTTP-Cookie (with the header Set-cookie: in the HTTP response) HTTPMOD offers an even simpler way. With the attribute enableCookies a very basic cookie handling mechanism is activated that stores all cookies that the server sends to the HTTPMOD device and puts them back as cookie headers in the following requests.

For such cases no sidIdRegex and no $sid in a user defined header is necessary.

== Advanced configuration to define a <code>get</code> and request additional data with its own request from a device ==

The normal automatic HTTP request that is done repeatedly after the defined interval has elapsed works well in cases where all required readings can be requested in one common HTTP request. If however a device needs individual requests with different URLs or different POST data for each value, then another method is necessary.
For such cases a <code>get</code> option can be defined and the user can either issue FHEM <code>get</code> commands each time he needs the reading or the user can set an attribute to request the reading automatically together with the normal iteration.
For each <code>get</code> option attributes define an individual URL, optional headers, and post data as well as individual regular expressions and formatting options.

When a get option is defined by attributes, the module allows querying additional values from the device that require individual HTTP-Requests or special parameters to be sent

Extension to the above example:

<syntaxhighlight lang="perl">
attr PM get01Name MyGetValue
attr PM get01URL http://MyPoolManager/cgi-bin/directory/webgui.fcgi?special=1?sid=$sid
attr PM getHeader1 Content-Type: application/json
attr PM get01Data {"get" :{"30.1234.value"}}
</syntaxhighlight>

This example defines a get option with the name MyGetValue.
By issuing <code>get PM MyGetValue</code> in FHEM, the defined HTTP request is sent to the device.
The HTTP response is then parsed using the same readingXXName and readingXXRegex attributes as above so
additional pairs will probably be needed there for additional values.

if you prefer to define the parsing and formatting of readings individually per get command, you can use
attributes like get01Regex, get01XPath, get01Format, get01OMap and so on just like for reading01...

You can also include parameters / values that are passed to the get command in the request just like for set commands.
The placeholder $val will be replaced with the value given to the get command or you can specify your own replacement as described above.

If the new get parameter should also be queried regularly, you can define the following optional attributes:

<syntaxhighlight lang="perl">
attr PM get01Poll 1
attr PM get01PollDelay 300
</syntaxhighlight>

The first attribute includes this reading in the automatic update cycle and the second defines an alternative lower update frequency. When the interval defined initially in the define is over and the normal readings are read from the device, the update function will check for additional get parameters that should be included in the update cycle.

If a PollDelay is specified for a get parameter, the update function also checks if the time passed since it has last read this value is more than the given PollDelay. If not, this reading is skipped and it will be rechecked in the next cycle when interval is over again. So the effective PollDelay will always be a multiple of the interval specified in the initial define.

Please note that each defined get command that is included in the regular update cycle will create its own HTTP request. So if you want to extract several values from the same request, it is much more efficient to do this by defining readingXXName and readingXXRegex, XPath or JSON attributes and to specify an interval and a URL in the define of the HTTPMOD device.

Example for a Siemens webserver provided by Lanhydrock:
<syntaxhighlight lang="perl">
define ozw672 HTTPMOD https://192.168.178.8/api/auth/login.json?user=test&pwd=test 300

attr ozw672 get1Name tempAussen
attr ozw672 get1URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1960
attr ozw672 get1Poll 1
attr ozw672 get1PollDelay 1800

attr ozw672 get2Name tempAussenGemischt
attr ozw672 get2URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1964
attr ozw672 get2Poll 1
attr ozw672 get2PollDelay 1800

attr ozw672 get3Name tempTWW
attr ozw672 get3URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1996
attr ozw672 get3Poll 1

attr ozw672 get4Name tempKesselSoll
attr ozw672 get4URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1910
attr ozw672 get4Poll 1

attr ozw672 get5Name tempKesselRuecklauf
attr ozw672 get5URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1915
attr ozw672 get5Poll 1

attr ozw672 get6Name tempKesselRuecklaufSoll
attr ozw672 get6URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1916
attr ozw672 get6Poll 1

attr ozw672 get7Name anzahlStartsBrenner
attr ozw672 get7URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1927
attr ozw672 get7PollDelay 1800
attr ozw672 get7Poll 1

attr ozw672 get8Name statusKessel
attr ozw672 get8URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1898
attr ozw672 get8Poll 1
attr ozw672 get8Regex Value": "([a-zA-Zü ]*)"
attr ozw672 get8OMap Aus:0, Nachlauf aktiv:5, Freigegeben für TWW:10, Freigegeben für HK:20, In Teillastbetrieb für TWW:40, In Teillastbetrieb für HK:50, In Betrieb für Trinkwasser:90, In Betrieb für Heizkreis:100

attr ozw672 getRegex Value": "[ ]*([-.0-9]*)"

attr ozw672 reAuthRegex .*session not valid.*
attr ozw672 sid1IDRegex .*"(.*-.*-.*-[0-9a-z]*).*
attr ozw672 sid1URL https://192.168.178.8/api/auth/login.json?user=test&pwd=test
</syntaxhighlight>

== All attributes ==
;reading[0-9]+Name
:the name of a reading to extract with the corresponding readingRegex, readingJSON, readingXPath or readingXPath-Strict
:Please note that the old syntax readingsName.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.

;(get|set)[0-9]+Name
:Name of a get or set command
:If the HTTP response that is received after the command is parsed with an individual parse option then this name is also used as a reading name. Please note that no individual parsing needs to be defined for a get or set. If no regex, XPath or JSON is specified for the command, then HTTPMOD will try to parse the response using all the defined readingRegex, reading XPath or readingJSON attributes.

;(get|set|reading)[0-9]+Regex
:If this attribute is specified, the Regex defined here is used to extract the value from the HTTP Response and assign it to a Reading with the name defined in the (get|set|reading)[0-9]+Name attribute.
:If this attribute is not specified for an individual Reading or get or set but without the numbers in the middle, e.g. as getRegex or readingRegex, then it applies to all the other readings / get / set commands where no specific Regex is defined. 
:The value to extract should be in a capture group / sub expression e.g. ([\d\.]+) in the above example. Multiple capture groups will create multiple readings (see explanation above)
:Using this attribute for a set command (setXXRegex) only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
:Please note that the old syntax <code>readingsRegex.*</code> does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.
:If for get or set commands neither a generic Regex attribute without numbers nor a specific (get|set)[0-9]+Regex attribute is specified and also no XPath or JSON parsing specification is given for the get or set command, then HTTPMOD tries to use the parsing definitions for general readings defined in reading[0-9]+Name, reading[0-9]+Regex or XPath or JSON attributes and assigns the Readings that match here.

;(get|set|reading)[0-9]+RegOpt
:Lets the user specify regular expression modifiers. For example if the same regular expression should be matched as often as possible in the HTTP response, then you can specify RegOpt g which will case the matching to be done as /regex/g
:The results will be trated the same way as multiple capture groups so the reading name will be extended with -number.
:For other possible regular expression modifiers see http://perldoc.perl.org/perlre.html#Modifiers

;(get|set|reading)[0-9]+XPath
:defines an xpath to one or more values when parsing HTML data (see examples above)
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;get|set|reading[0-9]+XPath-Strict
:defines an xpath to one or more values when parsing XML data (see examples above)
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;(get|set|reading)[0-9]+AutoNumLen
:In cases where a regular expression or an XPath results in multiple results and these results are stored in a common reading name with extension -number, then you can modify the format of this number to have a fixed length with leading zeros. AutoNumLen 3 for example will lead to reading names ending with -001 -002 and so on.

;(get|set|reading)[0-9]+AlwaysNum
:if set to 1 this attributes forces reading names to end with a -1, -01 (depending on the above described AutoNumLen) even if just one value is parsed.

;get|set|reading[0-9]+JSON
:defines a path to the JSON object wanted by concatenating the object names. See the above example.
:If you don't know the paths, then start by using extractAllJSON and the use the names of the readings as values for the JSON attribute. 
:Please don't forget to also specify a name for a reading, get or set.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;(get|set|reading)[0-9]*RecombineExpr
:defines an expression that is used in an eval to compute one reading value out of the list of matches.
:This is supposed to be used for regexes or xpath specifications that produce multiple results if only one result that combines them is wanted. The list of matches will be in the variable @matchlist.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;get[0-9]*CheckAllReadings
:this attribute modifies the behavior of HTTPMOD when the HTTP Response of a get command is parsed. 
:If this attribute is set to 1, then additionally to the matching of the corresponding get specific regex (get[0-9]*Regex), XPath or JSON attribute also all the reading names and parse definitions defined in Reading[0-9]+Name and Reading[0-9]+Regex, XPath or JSON attributes are checked and if they match, the coresponding Readings are assigned as well.
:Please note that this does not mean that get01CheckAllReadings will cause a get02Regex to be used. Only the corresponding get01Regex will be used but additionally all the readingXYRegex attributes.
:This is automatically done if a get or set command is defined without its own parse attributes.

;(get|reading)[0-9]*OExpr
:defines an optional expression that is used in an eval to compute / format a readings value after parsing an HTTP response
:The raw value from the parsing will be in the variable $val.
:If specified as readingOExpr then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Expr.
:Please note that the old syntax readingsExpr.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.

;(get|reading)[0-9]*Expr
:This is the old syntax for (get|reading)[0-9]*OExpr. It should be replaced by (get|reading)[0-9]*OExpr. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.

;(get|reading)[0-9]*OMap
:Map that defines a mapping from raw value parsed to visible values like "0:mittig, 1:oberhalb, 2:unterhalb".
:If specified as readingOMap then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Map. 
:The individual options in a map are separated by a komma and an optional space. Spaces are allowed to appear in a visible value however kommas are not possible.

;(get|reading)[0-9]*Map
:This is the old syntax for (get|reading)[0-9]*OMap. It should be replaced by (get|reading)[0-9]*OMap. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.

;(get|set|reading)[0-9]*Format
:Defines a format string that will be used in sprintf to format a reading value.
:If specified without the numbers in the middle e.g. as readingFormat then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Format.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse. 

;(get|set|reading)[0-9]*Decode
:defines an encoding to be used in a call to the perl function decode to convert the raw data string read from the device to a reading.
:This can be used if the device delivers strings in an encoding like cp850 instead of utf8.
:If your reading values contain Umlauts and they are shown as strange looking icons then you probably need to use this feature.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;(get|set|reading)[0-9]*Encode
:defines an encoding to be used in a call to the perl function encode to convert the raw data string read from the device to a reading.
:This can be used if the device delivers strings in an encoding like cp850 and after decoding it you want to reencode it to e.g. utf8.
:If your reading values contain Umlauts and they are shown as strange looking icons then you probably need to use this feature.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;(get|set)[0-9]*URL
:URL to be requested for the set or get command. If this option is missing, the URL specified during define will be used.

;(get|set)[0-9]*Data
:Data to be sent to the device as POST data when the get or set command is executed. if this attribute is not specified, an HTTP GET method will be used instead of an HTTP POST

;(get|set)[0-9]*NoData
:can be used to override a more generic attribute that specifies POST data for all get or set commands. With NoData no data is sent and therefor the request will be an HTTP GET.

;(get|set)[0-9]*Header.*
:HTTP Headers to be sent to the device when the set is executed

;requestHeader.*
:Define an optional additional HTTP Header to set in the HTTP request of the main loop

;requestData
:optional POST Data to be sent in the request of the main loop. If not defined, it will be an HTTP GET request as defined in HttpUtils which is used by this module

;get[0-9]+Poll
:if set to 1 the get is executed automatically during the normal update cycle (after the interval provided in the define command has elapsed)

;get[0-9]+PollDelay
:if the value should not be read in each iteration (after the interval given to the define command), then a minimum delay can be specified with this attribute. This has only an effect if the above Poll attribute has also been set. Every time the update function is called, it checks if since this get has been read the last time, the defined delay has elapsed. If not, then it is skipped this time.
:PollDelay can be specified as seconds or as x[0-9]+ which means a multiple of the interval in the define command.

;(get|set)[0-9]*TextArg
:For a get command this defines that the command accepts a text value after the option name. By default a get command doesn't accept optional values after the command name.
:If TextArg is specified and a value is passed after the get name then this value can then be used in a request URL, header or data as replacement for $val or in a user defined replacement that uses the internal "value" ($hash->{value}).
:If used for a set command then it defines that the value to be set doesn't require any validation / conversion.
:The raw value is passed on as text to the device. By default a set command expects a numerical value or a text value that is converted to a numeric value using a map.

;set[0-9]+Min
:Minimum value for input validation.

;set[0-9]+Max
:Maximum value for input validation.

;set[0-9]+IExpr
:Perl Expression to compute the raw value to be sent to the device from the input value passed to the set.

;set[0-9]+Expr
:This is the old syntax for (get|reading)[0-9]*IExpr. It should be replaced by (get|reading)[0-9]*IExpr. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.

;set[0-9]+IMap
:Map that defines a mapping from raw to input values like "0:mittig, 1:oberhalb, 2:unterhalb". This attribute atomatically creates a hint for FHEMWEB so the user can choose one of the input values.

;set[0-9]+Map
:This is the old syntax for (get|reading)[0-9]*IMap. It should be replaced by (get|reading)[0-9]*IMap. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.

;set[0-9]+Hint
:Explicit hint for fhemWEB that will be returned when set ? is seen. Can be used to get a slider or a list of values to choose from.

;set[0-9]*NoArg
:Defines that this set option doesn't require arguments. It allows sets like "on" or "off" without further values.

;set[0-9]*ParseResponse
:defines that the HTTP response to the set will be parsed as if it was the response to a get command.

;(get|set)[0-9]*URLExpr
:Defines a Perl expression to specify the HTTP Headers for this request. This overwrites any other header specification and should be used carefully only if needed. The original Header is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.

;(get|set)[0-9]*DatExpr
:Defines a Perl expression to specify the HTTP Post data for this request. This overwrites any other post data specification and should be used carefully only if needed. The original Data is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.

;(get|set)[0-9]*HdrExpr
:Defines a Perl expression to specify the URL for this request. This overwrites any other URL specification and should be used carefully only if needed. The original URL is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.

;ReAuthRegex
:regular Expression to match an error page indicating that a session has expired and a new authentication for read access needs to be done.
:This attribute only makes sense if you need a forms based authentication for reading data and if you specify a multi step login procedure based on the sid.. attributes.
:This attribute is used for all requests. For set and get operations you can however specify individual reAuthRegexes with the (get|set)[0-9]*ReAuthRegex attributes.

;(get|set)[0-9]*ReAuthRegex
:Regex that will detect when a session has expired during a set operation and a new login needs to be performed.
:It works like the global reAuthRegex but is used for set operations.

;sid[0-9]*URL
:different URLs or one common URL to be used for each step of an optional login procedure.

;sid[0-9]*IDRegex
:different Regexes per login procedure step or one common Regex for all steps to extract the session ID from the HTTP response

;sid[0-9]*Data.*
:data part for each step to be sent as POST data to the corresponding URL

;sid[0-9]*Header.*
:HTTP Headers to be sent to the URL for the corresponding step

;sid[0-9]*IgnoreRedirects
:Tells the HttpUtils to not follow HTTP Redirects for this Request. Might be needed for some devices that set a session cookie within a 303 Redirect.

;clearSIdBeforeAuth
:will set the session id to "" before doing the authentication steps

;authRetries
:number of retries for authentication procedure - defaults to 1

;replacement[0-9]*Regex
:Defines a replacement to be applied to an HTTP request header, data or URL before it is sent. This allows any part of the request to be modified based on a reading, an internal or an expression.
:The regex defines which part of a header, data or URL should be replaced. The replacement is defined with the following attributes:

;replacement[0-9]*Mode
:Defines how the replacement should be done and what replacementValue means. Valid options are text, reading, internal and expression.

;replacement[0-9]*Value
:Defines the replacement. If the corresponding replacementMode is <code>text</code>, then value is a static text that is used as the replacement.
:If replacementMode is <code>reading</code> then Value can be the name of a reading of this device or it can be a reading of a different device referred to by devicename:reading.
:If replacementMode is <code>internal</code> the Value can be the name of an internal of this device or it can be an internal of a different device referred to by devicename:internal.
:If replacementMode is <code>expression</code> the the Value is treated as a Perl expression that computes the replacement value. The expression can use $1, $2 and so on to refer to capture groups of the corresponding regex that is matched against the original URL, header or post data.
:If replacementMode is <code>key</code> then the module will use a value from a key / value pair that is stored in an obfuscated form in the file system with the set storeKeyValue command. This might be useful for storing passwords.

;[gs]et[0-9]*Replacement[0-9]*Value
:This attribute can be used to override the replacement value for a specific get or set.

;get|reading[0-9]*MaxAge
:Defines how long a reading is valid before it is automatically overwritten with a replacement when the read function is called the next time.

;get|reading[0-9]*MaxAgeReplacement
:specifies the replacement for MaxAge - either as a static text or as a perl expression.

;get|reading[0-9]*MaxAgeReplacementMode
:specifies how the replacement is interpreted: can be text, expression and delete.

;get|reading[0-9]*DeleteIfUnmatched
:If set to 1 this attribute causes certain readings to be deleted when the parsing of the website does not match the specified reading. Internally HTTPMOD remembers which kind of operation created a reading (update, Get01, Get02 and so on). Specified readings will only be deleted if the same operation does not parse this reading again. This is especially useful for parsing that creates several matches / readings and the number of matches can vary from request to request. For example if reading01Regex creates 4 readings in one update cycle and in the next cycle it only matches two times then the readings containing the remaining values from the last round will be deleted.
:Please note that this mechanism will not work in all cases after a restart. Especially when a get definition does not contain its own parsing definition but ExtractAllJSON or relies on HTTPMOD to use all defined reading.* attributes to parse the responsee to a get command, old readings might not be deleted after a restart of fhem.
;get|reading[0-9]*DeleteOnError
:If set to 1 this attribute causes certain readings to be deleted when the website can not be reached and the HTTP request returns an error. Internally HTTPMOD remembers which kind of operation created a reading (update, Get01, Get02 and so on). Specified readings will only be deleted if the same operation returns an error.
The same restrictions as for DeleteIfUnmatched apply regarding a fhem restart.

;httpVersion
:defines the HTTP-Version to be sent to the server. This defaults to 1.0.

;sslVersion
:defines the SSL Version for the negotiation with the server. The attribute is evaluated by HttpUtils. If it is not specified, HttpUtils assumes SSLv23:!SSLv3:!SSLv2

;sslArgs
:defines a list that is converted to a key / value hash and gets passed to HttpUtils. To avoid certificate validation for broken servers you can for example specify
:<code>attr myDevice sslArgs SSL_verify_mode,SSL_VERIFY_NONE</code>

;alignTime
:Aligns each periodic read request for the defined interval to this base time. This is typcally something like 00:00 (see the FHEM at command)

;noShutdown
:pass the noshutdown flag to HTTPUtils for webservers that need it (some embedded webservers only deliver empty pages otherwise)

;disable
:stop doing automatic HTTP requests while this attribute is set to 1

;enableControlSet
:enables the built in set commands interval, stop, start, reread, upgradeAttributes, storeKeyValue.

;enableCookies
:enables the built in cookie handling if set to 1. With cookie handling each HTTPMOD device will remember cookies that the server sets and send them back to the server in the following requests.
:This simplifies session magamenet in cases where the server uses a session ID in a cookie. In such cases enabling cookies should be sufficient and no sidRegex and no manual definition of a cookie header should be necessary.

;showMatched
:if set to 1 then HTTPMOD will create a reading with the name MATCHED_READINGS that contains the names of all readings that could be matched in the last request as well as UNMATCHED_READINGS and LAST_REQUEST.

;showError
:if set to 1 then HTTPMOD will create a reading and event with the Name LAST_ERROR that contains the error message of the last error returned from HttpUtils.

;removeBuf
:if set to 1 then HTTPMOD removes the internal named buf when a HTTP-response has been received.
:$hash->{buf} is used internally be Fhem httpUtils and in some use cases it is desireable to remove this internal after reception
:because it contains a very long response which looks ugly in Fhemweb.

;timeout
:time in seconds to wait for an answer. Default value is 2

;queueDelay
:HTTP Requests will be sent from a queue in order to avoid blocking when several Requests have to be sent in sequence. This attribute defines the delay between calls to the function that handles the send queue. It defaults to one second.

;queueMax
:Defines the maximum size of the send queue. If it is reached then further HTTP Requests will be dropped and not be added to the queue

;minSendDelay
:Defines the minimum time between two HTTP Requests.

== Links ==
* 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: [[Pollenflug|Pollen count]]
* Example: [[HTTPMOD Beispielkonfiguration zur Anbindung einer Daikin Klimaanlage mit WLAN-Modul|Connect Daikin aircondition to FHEM]]
* Example: [[Go-eCharger|Extract information from go-eCharger]]
* Example: [[Sonnenspeicher|Integration of energy supplies from sonnen (https://sonnenbatterie.de/en/start)]]
* Example: [https://forum.fhem.de/index.php/topic,95989.msg915870.html#msg915870 Miele 3rd party API für Miele Smarthome Geräte]
* Example: [https://forum.fhem.de/index.php/topic,84215.msg918662.html#msg918662 Honeywell Evohome Totalconnect]
* Example: [https://forum.fhem.de/index.php/topic,78613.msg889015.html#msg889015 Tigo Energy Integration]
* Example: [https://forum.fhem.de/index.php/topic,78613.msg708518.html#msg708518 Ecowater]
* {{Link2Forum|Topic=17804|LinkText=Thread}} in FHEM Forum that discusses the first version of this module
* {{Link2Forum|Topic=29471|LinkText=Thread}} in FHEM Forum that discusses the second major version of this module
* {{Link2Forum|Topic=45176|LinkText=Thread}} in FHEM Forum that discusses the third major version of this module
* [http://perldoc.perl.org/perlretut.html Introduction to regular expressions]
* [http://portswigger.net/burp/ BurpSuite]: Tool (local proxy) to help analyze http traffic

[[Kategorie:IP Components]]

HTTPMOD

2024-01-28T20:47:34Z

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

{{Infobox Modul
|ModPurpose=Extract information from devices with an HTTP interface (or, more generic, from any URL) or send information to such devices
|ModType=d
|ModCmdRef=HTTPMOD
|ModForumArea=Sonstiges
|ModTechName=98_HTTPMOD.pm
|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.

From the HTTP response it extracts readings named in attributes using Regexes, JSON or XPath parsing also defined by attributes.

In an advanced [[Konfiguration|configuration]] the module can also send information to devices. To do this, a generic <code>set</code> option can be configured using attributes.

== Introduction ==
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.

<syntaxhighlight lang="perl">
define PM HTTPMOD http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html 20000
</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.

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
<syntaxhighlight lang="perl">
attr PM reading1Name ARD
attr PM reading1Regex ARD<\/span>[\w\W]*?<div class="content">\s*<a[\w\W]*?>\s*(.*?)\s*<\/a>
attr PM reading2Name ARD_time
attr PM reading2Regex ARD<\/span>[\w\W]*?<td class="time">\s*(.*?)\s*<
attr PM reading3Name ARD_details
attr PM reading3Regex ARD<\/span>[\w\W]*?<div class="content">\s*<a[\w\W]*?>[\w\W]*?<\/a>\s*<br\/>\s*(.*?)(<img|<\/div)
</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.

There are cases where this is not enough. For example, it could be the case that the information from the web access is not automated, but manually received. Then a 0 must first be entered at the top of the duration. But how does HTTPMOD then know when the data should be retrieved? This is done with get-commands. If a get-command is executed, HTTPMOD accesses the website, fetches the information and fills the corresponding readings.

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
<syntaxhighlight lang="perl">
define PM HTTPMOD http://www.klack.de/fernsehprogramm/was-laeuft-gerade/0/-1/free.html 0
</syntaxhighlight>
and add the following to the attributes
<syntaxhighlight lang="perl">
attr PM get1Name ARDHolen
</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
<syntaxhighlight lang="perl">
attr PM get1CheckAllReadings 1
</syntaxhighlight>
needs to be defined.

If the URL is not sufficient when the web page is called, but a special header is to be sent with it, this can be done with the get1Header attribute. If the header is multiline, the individual lines can be entered with get1Header1, get1Header2, and so on.

If you want to evaluate or control different URLs, you can define several get commands (get1, get2, etc.) and provide them with your own URLs. get1 usually reads only the reading1, get2 reads only the reading2 and so on. With CheckAllReadings all readings are evaluated simultaneously.

If only data is to be sent on the web page, but not read, the set command is recommended. It has the same structure as the get-command.

It becomes a bit more complex if the website requires a login check. The sid attributes are used for this purpose.

== Availability, prerequisites and definition ==
This module is part of the regular FHEM distribution and uses the non blocking HTTP function <code>HttpUtils_NonblockingGet</code> provided by FHEM's [[HttpUtils]] in a new version published in December 2013.
If not already installed in your environment, please [[update]] FHEM or install it manually using appropriate commands from your environment.
Please also note that FHEM HttpUtils need the global attribute dnsServer to be set in order to work really non blocking even when dns requests can not be answered.

The device is defined as follows
<syntaxhighlight lang="perl">
define <name> HTTPMOD <URL> <Interval>
</syntaxhighlight>
The module connects to the given <code>URL</code> every <code>Interval</code> seconds, sends optional headers and data and then parses the response with regular expressions, xpath or json to set readings.

URL can be "none" and Interval can be 0 if you prefer to only query data with a get command and not in a defined interval.

Example:
<syntaxhighlight lang="perl">
define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60
</syntaxhighlight>

== Set-Commands ==
can be defined using attributes, see advanced configuration

If you set the attribute enableControlSet to 1, the following additional built in set commands are available:
;interval
:set new interval time in seconds and restart the timer
;reread
:request the defined URL and try to parse it just like the automatic update would do it every Interval seconds without modifying the running timer.
;stop
:stop interval timer.
;start
:restart interval timer to call GetUpdate after interval seconds
;upgradeAttributes
:convert outdated attributes for older HTTPMOD-Versions that are still defined for this device from the old syntax to the new one.
:attributes with the description "this attribute should not be used anymore" or similar will be translated to the new syntax, e.g. readingsName1 to reading01Name.
;storeKeyValue
:stores a key value pair in an obfuscated form in the file system. Such values can then be used in replacements where the mode is "key" e.g. to avoid storing passwords in the configuration in clear text

== Get-Commands ==
can be defined using attributes, see advanced configuration

== simple Attributes ==
;enableControlSet
:enables the built in set commands ''interval'', ''stop'', ''start'', ''reread'', ''upgradeAttributes'', ''storeKeyValue''

;enableCookies
:enables the cookie handling inside HTTPMOD. It is advisable to always set this attribute and allow HTTPMOD to track the state of cookies and set them for following HTTP-requests

;enforceGoodReadingNames
:makes sure that HTTPMOD only creates readings that are allowd for Fhem (especially if reading names are dynamically created from JSON object names with extractAllJSON. It is advisable to always set this attribute.

;handleRedirects
:enables the redirect handling inside HTTPMOD which should be used together with the cookie handling of HTTPMOD. HTTPMOD will then automatically follow redirects from a web server and keep track of cookies at the same time. It is advisable to always set this attribute.

;requestHeader.*
:Define an additional HTTP Header to set in the HTTP request

;requestData
:POST Data to be sent in the request. If not defined, it will be a GET request as defined in HttpUtils used by this module

;reading[0-9]+(-[0-9]+)?Name
:the name of a reading to extract with the corresponding readingRegex

;reading[0-9]*(-[0-9]+)?OExpr
:defines an expression that is used in an eval to compute the readings value. The raw value will be in the variable $val.

;reading[0-9]*(-[0-9]+)?OMap
:Output Map. Defines a mapping from raw to visible values like "0:mittig, 1:oberhalb, 2:unterhalb". If specified as readingOMap then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*OMap.

;reading[0-9]*(-[0-9]+)?Format
:Defines a format string that will be used in sprintf to format a reading value. If specified as readingFormat then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Format.

;reading[0-9]*(-[0-9]+)?Decode
:defines an encoding to be used in a call to the perl function decode to convert the raw data string read from the device to a reading. This can be used if the device delivers strings in an encoding like cp850 instead of utf8.

;reading[0-9]*(-[0-9]+)?Encode
:defines an encoding to be used in a call to the perl function encode to convert the raw data string read from the device to a reading. This can be used if the device delivers strings in an encoding like cp850 and after decoding it you want to reencode it to e.g. utf8.

;reading[0-9]+Regex
:defines the regex to be used for extracting the reading. The value to extract should be in a capture group / sub expression
:e.g. ([\d\.]+) in the above example. Multiple capture groups will create multiple readings (see explanation above)

;reading[0-9]+XPath
:defines an xpath to one or more readings when parsing HTML data (see examples below)

;reading[0-9]+XPath-Strict
:defines an xpath to one or more readings when parsing XML data (see examples below)

;reading[0-9]+JSON
:defines a path to the JSON object wanted by concatenating the object names with an underscore as delimiter (see the example below)

;noShutdown
:pass the noshutdown flag to HTTPUtils for webservers that need it (some embedded webservers only deliver empty pages otherwise)

;disable
:stop doing automatic HTTP requests while this attribute is set to 1

;timeout
:time in seconds to wait for an answer. Default value is 2

;do_not_notify

;readingFnAttributes

== Simple Configuration of HTTP Devices ==
If your device expects special HTTP-headers then specify them as <code>attr requestHeader1</code> to <code>attr requestHeaderX</code>.
If your Device expects an HTTP POST instead of HTTP GET then the POST-data can be specified as <code>attr requestData</code>.
To get the readings, specify pairs of <code>attr readingXName</code> and <code>attr readingXRegex</code>, <code>attr readingXXPath</code>, <code>attr readingXXPath-Strict</code> or <code>attr readingXJSON</code> to define which readings you want to extract from the HTTP response and how to extract them. (The old syntax <code>attr readingsNameX</code> and <code>attr readingsRegexX</code> is still supported but the new one with <code>attr readingXName</code> and <code>attr readingXRegex</code> should be preferred. The actual values to be extracted have to be sub expressions within () in the regex (see example below)

=== Example for a PoolManager 5: ===
The PoolManager Web GUI can be queried with HTTP POST Requests like this one:

<syntaxhighlight lang="perl">
POST /cgi-bin/webgui.fcgi HTTP/1.1
Host: 192.168.70.90
Accept: */*
Content-Type: application/json;charset=UTF-8
Content-Length: 60

{"get" :["34.4001.value" ,"34.4008.value" ,"34.4033.value"]}
</syntaxhighlight>

The resulting HTTP Response would look like this:

<syntaxhighlight lang="perl">
HTTP/1.1 200 OK
Content-type: application/json; charset=UTF-8
Expires: 0
Cache-Control: no-cache
Date: Sun, 12 Jan 2014 12:23:11 GMT
Server: lighttpd/1.4.26
Content-Length: 179

{
"data": {
"34.4001.value": "7.00",
"34.4008.value": "0.52",
"34.4033.value": "24.8"
},
"status": {
"code": 0
},
"event": {
"type": 1,
"data": "48.30000.0"
}
}
</syntaxhighlight>

To configure HTTPMOD for a PoolManager one would first define a PoolManager device with e.g. the name PM, the URL and an interval of e.g. 60 seconds.

Then the data to be sent in the request needs to be defined because in this example the device expects a POST request so the query is not contained in the URL but in the request data.

Also as seen above the device expects special HTTP headers in the request so these headers also need to be defined as <code>attr PM requestHeader1</code> and <code>attr PM requestHeader2</code>

Then the names of the readings to be extracted would be set with attributes

Then for each reading value to be extracted a regular expression needs to be set that will match the value in question within ().

Example:
<syntaxhighlight lang="perl">
define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60

attr PM enableControlSet 1
attr PM enableCookies 1
attr PM enforceGoodReadingNames 1
attr PM handleRedirects 1

attr PM reading01Name PH
attr PM reading01Regex 34.4001.value":[ \t]+"([\d\.]+)"

attr PM reading02Name CL
attr PM reading02Regex 34.4008.value":[ \t]+"([\d\.]+)"

attr PM reading03Name3TEMP
attr PM reading03Regex 34.4033.value":[ \t]+"([\d\.]+)"

attr PM requestData {"get" :["34.4001.value" ,"34.4008.value" ,"34.4033.value", "14.16601.value", "14.16602.value"]}
attr PM requestHeader1 Content-Type: application/json
attr PM requestHeader2 Accept: */*
attr PM stateFormat {sprintf("%.1f Grad, PH %.1f, %.1f mg/l Chlor", ReadingsVal($name,"TEMP",0), ReadingsVal($name,"PH",0), ReadingsVal($name,"CL",0))}
</syntaxhighlight>

=== Example for AmbientMonitor ===
AmbientMonitor is a webbased visualisation for sensors connected to an Arduino device. Its web interface can also be queried with HTTMOD to grab the data into readings.

This example was provided by locutus. The hardware configuration is an Arduino + Ethercard with ENC28J60 Controller + DHT22 Sensor and software can be downloaded from https://github.com/lucadentella/AmbientMonitor

In this example an HTTP GET is sufficent, so no <code>requestData</code> is needed. The device provides temperature and humidity readings in an HTTP response that looks like:
<syntaxhighlight lang="perl">
HTTP/1.0 200 OK
Content-Type: text/html

myCB({'temperature':22.00,'humidity':46.00})
</syntaxhighlight>

the definition could be:
<syntaxhighlight lang="perl">
define AmbientMonitor HTTPMOD http://192.168.1.221/?callback=? 300

attr AmbientMonitor enableControlSet 1
attr AmbientMonitor enableCookies 1
attr AmbientMonitor enforceGoodReadingNames 1
attr AmbientMonitor handleRedirects 1

attr AmbientMonitor requestHeader Content-Type: application/json
attr AmbientMonitor reading1Name Temperatur
attr AmbientMonitor reading1Regex temperature':([\d\.]+)
attr AmbientMonitor reading2Name Feuchtigkeit
attr AmbientMonitor reading2Regex humidity':([\d\.]+)
attr AmbientMonitor stateFormat {sprintf("Temperatur %.1f C, Feuchtigkeit %.1f %", ReadingsVal($name,"Temperatur",0), ReadingsVal($name,"Feuchtigkeit",0))}
</syntaxhighlight>

== formatting and manipulating values / readings ==
Values that are parsed from an HTTP response can be further treated or formatted with the following attributes:

* <code>(reading|get)[0-9]*(-[0-9]+)?OExpr</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?OMap</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?Format</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?Decode</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?Encode</code>

They can all be specified for an individual reading, for all readings in one match (e.g. if a regular expression has several capture groups) or for all readings in a get command (defined by getXX) or for all readings in the main reading list (defined by readingXX):
<syntaxhighlight lang="perl">
reading01Format %.1f
</syntaxhighlight>

will format the reading with the name specified by the attribute reading01Name to be numerical with one digit after the decimal point.
If the attribute reading01Regex is used and contains several capture groups then the format will be applied to all readings parsed by this regex unless these readings have their own format specified by reading01-1Format, reading01-2Format and so on.

<syntaxhighlight lang="perl">
reading01-2Format %.1f
</syntaxhighlight>

Can be used in cases where a regular expression specified as reading01regex contains several capture groups or an xpath specified as reading01XPath creates several readings.
In this case reading01-2Format specifies the format to be applied to the second match.

<syntaxhighlight lang="perl">
readingFormat %.1f
</syntaxhighlight>

applies to all readings defined by a reading-Attribute that have no more specific format.

If you need to do some calculation on a raw value before it is used as a reading, you can define the attribute <code>readingOExpr</code>.
It defines a Perl expression that is used in an eval to compute the readings value. The raw value will be in the variable $val.

Example for an expression:
<syntaxhighlight lang="perl">
attr PM reading03OExpr $val * 10
</syntaxhighlight>
Just like in the above example of the readingFormat attributes, readingOExpr and the other following attributes can be applied on several levels.

To map a numerical value to a name, you can use the readingOMap attribute.
It defines a mapping from raw to visible values like "0:mittig, 1:oberhalb, 2:unterhalb".

Example for a map:
<syntaxhighlight lang="perl">
attr PM reading02-3OMap 0:kalt, 1:warm, 2:sehr warm
</syntaxhighlight>

To convert character sets, the module can first decode a string read from the device and then encode it again. For example:
<syntaxhighlight lang="perl">
attr PM getDecode UTF-8
</syntaxhighlight>

This applies to all readings defined for Get-Commands.

== Some help with Regular Expressions ==
{{Randnotiz|RNTyp=y|RNText=Starting with version ''2018-02-10'' the internal that holds the HTTP response is no longer called '''''buf''''' but rather '''''httpbody''''', and it is only displayed when attribute '''''showBody''''' is set to "1".}}
If HTTPMOD seems not to work and the FHEM Logfile contains a message like
:<code>HTTPMOD: Response didn't match Reading ...</code>
then you should check if the value you want to extract is read into the internal with the name buf. Internals are visible when you click on the defined HTTPMOD Device. buf is an internal variable that contains the HTTP Response read. If the value is there and you get the mentioned message then probably something is wrong with your regular expression. Please note that buf might contain special characters like newlines but they are not shown in fhemweb. If you are new to regular expressions then the introduction at http://perldoc.perl.org/perlretut.html might be helpful.

For a typical HTTPMOD use case where you want to extract a number out of a HTTP-Response you can use something like <code>[\d\.]+</code> to match the number itself. The expression matches the number characters (<code>\d</code>) or a <code>.</code> if one of these characters occurs at least once.

To tell HTTPMOD that the number is what you want to use for the reading, you have to put the expression in between <code>()</code>. A <code>([\d\.]+)</code> alone would match the longest number in the HTTP Response which is very likely not the number you are looking for so you need to add something to the expression to give it a context and define how to find the number that you are looking for.

If there is a title text before the number or a special text after the number you can put this in the regex. In one of the examples above <code>humidity':([\d\.]+)</code> is looking for the number that immediately follows the text <code>humidity':</code> without any blanks in between.
Be careful if the text you are getting from your device contains special characters like newline. You don't see such special characters in the fhem webinterface as contents of the internal buf but they might cause your regular expression to fail.

If you have trouble defining a regular expression that matches a certain name, then many complicated characters and then a number, it might be helpful to use a negation in matching like <code>temp[^\d]+([\d\.]).*</code>. In this examle <code>[^\d]+</code> means any character that is not a numerical digit, more than once.

=== Regular Expressions with multiple capture Groups ===
The regular expressions used in the above example for a Poolmanager will take the value that matches one capture group. This is the part of the regular expression inside (). In the above example "([\d\.]+)" refers to numerical digits or points between double quotation marks. Only the string consiting of digits and points will match inside (). This piece is assigned to the reading.

You can also use regular expressions that have several capture groups which might be helpful when parsing tables. In this case an attribute like

<syntaxhighlight lang="perl">
reading02Regex something[ \t]+([\d\.]+)[ \t]+([\d\.]+)
</syntaxhighlight>

could match two numbers. When you specify only one reading02Name like
<syntaxhighlight lang="perl">
reading02Name Temp
</syntaxhighlight>

the name Temp will be used with the extension -1 and -2 thus giving a reading Temp-1 for the first number and Temp-2 for the second. You can also specify individual names for several readings that get parsed from one regular expression with several capture groups by defining attributes

<syntaxhighlight lang="perl">
reading02-1Name
reading02-2Name
...
</syntaxhighlight>
The same notation can be used for formatting attributes like readingXOMap, readingXFormat and so on.

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 ==

If a webservice delivers data in JSON format, HTTPMOD can directly parse JSON which might be easier in this case than definig regular expressions.
The next example shows the data that can be requested from a Poolmanager with the following partial configuration:

<syntaxhighlight lang="perl">
define test2 HTTPMOD none 0
attr test2 get01Name Chlor
attr test2 getURL http://192.168.70.90/cgi-bin/webgui.fcgi
attr test2 getHeader1 Content-Type: application/json
attr test2 getHeader2 Accept: */*
attr test2 getData {"get" :["34.4008.value"]}
</syntaxhighlight>

The data in the HTTP response looks like this:

<syntaxhighlight lang="perl">
{
"data": {
"34.4008.value": "0.25"
},
"status": {
"code": 0
},
"event": {
"type": 1,
"data": "48.30000.0"
}
}
</syntaxhighlight>

the classic way to extract the value 0.25 into a reading with the name Chlor with a regex would have been
<syntaxhighlight lang="perl">
attr test2 get01Regex 34.4008.value":[ \t]+"([\d\.]+)"
</syntaxhighlight>

with JSON you can write
<syntaxhighlight lang="perl">
attr test2 get01JSON data_34.4008.value
</syntaxhighlight>
which will create a reading with the Name "Chlor" (as shown above) and take the value 0.25 from the JSON string.

or if you don't care about the naming of your readings, you can simply extract all JSON data with
<syntaxhighlight lang="perl">
attr test2 extractAllJSON
</syntaxhighlight>

which would apply to all data read from this device and create the following readings out of the HTTP response shown above:

{| class="wikitable"
| data_34.4008.value || 0.25
|-
| event_data || 48.30000.0
|-
| event_type || 1
|-
| status_code || 0
|}

or you can specify
<syntaxhighlight lang="perl">
attr test2 get01ExtractAllJSON
</syntaxhighlight>
which would only apply to all data read as response to the get command defined as get01.

It might seem very simple at first sight to use extractAllJSON but if you prefer readings with a meaningful name you should instead define these readings with readingXXName and readingXXJSON or getXXName and getXXJSON individually. Of Course it would be possible to create additional user readings outside HTTPMOD but doing calculations, naming and formatting inside HTTPMOD is more efficient.

=== JSON Lists ===

imagine the HTTP Response contains:

<syntaxhighlight lang="perl">
{ "power":"0",
"modes":["Off","SimpleColor","RainbowChase"],
"code1":3,
"code2":4
}
</syntaxhighlight>

then a configuration like

<syntaxhighlight lang="perl">
attr device reading01JSON modes
attr device reading01Name Mode
</syntaxhighlight>

will create a list of Subreadings just like a regex with multiple matches can create multiple subreadings:

{| class="wikitable"
| Mode-1 || Off
|-
| Mode-2 || SimpleColor
|-
| Mode-3 || RainbowChase
|}

if you don't want several subreadings but one reading that contains the list of modes, you can specify a recombine expression:

<syntaxhighlight lang="perl">
attr device reading01Name Modes
attr device reading01RecombineExpr join ",", @matchlist
</syntaxhighlight>

which will create one reading containing a list:

{| class="wikitable"
| Modes || Off,SimpleColor,RainbowChase
|}

JSON parsing specifications also don't Need to match exactly. If there is no exact match for a defined reading, the HTTPMOD will try to Interpret the specification as a regex and look for json object paths that match the specification as a regex. For example:

<syntaxhighlight lang="perl">
attr device reading01Name CodeElem
attr device reading01JSON code
</syntaxhighlight>

which will create a list of readings:

{| class="wikitable"
| CodeElem-1|| 3
|-
| CodeElem-2 || 4
|}

and of course they could also be recombined into one reading with a RecombineExpr Attribute.

== Parsing http / XML using xpath ==
Another alternative to regex parsing is the use of XPath to extract values from HTTP responses.
The following example shows how XML data can be parsed with XPath-Strict or HTML Data can be parsed with XPath.
Both work similar and the example uses XML Data parsed with the XPath-Strict option:

If The XML data in the HTTP response looks like this:

<syntaxhighlight lang="xml">
<root xmlns:foo="http://www.foo.org/" xmlns:bar="http://www.bar.org">
<actors>
<actor id="1">Peter X</actor>
<actor id="2">Charles Y</actor>
<actor id="3">John Doe</actor>
</actor>
</root>
</syntaxhighlight>

with XPath you can write
<syntaxhighlight lang="perl">
attr htest reading01Name Actor
attr htest reading01XPath-Strict //actor[2]/text()
</syntaxhighlight>

This will create a reading with the Name "Actor" and the value "Charles Y".

Since XPath specifications can define several values / matches, HTTPMOD can also interpret these and store them in multiple readings:
<syntaxhighlight lang="perl">
attr htest reading01Name Actor
attr htest reading01XPath-Strict //actor/text()
</syntaxhighlight>

will create the readings

{| class="wikitable"
| Actor-1 || Peter X
|-
| Actor-2 || Charles Y
|-
| Actor-3 || John Doe
|}

== Further replacements of URL, header or post data ==
sometimes it might be helpful to dynamically change parts of a URL, HTTP header or post data depending on existing readings, internals or
perl expressions at runtime. This might be needed to pass further variables to a server, a current date or other things.

To support this HTTPMOD offers generic replacements that are applied to a request before it is sent to the server. A replacement can be defined with the attributes

* <code>replacement[0-9]*Regex</code>
* <code>replacement[0-9]*Mode</code>
* <code>replacement[0-9]*Value</code>
* <code>[gs]et[0-9]*Replacement[0-9]*Value</code>

a replacement always replaces a match of a regular expression.

'''replacement[0-9]*Mode:'''
The way the replacement value is defined can be specified with the replacement mode.
* If the <code>replacement[0-9]*Mode</code> is <code>reading</code>, then the corresponding <code>replacement[0-9]*Value</code> is interpreted as the name of a ''reading'' of the same device or as ''device:reading'' to refer to another device.
* If the <code>replacement[0-9]*Mode</code> is <code>internal</code>, then the corresponding <code>replacement[0-9]*Value</code> is interpreted as the name of an ''internal'' of the same device or as ''device:internal'' to refer to another device.
* If the <code>replacement[0-9]*Mode</code> is <code>text</code>, then the corresponding <code>replacement[0-9]*Value</code> is interpreted as a static text
* If the <code>replacement[0-9]*Mode</code> is <code>expression</code>, then the corresponding <code>replacement[0-9]*Value</code> is evaluated as a perl expression to compute the replacement. Inside such a replacement expression it is possible to refer to capture groups of the replacement regex.
* If the <code>replacement[0-9]*Mode</code> is <code>key</code>, then the module will use a value from a key / value pair that is stored in an obfuscated form in the file system with the set storeKeyValue command. This might be useful for storing passwords.

Example:

<syntaxhighlight lang="perl" line="1">
attr mydevice getData {"get" :["%%value%%.value"]}
attr mydevice replacement01Mode text
attr mydevice replacement01Regex %%value%%

attr mydevice get01Name Chlor
attr mydevice get01Replacement01Value 34.4008

attr mydevice get02Name Something
attr mydevice get02Replacement01Value 31.4024

attr mydevice get05Name profile
attr mydevice get05URL http://www.mydevice.local/getprofile?password=%%password%%
attr mydevice replacement02Mode key
attr mydevice replacement02Regex %%password%%
attr mydevice replacement02Value password
</syntaxhighlight>

defines that <code>%%value%%</code> will be replaced by a static text.

All Get commands will be HTTP post requests of a similar form. Only the <code>%%value%%</code> will be different from get to get.
The first get will set the reading named Chlor and for the request it will take the generic getData and replace %%value%% with 34.4008.

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

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.

The mode <code>expression</code> allows you to define your own replacement syntax:
<syntaxhighlight lang="perl">
attr mydevice replacement01Mode expression
attr mydevice replacement01Regex {{([^}]+)}}
attr mydevice replacement01Value ReadingsVal("mydevice", $1, "")
attr mydevice getData {"get" :["{{temp}}.value"]}
</syntaxhighlight>

In this example any <code><nowiki>{{name}}</nowiki></code> in a URL, header or post data will be passed on to the perl function ReadingsVal
which uses the string between <code><nowiki>{{}}</nowiki></code> as second parameter. This way one defined replacement can be used for many different
readings.

HTTPMOD has two built in replacements: One for session Ids and another one for the input value in a set command.
The placeholder $sid is always replaced with the internal <code>$hash->{sid}</code> which contains the session id after it is extracted from a previous HTTP response.
If you don't like to use the placeholder $sid then you can define your own replacement for example like:

<syntaxhighlight lang="perl">
attr mydevice replacement01Mode internal
attr mydevice replacement01Regex %session%
attr mydevice replacement01Value sid
</syntaxhighlight>

Now the internal <code>$hash->{sid}</code> will be used as a replacement for the placeholder %session%.

In the same way a value that is passed to a set-command can be put into a request with a user defined replacement.
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'''

The stove API of Rika on https://www.rika-firenet.com/web/ delivers a JSON string with all settings and values, and can be piloted with a data string containing all the "set" values at once.

Delivered JSON on get https://www.rika-firenet.com/api/client/xxxxxxxx/status : (xxxxxxxx must be replaced with the unique stove ID)
<syntaxhighlight lang="perl">
{
"name": "Vorzimmer",
"stoveID": "xxxxxxxxx",
"lastSeenMinutes": 1,
"lastConfirmedRevision": 1504385700,
"controls": {
"revision": 1504385700,
"onOff": true,
"operatingMode": 2,
"heatingPower": 65,
"targetTemperature": 24,
"heatingTimesActive": false,
"heatingTimesActiveForComfort": true,
"setBackTemperature": 18,
"convectionFan1Active": false,
"convectionFan1Level": 0,
"convectionFan1Area": 0,
"convectionFan2Active": false,
"convectionFan2Level": 0,
"convectionFan2Area": 0,
"frostProtectionActive": false,
"frostProtectionTemperature": 5
},
"sensors": {
"statusError": 0,
"statusWarning": 0,
"statusService": 0,
"statusMainState": 1,
"statusSubState": 3,
"statusFrostStarted": false,
"inputFlameTemperature": 21,
"inputRoomTemperature": 21,
"inputExternalRequest": true,
"outputDischargeMotor": 0,
"outputInsertionMotor": 0,
"outputIDFan": 0,
"outputAirFlaps": 0,
"outputIgnition": false,
"parameterStoveTypeNumber": 13,
"parameterVersionMainBoard": 223,
"parameterVersionTFT": 223,
"parameterRuntimePellets": 11,
"parameterRuntimeLogs": 0,
"parameterFeedRateTotal": 17,
"parameterFeedRateService": 683,
"parameterOnOffCycles": 2
},
"stoveType": "DOMO MultiAir",
"stoveFeatures": {
"multiAir1": true,
"multiAir2": true,
"insertionMotor": false,
"airFlaps": false,
"logRuntime": false
}
}
</syntaxhighlight>

Data string to send to https://www.rika-firenet.com/api/client/xxxxxxxx/controls in order to set values:
<syntaxhighlight lang="perl">
heatingTimesActiveForComfort=true&frostProtectionTemperature=3&setBackTemperature=18&targetTemperature=24&convectionFan2Level=0&convectionFan2Active=false&convectionFan1Level=0&onOff=true&convectionFan1Active=false&convectionFan2Area=0&revision=1505550101&heatingTimesActive=false&convectionFan1Area=0&frostProtectionActive=false&operatingMode=2&heatingPower=65
</syntaxhighlight>

Code in 99_myUtils.pm:
<syntaxhighlight lang="perl">
use JSON;
...
sub
replaceJSON ($$) {
my ($valToReplace, $value) = @_;

#$value in the parameters is a default value
#It has to be replaced through the real value nnn passed in the set command "set <device> valToset nnn"
$value = InternalVal("Ofen", "value", $value);
Log3 ("Ofen", 3, "replaceJSON Internalvalue: $value");

#Force an update to avoid outdated revision number
fhem ("get Ofen revision");

#Get all the controls as json
my $json = ReadingsVal("Ofen", "controlsJSON","");
Log3 ("Ofen", 3, "replaceJSON configsJSON: $json");

# When starting FHEM or rereading config, the reading controlsJSON is empty
return if ($json eq "");

my $decoded = decode_json($json);
my $result;
for my $key ( keys %$decoded ) {
$result .= "$key=";
if ($key eq $valToReplace) {
$result .= $value."&";
} else {
$result .= $decoded->{$key}."&";
}
}
chop($result); #remove last &
Log3("Ofen", 3, "replaceJSON Result: $result");
return $result;
}
</syntaxhighlight>

Define stove in fhem:
<syntaxhighlight lang="perl">
defmod Ofen HTTPMOD https://www.rika-firenet.com/api/client/xxxxxxxx/status 60

attr Ofen enableCookies 1
attr Ofen reAuthRegex id="login"|Unauthorized
attr Ofen sid01Data email=xx@xx&password=xx
attr Ofen sid01URL https://www.rika-firenet.com/web/login

attr Ofen reading01JSON sensors_inputRoomTemperature
attr Ofen reading01Name RaumTemp
attr Ofen reading02JSON controls_setBackTemperature
attr Ofen reading02Name Absenkung
attr Ofen reading03JSON controls_frostProtectionTemperature
attr Ofen reading03Name Frostschutz
attr Ofen reading10Name controlsJSON
attr Ofen reading10Regex (?s)controls.*?({.*?})

attr Ofen get09Name revision
attr Ofen get09URL https://www.rika-firenet.com/api/client/xxxxxxxx/status

attr Ofen setURL https://www.rika-firenet.com/api/client/xxxxxxxx/controls
attr Ofen setData {{data}}
attr Ofen replacement01Mode expression
attr Ofen replacement01Regex {{data}}

attr Ofen set11Name frostProtectionTemperature
attr Ofen set11Replacement01Value replaceJSON("frostProtectionTemperature", 2)

attr Ofen set12Name targetTemperature
attr Ofen set12Replacement01Value replaceJSON("targetTemperature", 24)
</syntaxhighlight>

A detailed explanation (in german) of the login process can be found here: [https://forum.fhem.de/index.php/topic,76220.msg682514.html#msg682514]
and the explanation of the other parameters here: [https://forum.fhem.de/index.php/topic,76220.msg685710.html#msg685710]

== replacing reading values when they have not been updated / the device did not respond ==
If a device does not respond then the values stored in readings will keep the same and only their timestamp shows that they are outdated.
If you want to modify reading values that have not been updated for a number of seconds, you can use the attributes

* <code>(reading|get)[0-9]*(-[0-9]+)?MaxAge</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacementMode</code>
* <code>(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacement</code>

Every time the module tries to read from a device, it will also check if readings have not been updated
for longer than the <code>MaxAge</code> attributes allow. If readings are outdated, the <code>MaxAgeReplacementMode</code> defines how the affected
reading values should be replaced. <code>MaxAgeReplacementMode</code> can be <code>text</code>, <code>reading</code>, <code>internal</code>, <code>expression</code> or <code>delete</code>.

<code>MaxAge</code> specifies the number of seconds that a reading should remain untouched before it is replaced.

<code>MaxAgeReplacement</code> contains either a static text that is used as replacement value or a Perl expression that is evaluated to
give the replacement value. This can be used for example to replace a temperature that has not bee updated for more than 5 minutes
with the string "outdated - was 12":
<syntaxhighlight lang="perl">
attr PM readingMaxAge 300
attr PM readingMaxAgeReplacement "outdated - was " . $val
attr PM readingMaxAgeReplacementMode expression
</syntaxhighlight>
The variable <code>$val</code> contains the value of the reading before it became outdated.

Or to show that a device was offline:
<syntaxhighlight lang="perl">
attr MyLight reading01Name color
attr MyLight reading01JSON result_02_color
attr MyLight reading01MaxAge 300
attr MyLight reading01MaxAgeReplacement "offline"
attr MyLight reading01MaxAgeReplacementMode text
</syntaxhighlight>

== Note on determining how to send requests to a special device ==
If you don't know which URLs, headers or POST data your web GUI uses, you might try a local proxy like BurpSuite [http://portswigger.net/burp/ BurpSuite] to track requests and responses. This is a tedious task but probably the best way to achieve a successful result.

Let us consider an example. The Telekom Speedport W724V has a login-site that is famous for being cumbersome. Burp allows to monitor each step in the login procedure. In the case of a speedport the following steps occur:

First burp shows that a get command is issued
##################################################################################################
GET / HTTP/1.1
Host: speedport.ip
Cache-Control: max-age=0
Upgrade-Insecure-Requests: 1
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.133 Safari/537.36
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
Accept-Language: de-DE,de;q=0.8,en-US;q=0.6,en;q=0.4
Cookie: lang=de
Connection: close
In order to mimic the behavior of a real person calling the website HTTPMOD should copy all necessary steps. Host, Cookie and the GET-command are usually necessary. The same cannot be said of the User-Agent because the website can be called from any mobile or desktop computer.

Then, the speedport will answer with a command that consists of several lines. By going through every line for every step in the login procedure one will finally arrive at the information that is necessary to successfully enter the login of the speedport (in case of the W724V, for example, it is necessary to copy a token called _httoken and to include the referer).

== Advanced configuration to define a <code>set</code> command and send data to a device ==

When a set option is defined by attributes, the module will use the value given to the set command and integrate it into an HTTP-Request that sends the value to the device. The definitions for URL, headers and post data can contain the placeholder $val which will be replaced by the (numerical) value given to the set command.

This can be as simple as:
<syntaxhighlight lang="perl">
# No cyclic requests and no main URL needed in this example
define MyDevice HTTPMOD none 0

attr MyDevice set01Name Licht
attr MyDevice set01URL http://192.168.1.22/switch=$val
</syntaxhighlight>

A user command
<syntaxhighlight lang="perl">
set MyDevice Licht 1
</syntaxhighlight>

will be translated into the http GET request
<syntaxhighlight lang="perl">
http://192.168.1.22/switch=1
</syntaxhighlight>

In this example a map would also be helpful, that translates on / off to 0 or 1 and allows the user to select on/of in fhemweb:
<syntaxhighlight lang="perl">
attr MyDevive set01IMap 0:off, 1:on
</syntaxhighlight>
This also provides input validation to make sure that only on and off can be used with the set command.

In more complex Scenarios you might need to login before sending a command and the Login might create a session id that has to be part of further requests either in the URL, in headers or in the post data.

Extension to the above example for a PoolManager 5 where a set needs a session id in the URL and the values have to be passed in JSON strings as post data:
<syntaxhighlight lang="perl">
attr PM set01Name HeizungSoll
attr PM set01URL http://MyPoolManager/cgi-bin/webgui.fcgi?sid=$sid
attr PM set01Hint 6,10,20,30
attr PM set01Min 6
attr PM set01Max 30
attr PM setHeader1 Content-Type: application/json
attr PM set01Data {"set" :{"34.3118.value" :"$val" }}
</syntaxhighlight>

This example defines a set option with the name HeizungSoll.
By issuing <code>set PM HeizungSoll 10</code> in FHEM, the value 10 will be sent in the defined HTTP
Post to URL <code>http://MyPoolManager/cgi-bin/webgui.fcgi</code> in the Post Data as

<syntaxhighlight lang="html">
{"set" :{"34.3118.value" :"10" }}
</syntaxhighlight>

The optional attributes set01Min and set01Max define input validations that will be checked in the set function.
The optional attribute set01Hint will define a selection list for the FHEMweb GUI.

The HTTP response to such a request will be ignored unless you specify the attribute <code>setParseResponse</code>
for all set commands or <code>set01ParseResponse</code> for the set command with number 01.
If the HTTP response to a set command is parsed then this is done like the parsing of responses to get commands and you can use the attributes ending e.g. on Format, Encode, Decode, OMap and OExpr to manipulate / format the values read.

If a parameter to a set command is not numeric but should be passed on to the device as text, then you can specify the attribute setTextArg. For example:
<syntaxhighlight lang="perl">
attr PM set01TextArg
</syntaxhighlight>

If a set command should not require a parameter at all, then you can specify the attribute NoArg. For example:
<syntaxhighlight lang="perl">
attr PM set03Name On
attr PM set03NoArg
</syntaxhighlight>

Here are the 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
attr WuT_Analog1 room W&T
attr WuT_Analog1 set01Max 16
attr WuT_Analog1 set01Min 0
attr WuT_Analog1 set01Name Output1
attr WuT_Analog1 set01URL http://192.xx.My_IP/outputaccess1?PW=MyPassword&State=$val&
attr WuT_Analog1 set02Max 16
attr WuT_Analog1 set02Min 0
attr WuT_Analog1 set02Name Output2
attr WuT_Analog1 set02URL http://192.xx.My_IP/outputaccess2?PW=MyPassword&State=$val&
</syntaxhighlight>

== Advanced configuration to create a valid session id that might be necessary ==
In simple cases logging in works with basic authentication. In the case HTTPMOD accepts a username and password as part of the URL in the form
<syntaxhighlight lang="perl">
http://User:Password@192.168.1.18/something
</syntaxhighlight>

However basic auth is seldom used. If you need to fill in a username and password in a HTML form and the session is then managed by a session id, here is how to configure this:

when sending data to an HTTP-Device in a set, HTTPMOD will replace any <code>$sid</code> in the URL, Headers and Post data with the internal <code>$hash->{sid}</code>. To authenticate towards the device and give this internal a value, you can use an optional multi step login procedure defined by the following attributes:

* <code>sid[0-9]*URL</code>
* <code>sid[0-9]*Data.*</code>
* <code>sid[0-9]*Header.*</code>
* <code>sid[0-9]*IgnoreRedirects</code>
* <code>idRegex</code>
* <code>idJSON</code>
* <code>idXPath</code>
* <code>idXPath-Strict</code>
* <code>(get|set|sid)[0-9]*IdRegex</code>
* <code>(get|set|sid)[0-9]*IdJSON</code>
* <code>(get|set|sid)[0-9]*IdXPath</code>
* <code>(get|set|sid)[0-9]*IdXPath-Strict</code>

Each step can have a URL, Headers, Post Data pieces and a Regex to extract a resulting Session ID into <code>$hash->{sid}</code>.
HTTPMOD will create a sorted list of steps (the numbers between sid and URL / Data / Header) and the loop through these steps and send the corresponding requests to the device. For each step a $sid in a Header or Post Data will be replaced with the current content of <code>$hash->{sid}</code>.

Using this feature, HTTPMOD can perform a forms based authentication and send user name, password or other necessary data to the device and save the session id for further requests.

To determine when this login procedure is necessary, HTTPMOD will first try to send a request without
doing the login procedure. If the result contains an error that authentication is necessary, then a login is performed.
To detect such an error in the HTTP response, you can again use a regular expression, JSON or XPath, this time with the attributes

* <code>reAuthRegex</code>
* <code>reAuthJSON</code>
* <code>reAuthXPath</code>
* <code>reAuthXPath-Strict</code>
* <code>(get|set)[0-9]*ReAuthRegex</code>
* <code>(get|set)[0-9]*ReAuthJSON</code>
* <code>(get|set)[0-9]*ReAuthXPath</code>
* <code>(get|set)[0-9]*ReAuthXPath-Strict</code>

reAuthJSON or reAuthXPath typically only extract one piece of data from a response.
If the existence of the specified piece of data is sufficent to start a login procedure, then nothing more needs to be defined to detect this situation.
If however the indicator is a status code that contains different values depending on a successful request and a failed request if a new authentication is needed,
then you can combine things like reAuthJSON with reAuthRegex. In this case the regex is only matched to the data extracted by JSON (or XPath).
This way you can easily extract the status code using JSON parsing and then specify the code that means "authentication needed" as a regular expression.

If for one step not all of the URL, Data or Header Attributes are set, then HTTPMOD tries to use a
<code>sidURL</code>, <code>sidData.*</code> or <code>sidHeader.*</code> Attribute (without the step number after sid). This way parts that are the same for all steps don't need to be defined redundantly.

=== Example for a multi step login procedure: ===
<syntaxhighlight lang="perl">
attr PM reAuthRegex /html/dummy_login.htm
attr PM sidURL http://192.168.70.90/cgi-bin/webgui.fcgi?sid=$sid
attr PM sidHeader1 Content-Type: application/json
attr PM sid1IDRegex wui.init\('([^']+)'
attr PM sid2Data {"set" :{"9.17401.user" :"fhem" ,"9.17401.pass" :"password" }}
attr PM sid3Data {"set" :{"35.5062.value" :"128" }}
attr PM sid4Data {"set" :{"42.8026.code" :"pincode" }}
</syntaxhighlight>

In this case HTTPMOD detects that a login is necessary by looking for the pattern /html/dummy_login.htm in the HTTP response.
If it matches, it starts a login sequence. In the above example all steps request the same URL. In step 1 only the defined Header is sent in an HTTP get request. The response will contain a session id that is extraced with the regex wui.init\('([^']+)'.

In the next step this session id is sent in a post request to the same URL where tha post data contains a username and password. The a third and a fourth request follow that set a value and a code. The result will be a valid and authorized session id that can be used in other requests where $sid is part of a URL, header or post data and will be replaced with the session id extracted above.

===Another Practical Example reading the SOC from a Renault Zoe===
<syntaxhighlight lang="perl">
define myZoe HTTPMOD https://www.services.renault-ze.com/api/vehicle/VINVINVIN/battery 7000
attr myZoe userattr reading01JSON reading01Name reading02JSON reading02Name reading03JSON reading03Nam\
e reading04JSON reading04Name reading05JSON reading05Name requestHeader02 sid1Data sid1Header01 sid1Id\
JSON sid1IgnoreRedirects:0,1 sid1URL
attr myZoe reAuthJSON message
attr myZoe reading01JSON charge_level
attr myZoe reading01Name SOC
attr myZoe reading02JSON charging
attr myZoe reading02Name charging
attr myZoe reading03JSON plugged
attr myZoe reading03Name plugged
attr myZoe reading04JSON remaining_range
attr myZoe reading04Name remaining_range
attr myZoe reading05JSON last_update
attr myZoe reading05Name last_update
attr myZoe requestHeader02 Authorization: Bearer $sid
attr myZoe sid1Data {"username":"ZEUSERNAME","password":"ZEPASSWORD"}
attr myZoe sid1Header01 Content-Type: application/json
attr myZoe sid1IdJSON token
attr myZoe sid1IgnoreRedirects 1
attr myZoe sid1URL https://www.services.renault-ze.com/api/user/login
attr myZoe timeout 10
#attr myZoe verbose 7
</syntaxhighlight>

The $sid is read by logging in with username and password from JSON {"token": ..} after detecting an error {"message": ..} from a failed request. This example offers no solution for the reading of the VIN from the login request, which in turn is part of the reading URL. It should be possible to read more than just the $sid from the login sequence.

In the special case where a session id is set as a HTTP-Cookie (with the header Set-cookie: in the HTTP response) HTTPMOD offers an even simpler way. With the attribute enableCookies a very basic cookie handling mechanism is activated that stores all cookies that the server sends to the HTTPMOD device and puts them back as cookie headers in the following requests.

For such cases no sidIdRegex and no $sid in a user defined header is necessary.

== Advanced configuration to define a <code>get</code> and request additional data with its own request from a device ==

The normal automatic HTTP request that is done repeatedly after the defined interval has elapsed works well in cases where all required readings can be requested in one common HTTP request. If however a device needs individual requests with different URLs or different POST data for each value, then another method is necessary.
For such cases a <code>get</code> option can be defined and the user can either issue FHEM <code>get</code> commands each time he needs the reading or the user can set an attribute to request the reading automatically together with the normal iteration.
For each <code>get</code> option attributes define an individual URL, optional headers, and post data as well as individual regular expressions and formatting options.

When a get option is defined by attributes, the module allows querying additional values from the device that require individual HTTP-Requests or special parameters to be sent

Extension to the above example:

<syntaxhighlight lang="perl">
attr PM get01Name MyGetValue
attr PM get01URL http://MyPoolManager/cgi-bin/directory/webgui.fcgi?special=1?sid=$sid
attr PM getHeader1 Content-Type: application/json
attr PM get01Data {"get" :{"30.1234.value"}}
</syntaxhighlight>

This example defines a get option with the name MyGetValue.
By issuing <code>get PM MyGetValue</code> in FHEM, the defined HTTP request is sent to the device.
The HTTP response is then parsed using the same readingXXName and readingXXRegex attributes as above so
additional pairs will probably be needed there for additional values.

if you prefer to define the parsing and formatting of readings individually per get command, you can use
attributes like get01Regex, get01XPath, get01Format, get01OMap and so on just like for reading01...

You can also include parameters / values that are passed to the get command in the request just like for set commands.
The placeholder $val will be replaced with the value given to the get command or you can specify your own replacement as described above.

If the new get parameter should also be queried regularly, you can define the following optional attributes:

<syntaxhighlight lang="perl">
attr PM get01Poll 1
attr PM get01PollDelay 300
</syntaxhighlight>

The first attribute includes this reading in the automatic update cycle and the second defines an alternative lower update frequency. When the interval defined initially in the define is over and the normal readings are read from the device, the update function will check for additional get parameters that should be included in the update cycle.

If a PollDelay is specified for a get parameter, the update function also checks if the time passed since it has last read this value is more than the given PollDelay. If not, this reading is skipped and it will be rechecked in the next cycle when interval is over again. So the effective PollDelay will always be a multiple of the interval specified in the initial define.

Please note that each defined get command that is included in the regular update cycle will create its own HTTP request. So if you want to extract several values from the same request, it is much more efficient to do this by defining readingXXName and readingXXRegex, XPath or JSON attributes and to specify an interval and a URL in the define of the HTTPMOD device.

Example for a Siemens webserver provided by Lanhydrock:
<syntaxhighlight lang="perl">
define ozw672 HTTPMOD https://192.168.178.8/api/auth/login.json?user=test&pwd=test 300

attr ozw672 get1Name tempAussen
attr ozw672 get1URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1960
attr ozw672 get1Poll 1
attr ozw672 get1PollDelay 1800

attr ozw672 get2Name tempAussenGemischt
attr ozw672 get2URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1964
attr ozw672 get2Poll 1
attr ozw672 get2PollDelay 1800

attr ozw672 get3Name tempTWW
attr ozw672 get3URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1996
attr ozw672 get3Poll 1

attr ozw672 get4Name tempKesselSoll
attr ozw672 get4URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1910
attr ozw672 get4Poll 1

attr ozw672 get5Name tempKesselRuecklauf
attr ozw672 get5URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1915
attr ozw672 get5Poll 1

attr ozw672 get6Name tempKesselRuecklaufSoll
attr ozw672 get6URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1916
attr ozw672 get6Poll 1

attr ozw672 get7Name anzahlStartsBrenner
attr ozw672 get7URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1927
attr ozw672 get7PollDelay 1800
attr ozw672 get7Poll 1

attr ozw672 get8Name statusKessel
attr ozw672 get8URL https://192.168.178.8/api/menutree/read_datapoint.json?SessionId=$sid&Id=1898
attr ozw672 get8Poll 1
attr ozw672 get8Regex Value": "([a-zA-Zü ]*)"
attr ozw672 get8OMap Aus:0, Nachlauf aktiv:5, Freigegeben für TWW:10, Freigegeben für HK:20, In Teillastbetrieb für TWW:40, In Teillastbetrieb für HK:50, In Betrieb für Trinkwasser:90, In Betrieb für Heizkreis:100

attr ozw672 getRegex Value": "[ ]*([-.0-9]*)"

attr ozw672 reAuthRegex .*session not valid.*
attr ozw672 sid1IDRegex .*"(.*-.*-.*-[0-9a-z]*).*
attr ozw672 sid1URL https://192.168.178.8/api/auth/login.json?user=test&pwd=test
</syntaxhighlight>

== All attributes ==
;reading[0-9]+Name
:the name of a reading to extract with the corresponding readingRegex, readingJSON, readingXPath or readingXPath-Strict
:Please note that the old syntax readingsName.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.

;(get|set)[0-9]+Name
:Name of a get or set command
:If the HTTP response that is received after the command is parsed with an individual parse option then this name is also used as a reading name. Please note that no individual parsing needs to be defined for a get or set. If no regex, XPath or JSON is specified for the command, then HTTPMOD will try to parse the response using all the defined readingRegex, reading XPath or readingJSON attributes.

;(get|set|reading)[0-9]+Regex
:If this attribute is specified, the Regex defined here is used to extract the value from the HTTP Response and assign it to a Reading with the name defined in the (get|set|reading)[0-9]+Name attribute.
:If this attribute is not specified for an individual Reading or get or set but without the numbers in the middle, e.g. as getRegex or readingRegex, then it applies to all the other readings / get / set commands where no specific Regex is defined. 
:The value to extract should be in a capture group / sub expression e.g. ([\d\.]+) in the above example. Multiple capture groups will create multiple readings (see explanation above)
:Using this attribute for a set command (setXXRegex) only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
:Please note that the old syntax <code>readingsRegex.*</code> does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.
:If for get or set commands neither a generic Regex attribute without numbers nor a specific (get|set)[0-9]+Regex attribute is specified and also no XPath or JSON parsing specification is given for the get or set command, then HTTPMOD tries to use the parsing definitions for general readings defined in reading[0-9]+Name, reading[0-9]+Regex or XPath or JSON attributes and assigns the Readings that match here.

;(get|set|reading)[0-9]+RegOpt
:Lets the user specify regular expression modifiers. For example if the same regular expression should be matched as often as possible in the HTTP response, then you can specify RegOpt g which will case the matching to be done as /regex/g
:The results will be trated the same way as multiple capture groups so the reading name will be extended with -number.
:For other possible regular expression modifiers see http://perldoc.perl.org/perlre.html#Modifiers

;(get|set|reading)[0-9]+XPath
:defines an xpath to one or more values when parsing HTML data (see examples above)
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;get|set|reading[0-9]+XPath-Strict
:defines an xpath to one or more values when parsing XML data (see examples above)
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;(get|set|reading)[0-9]+AutoNumLen
:In cases where a regular expression or an XPath results in multiple results and these results are stored in a common reading name with extension -number, then you can modify the format of this number to have a fixed length with leading zeros. AutoNumLen 3 for example will lead to reading names ending with -001 -002 and so on.

;(get|set|reading)[0-9]+AlwaysNum
:if set to 1 this attributes forces reading names to end with a -1, -01 (depending on the above described AutoNumLen) even if just one value is parsed.

;get|set|reading[0-9]+JSON
:defines a path to the JSON object wanted by concatenating the object names. See the above example.
:If you don't know the paths, then start by using extractAllJSON and the use the names of the readings as values for the JSON attribute. 
:Please don't forget to also specify a name for a reading, get or set.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;(get|set|reading)[0-9]*RecombineExpr
:defines an expression that is used in an eval to compute one reading value out of the list of matches.
:This is supposed to be used for regexes or xpath specifications that produce multiple results if only one result that combines them is wanted. The list of matches will be in the variable @matchlist.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;get[0-9]*CheckAllReadings
:this attribute modifies the behavior of HTTPMOD when the HTTP Response of a get command is parsed. 
:If this attribute is set to 1, then additionally to the matching of the corresponding get specific regex (get[0-9]*Regex), XPath or JSON attribute also all the reading names and parse definitions defined in Reading[0-9]+Name and Reading[0-9]+Regex, XPath or JSON attributes are checked and if they match, the coresponding Readings are assigned as well.
:Please note that this does not mean that get01CheckAllReadings will cause a get02Regex to be used. Only the corresponding get01Regex will be used but additionally all the readingXYRegex attributes.
:This is automatically done if a get or set command is defined without its own parse attributes.

;(get|reading)[0-9]*OExpr
:defines an optional expression that is used in an eval to compute / format a readings value after parsing an HTTP response
:The raw value from the parsing will be in the variable $val.
:If specified as readingOExpr then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Expr.
:Please note that the old syntax readingsExpr.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.

;(get|reading)[0-9]*Expr
:This is the old syntax for (get|reading)[0-9]*OExpr. It should be replaced by (get|reading)[0-9]*OExpr. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.

;(get|reading)[0-9]*OMap
:Map that defines a mapping from raw value parsed to visible values like "0:mittig, 1:oberhalb, 2:unterhalb".
:If specified as readingOMap then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Map. 
:The individual options in a map are separated by a komma and an optional space. Spaces are allowed to appear in a visible value however kommas are not possible.

;(get|reading)[0-9]*Map
:This is the old syntax for (get|reading)[0-9]*OMap. It should be replaced by (get|reading)[0-9]*OMap. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.

;(get|set|reading)[0-9]*Format
:Defines a format string that will be used in sprintf to format a reading value.
:If specified without the numbers in the middle e.g. as readingFormat then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Format.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse. 

;(get|set|reading)[0-9]*Decode
:defines an encoding to be used in a call to the perl function decode to convert the raw data string read from the device to a reading.
:This can be used if the device delivers strings in an encoding like cp850 instead of utf8.
:If your reading values contain Umlauts and they are shown as strange looking icons then you probably need to use this feature.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;(get|set|reading)[0-9]*Encode
:defines an encoding to be used in a call to the perl function encode to convert the raw data string read from the device to a reading.
:This can be used if the device delivers strings in an encoding like cp850 and after decoding it you want to reencode it to e.g. utf8.
:If your reading values contain Umlauts and they are shown as strange looking icons then you probably need to use this feature.
:Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.

;(get|set)[0-9]*URL
:URL to be requested for the set or get command. If this option is missing, the URL specified during define will be used.

;(get|set)[0-9]*Data
:Data to be sent to the device as POST data when the get or set command is executed. if this attribute is not specified, an HTTP GET method will be used instead of an HTTP POST

;(get|set)[0-9]*NoData
:can be used to override a more generic attribute that specifies POST data for all get or set commands. With NoData no data is sent and therefor the request will be an HTTP GET.

;(get|set)[0-9]*Header.*
:HTTP Headers to be sent to the device when the set is executed

;requestHeader.*
:Define an optional additional HTTP Header to set in the HTTP request of the main loop

;requestData
:optional POST Data to be sent in the request of the main loop. If not defined, it will be an HTTP GET request as defined in HttpUtils which is used by this module

;get[0-9]+Poll
:if set to 1 the get is executed automatically during the normal update cycle (after the interval provided in the define command has elapsed)

;get[0-9]+PollDelay
:if the value should not be read in each iteration (after the interval given to the define command), then a minimum delay can be specified with this attribute. This has only an effect if the above Poll attribute has also been set. Every time the update function is called, it checks if since this get has been read the last time, the defined delay has elapsed. If not, then it is skipped this time.
:PollDelay can be specified as seconds or as x[0-9]+ which means a multiple of the interval in the define command.

;(get|set)[0-9]*TextArg
:For a get command this defines that the command accepts a text value after the option name. By default a get command doesn't accept optional values after the command name.
:If TextArg is specified and a value is passed after the get name then this value can then be used in a request URL, header or data as replacement for $val or in a user defined replacement that uses the internal "value" ($hash->{value}).
:If used for a set command then it defines that the value to be set doesn't require any validation / conversion.
:The raw value is passed on as text to the device. By default a set command expects a numerical value or a text value that is converted to a numeric value using a map.

;set[0-9]+Min
:Minimum value for input validation.

;set[0-9]+Max
:Maximum value for input validation.

;set[0-9]+IExpr
:Perl Expression to compute the raw value to be sent to the device from the input value passed to the set.

;set[0-9]+Expr
:This is the old syntax for (get|reading)[0-9]*IExpr. It should be replaced by (get|reading)[0-9]*IExpr. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.

;set[0-9]+IMap
:Map that defines a mapping from raw to input values like "0:mittig, 1:oberhalb, 2:unterhalb". This attribute atomatically creates a hint for FHEMWEB so the user can choose one of the input values.

;set[0-9]+Map
:This is the old syntax for (get|reading)[0-9]*IMap. It should be replaced by (get|reading)[0-9]*IMap. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.

;set[0-9]+Hint
:Explicit hint for fhemWEB that will be returned when set ? is seen. Can be used to get a slider or a list of values to choose from.

;set[0-9]*NoArg
:Defines that this set option doesn't require arguments. It allows sets like "on" or "off" without further values.

;set[0-9]*ParseResponse
:defines that the HTTP response to the set will be parsed as if it was the response to a get command.

;(get|set)[0-9]*URLExpr
:Defines a Perl expression to specify the HTTP Headers for this request. This overwrites any other header specification and should be used carefully only if needed. The original Header is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.

;(get|set)[0-9]*DatExpr
:Defines a Perl expression to specify the HTTP Post data for this request. This overwrites any other post data specification and should be used carefully only if needed. The original Data is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.

;(get|set)[0-9]*HdrExpr
:Defines a Perl expression to specify the URL for this request. This overwrites any other URL specification and should be used carefully only if needed. The original URL is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.

;ReAuthRegex
:regular Expression to match an error page indicating that a session has expired and a new authentication for read access needs to be done.
:This attribute only makes sense if you need a forms based authentication for reading data and if you specify a multi step login procedure based on the sid.. attributes.
:This attribute is used for all requests. For set and get operations you can however specify individual reAuthRegexes with the (get|set)[0-9]*ReAuthRegex attributes.

;(get|set)[0-9]*ReAuthRegex
:Regex that will detect when a session has expired during a set operation and a new login needs to be performed.
:It works like the global reAuthRegex but is used for set operations.

;sid[0-9]*URL
:different URLs or one common URL to be used for each step of an optional login procedure.

;sid[0-9]*IDRegex
:different Regexes per login procedure step or one common Regex for all steps to extract the session ID from the HTTP response

;sid[0-9]*Data.*
:data part for each step to be sent as POST data to the corresponding URL

;sid[0-9]*Header.*
:HTTP Headers to be sent to the URL for the corresponding step

;sid[0-9]*IgnoreRedirects
:Tells the HttpUtils to not follow HTTP Redirects for this Request. Might be needed for some devices that set a session cookie within a 303 Redirect.

;clearSIdBeforeAuth
:will set the session id to "" before doing the authentication steps

;authRetries
:number of retries for authentication procedure - defaults to 1

;replacement[0-9]*Regex
:Defines a replacement to be applied to an HTTP request header, data or URL before it is sent. This allows any part of the request to be modified based on a reading, an internal or an expression.
:The regex defines which part of a header, data or URL should be replaced. The replacement is defined with the following attributes:

;replacement[0-9]*Mode
:Defines how the replacement should be done and what replacementValue means. Valid options are text, reading, internal and expression.

;replacement[0-9]*Value
:Defines the replacement. If the corresponding replacementMode is <code>text</code>, then value is a static text that is used as the replacement.
:If replacementMode is <code>reading</code> then Value can be the name of a reading of this device or it can be a reading of a different device referred to by devicename:reading.
:If replacementMode is <code>internal</code> the Value can be the name of an internal of this device or it can be an internal of a different device referred to by devicename:internal.
:If replacementMode is <code>expression</code> the the Value is treated as a Perl expression that computes the replacement value. The expression can use $1, $2 and so on to refer to capture groups of the corresponding regex that is matched against the original URL, header or post data.
:If replacementMode is <code>key</code> then the module will use a value from a key / value pair that is stored in an obfuscated form in the file system with the set storeKeyValue command. This might be useful for storing passwords.

;[gs]et[0-9]*Replacement[0-9]*Value
:This attribute can be used to override the replacement value for a specific get or set.

;get|reading[0-9]*MaxAge
:Defines how long a reading is valid before it is automatically overwritten with a replacement when the read function is called the next time.

;get|reading[0-9]*MaxAgeReplacement
:specifies the replacement for MaxAge - either as a static text or as a perl expression.

;get|reading[0-9]*MaxAgeReplacementMode
:specifies how the replacement is interpreted: can be text, expression and delete.

;get|reading[0-9]*DeleteIfUnmatched
:If set to 1 this attribute causes certain readings to be deleted when the parsing of the website does not match the specified reading. Internally HTTPMOD remembers which kind of operation created a reading (update, Get01, Get02 and so on). Specified readings will only be deleted if the same operation does not parse this reading again. This is especially useful for parsing that creates several matches / readings and the number of matches can vary from request to request. For example if reading01Regex creates 4 readings in one update cycle and in the next cycle it only matches two times then the readings containing the remaining values from the last round will be deleted.
:Please note that this mechanism will not work in all cases after a restart. Especially when a get definition does not contain its own parsing definition but ExtractAllJSON or relies on HTTPMOD to use all defined reading.* attributes to parse the responsee to a get command, old readings might not be deleted after a restart of fhem.
;get|reading[0-9]*DeleteOnError
:If set to 1 this attribute causes certain readings to be deleted when the website can not be reached and the HTTP request returns an error. Internally HTTPMOD remembers which kind of operation created a reading (update, Get01, Get02 and so on). Specified readings will only be deleted if the same operation returns an error.
The same restrictions as for DeleteIfUnmatched apply regarding a fhem restart.

;httpVersion
:defines the HTTP-Version to be sent to the server. This defaults to 1.0.

;sslVersion
:defines the SSL Version for the negotiation with the server. The attribute is evaluated by HttpUtils. If it is not specified, HttpUtils assumes SSLv23:!SSLv3:!SSLv2

;sslArgs
:defines a list that is converted to a key / value hash and gets passed to HttpUtils. To avoid certificate validation for broken servers you can for example specify
:<code>attr myDevice sslArgs SSL_verify_mode,SSL_VERIFY_NONE</code>

;alignTime
:Aligns each periodic read request for the defined interval to this base time. This is typcally something like 00:00 (see the FHEM at command)

;noShutdown
:pass the noshutdown flag to HTTPUtils for webservers that need it (some embedded webservers only deliver empty pages otherwise)

;disable
:stop doing automatic HTTP requests while this attribute is set to 1

;enableControlSet
:enables the built in set commands interval, stop, start, reread, upgradeAttributes, storeKeyValue.

;enableCookies
:enables the built in cookie handling if set to 1. With cookie handling each HTTPMOD device will remember cookies that the server sets and send them back to the server in the following requests.
:This simplifies session magamenet in cases where the server uses a session ID in a cookie. In such cases enabling cookies should be sufficient and no sidRegex and no manual definition of a cookie header should be necessary.

;showMatched
:if set to 1 then HTTPMOD will create a reading with the name MATCHED_READINGS that contains the names of all readings that could be matched in the last request as well as UNMATCHED_READINGS and LAST_REQUEST.

;showError
:if set to 1 then HTTPMOD will create a reading and event with the Name LAST_ERROR that contains the error message of the last error returned from HttpUtils.

;removeBuf
:if set to 1 then HTTPMOD removes the internal named buf when a HTTP-response has been received.
:$hash->{buf} is used internally be Fhem httpUtils and in some use cases it is desireable to remove this internal after reception
:because it contains a very long response which looks ugly in Fhemweb.

;timeout
:time in seconds to wait for an answer. Default value is 2

;queueDelay
:HTTP Requests will be sent from a queue in order to avoid blocking when several Requests have to be sent in sequence. This attribute defines the delay between calls to the function that handles the send queue. It defaults to one second.

;queueMax
:Defines the maximum size of the send queue. If it is reached then further HTTP Requests will be dropped and not be added to the queue

;minSendDelay
:Defines the minimum time between two HTTP Requests.

== Links ==
* 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: [[Pollenflug|Pollen count]]
* Example: [[HTTPMOD Beispielkonfiguration zur Anbindung einer Daikin Klimaanlage mit WLAN-Modul|Connect Daikin aircondition to FHEM]]
* Example: [[Go-eCharger|Extract information from go-eCharger]]
* Example: [[Sonnenspeicher|Integration of energy supplies from sonnen (https://sonnenbatterie.de/en/start)]]
* Example: [https://forum.fhem.de/index.php/topic,95989.msg915870.html#msg915870 Miele 3rd party API für Miele Smarthome Geräte]
* Example: [https://forum.fhem.de/index.php/topic,84215.msg918662.html#msg918662 Honeywell Evohome Totalconnect]
* Example: [https://forum.fhem.de/index.php/topic,78613.msg889015.html#msg889015 Tigo Energy Integration]
* Example: [https://forum.fhem.de/index.php/topic,78613.msg708518.html#msg708518 Ecowater]
* {{Link2Forum|Topic=17804|LinkText=Thread}} in FHEM Forum that discusses the first version of this module
* {{Link2Forum|Topic=29471|LinkText=Thread}} in FHEM Forum that discusses the second major version of this module
* {{Link2Forum|Topic=45176|LinkText=Thread}} in FHEM Forum that discusses the third major version of this module
* [http://perldoc.perl.org/perlretut.html Introduction to regular expressions]
* [http://portswigger.net/burp/ BurpSuite]: Tool (local proxy) to help analyze http traffic

[[Kategorie:IP Components]]

FileLog

2020-09-27T17:56:18Z

Jophb: Mehrere Werte und Dummy in einer Zeile loggen hinzugefügt

{{Infobox Modul
|ModPurpose=Protokollierung von Fhem-Ereignissen
|ModType=h
|ModForumArea=Automatisierung
|ModTechName=92_FileLog.pm
|ModOwner=rudolfkoenig ({{Link2FU|8|Forum}} / [[Benutzer Diskussion:Rudolfkoenig|Wiki]])}}

Das Modul [[FileLog]] dient zur Protokollierung von Ereignissen in FHEM. Die Einträge werden in eine einfache Textdatei geschrieben. Zur Protokollierung in eine Datenbank kann alternativ oder auch parallel das Modul [[DbLog]] verwendet werden.

Logdateien sind die Basis für die Erstellung von Diagrammen ([[SVG]]).

== Definition ==
Details in der {{Link2CmdRef|Anker=FileLogdefine}}.

== Attribute ==
Über {{Link2CmdRef|Anker=FileLogattr|Label=Attribute}} lässt sich unter anderem auch festlegen, wie die Archivierung von Logdateien durchgeführt werden soll (Archivierungsbefehl, -pfad sowie Anzahl von Archivgenerationen).

Wenn bestimmte Zeilen '''nicht''' in die Logdatei geschrieben werden sollen, ist das Attribut ''ignoreRegexp'' hilfreich. Wenn beispielsweise alle Zeilen, die die Zeichenfolge "AbCd" oder "CdEf" enthalten '''nicht''' geloggt werden sollen, dann wäre
:<code>attr <log-name> ignoreRegexp .*AbCd.*|.*CdEf.*</code>
eine Attributdefinition, die das ermöglicht.

Dies bezieht sich aber nur auf normale FileLog-Instanzen. Falls Events aus dem globalen FHEM-Logfile ausgeschlossen werden sollen, muss man das Attribut in '''global''' angeben. (Zusammenhang siehe [[#Globale Logdatei und "fakelog"|Globale Logdatei und "fakelog"]])
:<code>attr global ignoreRegexp .*AbCd.*|.*CdEf.*</code>

== Funktionen ==
''FileLog'' bietet Funktionen wie ''reopen'', ''absorb'' und ''get''. Details dazu sind in der {{Link2CmdRef|Anker=FileLogset}} zu finden.

Sofern eine Instanz vom Objekt [[eventTypes]] angelegt ist, bietet die Detailansicht eines FileLog eine komfortable Möglichkeit, die regulären Ausdrücke für den/die Filter zu bearbeiten. Siehe hierzu auch diesen {{Link2Forum|Topic=12557|Message=75436}}.

== Globale Logdatei und "fakelog" ==
Die globale Logdatei (üblicherweise als fhem.log bezeichnet) für FHEM wird mit dem Attribut
:<code>attr global logfile XXX</code>
für das ''global''-Objekt definiert, wobei für ''XXX'' normalerweise <code>./log/fhem-%Y-%m.log</code> verwendet wird.

Um das ''fhem.log'' über das [[FHEMWEB|Web Interface]] anzeigen zu können, ist ein weiterer Eintrag in der [[Konfiguration]] erforderlich, nämlich:
:<code>define Logfile FileLog XXX fakelog</code>
Das ''XXX'' muss '''zwingend''' durch den gleichen Wert ersetzt werden, wie in der Definition des globalen ''logfile'' Attributs, weil anderenfalls unterschiedliche Dateien verwendet werden - mit dem Effekt, dass die über das Web Interface angezeigte Datei nicht die erwarteten Einträge enthält (Details dazu auch in diesem {{Link2Forum|Topic=40041|Message=323315|LinkText=Forenbeitrag}}).

== Werte auslesen ==
Manchmal möchte man Daten aus den Logs abrufen ohne händisch in den Logfiles herumzuwühlen. Dies ist insb. auch dann hilfreich, wenn man eigenen Funktionen, Notifys oder spezielle Plots entwirft, bei denen man auf Logdaten zugreifen möchte.

Grundsätzlich beschrieben ist dies in der {{Link2CmdRef|Lang=de|Anker=FileLog}} und unterscheidet sich minimal (aber entscheidend) von der Struktur bei [[DbLog#Werte_auslesen|DbLogs]].

Hier ein paar Beispiele, was man damit anstellen kann:

* <code>get FileLog_FHT_3a32 - - 2016-10-01 2016-10-03</code> alle Einträge des FileLog_FHT_3a32 vom 01.10.-03.10.2016
* <code>get FileLog_FHT_3a32 - - 2016-10-01_08:00:00 2016-10-01_16:00:00</code> alle Einträge des FileLog_FHT_3a32 von 8-16 Uhr am 01.10.2016
* <code>get FileLog_FHT_3a32 - - 2016-10-01_08:00:00 2016-10-01_16:00:00 4:measured:0:</code> nur die Temperatur-Werte
* <code>{ ReadingsTimestamp("FHT_3a32","state","0") }</code> Timestamp des aktuellen state des FHT_3a32
* <code>{ OldTimestamp("FHT_3a32") }</code> Timestamp des letzten state des FHT_3a32
* <code>{ time_str2num(OldTimestamp("FHT_3a32")) }</code> Timestamp in Sekunden des letzten state des FHT_3a32
* ...
Weitere Beispiele kann man sich gut aus den SVG-Dateien ziehen.

== Mehrere Werte und Dummy in einer Zeile formatiert in Logdatei schreiben ==
Manchmal möchte man die einzelnen Werte nicht untereinander in der Logdatei haben, sondern wie bei einer CSV-Datei in einer Zeile.

Hierzu kann man wie im Beispiel die einzelnen Readings Kesseltemperatur, Vorlauftemperatur und Rücklauftemperatur aus One-Wire-Sensoren DS18B20 und die Außentemperatur als vierten Wert aus einem Dummy über sprintf formatieren. Wer das mit Kommas oder Semikolons getrennt haben möchte, ersetzt die Leerzeichen zwischen den einzelnen Werten durch sein Wunschtrennzeichen.<blockquote><code>attr HEIZUNG userReadings HeizDataLog {sprintf("K: %3.1f VL: %3.1f RL: %3.1f Pr: %4.1f", ReadingsVal("OWX_28_4C966XXXXXXX","temperature", 0),ReadingsVal("OWX_28_4F9XXXXXXXXX","temperature", 0),ReadingsVal("OWX_28_FFAXXXXXXXXX","temperature", 0), (Value("Heiz_Temp_Outside")))}</code></blockquote>Für die einzelnen Userreadings lassen sich auch unterschiedliche Intervalle angeben.<blockquote><code>attr HEIZUNG event-min-interval HeizDataLog:300, HeizKesselTemp:20</code></blockquote>Da im Beispiel nur Userreadings HeizDataLog geschreiben werden soll, muss es bei <regexp> dementsprechend angegeben werden.<blockquote><code># logging</code></blockquote><blockquote><code>define FileLog_Heizung FileLog ./log/Heizung/Heizung_%Y_%m.log HEIZUNG:HeizDataLog.*</code></blockquote><blockquote><code>attr FileLog_Heizung logtype text</code></blockquote><blockquote><code>attr FileLog_Heizung room LogFiles,Heizung</code></blockquote><blockquote><code>attr FileLog_Heizung group Heizung</code></blockquote>Das ergibt folgendes Ergebnis:<blockquote>2020-09-27_19:36:57 <code>HEIZUNG</code> <code>HeizDataLog</code>: K: 66.8 VL: 60.8 RL: 35.7 Out: 18.4</blockquote><blockquote>2020-09-27_19:41:58 <code>HEIZUNG</code> <code>HeizDataLog</code>: K: 60.0 VL: 56.9 RL: 34.3 Out: 18.3</blockquote><blockquote>2020-09-27_19:46:58 <code>HEIZUNG</code> <code>HeizDataLog</code>: K: 50.2 VL: 47.9 RL: 34.4 Out: 18.2</blockquote><blockquote></blockquote>

== Links ==
* {{Link2Forum|Topic=40041|Message=323315|LinkText=Forenbeitrag}} zum Thema fhem.log / fakelog

[[Kategorie:Logging]]

UserReadings

2018-02-03T23:08:51Z

Jophb: Link CommandRef eingefügt

{{SEITENTITEL:userReadings}} 
{{Baustelle}}
Über das Attribut [[userReadings]] können bei einem Device benutzerdefinierte Readings einschließlich der Anweisungen zum Befüllen derselben festgelegt werden. Das können zum Einen Formatänderungen ("sprintf"), oder aber auch durch die ''Modifier''
* difference
* differential
* integral
* offset
* monotonic
gesteuerte Berechnungen sein.

== Syntax ==
{{Randnotiz|RNTyp=y|RNText='''Geändertes Verhalten - bitte beachten'''
Im April 2016 hat sich die Verarbeitung des ''Triggers'' dahingehend geändert, dass die Trigger-Spezifikation jetzt als [[Regulärer Ausdruck]] interpretiert wird, damit also z.B. ein <code>avgTemp:temperature</code> geändert werden muss in <code>avgTemp:temperature.*</code>.

Technische Details dazu wurden in {{Link2Forum|Topic=52165|LinkText=diesem Forenthread}} diskutiert.
}}
Siehe {{Link2CmdRef|Anker=readingFnAttributes}}.

* Bei Eingabe im Editor-Feld müssen mehrere Befehle mit einem ";" getrennt werden, bei Änderung in der Eingabezeile sind zwei ";" notwendig.
* Die Variable, dessen Wert man im Reading haben möchte, kann man einfach ans Ende stellen[https://perldoc.perl.org/functions/return.html]
* mehrere UserReadings werden durch Komma getrennt.

myreading {my $v = ReadingsVal($name,"actuation","error")+62;; fhem("set PID desired $v");; $v},
myreading2 {my $v = ReadingsVal($name,"actuation","error")+62;; fhem("set PID2 desired $v");; $v}

== Beispiele ==

==== Ausgabe eines Homematic 3-State Fenstersensor als Zahl für Visualisierung mit Icons ====

attr HM_XXXXXX userReadings Statenum {if(ReadingsVal("HM_XXXXXX","state","") eq "closed") {return 0} elsif (ReadingsVal("HM_XXXXXX","state","") eq "tilted") {return 1} elsif (ReadingsVal("HM_XXXXXX","state","") eq "open") {return 2} else {return -1}}
==== Ausgabe als Moving Average und formatierung mit sprintf ====
attr HZ_EINSTRAHLUNG_RAW userReadings Einstr_Mean.av {sprintf("%.1f",movingAverage("HZ_EINSTRAHLUNG_RAW","reading",1200))}

==== Umrechnung der Temperatur (durch 10 geteilt) und Einheit [°C] angehängt ====
attr HZ_EINSTRAHLUNG_T userReadings SolarTemp {ReadingsVal("HZ_EINSTRAHLUNG_T","reading",0)/10 ." °C"}

==== Batterieüberwachung durch Erweiterung mit notify und userReading ====
[[Batterieüberwachung]]
==== Integralfunktion - integral ====
Die Verwendung der Integralfunktion bei ''userReadings'' ist ausführlich im Forenbeitrag {{Link2Forum|Topic=26300|Message=193084|LinkText=Integralfunktion bei UserReadings}} erklärt.

== Links ==
* {{Link2CmdRef|Lang=de|Anker=userReadings}} - userReadings
[[Kategorie:Attribut (allgemeingültig)]]

UserReadings

2018-02-03T23:01:24Z

Jophb: /* Beispiele */

Benutzer Diskussion:Ph1959de

2017-12-25T20:42:56Z

Jophb: Neuer Abschnitt /* Einfügen von Links und Beispielen */

== Kategoriestruktur ==

Ich habe eine Bestandsaufnahme der Kategoriestruktur mittels Freeplane Mindmap Programm erstellt. Die Quelldatei kann ich derzeit hier nicht ablegen, da nur Bilddateien erlaubt sind. Bei Bedarf bitte nach der .mm Datei fragen, ich sende sie gern an Interessenten (die willens sind, an der Umstrukturierung mitzuarbeiten). --[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 13:13, 8. Jul. 2013 (CEST)

::Darfst du die Datei im Forum hochladen? Dann könntest einfach von hier dorthin verlinken? Grüße, [[Benutzer:Rince|Rince]] ([[Benutzer Diskussion:Rince|Diskussion]]) 08:43, 10. Jul. 2013 (CEST)

== Löschkandidaten ==
Die ganzen unverlinkten Bilde in Löschkandidaten packen hättest du nicht machen brauchen. Ich lösch unverlinkte Bilder die aus dem Import kommen auch so... wenn ich zwischendurch immer mal Zeit [[Benutzer:Soulman|Soulman]] ([[Benutzer Diskussion:Soulman|Diskussion]]) 17:00, 9. Jul. 2013 (CEST)

: :-) ... War ich ja gar nicht - das war Markusbloch ... von mir war der Hinweis auf die unverlinkten Dateien. --[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 23:03, 9. Jul. 2013 (CEST)

::: Manchmal hab ich eben so ne Phase irgendwie. Ist genauso wie bei der manuellen Korrektur aller Artikel direkt nach dem Import ;-) --[[Benutzer:Markusbloch|Markusbloch]] ([[Benutzer Diskussion:Markusbloch|Diskussion]]) 18:33, 10. Jul. 2013 (CEST)

::::Oh ja, hab irgendwie nicht aufgepasst. Also gegen die Phasen hab ich nix :-) [[Benutzer:Soulman|Soulman]] ([[Benutzer Diskussion:Soulman|Diskussion]]) 20:24, 10. Jul. 2013 (CEST)

== Abbildung von Bauteilen als Foto ==
Hallo Peter,

ich habe eine grundsätzliche Frage zur Darstellung von eigenen Fotos unter FHEMWiki. Ist es urheberrechtilich zulässig, eigene Fotos von Bauteilen darzustellen ?

Gruß
Lothar

:Hallo Lothar, ich bin da zwar kein Experte, denke aber, dass genau diese Art von Bildern erlaubt ist. Was nicht geht, ist das Übernehmen von Bildern von z.B. einer Herstellerseite, oder das direkte einbinden von Bildern aus fremdem Webspace. Ich denke, diese Aussage ist auch durch die Beschreibung bei Wikipedia abgedeckt: http://de.wikipedia.org/wiki/Hilfe:Bildertutorial/2_Bildrechte.
:<hr>
:--[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 13:30, 27. Aug. 2013 (CEST)

== Urheberschaft der alten Einträge ==
Hallo,

ich habe festgestellt, dass ihr beim Neuaufsetzen des Wiki alle Urheberinformationen gelöscht habt. War das Absicht, oder ein Unfall ?

KG

pah
<hr />
:Hallo pah, muss man wohl eher als Unfall bezeichnen. Das Wiki war komplett weg (und das Backup war nicht wirklich als solches zu bezeichnen, sondern komplett unbrauchbar) und wurde aus dem Google-Cache wieder hergestellt. Dabei ist natürlich die ganze Änderungshistorie (und damit auch das was Du vermutlich als Urheberinformation bezeichnest?) verloren gegangen.
:Aber das erinnert mich daran, dass ich bei einem der Administratoren dringend mal nachfragen wollte, wie es jetzt um die Sicherstellung der Backups steht.
:Und noch ein Nachsatz: ''...dass ihr beim Neuaufsetzen des Wiki...'': daran war ich nicht wirklich aktiv beteiligt. Bin auch nur "ganz normaler" Wiki Benutzer ohne besondere Rechte. --[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 14:43, 10. Nov. 2013 (CET)

== Links auf der Willkommensseite ==
Hallo Peter,

ich bin - als Neuling - nicht ganz sicher, ob die Kommunikation mit Dir so gedacht ist, aber zumindest stand das so auf der Begrüßungsseite ;-)

Ich habe festgestellt, dass in der Begrüßungsseite die Links auf die englische Version von wikipedia verweisen. Ich denke gerade für Neulinge wäre da die deutsche Version besser. (Z.B. http://de.wikipedia.org/wiki/Wikipedia:Tutorial)

--[[Benutzer:Funfactor|Funfactor]] ([[Benutzer Diskussion:Funfactor|Diskussion]]) 12:31, 28. Nov. 2013 (CET)
: ... ja, ist mir bekannt (trotzdem danke für die Rückmeldung). Kann ich aber leider nicht ändern, aber wenn ich mich recht erinnere, habe ich da beim "Betreiber" unseres Wiki schon mal nachgefragt aber bisher keine Antwort bekommen. Ich werde noch mal nachhaken. --[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 13:40, 28. Nov. 2013 (CET)
:: Ok, ich habe mir das noch mal angeschaut. Ist für neue Benutzer wirklich ziemlich verwirrend, deshalb habe ich vorerst mal "hartcodiert" auf die Links auf die deutschen Wikipedia:-Hilfeseiten umgestellt. --[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 18:42, 28. Nov. 2013 (CET)

== Verwendung der Sandbox ==
Hallo Peter,

den Wiki "sauber" zu halten ist ja eine wichtige Sache und ich denke dafür ist die [[FhemWiki:Sandbox]] gedacht.
Leider ist mir völlig unklar, wie ich diese in diesem Sinne verwenden soll. Gibt es hierzu eine Anleitung oder ein paar Hinweise?

--[[Benutzer:Funfactor|Funfactor]] ([[Benutzer Diskussion:Funfactor|Diskussion]]) 17:01, 29. Nov. 2013 (CET)
:Die Geschichte mit der Sandbox sollte man vielleicht nicht überbewerten. Was vermieden werden sollte ist
:* das wilde Anlegen von neuen Artikeln mit zusätzlichem experimentieren mit den Seitennamen (das gibt dann immer gleich eine Weiterleitung und zusätzlichen Aufräumaufwand)
:* jede noch so kleine Änderung separat abzuspeichern (Vorschau, Vorschau, Vorschau!); es gibt einige Leute, die neue Änderungen querlesen - denen macht man die Arbeit sonst unnötig schwer
:* was mir sonst noch so eingefallen ist, habe ich schon auf die [[FHEMWiki:Über FHEMWiki]]-Seite geschrieben (darf natürlich ergänzt werden)
:Experimentieren kann man zur Not auch im eigenen Namensraum (also in Deinem Fall <nowiki>[[Funfactor/Experiment...]]</nowiki>. Aber weitere Ideen sind jederzeit willkommen (bitte beachten: ich bin auch nur "ganz normaler User" hier). --[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 18:35, 29. Nov. 2013 (CET)

== On-for-timer zurücksetzen ==
Hi, es gibt da einen Artikel, den ich erstmals gerne mit einem Template Löschkandidat oder Qualtitästsicherung versehen würde: '''On-for-timer zurücksetzen'''
Erbitte Zweitmeinung. Und ich weiss nicht, ob wir ggf passende Templates haben muss ich zugeben.

[[Benutzer:Soulman|Soulman]] ([[Benutzer Diskussion:Soulman|Diskussion]]) 16:38, 27. Dez. 2013 (CET)
:<hr>
:--[[Benutzer:Stephan|Stephan]] ([[Benutzer Diskussion:Stephan|Diskussion]]) 16:45, 27. Dez. 2013 (CET) ''(Stefans Beitrag auf die Diskussionsseite des Artikels ([[Diskussion:On-for-timer_zurücksetzen]]) verschoben [ph1959de])''

:<hr>
:Ich (traue mich fast nicht :-), aber ich ...) verweise einfach mal auf die [[:Kategorie:Löschkandidaten]] und dortselbst auf den einleitenden Text.
:--[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 17:54, 27. Dez. 2013 (CET)

== autocreate ==
du hast recht. in der default konfiguration von autocreate ist autosave an. aber es gibt devices wie z.b. OWServer/HUE und ich glaube sogar HM die gehen nicht über autocreate und da ist es auf jeden fall nötig von hand save zu sagen. [[Benutzer:Justme|Justme]] 19:56, 8. Jan. 2014 (CET)

== 1-Wire - Kategorie vs. Artikel ==
Ich finde es nicht richtig, die Übersichtsbeschreibung - z.B. was das 1-Wire System ist - aus der Kategorieseite herauszunehmen. Diese Trennung schafft Redundanz und verhindert sie nicht.

Die Beschreibung ist eine unmittelbare semantische Eigenschaft der Kategorie, und kein untergeordneter Begriff.
--[[Benutzer:Pahenning|Pahenning]] ([[Benutzer Diskussion:Pahenning|Diskussion]]) 19:05, 22. Feb. 2014 (UTC)
:''Ich habe mir mal erlaubt, die Diskussion zu einem eigenen Abschnitt zu machen.''
:Nachdem Du meine Änderung mittlerweile rückgängig gemacht hast, erübrigt sich ja eine weitere Diskussion. Konsequenterweise müsstest Du aber dann auch den Artikel [[1-Wire]] mitpflegen - Artikel und Kategorietext sind derzeit nur deshalb gleich, weil ich die Inhalte mit meiner Änderung auch konsolidiert hatte.
:Damit die Diskussion über dieses Thema leichter auffindbar ist, kopiere ich sie noch in die [[Kategorie_Diskussion:1-Wire]], wo sie dann ggf. auch weitergeführt werden kann/sollte.

::Werde ich machen
::--[[Benutzer:Pahenning|Pahenning]] ([[Benutzer Diskussion:Pahenning|Diskussion]]) 15:38, 24. Mär. 2014 (UTC)

== Disclaimer ==
Es erscheinen immer mehr Schaltpläne hier im Wiki. Vorschlag: Einen allgemeinen Disclaimer des Inhaltes:

- Nachbau aller Schaltpläne auf eigene Gefahr
- Weder Betreiber noch Autoren übernehmen irgendeine Haftung für Inhalte und unmittelbare oder mittelbare Folgen
- Hinweis auf die gesetzlichen Regelungen beim Anschluss an 230 V-Netze

und diesen dann ausdrücklich unten neben "Datenschutz etc." referenzieren.

LG

pah
--[[Benutzer:Pahenning|Pahenning]] ([[Benutzer Diskussion:Pahenning|Diskussion]]) 15:42, 24. Mär. 2014 (UTC)
<hr>
:Wenn Du damit ein Template/eine Vorlage meinst, die auf relevanten Seiten gezielt eingebunden werden kann/muss, kann ich das gern mal in Angriff nehmen. Ich würde mich dann an dem Text orientieren, den Du auf [[1W-WPump]] eingefügt hast. Im Augenblick ließe sich dafür auch die Vorlage <nowiki>{{Randnotiz|...}}</nowiki> (siehe [[FHEMWiki:Über_FHEMWiki#Vorlagen]]) verwenden.
:Für einen generellen Wiki-weiten Disclaimer würde ich Dich eher bitten, das selbst zu machen oder den Wiki-Admin [[Benutzer Diskussion:akw|Arno]] anzusprechen.
:--[[Benutzer:Ph1959de|Greetz, Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 10:45, 25. Mär. 2014 (UTC)

== Erweiterung der Vorlage "Infobox Hardware" ==
hallo peter,
ich habe deine nachricht eben erst gesehen.

die idee war die infoboxen für modul und hardware ähnlicher zu machen. es ging mir nicht um den link zum modul sondern tatsächlich zum maintainer und da die möglichkeit aufs forums profil zu verlinken. so wie du es bei der neuen FLOORPLAN seite gemacht hast. zumindest bei 'meinen' modulen ist es zur zeit so das die info für die hardware und das fhem modul auf einer seite stehen. siehe: pca301 oder panstamp/swap. da gibt es entweder nur eine der beiden boxen oder die gleiche info taucht in beiden boxen auf. beides gefällt mir nicht wirklich.

eigentlich wollte ich die komplette ersteller zeile optional haben. das habe ich aber mit der tabellen formatierung noch nicht hin bekommen. jetzt ist erst mal nur der inhalt optional.

inzwischen habe ich noch "FHEMDevice" in "Modulname" geändert so wie es in der modul infobox auch ist. und die reihenfolge unter sonstiges geändert.

ich kann das aber auch wieder zurück bauen.

--[[Benutzer:Justme|Justme]] ([[Benutzer Diskussion:Justme|Diskussion]]) 13:51, 16. Mai 2014 (UTC)
:Auf der [[Vorlage_Diskussion:Infobox_Hardware]]-Seite geht's weiter.

== neue seiten ==
wo wir gerade dabei sind :). ich glaube es wäre schon den auskommentierten abschnitt 'neue seiten' auf der einstiegsseite zu aktivieren. --[[Benutzer:Justme|Justme]] ([[Benutzer Diskussion:Justme|Diskussion]]) 14:01, 16. Mai 2014 (UTC)

== neue Seiten ==
Hallo Peter,

Ich bin auch ein Neuling, und will meine Erfahrungen gerne anbieten an andere Benutzer. Zum Beispiel habe ich gerade der Modul Openweathermap in Betrieb genommen, und habe dabei einige Probleme gelöst. Ich hätte gern mehr Beispiele gehabt, und will die darum in eine Seite verwenden. Ist das erwünscht? Wenn ja, wie sollen neue Seiten über Devices eingeordnet werden, z.B. Openweathermap? (Deutsch ist nicht meine Muttersprache, so hoffentlich mache ich nicht zuviel Fehler).

[[Benutzer:TrudiB|TrudiB]] ([[Benutzer Diskussion:TrudiB|Diskussion]]) 11:37, 23. Mai 2014 (UTC)

<hr />
:Hallo Trudi, es ist auf jeden Fall erwünscht, dass (funktionierende) Beispiele (möglichst komplett) vorgestellt werden.
:Um eine neue Modulbeschreibung anzulegen, würde ich empfehlen, mal [[Vorlage:Infobox_Modul]] anzuschauen. Auf der [[FHEMWiki:Über_FHEMWiki]]-Seite findest Du auch in der Spalte "Ref" eine Liste der Seiten, die nach dem Schema angelegt oder überarbeitet wurden.
:Im Zweifel einfach noch mal nachfragen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 13:11, 23. Mai 2014 (UTC)

== Admin ==
Ph1959de erhält mit sofortiger Wirkung Administrator-Status im FHEMWiki. --[[Benutzer:Akw|Akw]] ([[Benutzer Diskussion:Akw|Diskussion]]) 10:56, 31. Mai 2014 (UTC)

==ZHK Seiten Einzelmodule ==
Hallo Peter,
Ich würde den Meinungsaustausch zum Thema wiki Pages valves/stellmotor gerne zu einem gemeinsamen Abschluss bringen. Ein (Erneutes) Feedback von dir wäre dabei hilfreich. Ich möchte dich daher herzlich einladen meine
Disk.Seite erneut zu besuchen und um Dein Feedback zu bereichern.
LG florian

==Kategorien für EnOcean ==
Hallo Peter,
für EnOcean gibt es 2 Kategorien: EnOcean und EnOcean_Components (anlog Homematic u.a.). In EnOcean ist der "EnOcean starter guide" und die Kategorie ist sinnvoll ins Wiki eingebunden. In der nichteingebundenen Kategorie "EnOcean_Components" befindet sich nur ein Sensor. Ist das so beabsichtigt? oder sollte das nicht angepasste werden.
Danke, Christian
<hr>
:Hallo Christian, nachdem die "EnOcean Components" Kategorie gerade erst "angelegt" wurde, würde ich erst mal abwarten. Eigentlich passt die Kategorie eher ins Konzept als das reine "EnOcean". Ich tendiere also eher dazu, alles auf "EnOcean Components" zu konsolidieren. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 17:45, 13. Jul. 2014 (UTC)
::Hallo Peter, bin dabei, den EnOcean starter guide schrittweise zu überarbeiten. Ich würde dabei einige Aktoren- und Sensorenerläuterungen aus dem Starter guide entnehmen und als separate Artikel in "EnOcean components" aufnehmen; jedoch hätte ich gerne auch eine vernünftige Erreichbarkeit. Am einfachsten wäre es doch auch den starter guide zu verschieben. Dazu habe ich aber zuwenig Ahnung und würde das lieber einem Admin überlassen. --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 18:09, 13. Jul. 2014 (UTC)
::<hr>
:::Christian, wenn Du mit "Starter Guide verschieben" das Umhängen in Kategorie "EnOcean Components" meinst: das habe ich gerade gemacht (die Änderung besteht einfach nur aus dem Einsetzen des neuen Kategorienames im Artikel). Außerdem habe ich Kategorie "EnOcean" nach [[:Kategorie:EnOcean Components]] verschoben. Jetzt ist es einheitlich zu FS20, HomeMatic, etc.
:::... und jetzt kannst Du loslegen mit den weiteren Änderungen - nur eine Bitte noch: Namensschema gut überlegen und neue Artikel möglichst erst speichern, wenn Du wirklich komplett damit zufrieden bist (Vorschaufunktion "großzügig verwenden"). Das macht es den (wenigen) Leuten, die alle Änderungen hier im Wiki "sichten" einfacher. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 05:15, 14. Jul. 2014 (UTC)
:::: Vielen Dank für Deine schnelle Reaktion; werde versuchen Deine Bitten umzusetzen. Einen Wunsch habe ich natürlich noch ;-). Könnten wir EnOcean nicht auch auf der Hauptseite verlinken? Gruß, Christian--[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 09:27, 14. Jul. 2014 (UTC)
::::<hr>
:::::Ich habe ohnehin noch einige Änderungen für die Hauptseite auf meiner Liste. Da werde ich dann EnOcean auch mit aufnehmen ... bis dahin gibts ja dann vielleicht auch noch mehr Artikel in der Kategorie. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 09:44, 14. Jul. 2014 (UTC)
::::::zum Namensschema: Habe in der Kategorie den Hinweis zum Namensschema analog der anderen Hardwaresystme eingefügt. Mich stört eigentlich das Vorsetzen von EnOcean- ,würde es gerne weglassen, aber es scheint übliche Konvention hier zu sein. In der der Übersicht erscheint so aber alles unter "E". Hast Du dazu eine Meinung? Sorry, wenn ich so viel frage, aber bevor ich alles durcheinanderbringe...
::::::<hr>
:::::::Kein Problem (zu fragen) - ist wirklich einfacher, als nachher alles wieder "geradebiegen" zu müssen.
:::::::Nun, das Namensschema kannst ja Du im Augenblick noch festlegen. Bei den (z.B.) [[:Kategorie:FS20 Components|FS20 Komponenten]] ist es, wie Du schon bemerkt hast, so, dass alles unter einem Buchstaben im Index erscheint. Wie man das ändern kann, habe ich exemplarisch mal im [[FS20 WS1 Wechselschalter]] gezeigt.
:::::::Hat alles so seine Vor- und Nachteile. Auch wenn Du nicht immer "EnOcean" davor schreibst, werden doch trotzdem viele Geräte mit den gleichen Buchstaben beginnen. Dann kann es ja auch gleich das EnOcean sein. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 11:27, 14. Jul. 2014 (UTC)
:::: Hallo Peter! Danke für das kurzfristige Aufnehmen von EnOcean auf der Hauptseite. --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 15:14, 17. Jul. 2014 (UTC)

== Subtype Tabelle für EnOcean ... Wiki-Tipps? ==
Hallo Peter, bräuchte noch einmal Wiki-Nachhilfe, da ich keine einfache Lösung gefunden habe. Vielleicht hast Du eine Idee:
Ich würde gerne auf der Kategorie-Seite EnOcean Components die vorhandenen EnOcean-Wiki-Artikel noch einmal separat anhand des EnOcean-Attributs "subType" zuordnen und sichtbar machen.
Quasi eine (lange) Tabelle der Art
{| class="wikitable"
|-
! subType !! Wiki-Seite Geräte
|-
| switch || [[EnOcean-PTM-210-Taster]]
|-
| lightSensor.01 || [[EnOcean-FAH60-Au%C3%9Fen-Helligkeitssensor]]
|-
|}
Manuell könnte ich das auf die Kategorienseite einpflegen -> fehleranfällig

Unterkategorien -> nicht erwünscht und klickintensiv, aber weniger wartungsintensiv

Unterseite zu EnOcean Components -> fehleranfällig und nicht auffällig

Hast Du dazu eine Idee/Meinung? Danke --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 22:41, 5. Aug. 2014 (UTC)
<hr />
:Ich würde (zumindest für's Erste) mal was Ähnliches machen wie die "News" Sektion auf der Hauptseite. Da wird Vorlage [[Vorlage:FHEMWiki_News]] eingebunden. In dieser Vorlage wird (manuell, aber wie ich finde recht übersichtlich) eine Tabelle unter zuhilfenahme der Vorlage [[Vorlage:News]] aufgebaut.
:Wenn ich das richtig sehe, könntest Du sogar in (D)einer neuen Vorlage (nennen wir sie mal <nowiki>{{EnOceanSubTypeTable}}</nowiki>) einfach die News Vorlage so <nowiki>{{News|subType|Wiki-Seite}}</nowiki> "missbrauchen". Und die EnOceanSubTypeTable ließe sich dann nicht nur auf der Kategorie-Seite, sondern auch auf anderen Seiten bei Bedarf einfach so einbinden. Ansonsten halte ich mal die Augen offen und schaue, ob ich noch eine andere Lösung / einen besseren Ansatz finde.
:P.S.: Ich finde, Du machst einen Superjob in der "EnOcean-Abteilung" hier im Wiki. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 06:16, 6. Aug. 2014 (UTC)
:<hr />
:: Ich probiere einmal Deinen Vorschlag umzusetzen. Hoffe es gelingt; löschen kann man immer noch....
:: Nach Lösungen hatte ich auch gesucht, aber mit meinem Wiki-Halbwissen nichts einfaches entdecken können.
::P.S.: Danke, zurück an Dich (auch wegen Nachhilfe). Bei EnOcean hilft 50watt auch mit. --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 12:04, 6. Aug. 2014 (UTC)
:: Hm, hatte es befürchtet, Vorlage und Text waren schnell erstellt, aber dann: <s>Deine "nowiki" Geschichte habe ich anscheinend falsch verstanden.</s> (Man/Ich sollte erst denken und dann schreiben) Als Box -wie die News auf der Hauptseite- einbinden habe ich auf die Schnelle nicht hinbekommen. Da sind soviele Codetags mit denen ich mich noch beschäftigen muss. Hoffe ich habe hier kein Chaos verursacht; ansonsten bitte löschen. --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 13:31, 6. Aug. 2014 (UTC)
::<hr />
:::Sieht doch schon ganz gut aus. Für eine direkte Einbindung auf der Kategorieseite ist die Tabelle meiner Ansicht nach eh zu groß, daher finde ich den von Dir gewählen Ansatz mit der eigenen Seite ganz gut.
:::In der Vorlage müsstest Du noch die Erläuterung zum "xx" überarbeiten (die führende Leerstelle macht das automatisch zu einem <nowiki><pre></nowiki>. Wenn Du die Hervorhebung willst, müsstest Du den Satz in <nowiki><code></code></nowiki> setzen.
:::Das Layout der Tabelle kann man ja auch jederzeit noch ändern.
:::Wenn Du noch Hilfe / Unterstützung brauchst, lass es mich wissen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 14:36, 6. Aug. 2014 (UTC)
:::<hr />
::::Mit dem Ergebnis bin ich nicht wirklich zufrieden. Aber bevor ich daran weiterarbeite, muss ich mehr zur Wiki-Bearbeitung lernen.
::::Danke für Deine bisherige Unterstützung und auch das Hilfsangebot. Werde sicherlich darauf zurückkommen. --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 14:53, 6. Aug. 2014 (UTC)

== Vorlage Link2Forum ==
Hallo Peter, soll ich die Vorlage Link2Forum schon nutzen? Wenn ich es zeitlich morgen schaffe, wollte ich sowieso noch einige EnOcean Wiki-Seiten anfassen. Würde es dann schon mitändern. Oder kannst Du das automatisiert? Gruß, Christian --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 19:32, 11. Aug. 2014 (UTC)
<hr />
:Hallo Christian, ich würde die Vorlage bisher nur für den sparsamen Einsatz (kannst sie gern in ein oder zwei Artikeln ausprobieren) empfehlen. Insbesondere innerhalb der "Infobox Modul" bin ich noch nicht ganz soweit - da tendiere ich eher noch dazu, das Link2Forum direkt aus der Infobox heraus einzusetzen. Das wäre dann nur eine Änderung, die hoffentlich alle bisherigen Einsatzstellen der Infobox erwischen würde (wobei, der Forenlink ist meines Wissens noch lange nicht überall drin; das habe ich ja erst kürzlich in die Infobox aufgenommen).
:Automatisieren kann ich leider nichts; mir ist (zumindest noch) nicht bewusst, dass wir hier die Möglichkeit haben, irgendwelche Bots einzusetzen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 21:32, 11. Aug. 2014 (UTC)
:<hr />
::Nutze bei EnOcean nur "Infobox Hardware" intensiv, dort brauche ich die Links nicht. Innerhalb der Wiki-Seiten verlinke ich häufiger auf einen bestimmeten Beitrag im Forum. Dort könnte ich schon umstellen auf <nowiki>{{Link2Forum|Topic=12345|Message=54321}}</nowiki>. Über die Vorlage "Infobox Modul" habe ich mir bei EnOcean noch keine Gedanken gemacht (Momentan grübel ich eher noch Einsatzbeispiele analog zur Vorlage EnOceanSubTypetable zusammenzufassen). --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 22:04, 11. Aug. 2014 (UTC)
::<hr />
:::Wie gesagt, bitte noch "defensiv" benutzen, da ich noch keine umfangreicheren Tests gemacht habe. Daher bin ich aber natürlich auch an Rückmeldungen (die bitte dann auf der entsprechenden Diskussionsseite) zu der Vorlage interessiert (gibts Probleme, Änderungs-, Erweiterungswünsche und/oder -bedarf...?).
:::Ansonsten: Infobox Modul - dafür gäbe es bei EnOcean wohl nur genau eine Einsatzmöglichkeit, wenn ich das richtig sehe. Das könntest Du anlegen, wenn Du die Vorlage mal einsetzen möchtests. Oder gibt es weitere Module, die EnOcean implementieren? --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 05:06, 12. Aug. 2014 (UTC)

== Inhalt Hauptseite ==
Hallo Peter, folgende Idee/Vorschläge zur Wiki-Hauptseite:
Developers Corner: die dort direkt verlinkten Seiten sind -vorsichtig formuliert- nicht gerade die Aktuellsten; könnte man dort nicht besser gut gepflegte Seiten wie [[DevelopmentModuleIntro]] oder [[DevelopmentGuidelinesAV]] direkt verlinken? Außerdem ist das "Guter Startpunkt, sehr empfohlen!" unter "Wie fange ich an" meiner Meinung nach zu schwach. Ich denke das ist DIE Grundvoraussetzung für den ersten Überblick; hast Du auch unter [[Planung]] geschrieben. "Tipp der Woche" unter Ideen und Lösungen ist (war?) "nur" der "Tipp des Monats" und sollte dann auch so genannt werden. Wird anscheinend nur von soulman gepflegt. Wenn da nichts Aktuelles drin steht, wirkt das Wiki ziemlich tot. Andererseits habe ich persönlich auch keinen großen Antrieb dort etwas zu verfassen. Wer sucht dort wirklich?
Ich weis, kaum aktiv und schon Rumnörgeln... (Nicht wundern: Ich habe mich heute aber schon wieder darüber geärgert, dass immer mehr Blogs Fhem-Artikel mit typischen Wiki-Inhalt veröffentlichen statt dies hier zu tuen, wo ein zentraler Anlaufpunkt sein sollte. Wenn diese Blog-Artikel auch noch umständlich oder fehlerbehaftet sind, hat man keine Einfluß auf Korrekturen und der Kram ist im Umlauf. Dagegen sollten wir arbeiten.)--[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 15:22, 14. Aug. 2014 (UTC)
Auch <nowiki>[[Links|wichtige Fhem Links]]</nowiki> sind nicht gerade top-aktuell. Für wichtig halte ich die schon gar nicht. So, Frust weg ;-). Aber dennoch halte ich meine Anmerkungen für diskussionswürdig. Ich möchte auf der Hauptseite nicht eigenständig ändern, da mir nicht bekannt ist, ob das für Normal-Anwender erlaubt ist. --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 18:31, 14. Aug. 2014 (UTC)
<hr />
:Christian, auch die Hauptseite kann von jedem bearbeitet werden - aber vorherige Diskussion ist da vielleicht nicht falsch. Ich habe daher Deine Anregungen mal auf die [[Diskussion:Hauptseite#Vorschläge zur Überarbeitung der Hauptseite|Diskussionsseite]] übertragen. Lass uns die Sache da weiterführen ... vielleicht beteiligt sich ja noch jemand... --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 05:41, 15. Aug. 2014 (UTC)
<hr />
::Ok, werde auch versuchen meine Anmerkungen passender zu platzieren. Hoffe nur, dass das dann nicht komplett untergeht. Habe aber teilweise keine Ahnung, wo das hin soll - bin noch zu Wiki-unerfahren. Aktuell bspw. [[Spezial:Gewünschte_Seiten]] enthält nach meiner Meinung eine Vielzahl von "Leichen", die weg können (FR und alles was damit zusammenhängt; Links durch STELLMOTOR). Ich habe da keine Ahnung, wo ich anfangen soll/darf. Ich würde beispielsweise bei [[STELLMOTOR]] die "toten" Lemmas/Seiten herausnehmen. Der Ersteller von STELLMOTOR könnte sie wieder reinnehmen, wenn er tatsächlich daran arbeiten will; traue mich aber nicht.
::'' ... vielleicht beteiligt sich ja noch jemand...'' Hoffnung stirbt zuletzt.... ;-) --[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 08:15, 15. Aug. 2014 (UTC)
::<hr />
:::* Ist schon ok, das hier zu plazieren ... aber außer mir findet das hier keiner, daher der "Umzug"
:::* "Gewünschte Seiten" ... enthält alle <nowiki>[[Lemma...]]</nowiki> Stellen, die auf nicht existierende Seiten verweisen. Wenn's so extrem vorkommt wie in Deinem genannten Beispiel, einfach den entsprechenden Benutzer anschreiben. Wirklich stören tut's aber auch nicht - du glaubst gar nicht, wie '''wenige''' Benutzer die "Gewünschte Seiten" Seite jemals gesehen haben, geschweige denn regelmäßig benutzen.
:::* Anfangen darfst Du sicherlich da, wo ein Eintrag in die "Gewünschten Seiten" offensichtlich versehentlich entstanden ist, z.B. weil jemand sich schlicht vertippt hat; wenn jemand schon mal eine Liste erstellt hat, welche Seiten noch gemacht werden müssen (wie ich z.B. auf meiner Benutzerseite :-) ), würde ich das erst mal ganz gelassen so stehen lassen.
:::* Und immer im Hinterkopf behalten, dass viele Benutzer hier im Wiki nur ganz gelegentlich unterwegs sind um vielleicht den einen oder anderen Tippfehler zu korrigieren - und das war's dann auch schon. Die meisten Benutzer bekommen nicht mal die Begrüßungshinweise mit ... und/oder lesen sie nicht, halten sich nicht dran, verstehen sie nicht...
:::Bottom line: nicht zu viel erwarten, Dich selbst nicht "aufreiben", aber fleißig weitermachen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 08:35, 15. Aug. 2014 (UTC)
:::<hr />
::::Bottom line: keine Sorge, reibe mich schon nicht auf. ''weiter'''machen''''': ich würde es grds. einfach machen, will aber niemanden vergraulen und den Admins unnötig Arbeit machen; hätte in STELLMOTOR die "toten" Lemmas in normale Aufzählung verwandelt, FR gelöscht (Leiche des Absturzes), kleinere Änderungen an Hauptseite vorgenommen oder... Rückgängig kann man (Admin/Ersteller) es immer noch machen; eigentlich ist es mir zu viel Diskussion, die mMn keinen weiterbringt, (wie lange soll man auf Entgegnungen warten?).....
::::Meine Bottom line: Keine Sorge Umstrukturierungen (Kategorien) o.ä. würde ich nicht undiskutiert vornehmen
:::::Nur teilweise Offtoic: Peter, wenn Du meine Verlinkung in der Homematic-Kategorie nicht OK findest, mach es einfach rückgängig: Für mich ist das in Ordnung, habe damit grds. kein Problem; gilt immer. Gruß, Christian (Habe da eh noch einen Tippfehler eingebaut!)

== WikiArtikel Pflege ==
Hallo Peter,
die "Verschieben" Option von Artikeln kannte ich in der Tat noch nicht. Danke für den Hinweis..
:Kein Problem & gern geschehen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 06:45, 29. Aug. 2014 (UTC)

Du kannst meine Wiki-Artikel gerne korrigieren und vereinheitlichen. Wenn du mir zusätzlich noch verrätst worauf du achtest, kann ich versuchen diese Dinge gleich selbst zu beachten.
:<hr />
:Lässt sich so generell nicht beantworten; manchmal nur Kleinigkeiten. Beispiele:
:* Artikel in Ich-Form schreibe ich normalerweise auf neutrale Ausdrucksweise um (später weiß ohnehin niemand mehr, wer der "Ich" war); das ist verbindlicher und mMn für technische Beschreibungen angemessener.
:* Querverweise (Links auf andere Artikel) einfügen - auch IN anderen Artikeln wo sinnvoll Verweise auf Deinen neuen Artikel setzen (sonst entstehen "Waisen" und "Sackgassen"); ob es schon Links auf Deine Seite gibt, kannst Du über das "Links auf diese Seite" (links in der Navigationsleiste) herausfinden.
:* Rechtschreibung / Grammatik / Formulierung... ist eigentlich immer dabei
:* usw.
:-- [[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 06:45, 29. Aug. 2014 (UTC) <hr />

Nochetwas: ich vermisse eine Kategorie für selbst gebaute Schaltungen. Ich bin mir immer unsicher wo ich meine Artikel einstellen soll. ZurZeit sind 1wire-Schaltungen bei 1wire. Aber für Panstamps und Arduino basierte Schaltungen habe ich nichts gefunden. Kannst du helfen?
:<hr />
:Es bei Hardware die Unterkategorie "Other Components", da passt sowas derzeit immer rein. Sofern mal eine "kritische Masse" erreicht ist (also mehr als nur ein oder zwei Artikel), kann man ja überlegen, mal eine Unterkategorie "Eigenentwicklungen" (oder ähnlich) bei Hardware einzufügen.
:Für Arduino gibt es schon eine Kategorie (Unterkategorie von Hardware), für Panstamp könnte man sowas auch einrichten - wenn es vom Konzept her passt (dazu verstehe ich von der Arduino/Panstamp...-Welt zu wenig). Es sollten halt immer ähnliche Dinge in einer Kategorie/Unterkategorie... zusammengefasst sein.
:-- [[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 06:45, 29. Aug. 2014 (UTC) <hr />
::Misch mich mal ein: Fände Kategorie Eigenentwicklungen o.ä. nicht schlecht, da bestimmte Zielgruppe angesprochen wird. Ich lasse bspw. meine Finger davon. Würde den Artikel trotzdem zusätzlich noch in Other Components aufnehmen oder wenn es 1-wire ist auf jeden Fall in 1-Wire. Bei Homematic haben wir doch Unterkategorie HomeBrew, analog auch bei anderen anlegen!? Wir sollten etwas angehen....--[[Benutzer:Krikan|Krikan]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 08:18, 29. Aug. 2014 (UTC) <hr />
:::Ok, dann machen wir doch einfach einen Auftrag an Tobias daraus: mal sammeln, welche Artikel schon vorliegen (oder er in Planung hat) für eine solche Kategorie, dann schauen wir kurz drüber und beschließen, welche neuen Unterkategorien und wie einsortiert...
:::@Tobias: ich stell das mal so auf Deine Diskussionsseite --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 08:48, 29. Aug. 2014 (UTC) <hr />

GRuss
Tobias

== Verschieben von Wiki-Seiten ohne Weiterleitung ==
Hallo Peter,
könntest Du bitte
* [[Z-Wave-EVR_ST814-Temperatur-_und_Feuchtesensor]] auf Z-Wave-EVR_ST81'''4'''-Temperatur-_und_Feuchtesensor ohne Weiterleitung verschieben. Der Ersteller [[Benutzer_Diskussion:Morgennebel]] ist anscheinend nicht mehr aktiv; reagiert auch nicht auf PM.
: -> Erledigt --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 12:31, 27. Dez. 2014 (UTC)
* hier [[Diskussion:WS3600]] mal reinschauen. Dort hätte ich auch gerne eine Wiki Seite verschoben. Keine Ahnung, ob Dir das aufgefallen ist.
: -> Ja, hatte ich gesehen ... und jetzt auch erledigt --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 12:31, 27. Dez. 2014 (UTC)
* WebIO_Digital auf WEBIO_12DIGITAL verschieben --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 17:36, 7. Dez. 2015 (CET)
: -> Erledigt --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 17:52, 7. Dez. 2015 (CET)

== Nutzung von <nowiki><pre style="width:500px;"></nowiki> statt <nowiki><code></nowiki> ==
Hallo Peter, 
Du ersetzt teilweise in den Wikiseiten die Formatierung <nowiki><code></nowiki> durch <nowiki><pre style="width:500px;"></nowiki>. Hat das einen bestimmten Grund? Das führt nämlich dazu, dass der Text in einigen Fällen über den Boxrand geht. Mir ist nicht klar, wie ich das umsetzen/anwenden soll. Danke. --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 07:28, 5. Feb. 2015 (UTC)

:Hallo Christian, das mache ich (dachte ich) eigentlich nur, wenn die Zeilen in dem pre-Bereich durchweg relativ kurz sind. Was ich eigentlich häufiger mache, ist, pre durch code Tags zu ersetzen, gerade weil bei code ein automatischer Zeilenumbruch stattfindet. Insbesondere Einzeiler, die per nowiki, pre oder Leerzeichen in Spalte1 dann als Box formatiert werden ersetze ich gern duch <nowiki>:<code>define, attr, ...</code></nowiki>, weil's meiner Ansicht nach einfach flüssiger lesbar ist Gesamtkontext.
:Verhalte ich mich am Ende anders, als ich es in [[FHEMWiki:Über_FHEMWiki#Gewünschtes Verhalten / "Do and Don't"|diesem Abschnitt]] beschrieben habe? --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 07:45, 5. Feb. 2015 (UTC)
::Werde es beobachten. Vielleicht bin ich auch nur übermüdet/unkonzentriert: Habe nämlich gerade gesehen, dass ich [[HM-OU-CFM-Pl_MP3_Funk-Gong_mit_Signalleuchte|hier]] -was letztliche Anstoß zum Schreiben war- falsch geschaut habe. Die anderen Beispiele, die ich in Erinnerung habe, müsste ich mir noch einmal raussuchen. Vielleicht habe ich da auch schief geschaut. Also bitte erst einmal vergessen. Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 08:18, 5. Feb. 2015 (UTC) PS: Schaust Du bitte mit auf die diversen Unterkategorien zu "Hardware Typen" die ich angelegt habe und greifst bitte ggfs. korrigiernd ein.
:::Die neuen Unterkategorien habe ich schon zur Kenntnis genommen. Nachdem Du die letzten Änderungen an der Kategoriestruktur gemacht hast, kennst Du Dich da mittlerweile ja mindestens so gut aus wie ich. Das Einzige, was mir aufgefallen ist: auf den Kategorieseiten könnten noch ein paar kurze Worte zur Beschreibung der Kategorie eingefügt werden... aber das eilt nicht. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 08:26, 5. Feb. 2015 (UTC)

== PGM3 - Entwicklungsstand ==
Hallo Peter!
Habe heute bei PGM3 und PGM5 recht selbstsicher einen Hinweis "seit längerem nicht aktiv weiterentwickelt" hinzugefügt. Im Forum habe ich nichts gefunden und auch zu Google-Groups-Zeiten kann ich mich nicht wirklich erinnern. Bei der Nachkontrolle habe ich dann mit Erschrecken festgestellt, dass Du PGM3 auf der ToDo-Liste stehen hast und das plötzlich Martin Hass' PGM3 Screenshot-Seiten nach einer gefühlten Ewigkeit wieder erreichbar sind. Irre ich mich und PGM3 ist doch noch ein (aktuelles) Thema? Gruß, [[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 21:09, 18. Feb. 2015 (CET)
<hr />
:Christian, PGM3 auf meiner Todo-Liste ... eine Jugendsünde :-) ... fliegt gleich runter, weil bestimmt zwei Jahre alt und nie was gemacht. Die Updates auf Martin's Seiten solltest Du natürlich beobachten, aber auf mich musst Du keine Rücksicht nehmen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 06:55, 19. Feb. 2015 (CET)

== Begrüßungsseite Link: Was Wikipedia nicht ist ==
Hallo Peter,
ich hoffe, dass ich das hier jetzt richtig mache :-). Beim aufmerksamen Lesen der Begrüßungseite bin ich gleich auf einen Link: Was_Wikipedia_nicht_ist getappst.

Den kennt Wikipedia nicht...
Gruß Otto
<hr />
:Hallo Otto, danke für's aufmerksame Lesen :-)
:habe den (und einen weiteren) fehlerhaften Link korrigiert. Da die Vorlage mit "subst:" eingebunden wird, profitieren leider nur die Neuankömmlinge ab jetzt davon.
:Grund für das Problem ist wohl die Art, wie das Fhem-Wiki aufgesetzt wurde (bin mir aber jetzt nicht sicher, ob sich da in dieser Hinsicht nochmal was geändert hat, oder ob ich die beiden Links schlicht vergessen habe ... andere Links, wie z.B. den auf das Tutorial, habe ich vor längerer Zeit schon mal umgestellt). --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 06:57, 2. Apr. 2015 (CEST)

== Pflege von [[Spezial:Gewünschte_Seiten]] ==
Hallo Peter,
bin gerade im Aufräumfieber und über die gewünschten Seiten gestolpert. Einige Dinge habe ich eigenständig geklärt, aber nun benötige ich Deine Hilfe. Insbesondere das zum Aussterben verurteilte FS20 taucht dort sehr umfangreich auf. Die abnehmende Bedeutung spricht aus meiner Sicht dafür, diese "gewünschten Seiten" dort herauszunehmen. Denke es gibt wichtigere Baustellen und dringendere notwendige Seiten. Zudem sind das teilweise Karteileichen, die seit Urzeiten dort geführt werden. Aus meiner Sicht schreckt das, neben den Wiki-Softwareproblemen, Interessenten von der Mitarbeit ab. Darum bitte ich Dich um Deine Meinung als FS20-User, bevor ich das weiter anleiere. Andere Punkte, die ich nicht '''''<- meinst Du wirklich *nicht*?''''' ''<-ergänze: allein/eigenständig!'' klären wollte, betreffen bspw. die gewünschte Seite "Hilfe:Seite bearbeiten", "FHEMWiki:Stubs entfernen". Schöne Feiertage, [[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]])
:Hallo Christian, nur als schnelle Antwort (zu viele Baustellen gerade):
:* Gewünschte Seiten, speziell FS20: das was Mediawiki in die "gewünschten Seiten" einsortiert, sind die intra-Wiki Links, die nicht existieren also <nowiki>[[Existiert nicht]]</nowiki> würde da z.B. auftauchen - gewünschte Seiten im eigentlichen Sinn sind das nur dann, wenn der Verlinkung absichtlich gemacht wurde ... wie z.B. bei den vielen FS20 Seiten. Die sind nämlich häufig bei mir (hast Du doch bestimmt gesehen ;-) ), weil ich noch zu diversen FS20 Geräten was schreiben möchte und sollte. Leider (die vielen Baustellen, siehe oben) komme ich derzeit und schon lange nicht dazu. Ansonsten habe ich da immer mal wieder reingeschaut, um falsch geschriebene Links aufzuspüren und zu bereinigen. Aber vielleicht sollten wir den Link darauf einfach von der Hauptseite entfernen und z.B. auf die/eine Interna Seite holen. Vielleicht als Ersatz / Nachfolger der Randnotiz von der Über FHEMWiki Seite, auf der ich die offenen Baustellen mal aufgelistet hatte (und schon länger nicht mehr gepflegt).
::* Natürlich habe ich gesehen, dass FS20 (auch) von Dir kommt; darum habe ich mich auch mit Wiki-Eingriffen zurückgehalten, sonst.. ;-). Dein Alternativvorschlag ist gut. Die offenen Baustellen auf der Über FHEMWiki Seite: Zu den Kategorien wollte ich -auch seit langem- eine bessere "Anweisung" an die anderen Wikibearbeiter schreiben und dann abschließen. Und mich dann wieder verstärkt "meinen" eigentlichen Themen ZWave/EnO widmen.
:* Die Stubs-Seite / Kategorie / Vorlage kommt von Arno (akw), ist aber schon lange nicht mehr gepflegt worden und wird wohl auch nicht mehr aktiv genutzt
:* '''Hilfe:Seite bearbeiten''' fällt wohl in die Kategorie "Wiki-Softwareprobleme" (Du meinst den Link "Bearbeitungshilfe" neben den {{Taste|Speichern}} {{Taste|Vorschau zeigen}} Buttons?) und würde ich erst wieder aktiv in Angriff nehmen, wenn Arno die offenen Probleme komplett abgearbeitet hat :-(
::* Ja, werde mal Arno bitten.... [[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]])
:Ebenfalls schöne Feiertage, --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 15:21, 3. Apr. 2015 (CEST)

== Vorlagen: Link2Forum,.. ==
Hallo Peter,
ist die Notwendigkeit der Vorlagen "Link2Forum",.. nur darin begründet, dass man dann einfacher Anpassungen bei Änderungen der zugrundeliegenden Links vornehmen kann? Ich stelle nämlich immer wieder fest, dass außer uns beiden, die sowieso von (fast) keinem Wiki-Bearbeiter genutzt werden. Der Umstellungsaufwand im Änderungsfalle wird so vermutlich nicht sehr reduziert. Kann man dieses Problem der Linkänderungen nicht einfacher mit einem Bot lösen, der das Wiki mit Suchen/Ersetzen durchgeht? Dann hättest Du auch nicht den Pflegeaufwand für die Vorlagen. Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 11:16, 13. Aug. 2015 (CEST)
<hr>
:Hallo Christian, leider habe ich keine große Hoffnung, dass wir hier einmal die Chance haben werden, '''bot'''s einzusetzen und kenne mich damit auch (zumindest noch) nicht aus (Ausreden? Vielleicht).
:Interessant: ich habe gerade die DocLink Vorlage mal soweit fertig, dass man zumindest die ELV Links überarbeiten / generalisieren kann.
:Unterm Strich: ich werde die Vorlagen weiter pflegen und benutzen, wer sie benutzen mag soll's tun, zwingen werd ich niemanden. Wir haben halt immer noch sehr wenige Wiki-erfahrene Benutzer hier, was man auch an anderen Stellen merkt. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 11:50, 13. Aug. 2015 (CEST)
<hr>
:: Hallo Peter, will Dich auch nicht abhalten ;-) , sondern entlasten. Weil ich die DocLink-Vorlage gesehen habe, kam ich auf das Thema. Ich werde das bot-Thema mal auf meinen "Wunschzettel" aufnehmen und aktiv verfolgen. Schauen wir einmal, was sich ergibt. Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 12:04, 13. Aug. 2015 (CEST)
::<hr>
:::Kein Problem - ich denke es gibt bei beiden Vorgehensweisen Vor- und Nachteile. Meine Skepsis beruht darauf, dass die Bots ja wohl auf dem Wiki-Server laufen und ich kaum Hoffnung habe, da mehr Zugriff zu bekommen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 12:16, 13. Aug. 2015 (CEST)
== Codierung ==
Hallo Peter,

Du schreibst auf meiner Benutzerseite
HTML-Tags bitte nur verwenden, wenn es nicht anders geht
im Artikel
[[EnOcean-D-452-FU-EP-JR-Aktor-Beschattungselemente-Rollladen]]
hast Du die Codierung mittels Leerzeichen durch <nowiki><code></Code></nowiki> ersetzt. Die Leerzeichen waren aber in [[http://www.fhemwiki.de/wiki/FHEMWiki:%C3%9Cber_FHEMWiki#Gewünschtes Verhalten / "Do and Don't"]] explizit erlaubt.
Einen anderen Artikel von mir hast Du nicht korrigert.
Wo liegt mein Fehler? Ich wollte der Gemeinschaft gerne etwas zurück geben - vor allem für die Arbeit die Christian mit mir gehabt hat.

--[[Benutzer:BenMarloe|BenMarloe]] ([[Benutzer Diskussion:BenMarloe|Diskussion]]) 00:25, 21. Aug. 2015 (CEST)
<hr />
:Hallo Ben(Marloe), das ist schnell erklärt:
:HTML-Tags nur verwenden - bezieht sich, wenn ich das jemandem schreibe, meist auf exzessive <nowiki> </nowiki>-Tags. Da kann (sollte) im Wiki meistens einfach eine Leerzeile oder ein Zeilenumbruch verwendet werden (einfach die "Vorschau-funktion" verwenden, um zu kontrollieren, ob's "richtig" aussieht). Außerdem sieht der Wiki-Quelltext damit schon dem formatierten Ergebnis ähnlicher und ist einfacher lesbar. Nur bei manchen Vorlagen oder z.B. in Aufzählungen ist ein Zeilenumbruch "kontraproduktiv" und dann ist ein br nötig.
:Leerzeichen vs. code ... am besten veranschaulicht:
Leerzeichen in Position 1
:... und der weitere Text. Im Vergleich dazu:
::<code>ein (eingerückter) Einzeiler, der als Code formatiert werden soll</code>
:oder noch mal anders:
Leerzeichen und ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel Text
::<code>ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel, ganz viel Text, der als Code formatiert werden soll</code>
:Ich hoffe, der Unterschied wird damit klar: der Text wird meiner Ansicht nach kompakter, die Hervorhebung ist aber trotzdem da. Und: bei Mehrzeilern sieht das schon wieder ganz anders aus. Da ist aber meistens dann die Verwendung von <nowiki><pre></pre></nowiki> die bessere Wahl, weil damit (im Wiki Source Text) besser verdeutlicht wird, dass die Formatierung absichtlich so gewählt ist.
:Zum Thema ''Einen anderen Artikel von mir hast Du nicht korrigert'' ... ich kann nicht überall sein :-) ... nein, ohne Scherz, ich mache das hier auch "nur nebenbei", manches ist Geschmackssache, manches übersehe ich, manches ist "zu unwichtig", etc.
:Und ''Wo liegt mein Fehler?'' - nirgends; einfach fleissig weiter mitmachen.
:--[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 07:14, 21. Aug. 2015 (CEST)

== Neue Seite oder Ergänzung [erledigt]==
Mit Eurer Hilfe geht jetzt der EnOcean-FUD61NPN-Funk-Universal-Dimmaktor unidirektional bei mir.
Ich würde eine Anleitung erstellen, bin mir aber nicht sicher, ob ich das lieber als
# Ergänzung auf die existente Seite oder
# Kommentare auf die existente Seite mache oder
# eine neue Seite aufmache und wie die dann heißen soll.
Ich bitte um Vorschläge/Richtlinien 
--[[Benutzer:BenMarloe|BenMarloe]] ([[Benutzer Diskussion:BenMarloe|Diskussion]]) 16:48, 11. Sep. 2015 (CEST)
<hr />
:Ich denke, das kommt auf Art und Umfang der Änderungen/Ergänzungen an. Wenn das ein einzelner Abschnitt mit den Unterschieden ist, passt das sicherlich gut in [[EnOcean-FUD61NPN-Funk-Universal-Dimmaktor]], wären es Kommentare, überall auf der Seite verstreut, würde ich eine eigene Seite bevorzugen (dann bitte an den Seitennamen " (unidirektional)" anhängen). Die Kommentarseite ist für sowas eher nicht geeignet.
:Wenn's eine neue Seite wird, dann bitte auf der Seite des bidirektionalen Aktors verlinken. In jedem Fall die Bemerkung über *direktional... anpassen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 16:10, 12. Sep. 2015 (CEST)
<hr>
::so wird's gemacht. --[[Benutzer:BenMarloe|BenMarloe]] ([[Benutzer Diskussion:BenMarloe|Diskussion]]) 22:02, 18. Sep. 2015 (CEST)
==Extension SyntaxHighlight_GeSHi==
Ich hätte die [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi Extension] gerne, um Code besser lesbar darzustellen. Sollte eigentlich ab MediaWiki Version 1.21 dabei sein, aber eventuell ist sie nicht aktiviert? Wen muss ich dazu anbetteln? ;)
--[[Benutzer:Drhirn|Drhirn]] ([[Benutzer Diskussion:Drhirn|Diskussion]]) 15:58, 1. Okt. 2015 (CEST)
:[[Benutzer Diskussion:Akw#Wiki-Erweiterung Syntaxhighlight|Hier]] mal nachhaken? --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 18:57, 1. Okt. 2015 (CEST)
::Hat, wie ich gerade sehe, schon jemand anderer übernommen :) --[[Benutzer:Drhirn|Drhirn]] ([[Benutzer Diskussion:Drhirn|Diskussion]]) 10:26, 5. Okt. 2015 (CEST)
::<hr />
:::Nicht verzagen ... jede Stimme zählt :-) --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 16:36, 5. Okt. 2015 (CEST)

== Vorlage "Hinweis" ==
Hallo Peter,
hast Du Dir die neue Vorlage "Hinweis" einmal angeschaut? Gibt es Vorbehalte von Deiner Seite oder kann ich die problemlos nutzen. Habe die Vorlage testweise mal in 2 Seiten eingebaut und finde sie in gewissen Situationen grds. nicht schlecht.
Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 22:45, 6. Okt. 2015 (CEST)
<hr />
:Hallo Christian, ja, die Vorlage habe ich gesehen und mal kurz reingeschaut. Gibts von meiner Seite keine Einwände (den Kommentar "Randnotiz ... leider nur Teil der Bildschirmbreite..." finde ich etwas befremdlich, da der Name der Vorlage ja genau das verspricht, aber das tut ja der eigentlichen Sache keinen Abbruch) - ich denke, es gibt für die Vorlage sinnvolle Einsatzgebiete, ganz nach gewünschtem Effekt / Erscheinungsbild. Es unterbricht halt den Lesefluss deutlich stärker als die Randnotiz, aber wenn das gewünscht ist, dann passts ja. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 10:14, 7. Okt. 2015 (CEST)
<hr />
::Sollten wir die Vorlage dann nicht auch [[FHEMWiki:%C3%9Cber_FHEMWiki#Vorlagen|hier]] aufnehmen? Falls ja, Du oder ich? Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 10:30, 7. Okt. 2015 (CEST)
<hr/>
::Naja, "befremdlich" ;). Ich wollte nur erklären, warum ich extra eine neue Vorlage gemacht habe. Ich hätte natürlich auch die Vorlage "Randnotiz" um eine Option für die Breitenauswahl erweitern können. Grundsätzlich hätte die Randnotiz nämlich eh getan, was ich wollte. Aber das wäre etwas viel Arbeit geworden. --[[Benutzer:Drhirn|Drhirn]] ([[Benutzer Diskussion:Drhirn|Diskussion]]) 11:25, 23. Okt. 2015 (CEST)

== Änderung von Gliederungspunkten in Artikeln und wiki-interne Links ==
Hallo Peter,
hier [[Konfiguration]] wurde gestern ein Gliederungspunkt umbenannt. Gibt es/ Kennst Du eine einfache Möglichkeit herauszufinden, welche wiki-internen Link jetzt nicht mehr funktionieren? Bei den Spezial-Seiten finde ich dazu nichts und Google hilft mir auch nicht. Die Wiki-interne Suche ist dabei auch nicht optimal. Bisher vermeide ich aus diesem Grund auch eine Umbenennung von Gliederungspunkt. Danke und Gruß --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 09:48, 26. Okt. 2015 (CET)
<hr />
:Hallo Christian,
:ich hatte die Änderung zwar kurz angeschaut, aber gar nicht an diese (möglichen) Auswirkungen gedacht. Habe (auf die Schnelle) auch nur wenig zu diesem Thema gefunden (ausser vielleicht diese Seite in [https://en.wikipedia.org/wiki/Wikipedia:Database_reports/Broken_section_anchors/Configuration Wikipedia]).
:Vermutlich (hoffentlich?) werden wir aber nicht allzu häufig von dieser Problematik betroffen sein, für diesen aktuellen Fall sehe ich folgende mögliche Vorgehensweisen:
:* Änderung der Überschrift zurücknehmen, dafür diesen Abschnitt eine Gliederungsebene tiefer (passt dann ohnehin besser in die Seitenstruktur)
:* Verwendung von <nowiki>{{Anker|Ankertext}}</nowiki> mit der alten Überschrift, um das als zusätzlichen Anker einzufügen
:--[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 11:25, 26. Okt. 2015 (CET)
<hr />
::Hallo Peter,
::habe es mit 1. Ansatz umgesetzt, da mir der 2. Weg zu umständlich und (später) fehleranfällig erscheint. Obwohl ich irgendwann mal gelernt habe, dass es niemals nur einen Gliederungs-Unterpunkt gibt (halte ich hier aber auch nicht immer ein ;-) )
::Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 13:33, 26. Okt. 2015 (CET)

== Neuen Artikel verschieben/umbenenen ==
Hallo Peter,

ich habe meinen ersten Artikel erstellt und würde gerne den nächsten Schritt machen. Wohin muß ich verschieben und wie gehts dann weiter. (Wiki Anfänger)

Gruß [[Benutzer:Eisix|Eisix]] ([[Benutzer Diskussion:Eisix|Diskussion]]) 16:14, 25. Jan. 2016 (CET)
<hr />
:Hallo Eisix,
:# es wäre nicht nötig gewesen, den Artikel erst auf Deiner Benutzerseite zu erstellen; so viel ist hier nicht los, dass bei einem neuen Artikel gleich Konflikte entstehen; ich glaube, nur "verschieben" geht in diesem Fall nicht so gut, daher würde ich vorschlagen:
:# Du gehst auf deiner Benutzerseite auf "Bearbeiten" und
:# fügst <nowiki>[[EnOcean MwC-32...]]</nowiki> (die Details für die Namensfindung stehen auf der Kategorieseite [[:Kategorie:EnOcean Components]] oben rechts (ich glaube, "Deinen" Namen musst Du da noch etwas nachbearbeiten; im Zweifel [[Benutzer Diskussion:Krikan|Krikan]] fragen)) ein
:# Klickst auf {{Taste|Vorschau zeigen}}; daraufhin bekommst Du Deinen gewählten Seitentitel in rot in der Vorschau angezeigt; jetzt
:# öffnest Du diese "rote Seite" in einem neuen Browser-Tab
:# kopierst bzw. verschiebst den Quelltext Deiner Seite (ohne die gerade eingefügte Zeile) in das leere Editierfenster des zweiten Browser-Tabs
:# Dann noch ein paar Korrekturen (z.B. die korrekte Kategorie "EnOcean Components" verwenden); und schau Dir existierende (EnOcean-)Seiten (Gliederung!) an und übernimm das bitte entsprechend
:# Vorschau der neuen Seite anzeigen und überprüfen
:# wenn alles soweit stimmt, "Seite speichern"
:# Auf Deiner Benutzerseite kannst Du jetzt (z.B.) die Seite in (D)eine Liste der von Dir erstellten Seiten aufnehmen ... und evtl. noch ein paar Worte über Dich schreiben
:--[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 18:18, 25. Jan. 2016 (CET)
<hr />
: Hallo Eisix, Hallo Peter!
: Mische mich hier mal ein: Sind die Bildrechte für BSC-MwC-32.jpeg geklärt? Falls nein, bitte Bild nicht einbinden/löschen und gegebenenfalls eigenes Foto hochladen.
: Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 19:06, 25. Jan. 2016 (CET)
<hr />
: Hallo,
: @Peter ich wollte nicht wie ein Elefant im Porzellanladen durch die Wiki stapfen, dafür kenne ich mich damit zu wenig aus ;-)
: @Krikan guter Einwand das Bild ist von www.enocean-alliance.org wo auch die verlinkte Anleitung her ist. Eigenes Bild ist leider nicht mehr möglich da das ganze hinter einem Aquarium verbaut ist und nur mit größerem Aufwand wieder rauszuholen ist. Also nehme ich das Bild am besten wieder raus !?
:Gruß --[[Benutzer:Eisix|Eisix]] ([[Benutzer Diskussion:Eisix|Diskussion]]) 10:19, 26. Jan. 2016 (CET)

== Unterscheidung Code für DEF und .cfg ==
Hallo Peter! 
habe gelesen, dass Du auf [[Ölverbrauchsanzeige_/_Betriebsstundenzähler]] den Code als .cfg-Code per Hinweis markiert hast. Bisher haben wir bei der Unterscheidung DEF,Einzeiler, aus optischen Gründen umgebrochenen Einzeiler und .cfg Code im Wiki kein wirkliches System. Es bedarf jeweils der Interpretation. Vieles ist derzeit cfg.-Code. Eigentlich wünsche ich mir, dass wir überall einen Hinweis in den Codeboxen DEF bzw. cfg einpflegen. Das dürfte aber praktisch nicht umsetzbar sein und auch hohes Fehlerpotenzial haben. Hatte auch schon einmal einen Versuch in die Richtung unternommen, aber aufgegeben. 
Momentan tendiere ich dazu, auf [[Konfiguration]] einen Erläuterung einzufügen, woran man die verschiedenen Code-Varianten erkennt und die Seite -wie Du es mal geplant hattest, von allen anderen Seiten zu verlinken. Das ist mMn einfacher. Hast Du dazu eine Meinung/Idee? 
Würde das auf ggfs. auf meine Todo-Liste setzen. 
Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 10:10, 16. Feb. 2016 (CET)
<hr />
:Hallo Christian, ja, so eine grundlegende Vorgehensweise fehlt uns da noch. War mir auch bewusst, ich wollte aber in diesem konkreten Fall gleich was eintragen, weil das fehlende Wissen zu diesem Thema der Auslöser für den Forenthread war. Ich behalte das Thema auch im Hinterkopf - die zündende Idee, wie man das am besten umsetzen kann fehlt mir aber leider noch. Wer immer von uns früher dazu kommt, hat gewonnen :-) --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 12:28, 16. Feb. 2016 (CET)

==Nochmal Begrüßungsseite==
Hallo Peter,

Mein Benutzerkonto wurde gerade freigeschaltet und ich habe mich gewundert, warum die Begrüßungsseite so "wikipedistisch" ist. Sollten wir da nicht mal rangehen und eine Benutzerbegrüßung schreiben, die an das fhemwiki angepasst ist?

Ein paar Grundlagen wie Bearbeitungshilfe würde ich auch aus Wikipedia einbinden, aber die Infoseite "was Wikipedia nicht ist" scheint mir irgendwie hier deplatziert...

Ich würde mich dransetzen, aber brauche dann wahrscheinlich Hinweise, wo hier im fhemwiki die "Richtlinien" und andere Infos stecken, die man in der Willkommensnachricht verlinken könnte/sollte.

Gruß, Markus --[[Benutzer:Krokofant|Krokofant]] ([[Benutzer Diskussion:Krokofant|Diskussion]]) 11:31, 5. Mär. 2016 (CET)
<hr />
:Hallo Markus, die Begrüßungs-Vorlage ist einfach aus der Situation heraus mal entstanden. Es gab viele Neuanmeldungen von Leuten, die noch keinerlei Berührung mit Wiki(media) hatten und entsprechend gedankenlos ans Werk gegangen sind. War dann nachher mehr Aufräumarbeit nötig als dass die Mitarbeit Hilfe gewesen wäre. Dazu sind ein paar Hinweise auf Fhem-Wiki-Spezifika eingeflossen ... aber ''gelesen'' wird das Ganze leider ohnehin höchst selten, wenn man manche Beiräge hier so sieht.
:Aber lass Dich nicht entmutigen, Vorschläge und aktive Mitarbeit sind natürlich herzlich willkommen.
:Fhem-spezifische Informationen sind eigentlich komplett in Über FHEMWiki gesammelt bzw. über diese Seite zu erreichen. Wenn Du Dir die Änderungshistorie der Seite anschaust, wirst Du auch feststellen, dass das eine One-(oder Two, Krikan hilft auch mit)-Man-Show ist - von einigen "kurzen Strohfeuern" mal abgesehen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 12:02, 5. Mär. 2016 (CET)

== Vorlage:News und Interwiki-Links ==
Hallo Peter,

danke für die Einrichtung meines Logons.
# ich habe mir mal erlaubt die [[Vorlage:News]] zu Dokumentieren und dabei die Orientierung der ersten Spalte zu ändern. Ich finde es etwas irritierend beim Lesen wenn das Datum nicht auf der ersten Zeile des folgenden Eintrags steht. Ich hoffe das ist so für euch in Ordnung, ansonsten lässt sich das jederzeit wieder ändern. >> ''Klar; sieht jetzt besser aus und Dokumentation ist immer gut; ich sehe auch sonst keine Nachteile'' --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 14:45, 21. Apr. 2016 (CEST)
# Die Seite [[Spezial:Meiste_Interwikilinks]] ist hier leer und die [https://www.mediawiki.org/wiki/Extension:Interwiki Extension:Interwiki] scheint auch nicht installiert bzw. aktiviert zu sein. Sie gehört seit V1.21 zum Installationsbündel und müsste bei der hiesigen V1.24 also schon dabei sein. Man bräuchte sie also nur in Betrieb nehmen. Links auf die Wikipedia werden im FHEMWiki offenbar explizit als ausgeschriebene URL ausgeführt. Das ist meiner Erfahrung nach ungünstig. Auch Beiträge aus dem FHEM-Forum könnte man mit Interwikilinks konsistenter handhaben. Auch die [[Vorlage:DocLink]] lässt sich vermutlich damit einfacher gestalten. >> ''Wiki-seitig dürften sich da in nächster Zeit einige Änderungen ergeben, die das mit adressieren lassen. Als ich begonnen habe, die derzeitigen Links zu setzten, ging es leider nicht anders (wurde Server-seitig nicht angeboten). Da würde ich Dich einfach noch um etwas Geduld bitten - und später gern bei Dir nachhaken, nachdem Du Dich allein mit der Frage schon als Experte geoutet/qualifiziert hast :-) '' --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 14:45, 21. Apr. 2016 (CEST)

Viele Grüße --[[Benutzer:MGu|MGu]] ([[Benutzer Diskussion:MGu|Diskussion]]) 13:06, 16. Apr. 2016 (CEST)

== Infobox Modul: Neue untergeordnete Boards Wettermodule und Kalendermodule ==
Hallo Peter!

Könntest Du bei Gelegenheit bitte die Verbindung für die Infobox zu den neuen Unterboards einpflegen. Das scheint derzeit noch nicht zu funktionieren bzw. ich habe keine Ahnung wie... 
Danke und Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 21:56, 27. Mai 2016 (CEST)
<hr/>
:Hallo Christian...
:gut versteckt (hab selbst erst wieder "suchen" müssen) befindet sich die Liste der Forenboards in der Vorlage [[:Vorlage:Link2Forum|Link2Forum]]. Muss ich gelegentlich mal in der Doku zur Vorlage [[:Vorlage:Infobox Modul|Infobox Modul]] erwähnen.
:Habe gerade die neuen Unterboards eingefügt. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 09:38, 28. Mai 2016 (CEST)

== Bitte um Kontrolle/Meinung ==
Hallo Peter! 
Könntest Du bitte einmal hier [[Benutzer_Diskussion:Krueuw]] hineinschauen -falls noch nicht gesehen- und ggf. eingreifen, falls ich falsch liege und/oder etwas vergessen habe. 
Danke und Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 15:24, 7. Aug. 2016 (CEST)
:Vermutlich ist unsere Diskussion dort überholt. [[Benutzer:ThomasRamm]] hat die Artikel eben verschoben/geaendert/zusammengefasst und mir fehlt momentan darüber der Überblick. Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 16:50, 7. Aug. 2016 (CEST)

== Artikel betr.: Arduino MySensors MYSENSORS ==

Hallo Peter,

habe eben mal etwas in den Kategorienseiten rumgestöbert um zu sehen, wo - nach meinem Geschmack und begrenztem Verständnis - eigentlich was hinsollte und bin über ein paar Dinge gestolpert, die ich gerne zur Diskussion stellen wollte. Im Detail:

1. Unter "Arduino" finde ich nicht etwa den Hinweis, dass einige Projekte, die für FHEM eine größere Rolle spielen, Arduino-basiert sind, sondern die Beschreibung einer der Lösungen (ein FHEMduino?, der dazu noch recht alt ist und bei dem sich die verlinkten Sourcen evtl. mit heutiger SW-Umgebung gar nicht mehr compilieren lassen).

Fragen:

a) Sollte man die Seite nicht umbenennen (in FHEMduino?)?

b) Eine neue Seite mit diesem Namen wäre für den interessierten Laien hilfreich, in der (mindestens) die einzelnen verfügbaren Projekte kurz aufgelistet sind (auf die Schnelle: SIGNALduino, firmata, FHEMduino, nanoCUL, MySensors, Arducounter, panstamp?...) sowie der Hinweis, dass die uC's (und auch andere uC's wie der ESP8266) mit der gleichnamigen IDE recht einfach selber programmiert werden können.

2. Zu MySensors existieren derzeit drei Artikel: MySensors, MYSENSORS und MYSENSORS_DEVICE.

a) Die letzteren beiden Artikel sind inhaltlich völlig ok, ich würde aber vorschlagen, die im Titel ggf. bereits als (Modul) zu kennzeichnen?

b) Der MySensors-Artikel wäre an sich auch ok, wenn - jedenfalls aus Sicht des interessierten aber noch uniformierten Erstlesers - nicht der Eindruck entstehen würde,
* man bräuchte einen ESP und
* es handelte sich zwingend um eine IP-basierte Lösung - was es ja bei Verwendung der einfachsten Variante (Arduino als serielles GW) nicht ist!
Hier würde ich vorschlagen (bzw. das ggf. selbst tun), als erstes Beispiel noch ein schlichtes serielles GW zu nehmen.
Dann fehlt in dem Artikel m.E. nur der Verweis auf's Howto (s.u.)

c) Unter [[:Kategorie:Other_Components]] tauchen beide mysensors-Links auf, das ist m.E. einer zu viel (der auf's Modul).

3. M.E. fehlt dann eigentlich "nur noch" ein Howto mit den gesammelten Erkenntnissen (mein eigentlicher Job...). Wohin damit? nach [Kategorie:HOWTOS] oder nach [Kategorie:Examples]

Bitte um Rückmeldung dazu und auch die Info, was ich ggf. davon selber machen soll/kann/darf. Ich will ja auch niemandem zu nahe treten...

Gruß,

Jörg
<hr />
:Hallo Jörg,
:ich habe die Diskussion zur Kenntnis genommen, aber gerade nicht die Zeit, ausführlich darauf einzugehen und mich in die Artikelstruktur einzulesen. Hole ich in den nächsten Tagen nach. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 07:21, 11. Nov. 2016 (CET)

<hr />
::Hallo Peter,
::Danke für die Zwischeninfo. Nach meinen ersten Versuchen noch folgende Anmerkungen:
::*ad 1. Den Arduino-Artikel habe ich als Vorschlag umgebaut (s. Diskussion dazu), mich allerdings nicht getraut, das ohne Rücksprache "scharf" zu schalten
::*ad 2. Dass das Wiki erst mal davon ausgeht, dass aufgerufene Seiten auch existieren, hat mich genauso irritiert wie der Umstand, dass die URL's case-sensitive sind. So was ist mir vorher nirgends im Web aufgefallen. Ist das so beabsichtigt?
::*ad 3. Das Howto wird wohl kein hotwo im engeren Sinne (Anleitung), sondern eher eine Sammlung der bisherigen Erkenntnisse. Wie benennt man das am Besten? "Starter Guide" analog EnOcean?

== verwaiste Bilder löschen? ==
Hallo Peter! 
ich habe heute Bilder hochgeladen und eines davon nicht benötigt. Du hast mich auch diesbezüglich angeschrieben, aber ich finde keine Möglichkeit dies irgendwie zu löschen oder zum Löschen markieren. Ich dachte nicht verlinkte Bilder werden automatisch gelöscht!
Kannst du mir einen Tipp geben wie das gehen soll. Im MediaWiki habe ich gelesen ich muss hier einen Löschantrag erstellen, ist das wirklich so gemeint und wenn ja wie geht das hier?
--[[Benutzer:Reinhart|Reinhart]] ([[Benutzer Diskussion:Reinhart|Diskussion]]) 21:03, 5. Jan. 2017 (CET)
<hr />
:Habe Dir auf Deiner Diskussionsseite geantwortet. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 10:00, 6. Jan. 2017 (CET)

== Zitierhilfe: Erweiterung Cite ==
Hallo,

ich schlage vor, die ab MW Version 1.21 mitgelieferte [https://www.mediawiki.org/wiki/Extension:Cite/de Erweiterung ''Cite''] zu aktivieren bzw. sie nachzuladen.

Die Informationen in den Artikeln, die nicht originär vom jeweiligen Autor/Bearbeiter selbst stammen, sollten ja immer als Zitate gekennzeichnet bzw. deren Quellen vermerkt werden. ''Cite'' macht das wesentlich einfacher und unaufwändiger.

[[Benutzer:Baumbuwe|Uwe ]] ([[Benutzer Diskussion:Baumbuwe|Diskussion]]) 16:53, 9. Jun. 2017 (CEST)

: Hallo Peter, gibt es schon eine Meinung zu dem Vorschlag? [[Benutzer:Baumbuwe|Uwe ]] ([[Benutzer Diskussion:Baumbuwe|Diskussion]])
:<hr />
::Hallo Uwe, Markus hat die Extension gerade aktiviert ... kannst ja mal ausprobieren, ob es nach Deinen Vorstellungen funktioniert. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 19:26, 26. Jul. 2017 (CEST)
::<hr />
::: Alles prima, danke! Wenn es (wie es aussieht) die mitgelieferte Erweiterung ist, kann es nur richtig sein ;-). Vgl.: [[Telnet]].
:::[[Benutzer:Baumbuwe|Uwe ]] ([[Benutzer Diskussion:Baumbuwe|Diskussion]])

== Änderung von Seitentiteln ==
Hi Peter,
weißt du wie ich einen Seitentitel ändern kann?

panStamp Innenraumsensor --> ESP8266 Innenraumsensor und -Steuerung
<hr />
:Das "magic word" ist "verschieben" (siehe auch weiter oben auf dieser Seite). --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 10:03, 3. Aug. 2017 (CEST)

<hr/>
:: Danke, das wars

== Einfügen von Links und Beispielen ==

Hallo Peter,

ich schlage mich gerade mit dem PRESENCE-Modul herum und würde gerne einen kurzen Verweis und einen Link auf [https://wiki.fhem.de/wiki/FRITZBOX] FRITZBOX: Anwesenheitserkennung per regelmäßiger Abfrage über das PRESENCE Modul machen und eine Überschrift unter '''fritzbox - Das Überwachen von Geräten auf einer FritzBox via ctlmgr_ctl (Nur auf einer FritzBox möglich)''' mit dem Titel '''fritzbox - Anwesenheitserkennung per regelmäßiger Abfrage über das PRESENCE Modul''' einfügen.

Desweiteren würde ich gerne bei https://wiki.fhem.de/wiki/UserReadings zumindest mal ein Beispiel für UserReadings einfügen, an dem ich lange gekämpft habe (Syntaxprobleme). Da geht es darum, den Textwert eines HOMEMATIC 3-State-Sensor für Fenster (close, open, tilted) in Zahlenwerte für Thingspeak umzuwandeln: attr <DEVICE> userReadings Statenum {if(ReadingsVal("<DEVICE>","state","") eq "closed") {return 0} elsif (ReadingsVal("<DEVICE>","state","") eq "tilted") {return 1} elsif (ReadingsVal("<DEVICE>","state","") eq "open") {return 2} else {return -1}}

Wird das diskutiert oder werden solche "Schönheitsreparaturen" einfach gemacht?