Tutorial: GridVis Integration (DE)
- georg.kotek (Unlicensed)
- Wolfgang Granzer
- Stefanie Furtak
Für die Integration von Zählerwerten aus der Software GridVis steht ein Plugin zur Verfügung. Dieses Plugin ermöglicht das Abrufen von Online Zählerwerten über die GridVis REST WEB API (https://gridvis-energy.de/rest/doc/).
Installation und Lizenzierung
Für den Einsatz des GridVis-Plugins muss ein entsprechender Lizenzcode freigeschaltet sein. Dieser Code ist automatisch in der Demolizenz enthalten. Für gekaufte Lizenzen muss das Plugin in der Lizenz aktiviert werden. Zum Verwalten einer Lizenz, siehe: Softlock: Beziehen, Überprüfen und Übertragen einer Softlock-Lizenz
Der Treiber für den NETx Server ist als Plugin implementiert. Dieses ist über den "Extension Manager" zu installieren. Stoppen Sie dazu den Server und öffnen Sie den "Extension Manager" im Core Server Studio über das Menü “Erweiterungen → Manager → Start Extension manager …”. Wählen Sie "GridVis" aus und klicken Sie "Installieren":
Nach erfolgter Installation starten Sie den NETx Server und das NETx Studio neu.
Konfiguration
Die Konfiguration des GridVis Plugins erfolgt über das Studio der jeweiligen NETx Installation. Nach erfolgreicher Installation des GridVis Plugins erscheint ein zusätzlicher Eintrag mit dem Namen "GridVis" im Menü.
Im GridVis Menü befinden sich 4 Einträge:
Explorer starten: Um die Konfiguration zu vereinfachen, ist im Plugin ein Explorer Tool inkludiert. Dieses dient zum Suchen und Selektieren der GridVis Projekte, Geräte und Zählerwerte (Datenpunkte).
Serverdefinitionen: Diese Definitionstabelle enthält alle konfigurierten GridVis Server.
Data point definitions: Diese Definitionstabelle enthält alle konfigurierten GridVis Datenpunkte.
Treiberkonfiguration: Hier können globale Einstellungen wie Timeouts vorgenommen werden.
GridVis Explorer
Dieses Tool dient zum Suchen und Selektieren der GridVis Projekte, Geräte und Zählerwerte - über das Menü GridVis > Explorer starten erfolgt der Start.
Der Explorer kann nur gestartet werden, wenn der NETx Server gestoppt wurde.
Im oberen Bereichen können die verschiedenen GridVis Server verwaltet werden.
Im mittleren/unteren Bereich können die jeweiligen Datenpunkte des ausgewählten Servers konfiguriert werden.
Im linken Bereich sind die Datenpunkte aufgelistet, die mittels Online Scan vom GridVis Server detektiert wurden. Im rechten Bereich sind die im NETX Server konfigurierten Datenpunkte aufgelistet.
Serververwaltung
In der Dropdown-Liste sind alle momentan konfigurierten GridVis Server aufgelistet. Bei Auswahl eines Servers werden automatisch die für diesen Server konfigurierten Datenpunkte im rechten Bereich "Momentane Konfiguration" angezeigt.
Mittels Schaltfläche "Hinzufügen" können neue Server hinzugefügt werden. Eine Serverdefinition besteht aus einem freiwählbaren, eindeutigen Namen und der Server URL. Die Server URL kann nachträglich mittels Schaltfläche "Ändern" bearbeitet werden.
Mittels Schaltfläche "Löschen" kann der ausgewählte Server wieder gelöscht werden.
Wird ein Server gelöscht werden auch alle definierten Datenpunkte für diesen Server gelöscht.
Datenpunkte verwalten
Im mittleren/unteren Bereich können die Datenpunkte des selektierten Servers verwaltet werden.
Im linken Teil im selektierten GridVis Server nach verfügbaren Datenpunkte gesucht werden. Durch Auswahl der Schaltfläche "Online Scan" verbindet sich der Explorer mit dem GridVis Server und sucht nach verfügbaren GridVis Projekten, deren Geräte und Zählerwerte. Das Ergebnis wird in einer Baumstruktur dargestellt.
Bei den Projekten und Geräten wird zusätzlich zum Namen die Anzahl der darunterliegenden Knoten in runder Klammer angezeigt.
Oberhalb der Baumstruktur befinden sich Textfelder für Projekte, Geräte und Datenpunkte zum Filtern der Scanergebnisse. Durch Eingabe eines Textes innerhalb dieser Felder und anschließendem Betätigen der "Enter" Taste oder der Schaltfläche "Filtern" wird das Gesamtergebnis des Scans entsprechend gefiltert.
Der eingegeben Text muss im entsprechenden Namen enthalten sein wobei Groß- und Kleinschreibung ignoriert wird.
Mittels Checkbox können nun einzelne Datenpunkte selektiert werden. Wird ein Gerät oder ein Projekt ausgewählt, werden alle Unterknoten ebenfalls selektiert. Das Deselektieren funktioniert analog.
Wurden alle gewünschten Datenpunkte ausgewählt, können diese mittels Schaltfläche "Hinzufügen" zur aktuellen Konfiguration des NETx Servers hinzugefügt werden. Dabei muss ein Pollingintervall (in Sekunden) definiert werden. Dieses Pollingintervall gibt an, wie oft die Werte der selektieren Datenpunkte vom GridVis Server abgefragt werden sollen.
Nach Eingabe des Pollingintervalls muss das Speichern der momentanen Datenpunktliste bestätigt werden. Die hinzugefügten Datenpunkte sind nach dem Start des NETx Servers verfügbar.
Im rechten Bereich ist die momentane Datenpunktkonfiguration für den ausgewählten GridVis Server ersichtlich. Wird in der Dropdown-Liste der ausgewählte Server geändert, wird diese Liste automatisch aktualisiert. Auch hier werden alle konfigurierten Projekte, Geräte und deren Datenpunkte (Wertetypen) in einer Baumstruktur dargestellt. Bei Projekten und Geräten wird wiederum die Anzahl der darunterliegenden Knoten in runder Klammer angezeigt. Bei den Datenpunkten hingegen wird das momentan konfigurierte Pollingintervall in Sekunden dargestellt. Eine Filtermöglichkeit in Bezug auf Projekte, Geräte und Datenpunkte steht ebenfalls zur Verfügung.
Selektierte Datenpunkte können mittels Schaltfläche "Löschen" aus der momentanen Konfiguration entfernt werden. Wird ein Projekt oder ein Gerät selektiert, werden automatisch alle darunterliegenden Knoten gelöscht. Zusätzlich ist es möglich das Pollingintervall zu änderen (Schaltfläche "Ändere Polling ..."). Das Speichern muss bei beiden Aktionen bestätigt werden. Die geänderte Datenpunktliste steht nach dem Start des NETx Servers zur Verfügung.
Server- und Datenpunktdefinitionen
Alle Konfigurationsdaten werden vom GridVis Explorer im Workspace des NETx Servers als DAT Dateien hinterlegt.
Dabei wird die Konfiguration in Server- und Datenpunktkonfiguration unterteilt. Beide Definitionsdateien können im Studio über das Menü "GridVis" eingesehen und bearbeiten werden.
Die Konfigurationsdaten können auch ohne GridVis Explorer nachträglich geändert. Es ist allerdings zu beachten, dass hier keine Verifikation der Daten durchgeführt wird. Zusätzlich können die Tabellen mit den Schaltflächen "Nach Excel" und "Aus Excel" nach MS Excel exportiert und importiert werden. Dies ist besonders hilfreich wenn mehrere Daten gleichzeitig geändert werden müssen (z.B. das Pollingintervall).
Nachfolgende werden die einzelnen Spalten der Definitionstabellen erklärt:
Serverdefinitionen
Spalte | Beschreibung |
|---|---|
Servername | Dies ist ein frei wählbarer Name, der den GridVis Server im NETx Server identifiziert. Der Name muss eindeutig sein. |
Url | hier wird die Url des GridVis Servers definiert. |
Datenpunktdefinitionen
Spalte | Beschreibung |
|---|---|
Servername | Hier wird der Name des GridVis Servers definiert, zu dem der Datenpunkt zugeordnet ist. Der Name muss mit dem Servernamen in der Serverdefinition übereinstimmen. |
Project name | Projektname des GridVis Datenpunkts |
Geräte-ID | Device ID des GridVis Datenpunkts |
Device name (optional) | Dieser Name ist optional und wird im Datenpunktbaum in Kombination mit der Device ID angezeigt. |
Wert | Dies entspricht dem "Value" Tag des GridVis Datenpunkts |
Typ | Dies entspricht dem "Type" Tag des GridVis Datenpunkts |
Einheit (optional) | Einheit des Datenpunkts. Diese wird automatisch beim Scannen des GridVis Explorers detektiert. |
Polling interval | Gibt an, wie oft der Datenpunkt vom GridVis Server aktualisiert werden soll. Das Intervall ist in Sekunden anzugeben. |
Value name (optional) | Optionaler Text der im Property "Description" des Server Items inkludiert wird. Der GridVis Explorer verwendet das "valueName" Attribute des Scan Ergebnisses wenn vorhanden. |
Type name (optional) | Optionaler Text der im Property "Description" des Server Items inkludiert wird. Der GridVis Explorer verwendet das "typeName" Attribute des Scan Ergebnisses wenn vorhanden. |
Treiberkonfiguration
Hier können globale Einstellungen vorgenommen werden.
Spalte | Beschreibung |
|---|---|
Timeout | dieser Wert (in ms) wird als Parameter "timeout" beim Abfragen des GridVis Wertes verwendet. |
Timeliness | dieser Wert (in ms) wird als Parameter "timeliness" beim Abfragen des GridVis Wertes verwendet. |
Ignore item quality | ist diese Einstellung aktiv, werden bei fehlgeschlagenen HTTP Anfragen die entsprechende Datenpunkte im NETx Server nicht auf "UNCERTAIN" gesetzt. Das bedeutet, dass der jeweils letzte Wert sichtbar ist. |
Ignore NaN values | ist diese Einstellung aktiv, werden empfangene "NaN" Werte ignoriert. Das bedeutet, dass ein "NaN" den Datenpunkt im NETx Server nicht auf "UNCERTAIN" setzt. Somit ist ebenfalls immer der letzte gültige Wert sichtbar ist. |
HTTP Timeout (in ms) | Timeout für die HTTP Anfragen. Wird nach dem Timeout keine gültige HTTP Antwort empfangen, gilt die Anfrage als fehlgeschlagen. |
Empfohlen werden folgende Einstellungen:
Darstellung der Datenpunkte im NETx Server
Wurden alle Einstellungen korrekt vorgenommen, werden die GridVis Datenpunkte als sogenannte Server Items im NETx Server zur Verfügung gestellt.
Eine aktuelle Übersicht der verfügbaren Server Items ist über dem Item Tree des Studios zu finden.
Alle GridVis Datenpunkte werden im Unterbaum "NETx\XIO\GridVis" strukturiert angezeigt. Dabei werden die Datenpunkte nach dem GridVis Server, dem Projekt und dem Gerät untergliedert.
Jeder GridVis Server hat ein sogenanntes "GATEWAY" Item. Ist dieses Item "True" waren HTTP Anfragen des letzten Pollingintervalls erfolgreich. War zumindest eine Anfrage fehlerhaft (HTTP Timeout erreicht oder fehlerhaften Daten erhalten), ist dieses Item "False".
Zugriff auf die GridVis Daten
Sind die GridVis Datenpunkte im NETx Server integriert, können sie wie alle Server Items beliebig verwendet werden.
Beispielsweise können Client Applikation von Drittherstellern auf die Daten via diverse Schnittstellen zugreifen:
OPC DA: Alle Server Items sind via OPC DA als OPC Items verfügbar.
OPC UA: Zusätzlich zum "klassischen" OPC DA verfügt der NETx Server auch über eine OPC UA Schnittstelle. Diese Schnittstelle muss als Zusatzplugin über den Extension Manager im Menü Extensions > Manager > Start Extension Manager installiert werden.
oBIX: oBIX ist eine offene, standardisierte Webserver Schnittstelle für die Heim- und Gebäudeautomation. Diese Schnittstelle muss als Zusatzplugin über den Extension Manager im Menü Extensions > Manager > Start Extension Manager installiert werden.
BACnet: Server Items können über BACnet/IP an BACnet Clients als BACnet Objekte bereitgestellet werden.
Zusätzlich können die Datenpunkte auch mit anderen Datenpunkte verknüpft werden ("Gatewayfunktionalität").
Dabei stehen im NETx Server eine Reihe von Schnittstellen zur Verfügung (KNX, BACnet, Modbus, SNMP, ...). Weitere Informationen sind in der Knowledgebase zu finden.
GridVis Projekteinstellungen
Im GridVis Projekt ist folgende Einstellung notwendig: AutoOnlineValueTimeoutSeconds=500
Artikel ist für folgende Produkte anwendbar:
NETx BMS Platform
NETx Multi Protocol Server