> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/german/verpflichtende-basis/platform-core/connect-hub/edge-app-marketplace-for-plug-ins-and-extentions/apps/xovis.md).

# Xovis

Die Xovis-App ermöglicht die Erfassung von Daten von Xovis People Counter-Sensoren in BuildingPro Suites.

> Bitte beachten Sie, dass dies die Dokumentation für die Xovis-App ist, den Nachfolger der [Xovis People Counter-App](https://doc.eliona.io/collection/apps/apps/xovis-people-counter).

### Übersicht

Dieses Handbuch enthält Anweisungen zum Konfigurieren, Installieren und Verwenden der Xovis-App zur Verwaltung von Ressourcen und zur Synchronisierung von Daten zwischen BuildingPro Suites und Xovis People Counters.

### Installation

Installieren Sie die Xovis-App über den BuildingPro Suites App Store.

### Konfiguration

Die Xovis-App muss über die Einstellungsoberfläche von BuildingPro Suites konfiguriert werden. Nachfolgend finden Sie die allgemeinen Schritte und Details zur Konfiguration der App.

### Konfigurations- und Sensorerkennungs-Workflow der Xovis-App

Konfigurationen können in BuildingPro Suites unter `Einstellungen > Apps > Xovis`, erstellt werden, wodurch die App-Oberfläche geöffnet wird [Generisches Frontend](https://doc.eliona.io/collection/v/manuals/settings/apps). Nachfolgend finden Sie den vollständigen Workflow zur Konfiguration von Xovis-Geräten.

#### Schritt 1: Erstellen einer Xovis-App-Konfiguration

Zunächst muss eine Konfiguration erstellt werden, die definiert, wie BuildingPro Suites mit dem Xovis-Gerät interagiert. Diese Konfiguration enthält wichtige Details wie die Zertifikatsprüfung des Geräts, die Datenerfassungshäufigkeit und API-Timeouts.

**Endpunkt**: `/configs`

**Methode**: `POST`

**Erforderliche Daten**:

| Attribut           | Beschreibung                                                                                                                                                                            |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `checkCertificate` | Gibt an, ob das Zertifikat des Geräts überprüft werden soll (`true` für öffentlich zugängliche Geräte, `false` für nicht öffentlich zugängliche Geräte).                                |
| `aktivieren`       | Aktiviert oder deaktiviert die Datensynchronisierung für diese Konfiguration.                                                                                                           |
| `refreshInterval`  | Intervall in Sekunden für die Datenerfassung vom Xovis-Gerät (Standard: 60 Sekunden). Kann verkürzt werden, wenn Datapush verwendet wird.                                               |
| `requestTimeout`   | Timeout in Sekunden für API-Anfragen an das Xovis-Gerät (Standard: 120 Sekunden).                                                                                                       |
| `tenantIDs`        | Liste der BuildingPro Suites Mandanten-IDs, für die dieses Gerät Daten erfassen soll. Smart Devices werden für jede Mandanten-ID automatisch als Assets in BuildingPro Suites erstellt. |

#### Beispiel für eine Konfigurationsanfrage:

```json
{
  "checkCertificate": true,
  "enable": true,
  "refreshInterval": 60,
  "requestTimeout": 120,
  "tenantIDs": ["10"]
}
```

#### Antwort:

Nach erfolgreichem Erstellen der Konfiguration erhalten Sie eine Antwort mit der internen ID (`id`) der neu erstellten Konfiguration. Diese ID wird für die Konfiguration von Sensoren im nächsten Schritt benötigt.

#### Schritt 2: Hinzufügen von Xovis-Sensoren mit der Konfigurations-ID

Unter Verwendung der in Schritt 1 erhaltenen Konfigurations-ID (z. B. `"id": 1`), können Sie nun Xovis-Sensoren konfigurieren. Jeder Sensor ist mit einer Konfiguration verknüpft und unterstützt Erkennungsmethoden wie Layer 2 (L2) oder Layer 3 (L3).

Endpunkt: `/sensors`

Methode: `POST`

Erforderliche Daten:

| Attribut           | Beschreibung                                                                                                   |
| ------------------ | -------------------------------------------------------------------------------------------------------------- |
| `configuration_id` | Die ID der in Schritt 1 erstellten Konfiguration. Dadurch wird der Sensor mit der Konfiguration verknüpft.     |
| `username`         | Xovis-Sensor-Benutzername.                                                                                     |
| `password`         | Xovis-Sensor-Passwort.                                                                                         |
| `hostname`         | Hostname oder IP-Adresse des Xovis-Sensors.                                                                    |
| `port`             | Netzwerkport für die Kommunikation mit dem Sensor (z. B. 443 für HTTPS).                                       |
| `discovery_mode`   | Modus für die Sensorerkennung (`disabled`, `L2` oder `L3`).                                                    |
| `l3_first_ip`      | (Optional) Start-IP-Adresse für die Layer-3-(L3)-Erkennung, um Sensoren in einem bestimmten Bereich zu finden. |
| `l3_count`         | (Optional) Anzahl der IP-Adressen, die im L3-Erkennungsmodus gescannt werden sollen.                           |

#### Beispiel für eine Sensoranfrage:

```json
{
  "configuration_id": 1,
  "username": "sensor_user",
  "password": "securepassword123",
  "hostname": "sensor1.local",
  "port": 8080,
  "discovery_mode": "L3",
  "l3_first_ip": "192.168.1.10",
  "l3_count": 50
}
```

### Kontinuierliche Anlageerstellung (CAC)

Nach Abschluss der Konfiguration und der Sensorerkennung beginnt BuildingPro Suites mit der kontinuierlichen Anlageerstellung (CAC). Die erkannten Sensoren werden automatisch als Assets in BuildingPro Suites hinzugefügt:

* Sensorerkennung: Identifizierte Sensoren werden als Assets hinzugefügt.
* Automatische Anlageerstellung: Konfigurierte Logiken auf den Sensoren werden als Assets in BuildingPro Suites gespeichert.
* Benachrichtigungen: Der Benutzer erhält über das Benachrichtigungssystem von BuildingPro Suites eine Nachricht, wenn neue Assets erstellt wurden.

### Datapush

Für die kontinuierliche Datenübertragung (damit Daten sofort übertragen werden, wenn Personen unter den Sensoren hindurchgehen, anstatt auf den `refreshInterval`), kann Datapush konfiguriert werden:

1. Gehen Sie zur Konfigurationsoberfläche des Sensors.
2. Navigieren Sie zu `Einstellungen > Einzelner Sensor > Daten-Push`.
3. Richten Sie eine neue HTTPS-Verbindung mit dem Ziel ein `https://{your-eliona-instance}/apps-public/xovis/{configuration_id}/datapush`, Port 443.
4. Erstellen Sie einen neuen Agenten -> Live Data Push:
   * Datenfilterung: nach Wunsch
   * Format: JSON
   * Zeitformat: Unix-Zeit MS
   * Leere Frames: Leere Frames auslassen
   * Normalisierung: Stufe 1
   * Vollständige Paketinfo: aus
   * Vollständige Sensorinfo: aus
   * Schönes Format: aus


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.buildings.ability.abb/collection/german/verpflichtende-basis/platform-core/connect-hub/edge-app-marketplace-for-plug-ins-and-extentions/apps/xovis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
