Skip to content

Commit

Permalink
rrd plugin: fix docu
Browse files Browse the repository at this point in the history
  • Loading branch information
onkelandy committed Mar 3, 2024
1 parent f2a61b9 commit cb1e3b9
Showing 1 changed file with 5 additions and 35 deletions.
40 changes: 5 additions & 35 deletions rrd/user_doc.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
.. index:: Plugins; rrd
.. index:: rrd


===
rrd
===


Das `RRDTool <https://oss.oetiker.ch/rrdtool/>`_ ist ein weitverbreitetes Tool um Zeitreihen von Messdaten aufzuzeichnen.
Das `RRDTool <https://oss.oetiker.ch/rrdtool/>`_ ist ein weitverbreitetes Tool um Zeitreihen von Messdaten aufzuzeichnen.
Dieses Plugin stellt die Möglichkeit bereit Itemwerte an das RRDTool weiterzugeben.



Anforderungen
=============

Expand Down Expand Up @@ -47,36 +43,9 @@ Die Plugin Parameter und die Informationen zur Item-spezifischen Konfiguration d
unter :doc:`/plugins_doc/config/rrd` beschrieben.


plugin.yaml
-----------

Zu den Informationen, welche Parameter in der ../etc/plugin.yaml konfiguriert werden können bzw. müssen, bitte
bitte die Dokumentation :doc:`Dokumentation </plugins_doc/config/rrd>` lesen, die aus
den Metadaten der plugin.yaml erzeugt wurde (siehe oben).


items.yaml
----------

Zu den Informationen, welche Attribute in der Item Konfiguration verwendet werden können bzw. müssen, bitte
bitte die Dokumentation :doc:`Dokumentation </plugins_doc/config/rrd>` lesen, die aus
den Metadaten der plugin.yaml erzeugt wurde (siehe oben).


logic.yaml
----------

Zu den Informationen, welche Konfigurationsmöglichkeiten für Logiken bestehen, bitte
bitte die Dokumentation :doc:`Dokumentation </plugins_doc/config/rrd>` lesen, die aus
den Metadaten der plugin.yaml erzeugt wurde (siehe oben).

Funktionen
----------

Zu den Informationen, welche Funktionen das Plugin bereitstellt (z.B. zur Nutzung in Logiken), bitte
bitte die Dokumentation :doc:`Dokumentation </plugins_doc/config/rrd>` lesen, die aus
den Metadaten der plugin.yaml erzeugt wurde (siehe oben).

Das Plugin stellt für jedes Item das für die Verwendung mit dem Plugin konfiguriert wurde eine Datenbankfunktion bereit.

``sh.item.db(function, start, end='now')``
Expand All @@ -100,9 +69,10 @@ Für die Intervalleinheit können folgende Kennzeichnungen verwendet werden:
* `h`: hour
* `d`: day
* `w`: week
+ `m`: month
* `m`: month
* `y`: year


Beispiele
=========

Expand Down Expand Up @@ -135,11 +105,11 @@ Um das Minimum der letzten 24 Stunden zu ermitteln:
Um die Durchschnittstemperatur einer Woche zu ermitteln die vor genau 7 Tagen endete:

.. code-block:: python
sh.Aussen.Temperatur.db('avg', '2w', '1w')
Web Interface
=============

Aktuell hat das Plugin kein Webinterface
Aktuell hat das Plugin kein Webinterface

0 comments on commit cb1e3b9

Please sign in to comment.