Skip to content

Commit

Permalink
Merge feefc2b into 530cfc5
Browse files Browse the repository at this point in the history
  • Loading branch information
@ChristianMayer
ChristianMayer committed Nov 10, 2019
2 parents 530cfc5 + feefc2b commit 74c1c87
Show file tree
Hide file tree
Showing 9 changed files with 261 additions and 65 deletions.
26 changes: 14 additions & 12 deletions doc/manual/de/config/widgets/index.rst
View file
Expand Up @@ -163,25 +163,33 @@ also z.B.:
+----------------------------------------------------------+---------------------------------------------------------------------+
| Widget | Beschreibung |
+==========================================================+=====================================================================+
| CalendarList | externen Kalendar einbinden |
+----------------------------------------------------------+---------------------------------------------------------------------+
| Clock | Plugin zum Darstellen der Uhrzeit von einer Adresse. |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`ColorChooser <plugins/colorchooser/index>` | Farb-Auswahl-Rad für RGB-Beleuchtung |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`Diagram <plugins/diagram/index>` | RRD-basierte Diagramme |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`Diagram_Info <plugins/diagram_info/index>` | Informations-Anzeige, die beim Klick ein Diagramm öffnet |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`PowerSpectrum <plugins/powerspectrum/index>` | Darstellung des Strom-Spektrums |
| :doc:`Gauge <plugins/gauge/index>` | Zeigerinstrument |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`Strftime <plugins/strftime/index>` | Darstellung der Uhrzeit in Textform |
| :doc:`Link <plugins/link/index>` | Fügt der Visu einen einfachen anklickbaren Link hinzu |
+----------------------------------------------------------+---------------------------------------------------------------------+
| RSSlog | Interaktive Log-Meldungen basierend auf RSS-Technologie |
| :doc:`openHAB <plugins/openhab/index>` | Verbesserte Integration mit dem openHAB2 Backend |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`OpenweatherMap <plugins/openweathermap/index>` | Wettervorhersage |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`PowerSpectrum <plugins/powerspectrum/index>` | Darstellung des Strom-Spektrums |
+----------------------------------------------------------+---------------------------------------------------------------------+
| RSS | RSS |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`Gauge <plugins/gauge/index>` | Zeigerinstrument |
| RSSlog | Interaktive Log-Meldungen basierend auf RSS-Technologie |
+----------------------------------------------------------+---------------------------------------------------------------------+
| CalendarList | externen Kalendar einbinden |
| :doc:`Speech <plugins/speech/index>` | Sprachausgabe (Text-to-speech) |
+----------------------------------------------------------+---------------------------------------------------------------------+
| Clock | Plugin zum Darstellen der Uhrzeit von einer Adresse. |
| :doc:`Strftime <plugins/strftime/index>` | Darstellung der Uhrzeit in Textform |
+----------------------------------------------------------+---------------------------------------------------------------------+
| SVG | Demo Plugin zur Anzeige einer interaktiv animierten SVG Datei |
+----------------------------------------------------------+---------------------------------------------------------------------+
Expand All @@ -191,12 +199,6 @@ also z.B.:
+----------------------------------------------------------+---------------------------------------------------------------------+
| UPNPController | UPNP-Controller |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`Speech <plugins/speech/index>` | Sprachausgabe (Text-to-speech) |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`openHAB <plugins/openhab/index>` | Verbesserte Integration mit dem openHAB2 Backend |
+----------------------------------------------------------+---------------------------------------------------------------------+
| :doc:`Link <plugins/link/index>` | Fügt der Visu einen einfachen anklickbaren Link hinzu |
+----------------------------------------------------------+---------------------------------------------------------------------+


.. toctree::
Expand Down
Binary file added doc/manual/de/config/widgets/plugins/openweathermap/_static/weather.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 83 additions & 0 deletions doc/manual/de/config/widgets/plugins/openweathermap/index.rst
View file
@@ -0,0 +1,83 @@
.. _openweathermap:

Das OpenweatherMap Plugin
=========================

.. api-doc:: cv.plugins.OpenweatherMap

Beschreibung
------------

Das OpenweatherMap Plugin fügt der Visu ein Widget für die Wettervorhersage
hinzu.


Einstellungen
-------------

Für eine grundsätzliche Erklärung des Aufbaus der Konfiguration und der Definition der im folgenden benutzten
Begriffe (Elemente, Attribute) sollte zunächst dieser Abschnitt gelesen werden: :ref:`visu-config-details`.

Das Verhalten und Aussehen des OpenweatherMap-Plugins kann durch die Verwendung von Attributen und Elementen beeinflusst werden.
Die folgenden Tabellen zeigen die erlaubten Attribute und Elemente. In den Screenshots sieht man, wie
beides über den :ref:`Editor <editor>` bearbeitet werden kann.

Nur die mit ..... unterstrichenen Attribute/Elemente müssen zwingend angegeben werden, alle anderen sind optional und können
daher weg gelassen werden.


Erlaubte Attribute im OpenweatherMap-Element
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. parameter-information:: openweathermap


.. IMPORTANT::
Der Wert des Attibuts `appid` muss durch den eigenen Schlüssel ersetzt werden!

Das OpenweatherMap nutzt den Web-Service von https://openweathermap.org/ um
die aktuellen Wetterdaten bzw. Vorhersage darstellen zu können. Um auf diese
Daten zugreifen zu können benötigt man einen Schlüssel, der dort auf der
Homepage kostenlos erzeugt werden kann und im Attribut `appid` angegeben
werden muss.

Erlaubte Kind-Elemente und deren Attribute
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. elements-information:: openweathermap

Keine.

XML Syntax
----------

Alternativ kann man für das OpenweatherMap Plugin auch von Hand einen Eintrag in
der :ref:`visu_config.xml <xml-format>` hinzufügen.

.. CAUTION::
In der Config selbst dürfen NUR UTF-8 Zeichen verwendet
werden. Dazu muss ein auf UTF-8 eingestellter Editor verwendet werden!

.. IMPORTANT::
Der Wert des Attibuts `appid` muss durch den eigenen Schlüssel ersetzt werden!

Hier der minimale Beispielcode der das OpenweatherMap Plugin aus dem folgenden,
Screenshot erzeugt:

.. figure:: _static/weather.png

.. code-block:: xml
<meta>
<plugins>
<plugin name="openweathermap" />
</plugins>
</meta>
...
<openweathermap q="Munich" appid="..." />
.. rubric:: Fußnoten

.. [#f1] In der vereinfachten Ansicht sind ggf. einige Dinge ausgeblendet. In der Expertenansicht ist alles zu sehen.
22 changes: 12 additions & 10 deletions doc/manual/en/config/widgets/index.rst
View file
Expand Up @@ -162,25 +162,31 @@ For example:
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| Widget | Description |
+=======================================================================+=======================================================================================================================+
| CalendarList | External calendar. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| Clock | Widget to display the time of an address. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| ColorChooser | Color selection wheel for RGB illumination. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :doc:`Diagram <plugins/diagram/index>` | RRD based graphs. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| Diagram_Info | Information display that opens a graph when you click on it. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :doc:`PowerSpectrum <plugins/powerspectrum/index>` | Graph of the spectrum of a power source. |
| :doc:`Gauge <plugins/gauge/index>` | Pointer instrument. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :doc:`Strftime <plugins/strftime/index>` | Display of the time in text form. |
| :doc:`Link <plugins/link/index>` | Add a simple clickable link that opens another website. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| RSSlog | Display of RSS feed. |
| :doc:`OpenweatherMap <plugins/openweathermap/index>` | Weather forecast |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :doc:`PowerSpectrum <plugins/powerspectrum/index>` | Graph of the spectrum of a power source. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :doc:`RSS <plugins/rss/index>` | Display of RSS feed. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :doc:`Gauge <plugins/gauge/index>` | Pointer instrument. |
| RSSlog | Display of RSS feed. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| CalendarList | External calendar. |
| :doc:`Speech <plugins/speech/index>` | Uses the browsers built in text-to-speech engine to speak text. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| Clock | Widget to display the time of an address. |
| :doc:`Strftime <plugins/strftime/index>` | Display of the time in text form. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| SVG | Demo plugin to show the integration of an interactive scalable vector graphic. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
Expand All @@ -190,10 +196,6 @@ For example:
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| UPNPController | UPNP Controller. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :doc:`Speech <plugins/speech/index>` | Uses the browsers built in text-to-speech engine to speak text. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :doc:`Link <plugins/link/index>` | Add a simple clickable link that opens another website. |
+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+

.. toctree::
:titlesonly:
Expand Down
Binary file added doc/manual/en/config/widgets/plugins/openweathermap/_static/weather.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 24 additions & 29 deletions doc/manual/en/config/widgets/plugins/openweathermap/index.rst
View file
Expand Up @@ -33,42 +33,20 @@ Allowed attributes in the openweathermap-element

.. parameter-information:: openweathermap

.. widget-example::
:editor: attributes
:scale: 75
:align: center
.. IMPORTANT::
The value of the attribute `appid` has to be replaced by your own key!

<caption>Attributes in the editor (simple view) [#f1]_</caption>
<meta>
<plugins>
<plugin name="openweathermap" />
</plugins>
</meta>
<openweathermap>
<layout colspan="4" />
</openweathermap>
The OpenweatherMap uses the web service of https://openweathermap.org/ to fetch
the current weather date and forecast. To be able to access this data you need
a key that can be obtained free of charge at the homepage and which must be
inserted at the `appid` attribute.


Allowed child-elements und their attributes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. elements-information:: openweathermap

.. widget-example::
:editor: elements
:scale: 75
:align: center
None.

<caption>Elements in the editor</caption>
<meta>
<plugins>
<plugin name="openweathermap" />
</plugins>
</meta>
<openweathermap>
<layout colspan="4" />
<label>openweathermap</label>
</openweathermap>

Examples
--------
Expand All @@ -80,6 +58,23 @@ for the openweathermap plugin.
Make sure that you only use UTF-8 encoded characters by settings the encoding in your
XML-editor to UTF-8 mode!

.. IMPORTANT::
The value of the attribute `appid` has to be replaced by your own key!

This minimal example code will create this screen shot:

.. figure:: _static/weather.png

.. code-block:: xml
<meta>
<plugins>
<plugin name="openweathermap" />
</plugins>
</meta>
...
<openweathermap q="Munich" appid="..." />
.. ###START-WIDGET-EXAMPLES### Please do not change the following content. Changes will be overwritten
Expand Down

0 comments on commit 74c1c87

Please sign in to comment.