Das REV Plus Cloud System bietet für alle REV Mobile Benutzer eine Websocket Alarm API zur Anbindung der eigenen Smart-Home Lösungen oder auch anderer Selbstbaulösungen. Der Phantasie sind keine Grenzen gesetzt.

Zugriffsschlüssel erstellen

Bevor ihr eine Verbindung zur Websocket Alarm API aufbauen könnt, benötigt ihr einen persönlichen Zugriffsschlüssel oder auch "Personal-Access-Token". Diesen könnt ihr unter dem Menüpunkt Access Tokens im REV Plus Cloud-Portal erstellen. Klickt dort auf Neuen PAT erstellen und vergebt dem PAT einen Namen, damit ihr es nachher wiederfindet. Aktiviert bei "Berechtigungen" den Punkt WS Alarm API. Anschließend klickt ihr auf Zugriffsschlüssel erstellen. Nun wird euch der erzeugte Schlüssel angezeigt. Diesen müsst ihr kopieren und an einer sicheren Stelle speichern. Wichtig: Der Token wird euch nur einmalig angezeigt, danach könnt ihr diesen nicht mehr aufrufen.

warnung

Access Tokens laufen nach einer bestimmten Zeit aus. Den Gültigkeitszeitraum des Tokens könnt ihr in der Liste aller Tokens einsehen. Sobald ein Token abgelaufen ist, können keine API Aufrufe mehr durchgeführt werden. Daher müsst ihr frühzeitig ein neues Token erstellen.

Verbindung aufbauen

Nun könnt ihr mit Hilfe des Tokens eine Websocket-Verbindung zur WS Alarm API aufbauen. Die URL zur API lautet:

wss://broker.einsatzverwaltung.de/alarm?AccessToken=<Persönliches Token>

Ersetzt den Ausdruck <Persönliches Token> mit euerm generierten Token. Anschließend könnt ihr die Verbindung aufbauen.

Datenübertragung

Sobald ein Ereignis wie eine Alarmierung ausgelöst wird, erhaltet ihr eine Nachricht im JSON Format. Die Nachricht ist grundsätlich folgendermaßen aufgebaut:

{
    "type": "alert",
    "message: {
    
    }
}

Es existieren aktuell drei Nachrichtentypen:

• Alarmierungen (alert)
• Einsatz-Updates (update)
• Verfügbarkeitsänderungen (availability)

Alarmierungen / Updates

Alarmierungen und Einsatz-Updates haben den gleichen Aufbau. Alarmierungen mit dem Type alert werden gesendet, sobald ein Alarm an dein Smartphone gesendet wurde. Werden im Nachgang Änderungen an den Einsatzdaten gemacht oder weitere Alarmgruppen ausgelöst, die dich nicht betreffen, wird die Nachricht erneut gesendet, diesmal mit den aktuellen Daten und dem Type update.

Beispielnachricht

{
    "type": "alert",
    "message": {
        "alertId": "6834ad48-c361-42ac-8b06-1ae34471a908",
        "alarmLevel": 0,
        "groups": [
            "Leitung der Feuerwehr",
            "Stadtteil A-Dorf",
            "Stadtteil B-Dorf"
        ],
        "myGroups": [
            "Stadtteil A-Dorf"
        ],
        "properties": {
            "kwk": false,
            "abbruch": false,
            "sosi": true,
            "prio": 2
        },
        "stichwort": {
            "eart": "H",
            "indikation": "12",
            "gruppe": "H-1",
            "stichwort": "Türöffnung",
            "diagnose": null,
            "meldung": "Person hinter Tür"
        },
        "einsatzort": {
            "strasse": "Hauptstraße",
            "hnr": "12",
            "plz": "12345",
            "stadt": "Teststadt",
            "stadtteil": "A-Dorf",
            "objekt": {
                "name": "Grundschule"
            }
        },
        "bemerkung": "Testbemerkung",
        "einsatznummer": "12345"
    }
}

Verfügbarkeitsmeldungen

Eien Verfügbarkeitsmeldung wird gesendet, sobald du deinen Verfügbarkeitsstatus in der App geändert hast. Diese Nachricht ist vom Type availability. Sie enthält die eindeutige UUID der Organisation, für den du den Status geändert hast, als auch ein Wert für deine Verfügbarkeit.

• Verfügbar (0)
• Verspätet verfügbar (1)
• Nicht verfügbar (2)
• Dauerhaft nicht verfügbar (3)
• Urlaub (4)
• Krank (5)
• Quarantäne (6)

Beispielnachricht

{
    "type": "availability",
    "message": {
        "availability": 0,
        "organization": "0b3b0e84-d260-4e2e-b873-c2fe99475087"
    }
}

Node-RED

Zur Nutzung mit Node RED kann hier ein Beispiel-Flow heruntergeladen werden:

Node RED Beispielflow