From b570745adefc91a0eac3d3951c6a5d6b1ad97be5 Mon Sep 17 00:00:00 2001 From: Onkel Andy Date: Fri, 29 Dec 2023 23:56:14 +0100 Subject: [PATCH 1/2] byd_bat plugin: move images to correct folder for docu --- byd_bat/{webif/static/img => assets}/diag.png | Bin byd_bat/{webif/static/img => assets}/home.png | Bin byd_bat/{webif/static/img => assets}/temp.png | Bin byd_bat/{webif/static/img => assets}/volt.png | Bin byd_bat/webif/static/img/readme.txt | 6 ------ 5 files changed, 6 deletions(-) rename byd_bat/{webif/static/img => assets}/diag.png (100%) rename byd_bat/{webif/static/img => assets}/home.png (100%) rename byd_bat/{webif/static/img => assets}/temp.png (100%) rename byd_bat/{webif/static/img => assets}/volt.png (100%) delete mode 100644 byd_bat/webif/static/img/readme.txt diff --git a/byd_bat/webif/static/img/diag.png b/byd_bat/assets/diag.png similarity index 100% rename from byd_bat/webif/static/img/diag.png rename to byd_bat/assets/diag.png diff --git a/byd_bat/webif/static/img/home.png b/byd_bat/assets/home.png similarity index 100% rename from byd_bat/webif/static/img/home.png rename to byd_bat/assets/home.png diff --git a/byd_bat/webif/static/img/temp.png b/byd_bat/assets/temp.png similarity index 100% rename from byd_bat/webif/static/img/temp.png rename to byd_bat/assets/temp.png diff --git a/byd_bat/webif/static/img/volt.png b/byd_bat/assets/volt.png similarity index 100% rename from byd_bat/webif/static/img/volt.png rename to byd_bat/assets/volt.png diff --git a/byd_bat/webif/static/img/readme.txt b/byd_bat/webif/static/img/readme.txt deleted file mode 100644 index 1a7c55eef..000000000 --- a/byd_bat/webif/static/img/readme.txt +++ /dev/null @@ -1,6 +0,0 @@ -This directory is for storing images that are used by the web interface. - -If you want to have your own logo on the top of the web interface, store it here and name it plugin_logo.. - -Extension can be png, svg or jpg - From 5b49dada73bf59b055975f89654d79f3a8eced6f Mon Sep 17 00:00:00 2001 From: Onkel Andy Date: Fri, 29 Dec 2023 23:56:34 +0100 Subject: [PATCH 2/2] byd_bat plugin: fix and simplify docu --- byd_bat/user_doc.rst | 30 ++++++------------------------ 1 file changed, 6 insertions(+), 24 deletions(-) diff --git a/byd_bat/user_doc.rst b/byd_bat/user_doc.rst index c1aad8f5f..1b2850071 100644 --- a/byd_bat/user_doc.rst +++ b/byd_bat/user_doc.rst @@ -20,10 +20,12 @@ Die Grunddaten werden alle 60 Sekunden aktualisiert. Die Diagnosedaten werden be Die Spannungen und Temperaturen in den Modulen werden mit Hilfe von Heatmaps dargestellt. Diese werden im Web Interface angezeigt. Zusätzlich können diese Bilder auch in ein weiteres Verzeichnis kopiert werden (z.Bsp. für smartvisu). -Das Pflugin benoetigt nur ein Item mit der folgenden Deklaration: +Das Plugin benoetigt nur ein Item mit der folgenden Deklaration: -byd: - struct: byd_bat.byd_struct +.. code-block:: yaml + + byd: + struct: byd_bat.byd_struct Alle verfügbaren Daten werden im Struct 'byd_struct' bereitgestellt. Diverse Parameter besitzen bereits die Eigenschaft 'database: init', so dass die Daten für die Visualisierung bereitgestellt werden. @@ -52,28 +54,8 @@ Bitte Debug-Daten (level: DEBUG) von noch nicht getesteten BYD Energiespeichern Konfiguration ============= -plugin.yaml ------------ - -Zu den Informationen, welche Parameter in der ../etc/plugin.yaml konfiguriert werden können bzw. müssen, bitte die Dokumentation :doc:`Dokumentation ` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde. - - -items.yaml ----------- - -Zu den Informationen, welche Attribute in der Item Konfiguration verwendet werden können bzw. müssen, bitte die Dokumentation :doc:`Dokumentation ` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde. - - -logic.yaml ----------- - -Zu den Informationen, welche Konfigurationsmöglichkeiten für Logiken bestehen, bitte die Dokumentation :doc:`Dokumentation ` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde. - - -Funktionen ----------- +Detaillierte Information sind :doc:`/plugins_doc/config/byd_bat` zu entnehmen. -Zu den Informationen, welche Funktionen das Plugin bereitstellt (z.B. zur Nutzung in Logiken), bitte die Dokumentation :doc:`Dokumentation ` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde. Web Interface =============