panasonic_ac: Updated user_doc.rst and added plugin logo

panasonic_ac/__init__.py

@@ -63,7 +63,7 @@ class properties and methods (class variables and class functions)
     are already available!
     """
 
-    PLUGIN_VERSION = '0.3.0'    # (must match the version specified in plugin.yaml), use '1.0.0' for your initial plugin Release
+    PLUGIN_VERSION = '0.3.1'    # (must match the version specified in plugin.yaml), use '1.0.0' for your initial plugin Release
 
     def __init__(self, sh):
         """

panasonic_ac/plugin.yaml

@@ -12,7 +12,7 @@ plugin:
 #    documentation: https://github.com/smarthomeNG/smarthome/wiki/CLI-Plugin        # url of documentation (wiki) page
     support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1976353-support-thread-für-das-panasonic_ac-plugin
 
-    version: 0.3.0                  # Plugin version (must match the version specified in __init__.py)
+    version: 0.3.1                  # Plugin version (must match the version specified in __init__.py)
     sh_minversion: '1.10.0'         # minimum shNG version to use this plugin
 #    sh_maxversion:                 # maximum shNG version to use this plugin (leave empty if latest)
 #    py_minversion: 3.6             # minimum Python version to use for this plugin

panasonic_ac/user_doc.rst

@@ -1,52 +1,98 @@
-.. index:: Plugins; pcomfcloud
-.. index:: pcomfcloud
+.. index:: Plugins; panasonic_ac
+.. index:: panasonic_ac
 
-==========
-pcomfcloud
-==========
+============
+panasonic_ac
+============
 
-.. image:: webif/static/img/plugin_logo.png
+.. image:: webif/static/img/plugin_logo.jpg
    :alt: plugin logo
    :width: 300px
    :height: 300px
    :scale: 50 %
    :align: left
 
 
-<Hier erfolgt die allgemeine Beschreibung des Zwecks des Plugins>
+Mit diesem Plugin können Klimaanlagen der Firma Panasonic vom Typ Etherea gesteuert werden. Die Ansteuerung erfolgt
+durch das WLAN Interface der Klimaanlagen und einen von Panasonic zur Verfügung gestellen Cloud Service
+(Panasonic Comfort Cloud).
 
 |
 
+Anforderungen
+=============
+
+Das Plugin benötigt das Python Package **pcomfortcloud**. Allerdings ist die aktuell releaste Version 0.0.27 dieses
+Packages nicht kompatibel mit dem aktuelllen (neuen) Anmeldeverfahren der Panasonic Comfort Cloud. Es wird eine
+neuere Version des Packages benötigt, die mit dem Plugin im Unterververzeichnis **packages** des Plugins installiert
+wird.
+
+Notwendige Software
+-------------------
+
+Es wird eine aktuelle Develop Version des Packages **pcomfortcloud** benötigt. Diese Version muß Stand 18. August 2024
+oder neuer sein.
+
+|
 
 Plugin Instanz hinzufügen
 =========================
 
 Da das Plugin ohne vorherige Konfiguration weiterer Parameter lauffähig ist, wird die Instanz beim Hinzufügen in
-der Admin GUI auch gleich aktiviert und beim Neustart von SmartHomeNG geladen. Die Konfiguration erfolgt anschließend
-im Web Interface.
-
-Das Plugin unterstützt je Instanz nur eine Bridge. Dafür ist es Multi-Instance fähig, so dass bei Einsatz mehrerer
-Bridges einfach mehrere Instanzen des Plugins konfiguriert werden können.
+der Admin GUI auch gleich aktiviert und beim Neustart von SmartHomeNG geladen.
 
+|
 
 Konfiguration
 =============
 
-Die grundlegende Konfiguration des Plugins selbst, erfolgt durch das Web Interface des Plugins. Mit dem Web Interface
-kann die Verbindung zu einer Bridge hergestellt werden kann. Optionale weitere Einstellungen
-(z.B. default_transitionTime) können über die Admin GUI vorgenommen werden. Diese Parameter und die Informationen
-zur Item-spezifischen Konfiguration des Plugins sind unter :doc:`/plugins_doc/config/hue3` beschrieben.
+Optionale Einstellungen können über die Admin GUI vorgenommen werden. Diese Parameter und die Informationen
+zur Item-spezifischen Konfiguration des Plugins sind unter :doc:`/plugins_doc/config/panasonic_ac` beschrieben.
 
 |
 
+Verwendung von structs
+----------------------
+
+Mit der Hilfe von Struktur Templates wird die Einrichtung von Items stark vereinfacht. Hierzu wird ein struct Template
+vom Plugin mitgeliefert:
+
+- **panasonic_ac.air_condition** - Standard Definition für Panasonic Klimaanlagen
+
+Ein Item für eine Panasonic Klimaanlage kann einfach folgendermaßen konfiguriert werden, indem nur der Index der zu
+steuernden Anlage als ``pcc_index`` angegeben wird:
+
+.. code-block:: yaml
+
+    klimaanlage:
+        pcc_index: 1
+        struct: panasonic_ac.air_condition
+
+Der Index der jeweiligen Klimaanlage kann dem 3. Tab des Webinterfaces entnommen werden. Die Numerierung beginnt bei 1.
+Falls also nur eine Klimaanlage mit der Panasonic Comfort Cloud verbunden ist, ist ``pcc_index: 1``
+
+Die struct richtet folgende Unteritems ein: ``temp_inside``, ``temp_outside``, ``temp``, ``power``,
+``mode``, ``fanspeed``, ``swing_hor``, ``swing_vert``, ``eco`` und ``nanoe``.
+
+Das Item ``Klimaanlage`` enthält als Wert den Namen der Klimaanlage.
+
+Die Werte für ``Klimaanlage``, ``temp_inside`` und ``temp_outside`` können nur von der Comfort Cloud gelesen
+werden. Eine Veränderung des Item-Wertes hal also keine Auswirkung auf die Klimaanlage.
+
+
+Item Attribute
+--------------
+
+Die vollständige Übersicht über die unterstützen Attribute und deren zulässige Werte kann auf der
+Seite :doc:`/plugins_doc/config/panasonic_ac` nachgelesen werden.
 
 
 |
 
 Web Interface
 =============
 
-Das pcomfcloud Plugin verfügt über ein Webinterface, mit dessen Hilfe die Items die das Plugin nutzen
+Das panasonic_ac Plugin verfügt über ein Webinterface, mit dessen Hilfe die Items die das Plugin nutzen
 übersichtlich dargestellt werden. Außerdem können Informationen zu den Devices angezeigt werden,
 die durch die Panasonic Comfort Cloud verwaltet werden.
 
@@ -57,8 +103,7 @@ Aufruf des Webinterfaces
 Das Plugin kann aus der Admin GUI (von der Seite Plugins/Plugin Liste aus) aufgerufen werden. Dazu auf der Seite
 in der entsprechenden Zeile das Icon in der Spalte **Web Interface** anklicken.
 
-Außerdem kann das Webinterface direkt über ``http://smarthome.local:8383/plugin/pcomfcloud`` bzw.
-``http://smarthome.local:8383/plugin/pcomfcloud_<Instanz>`` aufgerufen werden.
+Außerdem kann das Webinterface direkt über ``http://smarthome.local:8383/plugin/panasonic_ac`` aufgerufen werden.
 
 |
 
@@ -79,15 +124,15 @@ Im ersten Tab werden die Items angezeigt, die das Plugin nutzen:
 |
 |
 
-Im zweiten Tab werden Informationen zu den Leuchten angezeigt, die in der Hue Bridge bekannt sind:
+Im zweiten Tab werden Informationen zur aktuellen Parametrierung des einzelnen Klimaanlagen angezeigt:
 
 .. image:: assets/webif_tab2.jpg
    :class: screenshot
 
 |
 |
 
-Im dritten Tab werden die Szenen angezeigt, die in der Hue Bridge definiert sind:
+Im dritten Tab werden die Grunddaten der einzelnen Klimaanlagen angezeigt:
 
 .. image:: assets/webif_tab3.jpg
    :class: screenshot
@@ -96,37 +141,3 @@ Im dritten Tab werden die Szenen angezeigt, die in der Hue Bridge definiert sind
 |
 |
 
-Im vierten Tab werden die Gruppen angezeigt, die in der Hue Bridge definiert sind:
-
-.. image:: assets/webif_tab4.jpg
-   :class: screenshot
-
-
-|
-|
-
-Im fünften Tab werden die Sensoren angezeigt, die in der Hue Bridge bekannt sind:
-
-.. image:: assets/webif_tab5.jpg
-   :class: screenshot
-
-|
-|
-
-Im sechsten Tab werden die Devices angezeigt, die in der Hue Bridge bekannt sind:
-
-.. image:: assets/webif_tab6.jpg
-   :class: screenshot
-
-|
-|
-
-Auf dem siebten Reiter werden Informationen zur Hue Bridge angezeigt. Wenn weitere Anwendungen die Bridge nutzen,
-wird zusätzlich eine Liste der in der Bridge konfigurierten Benutzer/Apps angezeigt.
-
-.. image:: assets/webif_tab7.jpg
-   :class: screenshot
-
-|
-|
-

panasonic_ac/webif/templates/index.html

@@ -385,27 +385,27 @@
 <table class="table table-striped table-hover">
 	<tbody>
 		<tr>
-			<td class="py-1"><strong>Prompt 1</strong></td>
-			<td class="py-1">{% if 1 == 2 %}{{ _('Ja') }}{% else %}{{ _('Nein') }}{% endif %}</td>
+			<td class="py-1"><strong>&nbsp;</strong></td>
+			<td class="py-1">{{ _(' ') }}</td>
 			<td class="py-1" width="50px"></td>
-			<td class="py-1"><strong>Prompt 4</strong></td>
-			<td class="py-1">{{ _('Wert 4') }}</td>
+			<td class="py-1"><strong></strong></td>
+			<td class="py-1">{{ _('') }}</td>
 			<td class="py-1" width="50px"></td>
 		</tr>
 		<tr>
-			<td class="py-1"><strong>Prompt 2</strong></td>
-			<td class="py-1">{{ _('Wert 2') }}</td>
+			<td class="py-1"><strong>&nbsp;</strong></td>
+			<td class="py-1">{{ _('') }}</td>
 			<td></td>
-			<td class="py-1"><strong>Prompt 5</strong></td>
-			<td class="py-1">-</td>
+			<td class="py-1"><strong></strong></td>
+			<td class="py-1"></td>
 			<td></td>
 		</tr>
 		<tr>
-			<td class="py-1"><strong>Prompt 3</strong></td>
-			<td class="py-1">-</td>
+			<td class="py-1"><strong>&nbsp;</strong></td>
+			<td class="py-1"></td>
 			<td></td>
-			<td class="py-1"><strong>Prompt 6</strong></td>
-			<td class="py-1">-</td>
+			<td class="py-1"><strong></strong></td>
+			<td class="py-1"></td>
 			<td></td>
 		</tr>
 	</tbody>