README.md

ONVIF Events

Bildet verschiedene Ereignisse (Events) als Statusvariablen in Symcon ab.

Inhaltsverzeichnis

• 1. Funktionsumfang
• 2. Voraussetzungen
• 3. Software-Installation
• 4. Einrichten der Instanzen in IP-Symcon
  • Anlegen der Instanz:
  • Zuordnen zur IO-Instanz:
  • Auswahl des Ereignis-Pfad
• 5. Statusvariablen
  • Beispiel 1: Ein einzelnes Ereignis
  • Beispiel 2: Ein einzelnes Ereignis, mehrere Quellen
  • Beispiel 3: Ein Ordner
  • Beispiel 4: Ein Teilbaum
  • Tips & Tricks
• 6. WebFront
• 7. PHP-Funktionsreferenz
• 8. Aktionen
• 9. Anhang
  • 1. Changelog
  • 2. Spenden
• 10. Lizenz

1. Funktionsumfang

• Empfang von Statusmeldungen von einem ONVIF-Gerät.

2. Voraussetzungen

• IP-Symcon ab Version 6.1
• Kameras oder Video-Encoder mit ONVIF Profil S und/oder Profil T Unterstützung.
• Geräte müssen ONVIF-Events unterstützen.

3. Software-Installation

• Dieses Modul ist Bestandteil der ONVIF-Library.

4. Einrichten der Instanzen in IP-Symcon

Anlegen der Instanz:

Unter 'Instanz hinzufügen' ist das 'ONVIF Events'-Modul unter dem Hersteller 'ONVIF' aufgeführt.

Diese Instanzen können nicht über die dazugehörige Instanz des Configurator-Moduls von diesem Geräte angelegt werden und müssen immer manuell erzeugt hinzugefügt werden.

Zuordnen zur IO-Instanz:

Nach dem erzeugen der Instanz, muss zuerst über die Schaltfläche Gateway ändern die gewünschte IO-Instanz ausgewählt werden, von welcher Ereignisse empfangen werden sollen.

Auswahl des Ereignis-Pfad

Beispiel von Ereignissen:

Name	Text	Beschreibung
EventTopic	Ereignis-Pfad	Auswahl des Ereignis-Pfad ab welchen Ereignisse empfangen und verarbeitet werden. (*)

(*) Durch eine Änderung des Ereignis-Pfad werden die alten Statusvariablen hinfällig und müssen manuell gelöscht werden.

Der Ereignis-Pfad kann ein einzelnen Ereignis oder mehrere Ereignisse abbilden.
Der Pfad ist wie eine Baum/Ordner-Struktur zu verstehen und bildet alle Unterobjekte ab.
Der initiale Name der erzeugten Statusvariablen integriert eventuelle Strukturen mit ab.

5. Statusvariablen

Die Statusvariablen werden automatisch angelegt, sobald ein entsprechendes Ereignis empfangen wurde.
Dies erfolgt immer, wenn sich die dazugehörige IO-Instanz neu verbindet, sowie beim Systemstart von Symcon.

Die Namen der Statusvariablen werden initial vorgegeben, damit Diese einfach zu identifizieren sind. Selbstverständlich können die Statusvariablen beliebig umbenannt werden.

Beispiel 1: Ein einzelnes Ereignis

Beispiel-Baum

tns1:Device
│    │──tnsaxis:IO
│    │   │──VirtualInput
│    │   └──VirtualPort
│    │──tnsaxis:HardwareFailure
│    │   └──StorageFailure
│    │──tnsaxis:Status
│    │   └──SystemReady
│    │──tnsaxis:Network
│    │   └──Lost

Als Ereignis-Pfad wurde nur tns1:Device/tnsaxis:Status/SystemReady ausgewählt. Der Objektbaum enthält eine Statusvariable:

Der Name entspricht der Name der Daten-Spalte aus der Tabelle der möglichen Ereignisse in der IO-Instanz (Beispiel: ready).

Beispiel 2: Ein einzelnes Ereignis, mehrere Quellen

Als Ereignis-Pfad wurde der Ordner tns1:Device/tnsaxis:HardwareFailure/StorageFailure ausgewählt. Der Objektbaum enthält, bei diesem Beispiel-Baum, zwei Statusvariablen:

Der Name entspricht wieder der Name der Daten-Spalte aus der Tabelle der möglichen Ereignisse in der IO-Instanz (Beispiel: disruption).
Zusätzlich wird an dem Namen der Name der Quelle angehängt.
In diesem Beispiel sind die Quellen die möglichen Typen von Speichermedien (Storage) NetworkShare und SD_DISK.

Beispiel 3: Ein Ordner

Als Ereignis-Pfad wurde der Ordner tns1:Device/tnsaxis:HardwareFailure/ ausgewählt.
Der Objektbaum enthält, bei diesem Beispiel-Baum, wieder zwei Statusvariablen:
Der Name der Statusvariable entspricht dem Beispiel 2, zusätzlich wird aber der jeweilige Name vom Ereignis (Beispiel: StorageFailure) vorangestellt.

Beispiel 4: Ein Teilbaum

Als Ereignis-Pfad wurde der Ordner tns1:Device/ ausgewählt. Der Objektbaum enthält, bei diesem Beispiel-Baum, vierzig Statusvariablen:

Dem Namen der Statusvariablen wird, zusätzlich wie bei Beispiel 3, der jeweilige Name der Ebenen vorangestellt. Da einige Ereignisse mehrere Quellen haben, werden z.B. für VirtualInput alle 32 Quellen als Statusvariablen angelegt.
In diesem Beispiel fehlt eine Statusvariable für Network - Lost, da das Gerät keine Ereignisse für das Event tns1:Device/tnsaxis:Network/Lost sendet.
Das ist nicht verwunderlich, da ohne Netzwerkverbindung kein Ereignis mehr versendet werden kann und somit das Gerät dieses Event nie mit einen false senden könnte.

Tips & Tricks

Events für Videoquellen können direkt in der Stream-Instanz oder der Image Grabber-Instanz verarbeitet werden.
Hier wird automatisch auf die korrekte VideoSource gefiltert, welche in diesen Instanzen konfiguriert wurde.

6. WebFront

Die direkte Darstellung der Statusvariablen von Ereignissen ist möglich; es wird aber empfohlen mit Links zu arbeiten.

7. PHP-Funktionsreferenz

Keine Funktionen verfügbar.

8. Aktionen

Keine Aktionen verfügbar.

9. Anhang

1. Changelog

Changelog der Library

2. Spenden

Die Library ist für die nicht kommerzielle Nutzung kostenlos, Schenkungen als Unterstützung für den Autor werden hier akzeptiert:

10. Lizenz

IPS-Modul:
CC BY-NC-SA 4.0