Beschreibung
Setzt den Verfügbarkeitsstatus in DIVERA 24/7 oder gibt eine Einsatzrückmeldung.
- Gerät
- Gira X1
- Version
- 1.0.0
- Lizenz
- Ein Schlüssel je X1 (MAC-Adresse), dauerhaft nutzbar
- Thema
- Sicherheit
Hinweis zur Schnittstelle: Der Baustein nutzt die Schnittstelle von DIVERA 24/7. Ändert der Anbieter sie oder stellt sie ein, kann der Baustein eingeschränkt oder gar nicht mehr funktionieren, bis er angepasst ist. Wir passen ihn nach Möglichkeit an, einen Anspruch darauf gibt es nicht.
Anleitung
Welcher API-Key?
DIVERA kennt drei Arten von API-Keys mit unterschiedlichen Rechten. Am Baustein wird die Art im Parameter „Art des API-Keys“ eingestellt. Davon hängen Filter und Fehlertexte ab.
| Art | Wo zu finden | Divera Alarm | Divera Status |
|---|---|---|---|
| Einheit | Verwaltung > Schnittstellen | alle Einsätze der Einheit | nicht möglich, DIVERA lehnt ab |
| Persönlich | Einstellungen > Debug (eigenes Konto) | nur Einsätze, bei denen der Benutzer adressiert ist | eigener Status, braucht das Recht „Status“ |
| Systembenutzer | Verwaltung > Benutzer (Systembenutzer anlegen) | braucht das Recht „Alarmierungen“ | Status einer anderen Person über deren Fremdschlüssel |
DIVERA empfiehlt, für jede Anwendung einen eigenen Systembenutzer bzw. API-Key zu verwenden und die Rechte auf das Nötigste zu beschränken.
Funktionen und Anschlüsse
Setzt den Verfügbarkeitsstatus (POST /api/setstatus) oder gibt eine Rückmeldung zum Einsatz. Gesendet wird, wenn „Trigger“ den Wert 1 bekommt oder am Eingang „Status“ ein Wert ankommt.
Eingänge
| Eingang | Bedeutung |
|---|---|
| Trigger | Sendet den Status, der am Eingang „Status“ anliegt |
| Status | Laufende Nummer im Statusgeber (ab 1, von oben links gezählt) oder Status-ID, siehe Parameter „Status angeben als“. Vorgabe 1: Ist der Eingang nicht verbunden, sendet „Trigger“ den Status 1 |
| Notiz (ausgeblendet) | Freitext zur Statusmeldung, optional |
| Als Einsatzrückmeldung (ausgeblendet) | 1: Der Status gilt als Rückmeldung zum Einsatz |
| Einsatz-ID (0 = aktueller Einsatz) (ausgeblendet) | Einsatz, auf den sich die Rückmeldung bezieht, z. B. vom Ausgang „Einsatz-ID“ von „Divera Alarm | SMoLabs“. 0 = aktueller Einsatz |
Parameter
| Parameter | Bedeutung |
|---|---|
| API-Key | Persönlicher Key oder Key eines Systembenutzers |
| Art des API-Keys | Persönlich (Vorgabe) oder Systembenutzer |
| Fremdschlüssel der Person (nur Systembenutzer) (ausgeblendet) | Pflichtfeld bei Systembenutzer: Fremdschlüssel der Person, deren Status gesetzt wird (Feld „Fremdschlüssel“ im Benutzer). Fehlt er, meldet die Projektprüfung im GPA einen Fehler. Das Feld ist ausgeblendet und muss für Systembenutzer eingeblendet werden |
| Status angeben als | Laufende Nummer (Vorgabe) oder Status-ID |
| Lizenzschlüssel | Schlüssel für diesen X1, siehe „Lizenz“ |
Ausgänge: Erfolg (Bool), Aktuelle Status-ID (laut Antwort von DIVERA, ausgeblendet), Lizenzstatus, Debug.
Fehlerverhalten: Lehnt DIVERA ab oder ist der Server nicht erreichbar, wird „Erfolg“ 0 und „Debug“ nennt den Grund. Bei HTTP 403 steht dort, ob der Key ungültig ist, das Recht „Status“ fehlt oder der Fremdschlüssel unbekannt ist.
Ausgeblendete Ein- und Ausgänge und Parameter lassen sich im GPA am Baustein einblenden.
Beispiel: Ein Taster an der Haustür meldet „Komme“ zum laufenden Einsatz. Taster auf „Trigger“, „Status“ fest auf die Nummer von „Komme“, „Als Einsatzrückmeldung“ einblenden und auf 1 setzen.
Lizenz
Der Lizenzschlüssel wird im GPA im Parameter „Lizenzschlüssel“ eingetragen. Der Baustein prüft ihn beim Start auf dem X1, offline und gebunden an die MAC-Adresse des X1. Der Ausgang „Lizenzstatus“ zeigt das Ergebnis, bei einem Schlüssel für ein anderes Gerät auch die MAC-Adresse dieses X1. Ohne gültigen Schlüssel bleibt der Baustein untätig. In der Simulation des GPA am PC läuft er ohne Lizenzprüfung, damit sich Logikblätter testen lassen. Jeder der beiden Bausteine braucht einen eigenen Schlüssel.
Den Schlüssel erhältst du beim Kauf über smolabs.de.
Verwendetes Icon: https://www.flaticon.com/de/kostenlose-icons/alarm Alarm Icons erstellt von Freepik – Flaticon
Changelog
Version 1.0.0
- Erste Version.
Rezensionen
Es gibt noch keine Rezensionen.