Skip to content

Latest commit

 

History

History
113 lines (76 loc) · 6.05 KB

README.md

File metadata and controls

113 lines (76 loc) · 6.05 KB

SDK Version Version
License Check Style Run Tests
SpendenWunschliste

ONVIF Digital Output

Bildet Digitale Ausgänge (Relays) in Symcon ab.

Inhaltsverzeichnis

1. Funktionsumfang

  • Empfang von Statusmeldungen der Digitalen Ausgängen von ONVIF-Geräten.
  • Ansteuern der Digitalen Ausgänge über Symcon.

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 über mindestens einen Digitalen Ausgang (bzw. Relais) verfügen.

3. Software-Installation

4. Einrichten der Instanzen in IP-Symcon

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

Es wird empfohlen diese Instanz über die dazugehörige Instanz des Configurator-Moduls von diesem Geräte anzulegen.

Konfigurationsseite:

Config

Name Text Beschreibung
EventTopic Ereignisse der Ausgänge Auswahl des Ereignis-Pfad ab welchen Ereignisse empfangen und verarbeitet werden.
EmulateStatus Status simulieren Wenn aktiviert, wird die Statusvariable in Symcon auf den neuen Wert gesetzt, sobald ein Schaltbefehl erfolgreich übertragen wurde. Sonst wird nur über ankommende Ereignisse gesetzt.

Der Ereignis-Pfad wird bei Digital-Outputs versucht automatisch zu erkennen, funktioniert dies nicht, ist das Eingabefeld aktiv und das Ereignis muss manuell ausgewählt werden.

5. Statusvariablen

Die Statusvariablen werden automatisch angelegt und erhalten das ~Switch Profil. Das Löschen einzelner Statusvariablen kann zu Fehlfunktionen führen.

Name Typ Beschreibung
je nach Name des Relay-Token aus dem Onvif-Ereignis bool Für jeden bekannten Output wird eine passende Variable in Symcon erstellt.

6. WebFront

Die Statusvariablen haben eine hinterlegte Standardaktion und somit können die Ausgänge direkt aus dem WebFront bedient werden.

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

7. PHP-Befehlsreferenz

boolean ONVIF_SetRelayOutputState(integer $InstanzID, string $Ident, bool $Value);

De/Aktiviert den in $Ident übergeben Ausgang, je nach übergebenen Wert in $Value.
Konnte der Befehl erfolgreich ausgeführt werden, wird TRUE zurückgegeben.
Im Fehlerfall wird eine Warnung erzeugt und FALSE zurückgegeben.

Beispiel: ONVIF_SetRelayOutputState(12345, '1', true);
Schalte Ausgang 1 an.

8. Aktionen

Grundsätzlich können alle bedienbaren Statusvariablen als Ziel einer Aktion mit 'Auf Wert schalten' angesteuert werden, so das hier keine speziellen Aktionen benutzt werden müssen.

Dennoch gibt es eine Aktion für die 'ONVIF Digital Output' Instanz.
Wenn so eine Instanz als Ziel einer Aktion ausgewählt wurde, steht folgende Aktion zur Verfügung:
Aktionen

  • Aktivieren oder deaktivieren eines digitalen Ausgang

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:

Wunschliste

10. Lizenz

IPS-Modul:
CC BY-NC-SA 4.0