From ace6139b249ebea625b7e0b01fed12d288fd0a6e Mon Sep 17 00:00:00 2001
From: odroegehorn <>
Date: Fri, 5 Dec 2008 12:03:06 +0000
Subject: [PATCH] Added Docs for FHEMRENDERER
git-svn-id: https://svn.fhem.de/fhem/trunk@279 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
fhem/docs/commandref.html | 128 ++++++++++++++++++++++++++++++++++++++
1 file changed, 128 insertions(+)
diff --git a/fhem/docs/commandref.html b/fhem/docs/commandref.html
index 87bc39467..fb08dfc44 100644
--- a/fhem/docs/commandref.html
+++ b/fhem/docs/commandref.html
@@ -74,6 +74,7 @@
WS300
X10
weblink
+ FHEMRENDERER
@@ -3208,6 +3209,133 @@ isday, sunrise_coord
Attributes
+
+FHEMRENDERER
+
+ The FHEMRENDERER module is intended to render (draw) graphics based on the FHEM Log-Files.
+ This can be done either based on a timer (used in the module) or based on a direct call of GET.
+ The rendered graphics will be stored in a pre-defined directory with a predefined prefix of the files.
+
+
+
+ Define
+
+ define <name> FHEMRENDERER [global]
+
+ This defines a new "device", that is of type FHEMRENDERER. The option 'global' can be used if needed for sorting reasons.
+ Otherwise this option has no real meaning for FHEMRENDERER.
+
+ As a side-effect of defining this "device" the following attributes will be set for this "device":
+ plotmode gnuplot
+ plotsize 800,200
+ refresh 00:10:00
+ room Unsorted
+ status off
+ tmpfile /tmp/
+
+ NOTE: The Logfile will report (with LogLevel 2) that the FHEMRENDERER has been defined.
+
+
+
+
+
+ Set
+
+ set <name> <value>
+ Set either on or off.
+
+ This switches the timer-based rendering on/off. The attribute 'status' will be modified accordingly.
+ NOTE: only WebLink based graphics will be rendered.
+
+
+
+
+
+ Get
+
+ get <name> <[[file-name] device type logfile [pos=zoom=XX&off=YY]]>
+
+ The get function supports different sets of arguments:
+ Arguments:
+ NONE: all WebLink based FilePlots will be rerendered
+ The resulting filename will be '.png'
+ THREE: device type logfile
+ In this case only one specific graphic will be rendered:
+ A graphic will be rendered for 'device', where device is a FileLog, based on the type 'type' based on the given 'logfile'
+ The resulting filename will be 'attr-tmpfile logfile.png'
+ FOUR: file-name device type logfile
+ In this case only one specific graphic will be rendered:
+ A graphic will be rendered for 'device', where device is a FileLog, based on the type 'type' based on the given 'logfile'
+ The resulting filename will be 'attr-tmpfile file-name.png'
+ FIVE: file-name device type logfile pos=zoom=XX&off=YYY
+ In this case only one specific graphic will be rendered assuming that plotmode is 'gnuplot-scroll':
+ A graphic will be rendered for 'device', where device is a FileLog, based on the type 'type' based on the given 'logfile'
+ The 'zoom' will be either qday/day/week/month/year (same as used in FHEMWEB).
+ The offset 'off' is either 0 (then the second part can be omitted, or -1/-2.... to jump back in time.
+ The resulting filename will be 'attr-tmpfile file-name.png'
+
+ NOTE: If you want to use zoom AND offset then you have to concatenate via '&' !!
+
+ NOTE: combinations are possible in limited ranges:
+ meaning: you can add the 'pos=zoom=XX&off=YY' to any of the first three sets.
+ This may e.g. result in rendering all WebLinks with a specific zoom or offset
+ (if you just pass the 'pos=zoom=xx&off=yy' parameter);
+
+ Any rendered image (one or all WebLinks) will be stored in 'attr-tmpfile' followed by a 'filename.png'. The filename will be
+ either derived (from weblink-name or logfile-name) or, for single files, can be assigend.
+
+
+
+
+
+ Attributes
+
+
+ - plotmode
+ Specifies how to generate the plots:
+
+ - gnuplot
+ Call the gnuplot script with each logfile. The filename
+ specification of the FileLog device will
+ determine what is in the plot. The data is converted into an
+ image on the backend with gnuplot.
+ - gnuplot-scroll
+ FHEMRENDERER will offer zoom and offset possibilities in order to navigate
+ in the current logfile, i.e. you can select just a part of the
+ data to be displayed. The more data is contained in a single
+ logfile, the easier you can navigate. The recommendation is to
+ store the data for a whole year in one logfile. The data is
+ converted into an image on the backend with gnuplot.
+
+
+
+
+ - plotsize
+ the default size of the plot, in pixels, separated by comma:
+ width,height. You can set individual sizes by setting the plotsize of
+ the weblink.
+
+
+ - status
+ Reflects the status, if the renderer timer has been set to ON or OFF.
+ By reading the status, you can detect, if the timer is running, or not.
+
+
+
+ - refresh
+ This defines the time-interval in which a new rendering of the defined WebLinks will be done.
+
+
+
+ - tmpfile
+ This gives the path and a possible prefix for the rendered filenames.
+ You can specify a path to which the files will be rendered. If you also specify a prefix, this will be used to build the resulting filename.
+
+
+
+
+
+
Perl specials