1.Einführung
HS-Monitor ist eine im Browser aufrufbare Funktion, die Telegramme von Gruppenadressen empfangen und senden kann.
Jede Gruppenadresse steht entweder für ein internes oder ein externes (EIB) K-Objekt des HS/FS, das in der Experte-Software für die Benutzung mit HS-Monitor freigegeben wurde.
Die Gruppenadressen werden in einer Liste auf der Maske K-Objekte dargestellt, die jeweils genau einen Eintrag (eine Zeile) pro Gruppenadresse enthält. Dieser Eintrag enthält außer der Gruppenadresse und dem aktuellen Wert optional den Namen des K-Objekts und weitere Informationen.
In einer zweiten Liste in der Maske Protokoll werden alle Telegramme von zuvor vom Benutzer markierten Gruppenadressen protokolliert. Diese Liste kann als ".csv"-Datei exportiert werden.
Jede Gruppenadresse steht entweder für ein internes oder ein externes (EIB) K-Objekt des HS/FS, das in der Experte-Software für die Benutzung mit HS-Monitor freigegeben wurde.
Die Gruppenadressen werden in einer Liste auf der Maske K-Objekte dargestellt, die jeweils genau einen Eintrag (eine Zeile) pro Gruppenadresse enthält. Dieser Eintrag enthält außer der Gruppenadresse und dem aktuellen Wert optional den Namen des K-Objekts und weitere Informationen.
In einer zweiten Liste in der Maske Protokoll werden alle Telegramme von zuvor vom Benutzer markierten Gruppenadressen protokolliert. Diese Liste kann als ".csv"-Datei exportiert werden.
1.1.Voraussetzungen
Voraussetzung für die Nutzung von HS-Monitor:
Hard- und Software:
Hard- und Software:
- Home- oder FacilityServer mit einer Firmware ab Version 4.7.x.
- Experten-Software ab Version 4.7.x.
- Mozilla Firefox ab Version 59
- Google Chrome ab Version 65
- Microsoft Edge ab Version 41
- Microsoft Internet Explorer ab Version 11
- Google Chrome Android 66
- iOS Safari 11
1.2.Installation, Einrichtung, Zugriff und Aufruf
Achtung
Nach einer Änderung im Experte bei den folgenden Einstellungen muss das Projekt neu übertragen werden!
Zugriff
Um HS-Monitor nutzen zu können, muss eine der beiden folgenden Einstellungen im HS/FS-Experte unter der Rubrik Stammdaten -> Projekteinstellungen -> Oberfläche aktiviert werden:
Entweder
Entweder
- muss die Option Alle aktiviert sein,
- die Option Benutzerdefiniert muss aktiviert sein
und
die Checkbox hsmonitor muss aktiviert sein.
Einrichtung
Im HS/FS-Experte unter der Rubrik Stammdaten -> Projekteinstellungen -> Netzwerk -> KO-Gateway muss die Einstellung Zugriff über WebSocket aktiviert sein!
Die weiteren unter diesem Punkt einstellbaren Optionen werden in der Experte-Hilfe zum KO-Gateway beschrieben.
Die weiteren unter diesem Punkt einstellbaren Optionen werden in der Experte-Hilfe zum KO-Gateway beschrieben.
Aufruf
HS-Monitor wird im Browser unter der folgenden URL aufgerufen:
oder
HTTPS://HS_IP/opt/hsmonitor/index.html
oder
HTTPS://HS_IP/opt/hsmonitor/index.html#key=
[Schlüssel]Login
Beim Start des HS-Monitor erscheint die Login Maske. Hier kann der im Experte-Projekt definierte Schlüssel für die KO-Gateway Datenverbindung angegeben werden.
HS-Monitor merkt sich diesen Schlüssel solange, bis der Browser beendet wird.
HS-Monitor verlangt eine Eingabe dieses Schlüssel beim ersten Start, oder wenn sich der Schlüssel, z.B. nach Änderung im Projekt und dessen Neu-Übertragung, geändert hat.
Der Schlüssel kann auch direkt beim Aufruf von HS-Monitor als Parameter in der URL angegeben werden.
HS-Monitor merkt sich diesen Schlüssel solange, bis der Browser beendet wird.
HS-Monitor verlangt eine Eingabe dieses Schlüssel beim ersten Start, oder wenn sich der Schlüssel, z.B. nach Änderung im Projekt und dessen Neu-Übertragung, geändert hat.
Der Schlüssel kann auch direkt beim Aufruf von HS-Monitor als Parameter in der URL angegeben werden.
Aufruf-Beispiele
Beispiel für einen Aufruf auf einem HS/FS mit der IP-Adresse 192.168.0.11 mit sicherer Kommunikation:
Beim Aufruf kann der Schlüssel mit angegeben werden (siehe Einstellungen).
Beispiel für denselben Aufruf mit Angabe des Schlüssels "my123key":
HTTPS://192.168.0.11/opt/hsmonitor/index.html
Beim Aufruf kann der Schlüssel mit angegeben werden (siehe Einstellungen).
Beispiel für denselben Aufruf mit Angabe des Schlüssels "my123key":
HTTPS://192.168.0.11/opt/hsmonitor/index.html#key=my123key
2.HS-Monitor
Die Darstellung des HS-Monitor gliedert sich in drei Bereiche und eine PopUp-Maske:
- Bereich 1: Kopfzeile
- Bereich 2: Maske K-Objekte
- Bereich 3: Protokoll-Maske
2.1.Kopfzeile
Die Kopfzeile bildet den kompletten oberen Bereich der Webseite.
Hier befinden sich die Laschen zur Umschaltung der Anzeige, der Verbindungs-Status Anzeiger und der Button für den Aufruf der Hilfe.
Hier befinden sich die Laschen zur Umschaltung der Anzeige, der Verbindungs-Status Anzeiger und der Button für den Aufruf der Hilfe.
Lasche K-Objekte
Zeigt die Maske K-Objekte mit der Liste der im Projekt zur Verfügung gestellten K-Objekte und die Aktions-Leiste. Mit dieser Darstellung startet HS-Monitor.
Lasche Protokoll
Zeigt die Protokoll-Maske.
Jeder Eintrag in der Liste zeigt ein Telegramm zu einem der K-Objekte an, das in der Maske K-Objekte zum Protokollieren markiert wurde (d.h., die Checkbox des betreffenden K-Objekts in der linken Spalte ist aktiviert).
Ist aktuell gerade die Maske K-Objekte aktiv, wird rechts oben an der Protokoll-Lasche beim Eintreffen eines neuen Telegramms ein Badge angezeigt, in dem die Anzahl der neuen Telegramme seit dem Verlassen der Protokoll-Maske angezeigt wird (bzw. dem Start von HS-Monitor, falls die Protokoll-Maske noch gar nicht aufgerufen wurde).
Beim erneuten Anzeigen der Protokoll-Maske wird der Badge entfernt und die Zählung beginnt wieder bei '0'.
Jeder Eintrag in der Liste zeigt ein Telegramm zu einem der K-Objekte an, das in der Maske K-Objekte zum Protokollieren markiert wurde (d.h., die Checkbox des betreffenden K-Objekts in der linken Spalte ist aktiviert).
Ist aktuell gerade die Maske K-Objekte aktiv, wird rechts oben an der Protokoll-Lasche beim Eintreffen eines neuen Telegramms ein Badge angezeigt, in dem die Anzahl der neuen Telegramme seit dem Verlassen der Protokoll-Maske angezeigt wird (bzw. dem Start von HS-Monitor, falls die Protokoll-Maske noch gar nicht aufgerufen wurde).
Beim erneuten Anzeigen der Protokoll-Maske wird der Badge entfernt und die Zählung beginnt wieder bei '0'.
Verbindungs-Status
Links neben dem Schriftzug "HS-Monitor" befindet sich ein Symbol, das zwei Pfeile anzeigt. Dieses Symbol zeigt den aktuellen Verbindungs-Status zwischen HS-Monitor (im Browser) und HS/FS an.
Dieses Symbol kann zwei Farben annehmen:
Dieses Symbol kann zwei Farben annehmen:
- Grün: Es besteht eine aktive Verbindung.
- Rot: Es besteht momentan keine Verbindung.
Hinweis
Beachten Sie, dass beim erneuten Verbinden mit dem HS/FS bei allen K-Objekten die Checkbox für die Protokoll-Funktion deaktiviert und die Spalte "Anz. / Count" auf '0' gesetzt wird!
Die Protokoll-Liste wird bei einem Verbindungs-Abbruch bzw. beim erneuten Verbinden nicht gelöscht!
Die Protokoll-Liste wird bei einem Verbindungs-Abbruch bzw. beim erneuten Verbinden nicht gelöscht!
2.2.Maske K-Objekte
Hier wird die Liste der im aktuellen HS/FS-Projekt zum Anzeigen freigegebenen K-Objekte angezeigt.
Jedes K-Objekt wird durch genau eine Zeile in der Liste repräsentiert.
Die Angaben zu den einzelnen Spalten der Liste finden Sie unter dem Punkt Liste der K-Objekte.
Durch Anklicken einer Zeile kann diese für spezielle Aktionen ausgewählt werden:
Jedes K-Objekt wird durch genau eine Zeile in der Liste repräsentiert.
Die Angaben zu den einzelnen Spalten der Liste finden Sie unter dem Punkt Liste der K-Objekte.
Durch Anklicken einer Zeile kann diese für spezielle Aktionen ausgewählt werden:
2.2.1.Liste der K-Objekte
Auflistung aller im Experte-Projekt freigegebenen K-Objekte, sortiert nach Gruppenadresse.
Bedeutung der einzelnen Spalten:
Bedeutung der einzelnen Spalten:
Spalte | Erklärung |
---|---|
Spalte 1 | Checkbox für die Kennzeichnung zur Protokollierung. Jedes hiermit aktivierte K-Objekt wird im Protokoll / Protocol aufgezeichnet. |
Grp.-Adr. | Gruppenadresse im Format x/y/z. |
Name | Bezeichnung des K-Objekts. |
Anz. / Count | Anzahl der eingegangenen Telegramme seit Start des HS-Monitor. |
Zeit / Time | Uhrzeit des letzten eingegangenen Telegramms. |
Wert / Value | Aktueller Wert des K-Objekts. |
Typ(e) | Format des K-Objekts Folgende Angaben sind möglich:
|
Min | Minimum Der im Experte für das K-Objekt definierte kleinstmögliche Wert. |
Max | Maximum Der im Experte für das K-Objekt definierte größtmögliche Wert. |
S L | Kennzeichen für Schrittgröße / Step und Liste / List Ist im Experte für dieses K-Objekt eine Schrittgröße / Step definiert, wird hier ein S angezeigt. Ist im Experte für dieses K-Objekt eine Liste / List definiert, wird hier ein L angezeigt. |
2.2.2.Aktions-Leiste
Die Aktions-Leiste am rechten Rand der Maske K-Objekte bietet die Möglichkeit, die nebenstehende Liste zu Filtern und/oder einzelnen K-Objekten neue Werte zuzuweisen.
Ausnahmen sind dabei K-Objekte mit dem Format "date" und "time", die mit HS-Monitor nicht verändert, sondern nur angezeigt werden können.
Um ein K-Objekt zu verändern, muss zuvor die entsprechende Zeile selektiert (angeklickt) werden. Die Zeile wird dann mit grauem Hintergrund dargestellt.
Ausnahmen sind dabei K-Objekte mit dem Format "date" und "time", die mit HS-Monitor nicht verändert, sondern nur angezeigt werden können.
Um ein K-Objekt zu verändern, muss zuvor die entsprechende Zeile selektiert (angeklickt) werden. Die Zeile wird dann mit grauem Hintergrund dargestellt.
Filter (Lupen-Symbol)
Die Liste der K-Objekte kann gefiltert werden, d.h. es werden, sobald ein Filter eingegeben wird, nur noch die zum Filter passenden K-Objekte angezeigt.
- Die Filterung beginnt nach der Eingabe des ersten Zeichens.
- Bei der Eingabe jedes weiteren Zeichens wird der Filter aktualisiert.
- Es können mehrere durch Leerzeichen getrennte Filter angegeben werden, die UND-verknüpft angewendet werden.
- Die Reihenfolge der angegebenen Filter spielt keine Rolle.
- Die Filterkriterien werden auf die Felder "Grp.-Adr." und "Name" angewendet.
- Um die Filterung aufzuheben, muss das Filterfeld geleert werden.
Hinweis
Das Selektieren einer Zeile hat keinen Einfluss auf die Filterung.
Das Verhalten von K-Objekten bei Wertzuweisungen außerhalb der für sie definierten Min/Max-Grenzen wird in der Experte-Hilfe im Kapitel "Kommunikationsobjekte" beschrieben.
Das Verhalten von K-Objekten bei Wertzuweisungen außerhalb der für sie definierten Min/Max-Grenzen wird in der Experte-Hilfe im Kapitel "Kommunikationsobjekte" beschrieben.
Wert setzen / Send Value
Zuerst muss im Eingabefeld ein Wert angegeben werden, dann wird der Wert des K-Objekts durch Klicken auf einen der beiden Buttons entsprechend verändert:
- Absolut(e): Der aktuelle Wert des K-Objektes wird auf den eingegebenen Wert gesetzt.
- Relativ(e): Der eingegebene Wert wird auf den aktuellen Wert des K-Objekts addiert.
Hinweis
Zum Subtrahieren eines Werts geben Sie eine Zahl mit einem "Minus"-Zeichen davor an und klicken Sie auf "Relativ(e)".
Schrittgröße / Step
Hinweis
Diese Eingabe-Box ist nur sichtbar, wenn für das K-Objekt im Projekt eine Schrittgröße definiert wurde.
Die Schrittgröße wird angezeigt.
Durch Klick auf einen der beiden Buttons ("+" oder "-") wird die Schrittgröße auf den aktuellen Wert des K-Objekts addiert (Button "+") oder von ihm subtrahiert (Button "-").
Durch Klick auf einen der beiden Buttons ("+" oder "-") wird die Schrittgröße auf den aktuellen Wert des K-Objekts addiert (Button "+") oder von ihm subtrahiert (Button "-").
2.3.Protokoll-Maske
In dieser Maske wird die Liste der eingegangenen Telegramme angezeigt.
Außerdem haben Sie hier die Möglichkeit, die Liste zu löschen und/oder zu exportieren.
Außerdem haben Sie hier die Möglichkeit, die Liste zu löschen und/oder zu exportieren.
2.3.1.Liste der eingegangenen Telegramme
Spalte | Erklärung |
---|---|
Zeit / Time | Uhrzeit, an der die Wertzuweisung stattgefunden hat. |
Grp.-Adr. | Gruppenadresse. |
Wert / Value | Der Wert, der dem K-Objekt zugewiesen wurde. |
Name | Die Bezeichnung des K-Objekts. |
Typ(e) | Format des K-Objekts Folgende Angaben sind möglich:
|
Hinweis
Die Deaktivierung eines oder mehrerer K-Objekte hat keinen Einfluss auf zu diesem Zeitpunkt bereits in der Liste angezeigte Zeilen.
Hinweis
Das Aktualisieren des Browsers, sowohl manuell, als auch automatisch verursacht (z.B. bei Neu-Übertragung des Projekts auf den HS/FS), hat keinen Einfluss auf die zu diesem Zeitpunkt bereits in der Liste angezeigten Wertzuweisungen.
Löschen oder Ändern von K-Objekten im Projekt, für die bereits Einträge in der Liste existieren, hat auf diese Einträge auch nach Neu-Übertragung des Projekts keinen Einfluss.
Löschen oder Ändern von K-Objekten im Projekt, für die bereits Einträge in der Liste existieren, hat auf diese Einträge auch nach Neu-Übertragung des Projekts keinen Einfluss.
2.3.2.Bearbeitungs-Leiste
In der Bearbeitungs-Leiste am rechten Rand der Protokoll-Maske finden Sie Möglichkeiten zur Bearbeitung der Liste und zur Weiterverarbeitung der dargestellten Daten.
3.FAQ
Problem: Es werden nur die Gruppenadressen und die Werte angezeigt.
Lösung: Im Experte unter Stammdaten -> Projekteinstellungen -> Netzwerk -> KO-Gateway muss die Option "XML-Struktur der K.-Objekte auf Gerät übertragen" aktiviert werden.
Problem: Es werden keine Gruppenadressen in der Maske K-Objekte angezeigt.
Es gibt mehrere mögliche Ursachen für diesen Fehler:
- Ein Fehler in der Konfiguration für den Zugriff
- Ein Fehler in der Konfiguration für die Einrichtung
- Die IP-Adresse des Geräts, auf dem HS-Monitor läuft, ist nicht in der Liste der erlaubten Absender-Adressen enthalten:
- Experte: Stammdaten -> Projekteinstellungen -> Netzwerk -> KO-Gateway - Die IP-Adresse des Geräts, auf dem HS-Monitor läuft, ist zwar in der Liste der erlaubten Absender-Adressen enthalten, aber der dort definierte Schlüssel ist ein anderer als der, den Sie im Browser angegeben haben:
- Aufruf
- Einstellungen
- Experte: Stammdaten -> Projekteinstellungen -> Netzwerk -> KO-Gateway
Problem: Es fehlen einige Gruppenadressen in der Maske K-Objekte.
Es gibt mehrere mögliche Ursachen für diesen Fehler:
- Im Experte sind bestimmte Optionen deaktiviert:
Unter Stammdaten -> Projekteinstellungen -> Netzwerk -> KO-Gateway eine oder beide der folgenden Optionen:- Empfangen für alle K-Objekte aktivieren
- Senden für alle K-Objekte aktivieren
- KO-Gateway empfangen
- KO-Gateway senden
Lösung: Aktivieren Sie bei den einzelnen K-Objekten die Optionen für "Empfangen" und/oder "Senden", um genau diese K-Objekte anzeigen zu lassen, oder aktivieren Sie in den KO-Gateway-Einstellungen die Optionen für "Empfangen" und/oder "Senden", um unabhängig von den Einstellungen der einzelnen K-Objekte alle K-Objekte mit zugewiesener Gruppenadresse anzeigen zu lassen. - Sie haben den "fehlenden" K-Objekten keine Gruppenadresse zugeordnet:
Lösung: Tragen Sie bei jedem gewünschten K-Objekt unter Stammdaten -> Kommunikationsobjekte eine Gruppenadresse ein.