mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-01-31 12:49:34 +00:00
updated documentation
git-svn-id: https://svn.fhem.de/fhem/trunk@2970 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
johannnes
parent
20b697c42c
commit
d486ba5a17
@ -1168,7 +1168,7 @@ sub chartQuery($@) {
|
||||
|
||||
<ul>
|
||||
<li><name><br>
|
||||
The name of the defined DbLog, like it is given in fhem.cfg. For functionality this has to be set to <code>logdb</code>.</li>
|
||||
The name of the defined DbLog, like it is given in fhem.cfg.</li>
|
||||
<li><in><br>
|
||||
A dummy parameter for FileLog compatibility. Always set to <code>-</code></li>
|
||||
<li><out><br>
|
||||
@ -1186,7 +1186,14 @@ sub chartQuery($@) {
|
||||
<code>getdevices</code> to retrieve all available devices<br>
|
||||
<code>timerange</code> to retrieve charting data, which requires a given xaxis, yaxis, device, to and from<br>
|
||||
<code>savechart</code> to save a chart configuration in the database. Requires a given xaxis, yaxis, device, to and from, and a 'savename' used to save the chart<br>
|
||||
<code>deletechart</code> to delete a saved chart. Requires a given 'savename' which was used to save the chart<br>
|
||||
<code>deletechart</code> to delete a saved chart. Requires a given id which was set on save of the chart<br>
|
||||
<code>getcharts</code> to get a list of all saved charts.<br>
|
||||
<code>getTableData</code> to get jsonformatted data from the database. Uses paging Parameters like start and limit.<br>
|
||||
<code>hourstats</code> to get statistics for a given value (yaxis) for an hour.<br>
|
||||
<code>daystats</code> to get statistics for a given value (yaxis) for a day.<br>
|
||||
<code>weekstats</code> to get statistics for a given value (yaxis) for a week.<br>
|
||||
<code>monthstats</code> to get statistics for a given value (yaxis) for a month.<br>
|
||||
<code>yearstats</code> to get statistics for a given value (yaxis) for a year.<br>
|
||||
</li>
|
||||
<li><xaxis><br>
|
||||
A string which represents the xaxis</li>
|
||||
@ -1194,8 +1201,13 @@ sub chartQuery($@) {
|
||||
A string which represents the yaxis</li>
|
||||
<li><savename><br>
|
||||
A string which represents the name a chart will be saved with</li>
|
||||
|
||||
<li><chartconfig><br>
|
||||
A jsonstring which represents the chart to save</li>
|
||||
<li><pagingstart><br>
|
||||
An integer used to determine the start for the sql used for query 'getTableData'</li>
|
||||
</ul>
|
||||
<li><paginglimit><br>
|
||||
An integer used to set the limit for the sql used for query 'getTableData'</li>
|
||||
<br><br>
|
||||
Examples:
|
||||
<ul>
|
||||
@ -1210,8 +1222,8 @@ sub chartQuery($@) {
|
||||
Will ouput a JSON like this: <code>[{'TIMESTAMP':'2013-02-11 00:10:10','VALUE':'0.22431388090756'},{'TIMESTAMP'.....}]</code></li>
|
||||
<li><code>get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e savechart TIMESTAMP day_kwh tageskwh</code><br>
|
||||
Will save a chart in the database with the given name and the chart configuration parameters</li>
|
||||
<li><code>get logdb - webchart "" "" "" deletechart "" "" tageskwh</code><br>
|
||||
Will delete a chart from the database with the given name</li>
|
||||
<li><code>get logdb - webchart "" "" "" deletechart "" "" 7</code><br>
|
||||
Will delete a chart from the database with the given id</li>
|
||||
</ul>
|
||||
<br><br>
|
||||
</ul>
|
||||
@ -1389,7 +1401,7 @@ sub chartQuery($@) {
|
||||
|
||||
<ul>
|
||||
<li><name><br>
|
||||
Der Name des definierten DbLogs, so wie er in der fhem.cfg angegeben wurde. Muss für Funktionalität auf <code>logdb</code> gesetzt werden.</li>
|
||||
Der Name des definierten DbLogs, so wie er in der fhem.cfg angegeben wurde.</li>
|
||||
<li><in><br>
|
||||
Ein Dummy Parameter um eine Kompatibilität zum Filelog herzustellen.
|
||||
Dieser Parameter ist immer auf <code>-</code> zu setzen.</li>
|
||||
@ -1409,7 +1421,14 @@ sub chartQuery($@) {
|
||||
<code>getdevices</code> um alle verfügbaren devices zu erhalten<br>
|
||||
<code>timerange</code> um Chart-Daten abzufragen. Es werden die Parameter 'xaxis', 'yaxis', 'device', 'to' und 'from' benötigt<br>
|
||||
<code>savechart</code> um einen Chart unter Angabe eines 'savename' und seiner zugehörigen Konfiguration abzuspeichern<br>
|
||||
<code>deletechart</code> um einen zuvor gespeicherten Chart unter Angabe eines 'savename' zu löschen<br>
|
||||
<code>deletechart</code> um einen zuvor gespeicherten Chart unter Angabe einer id zu löschen<br>
|
||||
<code>getcharts</code> um eine Liste aller gespeicherten Charts zu bekommen.<br>
|
||||
<code>getTableData</code> um Daten aus der Datenbank abzufragen und in einer Tabelle darzustellen. Benötigt paging Parameter wie start und limit.<br>
|
||||
<code>hourstats</code> um Statistiken für einen Wert (yaxis) für eine Stunde abzufragen.<br>
|
||||
<code>daystats</code> um Statistiken für einen Wert (yaxis) für einen Tag abzufragen.<br>
|
||||
<code>weekstats</code> um Statistiken für einen Wert (yaxis) für eine Woche abzufragen.<br>
|
||||
<code>monthstats</code> um Statistiken für einen Wert (yaxis) für einen Monat abzufragen.<br>
|
||||
<code>yearstats</code> um Statistiken für einen Wert (yaxis) für ein Jahr abzufragen.<br>
|
||||
</li>
|
||||
<li><xaxis><br>
|
||||
Ein String, der die X-Achse repräsentiert</li>
|
||||
@ -1418,6 +1437,13 @@ sub chartQuery($@) {
|
||||
<li><savename><br>
|
||||
Ein String, unter dem ein Chart in der Datenbank gespeichert werden soll</li>
|
||||
</ul>
|
||||
<li><chartconfig><br>
|
||||
Ein jsonstring der den zu speichernden Chart repräsentiert</li>
|
||||
<li><pagingstart><br>
|
||||
Ein Integer um den Startwert für die Abfrage 'getTableData' festzulegen</li>
|
||||
</ul>
|
||||
<li><paginglimit><br>
|
||||
Ein Integer um den Limitwert für die Abfrage 'getTableData' festzulegen</li>
|
||||
<br><br>
|
||||
Beispiele:
|
||||
<ul>
|
||||
@ -1432,8 +1458,8 @@ sub chartQuery($@) {
|
||||
Die Ausgabe erfolgt als JSON, z.B.: <code>[{'TIMESTAMP':'2013-02-11 00:10:10','VALUE':'0.22431388090756'},{'TIMESTAMP'.....}]</code></li>
|
||||
<li><code>get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e savechart TIMESTAMP day_kwh tageskwh</code><br>
|
||||
Speichert einen Chart unter Angabe eines 'savename' und seiner zugehörigen Konfiguration</li>
|
||||
<li><code>get logdb - webchart "" "" "" deletechart "" "" tageskwh</code><br>
|
||||
Löscht einen zuvor gespeicherten Chart unter Angabe eines 'savename'</li>
|
||||
<li><code>get logdb - webchart "" "" "" deletechart "" "" 7</code><br>
|
||||
Löscht einen zuvor gespeicherten Chart unter Angabe einer id</li>
|
||||
</ul>
|
||||
<br><br>
|
||||
</ul>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user