From 397b82e30d0f66f02d788ce79b70ed75cb953b21 Mon Sep 17 00:00:00 2001
From: johannnes <>
Date: Sat, 23 Mar 2013 16:02:33 +0000
Subject: [PATCH] updated documentation
git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@2970 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
www/frontend/FHEM/93_DbLog.pm | 44 ++++++++++++++++++++++++++++-------
1 file changed, 35 insertions(+), 9 deletions(-)
diff --git a/www/frontend/FHEM/93_DbLog.pm b/www/frontend/FHEM/93_DbLog.pm
index 69c8e3a76..222c935e0 100644
--- a/www/frontend/FHEM/93_DbLog.pm
+++ b/www/frontend/FHEM/93_DbLog.pm
@@ -1168,7 +1168,7 @@ sub chartQuery($@) {
- <name>
- The name of the defined DbLog, like it is given in fhem.cfg. For functionality this has to be set to logdb.
+ The name of the defined DbLog, like it is given in fhem.cfg.
- <in>
A dummy parameter for FileLog compatibility. Always set to -
- <out>
@@ -1186,7 +1186,14 @@ sub chartQuery($@) {
getdevices to retrieve all available devices
timerange to retrieve charting data, which requires a given xaxis, yaxis, device, to and from
savechart 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
- deletechart to delete a saved chart. Requires a given 'savename' which was used to save the chart
+ deletechart to delete a saved chart. Requires a given id which was set on save of the chart
+ getcharts to get a list of all saved charts.
+ getTableData to get jsonformatted data from the database. Uses paging Parameters like start and limit.
+ hourstats to get statistics for a given value (yaxis) for an hour.
+ daystats to get statistics for a given value (yaxis) for a day.
+ weekstats to get statistics for a given value (yaxis) for a week.
+ monthstats to get statistics for a given value (yaxis) for a month.
+ yearstats to get statistics for a given value (yaxis) for a year.
- <xaxis>
A string which represents the xaxis
@@ -1194,8 +1201,13 @@ sub chartQuery($@) {
A string which represents the yaxis
- <savename>
A string which represents the name a chart will be saved with
-
+ - <chartconfig>
+ A jsonstring which represents the chart to save
+ - <pagingstart>
+ An integer used to determine the start for the sql used for query 'getTableData'
+ <paginglimit>
+ An integer used to set the limit for the sql used for query 'getTableData'
Examples:
@@ -1210,8 +1222,8 @@ sub chartQuery($@) {
Will ouput a JSON like this: [{'TIMESTAMP':'2013-02-11 00:10:10','VALUE':'0.22431388090756'},{'TIMESTAMP'.....}]
get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e savechart TIMESTAMP day_kwh tageskwh
Will save a chart in the database with the given name and the chart configuration parametersget logdb - webchart "" "" "" deletechart "" "" tageskwh
- Will delete a chart from the database with the given nameget logdb - webchart "" "" "" deletechart "" "" 7
+ Will delete a chart from the database with the given id
@@ -1389,7 +1401,7 @@ sub chartQuery($@) {
- <name>
- Der Name des definierten DbLogs, so wie er in der fhem.cfg angegeben wurde. Muss für Funktionalität auf logdb gesetzt werden.
+ Der Name des definierten DbLogs, so wie er in der fhem.cfg angegeben wurde.
- <in>
Ein Dummy Parameter um eine Kompatibilität zum Filelog herzustellen.
Dieser Parameter ist immer auf - zu setzen.
@@ -1409,7 +1421,14 @@ sub chartQuery($@) {
getdevices um alle verfügbaren devices zu erhalten
timerange um Chart-Daten abzufragen. Es werden die Parameter 'xaxis', 'yaxis', 'device', 'to' und 'from' benötigt
savechart um einen Chart unter Angabe eines 'savename' und seiner zugehörigen Konfiguration abzuspeichern
- deletechart um einen zuvor gespeicherten Chart unter Angabe eines 'savename' zu löschen
+ deletechart um einen zuvor gespeicherten Chart unter Angabe einer id zu löschen
+ getcharts um eine Liste aller gespeicherten Charts zu bekommen.
+ getTableData um Daten aus der Datenbank abzufragen und in einer Tabelle darzustellen. Benötigt paging Parameter wie start und limit.
+ hourstats um Statistiken für einen Wert (yaxis) für eine Stunde abzufragen.
+ daystats um Statistiken für einen Wert (yaxis) für einen Tag abzufragen.
+ weekstats um Statistiken für einen Wert (yaxis) für eine Woche abzufragen.
+ monthstats um Statistiken für einen Wert (yaxis) für einen Monat abzufragen.
+ yearstats um Statistiken für einen Wert (yaxis) für ein Jahr abzufragen.
- <xaxis>
Ein String, der die X-Achse repräsentiert
@@ -1418,6 +1437,13 @@ sub chartQuery($@) {
- <savename>
Ein String, unter dem ein Chart in der Datenbank gespeichert werden soll
+ <chartconfig>
+ Ein jsonstring der den zu speichernden Chart repräsentiert
+ <pagingstart>
+ Ein Integer um den Startwert für die Abfrage 'getTableData' festzulegen
+
+ <paginglimit>
+ Ein Integer um den Limitwert für die Abfrage 'getTableData' festzulegen
Beispiele:
@@ -1432,8 +1458,8 @@ sub chartQuery($@) {
Die Ausgabe erfolgt als JSON, z.B.: [{'TIMESTAMP':'2013-02-11 00:10:10','VALUE':'0.22431388090756'},{'TIMESTAMP'.....}]
get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e savechart TIMESTAMP day_kwh tageskwh
Speichert einen Chart unter Angabe eines 'savename' und seiner zugehörigen Konfigurationget logdb - webchart "" "" "" deletechart "" "" tageskwh
- Löscht einen zuvor gespeicherten Chart unter Angabe eines 'savename'get logdb - webchart "" "" "" deletechart "" "" 7
+ Löscht einen zuvor gespeicherten Chart unter Angabe einer id