FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-04-20 19:36:02 +00:00
Code Issues Releases Wiki Activity

docu

Browse Source 
git-svn-id: https://svn.fhem.de/fhem/trunk@4921 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
tpoitzsch 2014-02-14 18:48:57 +00:00
parent 99826d0c72
commit aa7da050a8
1 changed files with 29 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
fhem/FHEM/70_JSONMETER.pm
View File

@ -70,7 +70,7 @@ sub JSONMETER_UpdateAborted($);
############################################################## ##############################################################
# Syntax: valueType, code, FHEM reading name, statisticType # Syntax: valueType, code, FHEM reading name, statisticType
# valueType: 1=OBISvalue | 2=OBISvalueString | 3=jsonProperty | 4=jsonPropertyTime # valueType: 1=OBISvalue | 2=OBISvalueString | 3=jsonProperty | 4=jsonPropertyTime
# statisticType: 0=noStatistic | 1=maxMinStatistic | 2=timeStatistic # statisticType: 0=noStatistic | 1=maxMinStatistic | 2=integralTimeStatistic
############################################################## ##############################################################
my @jsonFields = ( my @jsonFields = (
[3, "meterType", "meterType", 0] # {"meterId": "0000000061015736", "meterType": "Simplex", "interval": 0, "entry": [ [3, "meterType", "meterType", 0] # {"meterId": "0000000061015736", "meterType": "Simplex", "interval": 0, "entry": [
@ -101,7 +101,7 @@ sub JSONMETER_UpdateAborted($);
,[1, "010002080082", "electricityProducedLastWeek", 1] ,[1, "010002080082", "electricityProducedLastWeek", 1]
,[1, "010002080083", "electricityProducedLastMonth", 1] ,[1, "010002080083", "electricityProducedLastMonth", 1]
,[1, "010002080084", "electricityProducedLastYear", 1] ,[1, "010002080084", "electricityProducedLastYear", 1]
,[1, "0101020800FF", "electricityPowerOutput", 2] ,[1, "0101020800FF", "electricityPowerOutput", 1]
,[1, "010020070000", "electricityVoltagePhase1", 1] #{"obis":"010020070000","value":237.06,"unit":"V"}, ,[1, "010020070000", "electricityVoltagePhase1", 1] #{"obis":"010020070000","value":237.06,"unit":"V"},
,[1, "010034070000", "electricityVoltagePhase2", 1] # {"obis":"010034070000","value":236.28,"unit":"V"}, ,[1, "010034070000", "electricityVoltagePhase2", 1] # {"obis":"010034070000","value":236.28,"unit":"V"},
,[1, "010048070000", "electricityVoltagePhase3", 1] # {"obis":"010048070000","value":236.90,"unit":"V"}, ,[1, "010048070000", "electricityVoltagePhase3", 1] # {"obis":"010048070000","value":236.90,"unit":"V"},
@ -610,6 +610,7 @@ JSONMETER_UpdateAborted($)
If the pool interval is omitted, it is set to 300 (seconds). Smallest possible value is 10. If the pool interval is omitted, it is set to 300 (seconds). Smallest possible value is 10.
<br> <br>
With 0 it will only update on "manual" request. With 0 it will only update on "manual" request.
<br>&nbsp;
<li><code>&lt;deviceType&gt;</code> <li><code>&lt;deviceType&gt;</code>
<br> <br>
Used to define the path and port to extract the json file. Used to define the path and port to extract the json file.
@ -617,7 +618,7 @@ JSONMETER_UpdateAborted($)
The attribute 'pathString' can be used to add login information to the URL-path of predefined devices. The attribute 'pathString' can be used to add login information to the URL-path of predefined devices.
<br>&nbsp; <br>&nbsp;
<ul> <ul>
<li><b>ITF</b> - One tariff electrical meter used by N-ENERGY (Industrietechnik Fr&ouml;schle)</li> <li><b>ITF</b> - One tariff electrical meter used by N-ENERGY (<a href="www.itf-edv.de">ITF-EDV Fr&ouml;schl</a>)</li>
<li><b>EFR</b> - <a href="http://www.efr.de">EFR</a> Smart Grid Hub for electrical meter used by EON, N-ENERGY and EnBW <li><b>EFR</b> - <a href="http://www.efr.de">EFR</a> Smart Grid Hub for electrical meter used by EON, N-ENERGY and EnBW
<br> <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;use the 'pathstring' attribute to specifiy your login information &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;use the 'pathstring' attribute to specifiy your login information
@ -636,10 +637,10 @@ JSONMETER_UpdateAborted($)
<ul> <ul>
<li><code>INTERVAL &lt;polling interval&gt;</code><br> <li><code>INTERVAL &lt;polling interval&gt;</code><br>
Polling interval in seconds Polling interval in seconds
<br></li> </li><br>
<li><code>statusRequest</code><br> <li><code>statusRequest</code><br>
Update device information Update device information
<br></li> </li><br>
<li><code>restartJsonAnalysis</code><br> <li><code>restartJsonAnalysis</code><br>
Restarts the analysis of the json file for known readings (compliant to the OBIS standard). Restarts the analysis of the json file for known readings (compliant to the OBIS standard).
<br> <br>
@ -652,7 +653,7 @@ JSONMETER_UpdateAborted($)
<li><code>jsonFile</code> <li><code>jsonFile</code>
<br> <br>
extracts and shows the json data extracts and shows the json data
<br></li> </li><br>
<li><code>jsonAnalysis</code> <li><code>jsonAnalysis</code>
<br> <br>
extracts the json data and shows the result of the analysis</li> extracts the json data and shows the result of the analysis</li>
@ -667,22 +668,22 @@ JSONMETER_UpdateAborted($)
Repeats by each update the json analysis - use if structure of json data changes Repeats by each update the json analysis - use if structure of json data changes
<br> <br>
Normally the once analysed structure is saved to reduce CPU load. Normally the once analysed structure is saved to reduce CPU load.
<br></li> </li><br>
<li><code>doStatistics &lt; 0 | 1 &gt;</code> <li><code>doStatistics &lt; 0 | 1 &gt;</code>
<br> <br>
Calculates statistic values - <i>not implemented yet</i> Calculates statistic values - <i>not implemented yet</i>
<br></li> </li><br>
<li><code>pathString &lt;string&gt;</code> <li><code>pathString &lt;string&gt;</code>
<ul> <ul>
<li>if deviceType = 'file': specifies the local file name and path</li> <li>if deviceType = 'file': specifies the local file name and path</li>
<li>if deviceType = 'url': specifies the url path</li> <li>if deviceType = 'url': specifies the url path</li>
<li>other deviceType: can be used to add login information to the url path of predefined devices</li> <li>other deviceType: can be used to add login information to the url path of predefined devices</li>
</ul> </ul>
<br></li> </li><br>
<li><code>port &lt;number&gt;</code> <li><code>port &lt;number&gt;</code>
<br> <br>
Specifies the IP port for the deviceType 'url' (default is 80) Specifies the IP port for the deviceType 'url' (default is 80)
<br></li> </li><br>
<li><a href="#readingFnAttributes">readingFnAttributes</a></li> <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
</ul> </ul>
</ul> </ul>
@ -719,13 +720,13 @@ JSONMETER_UpdateAborted($)
<br> <br>
Mit dem Attribute 'pathString' k&ouml;nnen Login Information an den URL-Pfad von vordefinierten Ger&auml;te angehangen werden. Mit dem Attribute 'pathString' k&ouml;nnen Login Information an den URL-Pfad von vordefinierten Ger&auml;te angehangen werden.
<ul> <ul>
<li><b>ITF</b> - Eintarifz&auml;hler von N-ENERGY Netz GmbH (Industrietechnik Fr&ouml;schle)</li> <li><b>ITF</b> - Eintarifz&auml;hler von N-ENERGY Netz GmbH (<a href="www.itf-edv.de">ITF-EDV Fr&ouml;schl</a>)</li>
<li><b>EFR</b> - Stromz&auml;hler von EON, N-ENERGY, EnBW <li><b>EFR</b> - Stromz&auml;hler von EON, N-ENERGY, EnBW
<br> <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Die Login-Information wird &uuml;ber das Attribute 'pathstring' angegeben. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Die Login-Information wird &uuml;ber das Attribute 'pathstring' angegeben.
<br> <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>?LogName=<i>Benutzer</i>&LogPSWD=<i>Passwort</i></code></li> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>?LogName=<i>Benutzer</i>&LogPSWD=<i>Passwort</i></code></li>
<li><b>LS110</b> - <a href="http://www.youless.nl/productdetails/product/ls110.html">YouLess LS110</a> Netzwerkf&auml;higer Sensor für elektromechanische Stromz&auml;hler</li> <li><b>LS110</b> - <a href="http://www.youless.nl/productdetails/product/ls110.html">YouLess LS110</a> Netzwerkf&auml;higer Sensor f&uuml;r elektromechanische Stromz&auml;hler</li>
<li><b>url</b> - benutzt die URL, welche durch das Attribut 'pathString' und 'port' definiert wird.</li> <li><b>url</b> - benutzt die URL, welche durch das Attribut 'pathString' und 'port' definiert wird.</li>
<li><b>file</b> - benutzt die Datei, welche durch das Attribut 'pathString' definiert wird (im FHEM Dateisystem)</li> <li><b>file</b> - benutzt die Datei, welche durch das Attribut 'pathString' definiert wird (im FHEM Dateisystem)</li>
</ul> </ul>
@ -741,17 +742,17 @@ JSONMETER_UpdateAborted($)
<br> <br>
Dies ist sinnvoll, wenn sich die JSON-Struktur &auml;ndert. Normalerweise wird die analysierte Struktur Dies ist sinnvoll, wenn sich die JSON-Struktur &auml;ndert. Normalerweise wird die analysierte Struktur
zwischengespeichert, um die CPU-Last gering zu halten. zwischengespeichert, um die CPU-Last gering zu halten.
<br></li> </li><br>
<li><code>INTERVAL &lt;Abfrageinterval&gt;</code> <li><code>INTERVAL &lt;Abfrageinterval&gt;</code>
<br> <br>
Abfrageinterval in Sekunden Abfrageinterval in Sekunden
<br></li> </li><br>
<li><code>restartJsonAnalysis</code> <li><code>restartJsonAnalysis</code>
<br> <br>
Neustart der Analyse der json-Datei zum Auffinden bekannter Ger&auml;tewerte (kompatibel zum OBIS Standard). Neustart der Analyse der json-Datei zum Auffinden bekannter Ger&auml;tewerte (kompatibel zum OBIS Standard).
<br> <br>
Diese Analysie wird normaler Weise nur einmal durchgef&uuml;hrt, wenn Ger&auml;tewerte gefunden wurden. Diese Analysie wird normaler Weise nur einmal durchgef&uuml;hrt, wenn Ger&auml;tewerte gefunden wurden.
<br></li> </li><br>
<li><code>statusRequest</code> <li><code>statusRequest</code>
<br> <br>
Aktualisieren der Ger&auml;tewerte</li> Aktualisieren der Ger&auml;tewerte</li>
@ -762,7 +763,11 @@ JSONMETER_UpdateAborted($)
<ul> <ul>
<li><code>jsonFile</code> <li><code>jsonFile</code>
<br> <br>
Liest die JSON-Datei ein und zeigt sie an.</li> Liest die JSON-Datei ein und zeigt sie an.
</li><br>
<li><code>jsonAnalysis</code>
<br>
Extrahiert die JSON-Daten und zeigt das Resultat der JSON-Analyse.</li>
</ul> </ul>
<br> <br>
@ -772,20 +777,21 @@ JSONMETER_UpdateAborted($)
<li><code>doStatistics &lt; 0 | 1 &gt;</code> <li><code>doStatistics &lt; 0 | 1 &gt;</code>
<br> <br>
Berechnet statistische Werte - <i>noch nicht implementiert</i> Berechnet statistische Werte - <i>noch nicht implementiert</i>
<br><</li> </li><br>
<li><code>pathString &lt;Zeichenkette&gt;</code> <li><code>pathString &lt;Zeichenkette&gt;</code>
<ul> <ul>
<li>Ger&auml;tetyp 'file': definiert den lokalen Dateinamen und -pfad <li>Ger&auml;tetyp 'file': definiert den lokalen Dateinamen und -pfad
<br><</li>
<li>Ger&auml;tetyp 'url': Definiert den URL-Pfad
<br><</li>
<li>Andere: Kann benutzt werden um Login-Information zum URL Pfad von vordefinerten Ger&auml;ten hinzuzuf&uuml;gen
<br><</li>
</ul>
</li> </li>
<li>Ger&auml;tetyp 'url': Definiert den URL-Pfad
</li>
<li>Andere: Kann benutzt werden um Login-Information zum URL Pfad von vordefinerten Ger&auml;ten hinzuzuf&uuml;gen
</li>
</ul>
</li><br>
<li><code>port &lt;Nummer&gt;</code> <li><code>port &lt;Nummer&gt;</code>
<br> <br>
Beim Ger&auml;tetyp 'url' kann hier der URL-Port festgelegt werden (standardm&auml;ssig 80)</li> Beim Ger&auml;tetyp 'url' kann hier der URL-Port festgelegt werden (standardm&auml;ssig 80)
</li><br>
<li><a href="#readingFnAttributes">readingFnAttributes</a></li> <li><a href="#readingFnAttributes">readingFnAttributes</a></li>
</ul> </ul>
</ul> </ul>