no message

Energy_Pie/README.md

@@ -1,67 +1,37 @@
-# Manager_1
+# Energy_Pie
-Beschreibung des Moduls.
 
-### Inhaltsverzeichnis
+IP-Symcon-Modul zur Darstellung von Energieverbrauch und Eigenverbrauch in der Kachelvisualisierung.
 
-1. [Funktionsumfang](#1-funktionsumfang)
+## Funktionen
-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
+Das Modul zeigt folgende Werte an:
 
-*
+- Produktion
+- Hausverbrauch
+- Netzbezug
+- Einspeisung
+- Eigenverbrauchsquote
+- Autarkiegrad
 
-### 2. Voraussetzungen
+Die Darstellung erfolgt mit zwei Kreisdiagrammen.
+
+## Voraussetzungen
 
 - IP-Symcon ab Version 7.1
+- Aktivierte Archivierung der verwendeten Energiezähler
+- Energiezähler als fortlaufende kWh-Zähler
 
-### 3. Software-Installation
+## Konfiguration
 
-* Über den Module Store das 'Manager_1'-Modul installieren.
+Folgende Variablen müssen ausgewählt werden:
-* Alternativ über das Module Control folgende URL hinzufügen
 
-### 4. Einrichten der Instanzen in IP-Symcon
+| Einstellung | Beschreibung |
+|---|---|
+| Produktion | Gesamte produzierte Energie in kWh |
+| Einspeisung | Ins Netz eingespeiste Energie in kWh |
+| Netzbezug | Aus dem Netz bezogene Energie in kWh |
 
- Unter 'Instanz hinzufügen' kann das 'Manager_1'-Modul mithilfe des Schnellfilters gefunden werden.  
+Der Hausverbrauch wird automatisch berechnet:
-    - Weitere Informationen zum Hinzufügen von Instanzen in der [Dokumentation der Instanzen](https://www.symcon.de/service/dokumentation/konzepte/instanzen/#Instanz_hinzufügen)
 
-__Konfigurationsseite__:
+```text
-
+Hausverbrauch = Produktion - Einspeisung + Netzbezug
-Name     | Beschreibung
--------- | ------------------
-         |
-         |
-
-### 5. Statusvariablen und Profile
-
-Die Statusvariablen/Kategorien werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen.
-
-#### Statusvariablen
-
-Name   | Typ     | Beschreibung
------- | ------- | ------------
-       |         |
-       |         |
-
-#### Profile
-
-Name   | Typ
------- | -------
-       |
-       |
-
-### 6. WebFront
-
-Die Funktionalität, die das Modul im WebFront bietet.
-
-### 7. PHP-Befehlsreferenz
-
-`boolean GEF_BeispielFunktion(integer $InstanzID);`
-Erklärung der Funktion.
-
-Beispiel:
-`GEF_BeispielFunktion(12345);`