diff --git a/Puffer_Speicher/README.md b/Puffer_Speicher/README.md index b059e3a..e6d9f1d 100644 --- a/Puffer_Speicher/README.md +++ b/Puffer_Speicher/README.md @@ -1,67 +1,80 @@ -# Manager_1 -Beschreibung des Moduls. +# Peakshaving -### Inhaltsverzeichnis +IP-Symcon Modul zur automatischen monatlichen Vorgabe von Peakshaving-Werten. -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) +Das Modul setzt je nach aktuellem Monat zwei Werte: -### 1. Funktionsumfang +- Kapazität Peakshaving in % +- Leistung Peakshaving in W -* +Die Werte werden intern als Statusvariablen angezeigt und optional auf konfigurierte Ziel-Instanzen übertragen. -### 2. Voraussetzungen +## Funktionsumfang -- IP-Symcon ab Version 7.1 +- Monatliche Vorgabewerte für Peakshaving +- Separate Ziel-Instanz für Kapazität +- Separate Ziel-Instanz für Leistung +- Frei konfigurierbare Property-Namen der Ziel-Instanzen +- Automatische tägliche Übernahme der aktuellen Monatswerte +- Manuelle Sofortübernahme über Button +- Manuelle Änderung der aktiven Werte über Statusvariablen -### 3. Software-Installation +## Voraussetzungen -* Über den Module Store das 'Manager_1'-Modul installieren. -* Alternativ über das Module Control folgende URL hinzufügen +- IP-Symcon +- Ziel-Instanz für Kapazität, falls Kapazitätswert automatisch gesetzt werden soll +- Ziel-Instanz für Leistung, falls Leistungswert automatisch gesetzt werden soll +- Die angegebenen Property-Namen müssen in den Ziel-Instanzen vorhanden sein -### 4. Einrichten der Instanzen in IP-Symcon +## Konfiguration - 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) +### Ziel-Module -__Konfigurationsseite__: +| Einstellung | Beschreibung | +|------------|--------------| +| Batterie Instanz | Ziel-Instanz für die Kapazität | +| Property-Name Kapazität | Property der Ziel-Instanz für die Kapazität | +| Instanz für Peakleistung | Ziel-Instanz für die Peakleistung | +| Manager Instanz | Property der Ziel-Instanz für die Peakleistung | -Name | Beschreibung --------- | ------------------ - | - | +Standardwerte: -### 5. Statusvariablen und Profile +| Property | Standard | +|---------|----------| +| CapacityTargetProperty | AufdasNachladen | +| PowerTargetProperty | Peakleistung | -Die Statusvariablen/Kategorien werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen. +## Monatswerte -#### Statusvariablen +| Monat | Kapazität [%] | Leistung [W] | +|------|----------------|--------------| +| Januar | 11 | 42000 | +| Februar | 11 | 42000 | +| März | 8 | 43000 | +| April | 8 | 44000 | +| Mai bis September | 8 | 44000 | +| Oktober | 12 | 43000 | +| November | 12 | 43000 | +| Dezember | 12 | 43000 | -Name | Typ | Beschreibung ------- | ------- | ------------ - | | - | | +Die Werte können in der Instanzkonfiguration angepasst werden. -#### Profile +## Statusvariablen -Name | Typ ------- | ------- - | - | +| Name | Ident | Typ | Profil | Beschreibung | +|-----|-------|-----|--------|--------------| +| Kapazität Peakshaving | ActiveCapacity | Float | ~Intensity.100 | Aktive Kapazität in % | +| Leistung Peakshaving | ActivePower | Float | ~Watt | Aktive Peakshaving-Leistung in W | -### 6. WebFront +Änderungen an diesen Statusvariablen werden direkt an die konfigurierte Ziel-Instanz übertragen. -Die Funktionalität, die das Modul im WebFront bietet. +## Automatische Übernahme -### 7. PHP-Befehlsreferenz +Das Modul prüft einmal täglich den aktuellen Monat und übernimmt die passenden Monatswerte. -`boolean GEF_BeispielFunktion(integer $InstanzID);` -Erklärung der Funktion. +Dabei werden: -Beispiel: -`GEF_BeispielFunktion(12345);` \ No newline at end of file +1. die Statusvariablen aktualisiert +2. die Kapazität an die konfigurierte Ziel-Instanz geschrieben +3. die Leistung an die konfigurierte Ziel-Instanz geschrieben +4. `IPS_ApplyChanges()` auf der jeweiligen Ziel-Instanz ausgeführt