SymconJoTKPP

Erweiterung zur Abfrage der Werte eines Kostal Wechselrichters via ModBus in IP-Symcon.

Dokumentation

Inhaltsverzeichnis

1. Funktionsumfang
2. Voraussetzungen
3. Unterstützte Geräte
4. Modul-Installation / Update
5. Einrichten der Instanz in IP-Symcon
   1. Erstellen einer neuen Instanz
   2. Konfiguration der Instanz
   3. Modul-Funktionen
   4. Batterie-Management
   5. Fehlersuche
6. Anhang
   1. Modul-Informationen
   2. Changelog
   3. Spenden
7. Support
8. Lizenz

1. Funktionsumfang

Das Modul "JoTKPP" stellt eine Instanz zur Abfrage der Werte von Kostal-Wechselrichtern für IP-Symcon zur Verfügung. Die Daten werden mittels ModBus abgefragt. Der Benutzer kann frei entscheiden, welche Werte abgefragt werden und ob dafür eine Instanz-Variable angelegt werden soll. Über IPS Ereignisse oder einen Aufruf der verschiedenen RequestRead-Funktionen können individuelle Abfrage-Muster realisiert werden (nur bei Bedarf, einmal am Tag, alle x Sekunden, usw.). Das Modul prüft zudem, ob online eine neue FW-Version für den Wechselrichter verfügbar ist.

2. Voraussetzungen

• IPS 6.0 oder höher
• Kostal Wechselrichter mit aktivierter ModBus-Schnittstelle

3. Unterstütze Geräte

Das Modul wird grundsätzlich für einen Kostal PLENTICORE Plus 7.0 programmiert / getestet. Da Kostal aber für alle Geräte der Serien "PLENTICORE plus" & "PIKO IQ" dieselben ModBus-Spezifikationen herausgibt, sollten auch andere Geräte dieser Serien funktionieren.

Hersteller: KOSTAL

Modell	MC-Version*	Status
PLENTICORE plus 4.2	?	bestätigt
PLENTICORE plus 5.5	?	bestätigt
PLENTICORE plus 7.0	1.57	getestet
PLENTICORE plus 8.5	?	bestätigt
PLENTICORE plus 10	?	bestätigt
PIKO IQ 4.2
PIKO IQ 5.5
PIKO IQ 7.0
PIKO IQ 8.5
PIKO IQ 10

*) Firmware MC-Version (neuere FW sollte funktionieren, hat aber ev. mehr/weniger Werte als im Modul verfügbar sind). Ansonste bitte eine Meldung im Forum hinterlassen. Die ModBus-Spezifikationen vom 17.09.2020 (Rev. 1.9 ab FW-Version 1.44) sind integriert.

4. Modul-Installation / Update

Die Installation erfolgt über den IPS Module-Store. In der Suche einfach JoTKPP oder Kostal eingeben (offizieller Name ist Kostal PLENTICORE (JoTKPP)) und die Installation starten. Update erfolgt ebenfalls über den Module-Store. Einfach beim installierten Modul auf Aktualisieren klicken.

Das Modul wird für den privaten Gebrauch kostenlos zur Verfügung gestellt.

Bei kommerzieller Nutzung (d.h. wenn Sie für die Einrichtung/Installation und/oder den Betrieb von IPS Geld erhalten) wenden Sie sich bitte an den Autor.

ACHTUNG: Der Autor übernimmt keine Haftung für irgendwelche Folgen welche durch die Nutzung dieses Modules entstehen!

5. Einrichten der Instanz in IP-Symcon

1. Erstellen einer neuen Instanz

1. Neue Instanz hinzufügen
2. Im Schnellfilter Kostal eingeben
3. Das Gerät Kostal PLENTICORE plus auswählen
4. Name & Ort anpassen (optional)
5. Falls noch keine ModBus Gateway Instanz vorhanden ist, wird eine solche erstellt. Diese entsprechend konfigurieren:
   • Modus: Modbus TCP
   • Geräte-ID: 71 (kann auf dem Wechselrichter in den Modbus-Einstellungen nachgeschaut werden)
   • Swap LSW/MSW for 32Bit/64Bit values (kann auf dem Wechselrichter in den Modbus-Einstellungen nachgeschaut werden):
     • Off = big-endian (ABCD) Sunspec
     • On = little-endian (CDAB) Standard Modbus

2. Konfiguration der Instanz

• Abfrage-Intervall: Definiert die Zeit, in welcher die Werte via ModBus abgefragt werden sollen. Es werden nur die Werte abgefragt, bei welchen Aktiv angehakt ist.

• Jetzt lesen: Liest im Hintergrund alle aktiven Idents aus und schreibt die Werte in die Instanz-Variablen.

• Gruppe / Ident: Diese Bezeichnung kann zur Abfrage einer Gruppe von Werten oder einzelner Werte mit der entsprechenden RequestRead-Methode verwendet werden.

• Name: Die Bezeichnung der Instanz-Variable gemäss Kostal Spezifikation.

• Eigener Name: Wenn euch die Bezeichnung der Instanz-Variabeln nicht gefällt, könnt ihr den Namen direkt in der Variable anpassen. Der neue Name wird dann in dieser Spalte angezeigt.

• Profil: Standard-Profil des Modules.

• Eigenes Profil: Ihr könnt der Instanz-Variable ein eigenes Profil zuweisen (z.B. für Batterie-Ladezustand). Dieses wird dann hier angezeigt.

• Aktiv: Wenn der Haken gesetzt ist, wird einen entsprechende Instanz-Variable erstellt. VORSICHT: Wird der Haken entfernt und die Konfiguration gespeichert, so wird die entsprechende Instanz-Variable gelöscht.

• Zusätzliche Abfragen erstellen:

  • Gewünsche Gruppen ODER Idents anklicken -> diese werden unten aufgelistet und können von hier direkt kopiert werden um ein Ereignis anzupassen oder in einer Modulfunktion abzufragen.
  • Einen Namen für das Ereignis eingeben (optional)
  • Den Ereignis-Typ auswählen
  • Das Ereignis mit dem Button Ereignis erstellen einrichten (das Ereignis wird nur erstellt, jedoch nicht aktiviert)
  • Mit dem zusätzliche Button Ereignis (xxxxx) prüfen kann das neu erstelle Ereignis direkt geöffnet und angepasst / aktiviert werden

  Mit den Bedingungen eines Ereignisses ist es möglich, sehr komplexe Abfrage-Muster zu erstellen (z.B. PV-Werte nur tagsüber abfragen, wenn da auch ein Strom fliesst). Ereignisse schreiben die Werte nur in eine Status-Variable, wenn diese vorher unter Geräte-Eigenschaften aktiviert wurden. Dort kann der Abfrage-Intervall dann einfach auf 0 gestellt werden.

3. Modul-Funktionen

Die folgenden Funktionen stehen in IPS-Ereignissen/-Scripts zur Verfügung:

JoTKPP_RequestRead();

Liest alle Werte, bei welchen der Haken Aktiv gesetzt ist. Aktualisiert die entsprechenden Instanz-Variablen und gibt die Werte als Array zurück.

JoTKPP_RequestReadAll();

Liest alle Werte vom Wechselrichter.*

JoTKPP_RequestReadIdent(string $Ident);

Liest alle Werte, deren Ident angegeben wird (mehrere Idents werden durch ein Leerzeichen getrennt).*

JoTKPP_RequestReadGroup(string $Gruppe);

Liest alle Werte, deren Gruppe angegeben wird (mehrere Gruppen werden durch ein Leerzeichen getrennt).*

JoTKPP_CheckFirmwareUpdate();

Holt den Namen der aktuellsten FW-Datei bei Kostal, speichert diese in einer Instanz-Variable und gibt sie als String zurück.

JoTKPP_GetDeviceInfo();

Gibt die wichtigsten Geräte-Informationen als Array zurück.*

IPS_RequestAction(int $InstanzID, string $Ident, mixed $Value);

Damit können die Idents, welche mit Zugriff RW oder W markiert sind geschrieben werden.

*) Die Werte werden auch gelesen, wenn der Haken Aktiv nicht gesetzt ist. Sie werden dann jedoch nur als Array zurückgegeben und nicht in eine Instanz-Variable geschrieben.

4. Batterie-Management

Ab FW-Version 1.46 auf dem Wechselrichter und Modul-Version 2.0 ist es möglich, das Batterie-Management und die AC-Leistung des Wechselrichters via ModBus zu steuern. Voraussetzung dafür ist, dass der Installateur auf dem Wechselrichter das externe Batterie-Management unter Servicemenu -> Batterieeinstellungen -> Batteriesteuerung aktiviert. Dieser Modus kann nicht mit dem normalen Anlagen-Benutzer aktiviert werden.

Details zum Batterie-Management sind unter Schnittstellen Protokolle bei den Downloads für den Wechselrichter auf der Kostal-Webseite zu finden. Beim Schreiben ist zu berücksichtigen, dass die Werte gemäss den Einheiten der Instanz-Variablen von IPS (also in kW anstatt W) angegeben werden müssen. Das Modul rechnet die Werte selbständig in W um, bevor diese an den Wechselrichter gesendet werden.

ACHTUNG: Der Autor lehnt jegliche Haftung für Schäden an den betroffenen Geräten (Wechselrichter, Batterie, PV-Anlage, usw.) ab, welche durch unsachgemässe Nutzung dieser Funktion entstehen können!

5. Fehlersuche

Die Debug-Funktion der Instanz liefert detaillierte Informationen über die Konvertierung der Werte und vom ModBus zurückgegebenen Fehler.

6. Anhang

1. Modul-Informationen

Modul	Typ	Hersteller	Gerät	Prefix	GUID
JoTKPP	Device	Kostal	PLENTICORE plus	JoTKPP	{E64278F5-1942-5343-E226-8673886E2D05}
JoTKPP	Device	Kostal	PIKO IQ	JoTKPP	{E64278F5-1942-5343-E226-8673886E2D05}

2. Changelog

Version 2.3

• FIX: Funktioniert nun auch mit IPS 7.0 TESTING ab 44dd2e95e8c4 (04.07.23) funktionieren
• FIX: Profil Battery.Capacity (Ah) wieder hinzugefügt
• FIX: Überprüfung von Profil-Namen verbessert
• FIX: Negative 0-Werte vom Wechselrichter werden nun als 0-Wert ohne Vorzeichen (positiver Wert) angezeigt

Version 2.2

• FIX: RW-Variablen können nun mit IPS_RequestAction geschrieben werden.
• Schreiben für Batterie-Management und AC-Control funktioniert nun über den IPS-internen DatenFlow. Allfällig vorhandene I/O-Instanzen JoTKPP_WriteSocket for #[InstanzID] können manuell gelöscht werden.
• Alle Werte der Gruppe Surplus wurden entfernt. Seit IPS 6.0 sind Verzögerungen in Ablaufplänen möglich und eine Programmierung für den PV-Überschuss ist damit viel komfortabler realisierbar. Als Auslöser entweder PMActivePowerTot mit Grenzunterschreitung eines gewünschten Wertes oder GridState = -1 benutzen und danach im Ablaufplan Warten, den Wert nochmals mit Wenn..., dann prüfen und wenn immer noch genügend Überschuss vorhanden die gewünschten Befehle ausführen. Tipp: Überschuss ist immer ein negativer Wert (Einspeisung).

Version 2.1

• FIX: Bei aktivem Polling wird nach einem Neustart von IPS nun kein Fehler mehr im Log generiert.
• Migrations-Funktionen für Update von Versionen < 1.4 entfernt

Version 2.0

• Schreiben für Batterie-Management und AC-Control eingebaut (Details siehe Batterie-Management).
• Button 'Jetzt lesen' im Konfigurations-Form liest alle ausgewählten Idents einmalig aus.
• LED für Lese-/Schreib-Aktivität im Konfigurations-Form hinzugefügt.
• Optimierung der Daten-Übertragung.
• Profile auf DE übersetzt.
• FIX: Selten auftretende Fehlermeldung 'NaN/INF Werte werden nicht unterstützt' vermutlich behoben.
• FIX: Instanz-Variable für FW-Update wird nun bei ApplyChanges nicht mehr gelöscht, wenn FW-Check aktiviert ist. Falls FW-Check beim Update aktiviert ist, wird die Variable einmalig neu erstellt und Ereignisse müssen ev. manuell angepasst werden.
• FIX: Änderungen am Gateway & ClientSocket werden nun erkannt und Gerät wird mit neuer Konfiguration neu ausgelesen.
• FIX: Fehler-Korrektur der folgenden Idents (falsche Daten-Übermittlung (Endianess) durch Wechselrichter): EMState, BTWorkCapacity, BTGrossCapacity, ACGenEnergy
• FIX: Fehler in FW-Update-Check behoben, wenn URL nicht erreichbar ist.
• FIX: Profil-Icons für Batterie-Status waren vertauscht.
• FIX: Konfigurationsform wird nun auch bei veralteter FW-Version korrekt geladen.

Version 1.6

• Restliche noch fehlende Geräte-Parmeter gemäss KOSTAL-Spezifikation 1.9 hinzugefügt (lesend).
• Zugriffs-Art wird nun in Konfigurationsform angezeigt.
• FIX: Total-Parameter (charge/discharge energy, energy from PV, AC to grid) werden nun korrekt ausgelesen.

Version 1.5

• PV-Überschuss hinzugefügt
• Berechnung von "Home own consumtion from all" hinzugefügt
• Berechnung von "Total power from PV strings" hinzugefügt
• Status für Batterie / Netz hinzugefügt
• ModBus-Bytereihenfolge des WR kann nun im ModBus-Gateway von IPS umgestellt werden (IPS 'Swap LSW/MSW...' AN = 'little-endian (CDAB)...' auf dem Wechselrichter).
• Wenn Variablen-Werte weniger als eine Sekunde alt sind, werde diese nicht erneut vom Wechselrichter abgefragt, sondern direkt vom "Cache" zurückgegeben.
• Scale Factors hinzugefügt
• Vorbereitungen für ModBus-Write (Batterie-Management)
• FIX: Abfrage-/FW-Update Intervall können nicht mehr negativ eingegeben werden.
• FIX: Fehler bei Rückgabe von NAN/INF-Werten

Version 1.4

• Folgende zusätzliche Parameter hinzugefügt: Installed powermeter, Total DC power, Battery ready flag, Battery cross capacity, Battery actual SOC, Battery Firmware MC, Battery Type, Total battery AC/DC (dis)charge, Total energy from PV(1-3).
• Folgende Parameter korrigiert: State of energy manager, Total DC power from PV.
• Profil Status.KostalFuse umgedreht (kann leider nicht testen, ob dies bei einer ausgelösten Sicherung nun korrekt funktioniert).
• Verbesserung bei den JSON-Konfigurations-Daten.
• Verbesserung beim Device-Discovery (inkl. Prüfung bei Änderung des Gateways).
• Fehler mit JoTKPP_RequestReadIdents behoben, wenn Idents gleichen String enthalten.
• Neue Public Function JoTKPP_GetDeviceInfo() hinzugefügt.
• Geräte-Informationen können nun direkt in der Instanzkonfiguration angezeigt werden.
• Im Konfigurationsformular ist es nun möglich, einzelne Idents / Gruppen auszuwählen und für deren Abfrage ein Ereignis zu erstellen.
• Interne Variablen optimiert.
• Verbesserte Fehlermeldungen bei Modul-Funktionen.

Version 1.3

• Fehler im Profil "JoTKPP.Battery.Charge" behoben, welcher dazu führte, dass IPS beim Anzeigen von Diagrammen mit diesem Profil abstürzte.

Version 1.2

• Überprüfung der übergeordneten Instanzen optimiert.
• Fehler bei Umrechnung von SInt-Werten (z.B. Actual Battery Power) behoben, wenn diese einen negativen Wert haben.
• Zusätzlicher Wert "Actual Inverter Generation power" hinzugefügt.

Version 1.1

• Timer für FW-Update-Check in Konfigurationsformular integriert.
• Default-Positionen auf 10er-Zahlen angepasst, damit Sortierung auch innerhalb einer Gruppe möglich ist.
• Zusätzliche Meldung im Debug-Log.

Version 1.0 (RC1)

• Bezeichnungen für Powermeter-Werte angepasst.
• Verbesserte Fehlerausgabe ModBus.

Version 0.9:

• Messwerte für Powermeter hinzugefügt.
• Verbesserungen beim DeviceDiscovery.
• Änderung des Gateways wird nun erkannt und verarbeitet.

Version 0.8:

• Erste öffentliche Beta-Version.
• Feedbacks zu Fehlern aber auch funktionierende Geräte & Konfigurationen sind willkommen.

3. Spenden

Das Modul ist für die nicht kommzerielle Nutzung kostenlos. Spenden als Unterstützung für den Autor sind aber willkommen:

7. Support

Fragen, Anregungen, Kritik und Fehler zu diesem Modul können im entsprechenden Thread des IPS-Forums deponiert werden. Da das Modul in der Freizeit entwickelt wird, kann es jedoch eine Weile dauern, bis eine Antwort im Forum verfügbar oder ein entsprechendes Update vorhanden ist. Besten Dank für euer Verständnis :-)

8. Lizenz

IPS-Modul: CC BY-NC-SA 4.0