# ROOMZ

### Übersicht

Dieses Handbuch enthält Anweisungen für die Installation, Konfiguration und Verwendung der ROOMZ-App zur Datenerfassung von ROOMZ-Sensoren.

### Installation

Installieren Sie die ROOMZ-App aus dem BuildingPro Suites App Store.

### Konfiguration

Registrieren Sie die App in ROOMZ und konfigurieren Sie dann die ROOMZ-App über die BuildingPro Suites-Einstellungen.

#### Registrierung der App im ROOMZ-Portal

Die ROOMZ-App verwendet ein experimentelles [Webhook-API](https://github.com/roomz-io/openapi) das noch nicht allgemein verfügbar ist. Wenden Sie sich an den ROOMZ-Support, um das Senden von Daten zu aktivieren und ein Webhook-Geheimnis zu erhalten. Der Webhook-Endpunkt für Ihre BuildingPro Suites-Instanz lautet: `https://{your-eliona-instance}/apps-public/roomz/webhook`.

> Da der Webhook-Endpunkt über das Internet erreichbar sein muss, werden alle eingehenden Daten mithilfe der ROOMZ-Signatur überprüft. Zur Überprüfung muss ROOMZ ein Webhook-Geheimnis und einen öffentlichen Schlüssel bereitstellen, um die Signatur zu prüfen.

#### Konfiguration der ROOMZ-App

Konfigurieren Sie die App in BuildingPro Suites, indem Sie zu `Apps > ROOMZ > Einstellungen`, wodurch die App- [Generic Frontend](https://doc.eliona.io/collection/v/eliona-english/manuals/settings/apps)navigieren. Verwenden Sie die POST-Methode, um die Konfiguration einzurichten. Jede Konfiguration erfordert die folgenden Parameter:

| Attribut    | Beschreibung                                                       |
| ----------- | ------------------------------------------------------------------ |
| `secret`    | Von ROOMZ bereitgestelltes Webhook-Geheimnis.                      |
| `enable`    | Schalter zum Aktivieren oder Deaktivieren dieser Konfiguration.    |
| `tenantIDs` | Liste der BuildingPro Suites Mandanten-IDs für die Datenerfassung. |

Beispiel für eine Konfigurations-JSON:

```json
{
  "secret": "some-webhook-secret",
  "enable": true,
  "tenantIDs": [
    "10"
  ]
}
```

### Kontinuierliche Asset-Erstellung

Nach der Konfiguration lauscht die App auf Datenaktualisierungen von ROOMZ. Jedes Mal, wenn sich der Präsenzstatus ändert (jemand einen Raum betritt oder verlässt), empfängt die App eine Nachricht von ROOMZ und schreibt die Daten in BuildingPro Suites.

Die App erstellt automatisch alle Assets für die überwachten Räume - Wenn die App zum ersten Mal Daten von einem Sensor empfängt, erstellt sie ein neues Asset unter dem Asset "ROOMZ root". Das Asset wird nach der Raum-ID benannt (der einzigen von der ROOMZ-API bereitgestellten Information), kann aber vom Benutzer umbenannt und verschoben werden.

Der Benutzer, der die Konfiguration der App erstellt oder zuletzt aktualisiert hat, wird über neu erstellte Assets benachrichtigt.