summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjasplin <qt-info@nokia.com>2009-12-01 08:56:10 +0100
committerjasplin <qt-info@nokia.com>2009-12-01 08:56:10 +0100
commita7b95b11070b3a5affc107a93cd878ce8b50ce4c (patch)
treefaa562137bf4c51216d16d6522fd35baeeb86ec1 /doc
parent33f37fe396b7c8e2c97b695eab1ae07a96dbabfb (diff)
Added 'curr timestamp' to 'get history*' request.
Passing the current timestamp as an argument to the 'get history*' requests makes it possible to use the current time of the web browser as the observation time instead of the current time of the bmclient host. In general this makes more sense. (Pass -1 to use the local time of the bmclient host anyway).
Diffstat (limited to 'doc')
-rw-r--r--doc/bmclient.html27
1 files changed, 20 insertions, 7 deletions
diff --git a/doc/bmclient.html b/doc/bmclient.html
index 721f036..38b98b9 100644
--- a/doc/bmclient.html
+++ b/doc/bmclient.html
@@ -398,7 +398,8 @@ Content-type: text/json
&lt;diff tolerance&gt; \
&lt;stab tolerance&gt; \
&lt;max size&gt; \
- &lt;style sheet&gt;
+ &lt;style sheet&gt; \
+ &lt;curr timestamp&gt;
</pre>
</td>
<td class="commandDescr">
@@ -551,13 +552,24 @@ non-negative, it limits the part of the input time series to pass to the
output. The oldest part will be dropped if necessary.
<br /><br />
-<b>Styling HTML output</b>
+<b>Generating HTML output</b>
<br /><br />
-When <span class="command"><b>get history</b></span> is used as a backend by
-the <span class="command"><b>get detailspage</b></span> command, the
-<span class="command">&lt;style&nbsp;sheet&gt;</span> specifies the URL to the
-style sheet to apply for the HTML output. Otherwise, the argument is just ignored.
+The following arguments control the appearance of the HTML output generated
+when <span class="command"><b>get history</b></span> is used as a backend by
+the <span class="command"><b>get detailspage</b></span> command:
+
+<ul>
+<li>
+ <span class="command">&lt;style&nbsp;sheet&gt;</span> specifies the style
+ sheet URL.
+</li>
+<li>
+ <span class="command">&lt;curr&nbsp;timestamp&gt;</span> defines the time
+ of observation used for calculating "days ago" and "age" values. If the
+ timestamp is negative, the local system time will be used.
+</li>
+</ul>
</td>
<td>
@@ -665,7 +677,8 @@ Content-type: text/html
&lt;stab tolerance&gt; \
&lt;max size&gt; \
&lt;shared time scale&gt; \
- &lt;style sheet&gt;
+ &lt;style sheet&gt; \
+ &lt;curr timestamp&gt;
</pre>
</td>
<td class="commandDescr">