diff --git a/Belevo_PV_Visu/README.md b/Belevo_PV_Visu/README.md index b059e3a..f01450a 100644 --- a/Belevo_PV_Visu/README.md +++ b/Belevo_PV_Visu/README.md @@ -1,67 +1,92 @@ -# Manager_1 -Beschreibung des Moduls. +# Belevo_PV_Visu + +Visualisierung des Eigenverbrauchs: Tages-Quoten für PV-Produktion vs. Einspeisung und Verbrauch vs. Netz-Bezug in IP-Symcon WebFront. ### Inhaltsverzeichnis -1. [Funktionsumfang](#1-funktionsumfang) -2. [Voraussetzungen](#2-voraussetzungen) -3. [Software-Installation](#3-software-installation) -4. [Einrichten der Instanzen in IP-Symcon](#4-einrichten-der-instanzen-in-ip-symcon) -5. [Statusvariablen und Profile](#5-statusvariablen-und-profile) -6. [WebFront](#6-webfront) -7. [PHP-Befehlsreferenz](#7-php-befehlsreferenz) +1. [Funktionsumfang](#1-funktionsumfang) +2. [Voraussetzungen](#2-voraussetzungen) +3. [Software-Installation](#3-software-installation) +4. [Einrichten der Instanzen in IP-Symcon](#4-einrichten-der-instanzen-in-ip-symcon) +5. [Statusvariablen und Profile](#5-statusvariablen-und-profile) +6. [WebFront](#6-webfront) +7. [PHP-Befehlsreferenz](#7-php-befehlsreferenz) + +--- ### 1. Funktionsumfang -* +* Anzeige von Tages-Quoten (in %) + * **Produktion** aufgeteilt in *Eigenverbrauch* vs. *Einspeisung* + * **Verbrauch** aufgeteilt in *PV-Anteil* vs. *Netz-Anteil* +* Zwei untereinander angeordnete Balkendiagramme +* Automatische Tages-Aggregation der Zählerwerte (kWh) +* Live-Update beim Laden der WebFront-Tile + +--- ### 2. Voraussetzungen -- IP-Symcon ab Version 7.1 +- IP-Symcon **ab Version 7.1** +- Aktiviertes **Archiv-Modul** (für Aggregation) +- Vier Zähler-Variablen (Produktion, Verbrauch, Einspeisung, Netz-Bezug) mit kWh-Zählerprofil + +--- ### 3. Software-Installation -* Über den Module Store das 'Manager_1'-Modul installieren. -* Alternativ über das Module Control folgende URL hinzufügen +1. **Über den Module Store** + - In der IPS-Konsole unter **Module → Modul Store** nach **Belevo_PV_Visu** suchen und installieren. +2. **Manuell per URL** + - In **Module → Einstellungen → Repositories** folgende Git-URL hinzufügen: + ``` + https://github.com/DeinRepo/Belevo_PV_Visu.git + ``` + - Anschließend **Module neu einlesen** und installieren. + +--- ### 4. Einrichten der Instanzen in IP-Symcon - Unter 'Instanz hinzufügen' kann das 'Manager_1'-Modul mithilfe des Schnellfilters gefunden werden. - - Weitere Informationen zum Hinzufügen von Instanzen in der [Dokumentation der Instanzen](https://www.symcon.de/service/dokumentation/konzepte/instanzen/#Instanz_hinzufügen) +Unter **Instanz hinzufügen** findet man das Modul über den Schnellfilter **“Belevo_PV_Visu”**. __Konfigurationsseite__: -Name | Beschreibung --------- | ------------------ - | - | +| Name | Beschreibung | +|------------------|----------------------------------------------------| +| **VarProduction**| Variable mit dem PV-Produktionszähler (kWh) | +| **VarConsumption**| Variable mit dem Gesamtverbrauchszähler (kWh) | +| **VarFeedIn** | Variable mit dem Einspeisezähler (kWh) | +| **VarGrid** | Variable mit dem Netz-Bezugszähler (kWh) | + +> Nach dem Speichern der Konfiguration stehen die Variablen zur Live-Auswertung in der WebFront-Tile zur Verfügung. + +--- ### 5. Statusvariablen und Profile -Die Statusvariablen/Kategorien werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen. +Dieses Modul legt **keine** eigenen Statusvariablen an, sondern nutzt ausschließlich die vom Anwender ausgewählten Zähler. Profiles müssen für die Quoten-Balken nicht angelegt werden – sämtliche Formatierung erfolgt in der HTML-SDK. -#### Statusvariablen - -Name | Typ | Beschreibung ------- | ------- | ------------ - | | - | | - -#### Profile - -Name | Typ ------- | ------- - | - | +--- ### 6. WebFront -Die Funktionalität, die das Modul im WebFront bietet. +* **Tile-Typ:** „Belevo_PV_Visu“ +* Zwei Balkendiagramme untereinander + 1. **Produktion** – Grün-Töne (Eigenverbrauch/Einspeisung) + 2. **Verbrauch** – Orange/Rot-Töne (PV-Anteil/Netz-Anteil) +* Beschriftung zeigt absolute Tages-Summen (kWh) +* Prozentwerte als Breite der jeweiligen Balken + +WebFront Tiles + +--- ### 7. PHP-Befehlsreferenz -`boolean GEF_BeispielFunktion(integer $InstanzID);` -Erklärung der Funktion. +Zur manuellen Aktualisierung der Visualisierung kann folgender Aufruf in einem Script verwendet werden: -Beispiel: -`GEF_BeispielFunktion(12345);` \ No newline at end of file +```php +// Aktualisiert die WebFront-Tile 'Belevo_PV_Visu' der Instanz $InstanceID +IPS_RequestAction($InstanceID, 'update', true); +Dieser Befehl löst das Neuberechnen der Tages-Aggregation aus und aktualisiert die Anzeige im WebFront. \ No newline at end of file diff --git a/Belevo_PV_Visu/module.php b/Belevo_PV_Visu/module.php index 38d3106..f1d7c54 100644 --- a/Belevo_PV_Visu/module.php +++ b/Belevo_PV_Visu/module.php @@ -1,4 +1,4 @@ -