OpenDevice Übersetzer(Zubehör-Add-on)

Überblick

Das OnGuard OAAP-Programm ermöglicht Drittanbietern(OAAP-Partnern), ihre Produkte mit der OnGuard-Softwareplattform zu verbinden. Die OpenDevice-APIs ermöglichen es Herstellern von Zutrittskontroll-, Aufzug-, Brandschutz-, Einbruch-, Zentralstellenempfänger-, Lebensrettungs- und Intercomsystemen, mit OnGuard zu kommunizieren.

Um die APIs zu verwenden, müssen Partner einen Übersetzer DLL entwickeln, der eine Reihe von COM-Schnittstellen implementiert, die von LenelS2 für die API veröffentlicht werden, die für den jeweiligen Drittanbieter-Produkttyp spezifisch ist.

Installation des Übersetzers

Der OAAP-Partner erhält das Registrierungskit, welches OnGuard, das OnGuard Software Development Kit (SDK) und eine Lizenzdatei enthält. Anschließend schließt der OAAP-Partner die Entwicklung der Translator-DLL ab und sendet eine Kopie der Translator-DLL an LenelS2.

LenelS2 erstellt und sendet ein Zubehör-Add-on für den zu integrierenden Paneltyp an den OAAP-Partner. Dies ist ein kleines Installationsprogramm, das die Übersetzer-DLL und alle abhängigen DLLs installiert und den neuen Feldtyp in der OnGuard-Datenbank veröffentlicht.

Die Installation des Zubehör-Add-Ons ermöglicht es Benutzern von OnGuard, den BlueConn OpenDevice-Übersetzer in ihrer Installation zu verwenden. Nach der Installation wird der Panel-Typ angezeigt und steht dem Benutzer zur Verfügung, und neue Türkomponenten können ihm zugewiesen werden.

Um mit der Installation zu beginnen, klicken Sie auf die Datei setup, wie unten angegeben:

Führen Sie die Datei ‚setup‘ aus, um zu starten.

Installationsassistent für den OpenDevice-Übersetzer

Während der Installation wird der folgende Informationspanel angezeigt. Stellen Sie sicher, dass Sie den BlueConn Konfigurator installiert haben bevor Sie fortfahren.

Stellen Sie sicher, dass Sie den BlueConn Konfigurator installiert haben, bevor Sie fortfahren.

Wenn die Installation erfolgreich ist, wird der folgende Bildschirm angezeigt.

Stellen Sie sicher, dass die Übersetzerdatei korrekt installiert ist.

Sobald das Add-On installiert wurde, müssen Sie ein neues Panel in OnGuard erstellen.

BlueConn panel button

BlueConn panel creation

Bitte beachten Sie bei der Erstellung eines neuen Panels die folgenden Details:

• Das Panel Sonstige wird angezeigt, wenn die Salto Space Lizenz in OnGuard aufgeführt ist
• Die Schaltfläche Hinzufügen des Bedienfelds ist nur aktiv, wenn der Translator erfolgreich installiert wurde

Wählen Sie unter Access Panel Type Salto Space aus.

Es können nur Salto Leser synchronisiert werden, die in Lenel erstellt wurden

Danach müssen Sie den Lenel Service Communication Server(oder den Lenel-Dienst) neu starten.

Restart the Lenel Service Communication Server

Überprüfen Sie danach, ob dieser Ordner korrekt im Lenel-Server erstellt wurde:

C:\PROGRAMDATA\SALTO\BLUECONN\

Um sicherzustellen, dass der Translator korrekt installiert ist, müssen Sie überprüfen, ob der BlueConn-Ordner in C:\PROGRAMDATA\SALTO erstellt wurde. Der Ordner sollte nach der Installation des Translators automatisch erstellt werden.

BlueConn Ordner Speicherort

Wenn Sie während der Installation des Translators eine Fehlermeldung wie unten erhalten, überprüfen Sie die Berechtigungen für die Anwendungsinstallation.

Überprüfen Sie die Berechtigungen, wenn Sie diese Art von Fehler erhalten

Wenn der Installer nicht installiert werden kann, ist es nicht möglich, Salto-Panels in OnGuard zu erstellen, Türen von OnGuard mit Salto zu synchronisieren oder die Lenel OnGuard-Alarmüberwachung zu verwalten.

Konfiguration des Übersetzers

Der BlueConn OpenDevice-Übersetzer verwendet eine Konfigurationsdatei, um Optionen zu speichern, die sich auf BlueConn-API-Einstellungen, Ereignissynchronisierungs- und Protokollierungsoptionen beziehen.

Diese Datei wird immer unter C:\ProgramData\SALTO\BlueVonn\BlueConn.ini abgelegt.

Prüfen Sie, ob der Dateipfad für die Installationsdatei korrekt ist.

BlueConn API-Einstellungen

Der OpenDevice-Übersetzer von BlueConn stellt eine Verbindung zur BlueConn Events-API her, um die neuesten Ereignisse abzurufen, die in Space generiert wurden. Hierfür muss es gültige Anmeldeinformationen bereitstellen, um eine Verbindung zur API herzustellen. Beachten Sie, dass diese Einstellungen mit den im BlueConn Web Configurator hinzugefügten übereinstimmen müssen.

Diese sind:

• Benutzername: Geben Sie den Benutzernamen ein, der für die Verbindung mit der BlueConn Events API verwendet wird.
  • Standard:ApiUser
• Passwort: Geben Sie das Passwort für das Benutzerkonto der BlueConn Events-API ein.
  • Default:Pass@Word!

Optionen für die Ereignissynchronisierung

Der OpenDevice-Translator funktioniert durch den Aufruf der Methode Lnl_PollPanelForEvents. Dies ist ein in den Übersetzer integrierter Abrufmechanismus, der mehrmals pro Sekunde ausgeführt wird. Durch die Bereitstellung dieser Synchronisierungsoptionen stellen Sie sicher, dass der Übersetzer die BlueConn-API nicht zu häufig abfragt und geben ihm die Flexibilität, wie oft neue Ereignisse abgerufen werden sollen.

Derzeit werden die folgenden 4 Ereignistypen verfolgt:

• Kartenereignis: Zutritt gewährt
• Kartenereignis: Zutritt verweigert
• Geräteereignis: Kommunikation verloren
• Gerätereignis: Kommunikation wiederhergestellt

Beispiel Alarmüberwachung

Häufigkeit der Ereignisse

Legt fest, wie oft der Übersetzer die BlueConn API abfragt, um zu überprüfen, ob neue Ereignisse in Space generiert wurden, die noch verarbeitet werden müssen. Wenn Ereignisse in der Warteschlange gefunden werden, konvertiert der Übersetzer diese Space-Ereignisse je nach Ereignistyp in OnGuard-Alarme. Für Kartenereignisse werden sofort OnGuard-Alarme generiert. Bei Geräteereignissen wird eine Statusaktualisierung ausgelöst, damit der Echtzeitstatus des Geräts aus Space abgerufen wird.

Frequenz und Verzögerung des Status-Updates

Wenn ein Ereignis für ein Gerät empfangen wird, wird der Status des Geräts nicht sofort aktualisiert (hauptsächlich, um zu vermeiden, dass Alarme ausgelöst werden, bevor der Status aktualisiert wird). Stattdessen wird die Einstellung Verzögerung der Statusaktualisierung verwendet, sodass der Synchronisierungsprozess einige Sekunden wartet, bevor die BlueConn API aufgerufen wird, um den aktuellsten Status der Geräte abzurufen. Ein neuer OnGuard-Alarm wird nur dann generiert, wenn sich der Status seit dem letzten Mal geändert hat. Der Alarm wird übersprungen, wenn der Status gleich ist.

Auch wenn Space-Ereignisse eine Statusaktualisierung auslösen, werden diese Alarme manchmal nicht über die Blue Conn API gesendet oder empfangen. Die Statusfrequenz bietet eine Möglichkeit, den Status der Geräte in einem bestimmten Intervall zu aktualisieren, um sicherzustellen, dass der Status der Geräte immer auf dem neuesten Stand ist.

Systemstatusbaum

Protokollierungsoptionen

Standardmäßig speichert der BlueConn-Geräteübersetzer Fehlerprotokolle, die sich auf Laufzeit-Ausnahmen oder BlueConn-API-Fehler beziehen, in einem Protokollordner.

Antwort der API und Laufzeit-Protokolle aktiviert

Wenn Sie jedes Mal, wenn der Übersetzer ausgeführt wird oder jedes Mal, wenn er eine API-Antwort empfängt, protokollieren möchten, aktivieren/deaktivieren Sie diese Einstellungen mithilfe von EIN/AUS. Wenn aktiviert, erstellt der Übersetzer die folgenden Protokolldateien:

• BlueConn_ApiResponses_YYYYMMDD.log
• BlueConn_Runtimes_YYYYMMDD.log

Der folgende Screenshot ist ein Beispiel dafür, wie ein echter Kunde aufgeführt wird:

Echte Kundenauflistung

Hinweis: Der Zugriff auf die Salto-Server-URL erfolgt über space_pm_ts, dies wird jedoch als http://space_pm_ts:9121/api geschrieben

Konfiguration der Space Alarm-Events

Um dem BlueConn OpenDevice-Übersetzer den Empfang von Ereignissen aus Salto Space zu ermöglichen, müssen Sie ein Alarm-Event-Webhook konfigurieren, das alle Ereignisse an die BlueConn API weiterleitet.

Um ein Alarm-Event zu konfigurieren, navigieren Sie zu Salto Space > Extras > Alarm Events und klicken Sie auf Zufügen.

Fügen Sie einen aussagekräftigen Namen hinzu(zum Beispiel: "BlueConn Alarm Webhook"). Klicken Sie im Abschnitt Auslöser auf die Schaltfläche Bearbeiten, wählen Sie Event aus Ereignisliste aus dem Dropdown-Menü Typ des Auslösers aus und belassen Sie die Standardoptionen unverändert. Klicken Sie anschließend auf OK.

Erstellen eines neuen Alarm-Events in Space

Im Abschnitt Aktionen klicken Sie auf Hinzufügen und wählen Sie Webanfrage stellen aus der Dropdown-Liste Typ. Im URL-Feld http://{SERVERNAME}:9121/api/Events hinzufügen, wobei {SERVERNAME} der Hostname ist, auf dem der BlueConn Web Configurator installiert wurde.

Als Nächstes wählen Sie POST als Methode und application/json als Content-Type. Um sich gegenüber der BlueConn API zu authentifizieren, müssen Sie eine Basis-Authentifizierung auswählen und die zuvor im Abschnitt 'Events API Einstellungen' des BlueConn Web-Konfigurators definierten Anmeldeinformationen verwenden.

![Neues Alarm-Event in Space](images/action-alarm-events.png "Wählen Sie die richtigen Optionen im Bereich "Aktion")

Um das zu beenden, fügen Sie die folgende Konfiguration im JSON-Format in das Feld Körper ein:

{
    "CardId": "(trigger.Card.ID}",
    "DoorId": "itrigger.Door.Gpf2",
    "DoorExtId": "{trigger.Door.ExtId}",
    "DoorName": "{trigger.Door.Name}",
    "UserExtId": "(trigger .User.ExtId}",
    "UserName": "{trigger.User.Name}",
    "CardNumber": "{trigger.User.Gpf4}",
    "IssueCode": "{trigger.User.Gpf5)",
    "EventType": "{trigger.EventType}",
    "OperationID": "{trigger.Operation.ID}",
    "EventUtcDate": "{trigger.UtcDate; format="yyyy-MM-dd HH:mm:ss"}"
}

Nachdem Sie die Konfigurationsdetails eingegeben haben, klicken Sie auf OK.

Stellen Sie sicher, dass alle Details für das Ereignis Alarm korrekt sind, und klicken Sie auf Speichern. Wenn diese Option aktiviert ist, leitet Space alle Alarm-Events an die BlueConn-API weiter, um für den BlueConn OpenDevice-Übersetzer zur Generierung von Alarmen in OnGuard verfügbar zu sein.

Stellen Sie sicher, dass die freien Felder (GPF4 und GPF5) im Space Personen-Reiter (System > Allgemeine Optionen > Personen) wie folgt eingestellt sind:

• Aktiviere Feld 4: CardNumber
• Aktiviere Feld 5: IssueCode

![Reiter Personen in den Allgemeinen Optionen von Space](Bilder/users-general-options-space.png "Sicherstellen, dass die richtigen Felder in der Registerkarte "Personen" in Space definiert sind.")

Gleichzeitig sollte im Space Zutrittspunkte-Tab (System > Allgemeine Optionen > Zutrittspunkte) das Feld GPF2 wie folgt definiert sein:

• Aktiviere Feld 2: DOORID

Stellen Sie sicher, dass das richtige Feld auf der Registerkarte 'Zutrittspunkte' in Space definiert ist.