Skip to content

daschaefer/SymconAlarmSystem

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Alarmanlagen Module für IP-Symcon

Dieses IP-Symcon PHP Modul dient zur Bereitstellung der Funktionalität einer Alarmanlage.

Content

  1. Funktionsumfang
  2. Anforderungen
  3. Variablen
  4. Funktionen
  5. Webhook Parameter

1. Funktionsumfang

In der Modulkonfiguration können beliebige Variablen von bspw. Sensoren, Reed-Kontakten, Bewegungsmeldern etc.pp. mit Auslösungswert eingetragen werden. Anhand dieser Konfiguration werden automatisch Ereignisse erzeugt die das Modul bei Auslösen ansprechen. Dieses Modul erzeugt dann wenn gewünscht eine Push Nachricht über IP-Symcon und setzt entsprechend eine ALARM Variable auf welche weitere Skripte "hören" können. Außerdem werden alle Auslösungen und Statusänderungen der Alarmanlage mit Timestamp protokolliert.

2. Anforderungen

  • IP-Symcon 4.x installation (Linux / Windows)
  • Unter IP-Symcon angelegte Sensoren die zum Auslösen verwendet werden können

3. Vorbereitung & Installation & Konfiguration

Installation in IPS 4.x

Im "Module Control" (Kern Instanzen->Modules) die URL "https://github.com/daschaefer/SymconAlarmSystem.git" hinzufügen.
Danach ist es möglich eine neue AlarmSystem Instanz innerhalb des Objektbaumes von IP-Symcon zu erstellen.

Konfiguration innerhalb IPS

WFC Objekt

Das WFC Objekt welches für den Versand der Push Notifications verantwortlich sein soll

Pushbenachrichtigung bei Alarm senden

Push Benachrichtigungen über IP-Symcon aktivieren/deaktivieren

Protokoll automatisch ausblenden

Beim Deaktivieren der Alarmanlage kann das Protokoll automatisch ausgeblendet werden.

Auslöser

Definition der Auslöser Variablen und deren Auslösewert

Auslöseverzögerung

Verzögerung der Auslösung in Sekunden

Protokoll behalten

Protokolleinträge älter als X Tage werden verworfen

Vor 'Scharf' ausführen

*Skript welches vor dem Scharfschalten ausgeführt wird. Kann genutzt werden um Prüfungen vorzunehmen. Rückgabewert muss als echo erfolgen, "0" = misserfolg / "1" = erfolg. Das Skript muss einen Wert als String ausgeben. Beispiel: echo "0";

Vor 'Unscharf' ausführen

*Skript welches vor dem Unscharfschalten ausgeführt wird. Kann genutzt werden um Prüfungen vorzunehmen. Rückgabewert muss als echo erfolgen, "0" = misserfolg / "1" = erfolg. Das Skript muss einen Wert als String ausgeben. Beispiel: echo "0";

Vor 'Aus' ausführen

*Skript welches vor dem Ausschalten ausgeführt wird. Kann genutzt werden um Prüfungen vorzunehmen. Rückgabewert muss als echo erfolgen, "0" = misserfolg / "1" = erfolg. Das Skript muss einen Wert als String ausgeben. Beispiel: echo "0";

3. Variablen

ALARM

Wird TRUE wenn ein Alarm ausgelöst wurde. Ansonsten FALSE.

Protokoll

Protokoll für das Webinterface, und kann dort verlinkt werden.

Status

Status der Alarmanlage. Kann folgende Werte annehmen: Aus (0), Unscharf (1), Scharf (2), Alarm (3). Diese Variable sollte ebenfalls im Webinterface verlinkt werden.

6. Funktionen

ALRM_Arm(integer $InstanceID)

Schaltet die Alarmanlage auf Scharf.


ALRM_Disarm(integer $InstanceID)

Schaltet die Alarmanlage auf Unscharf.


ALRM_Trigger(integer $InstanceID, variant $identifier)

Alarmanlage auslösen, wobei $identifier irgendein String sein kann.


ALRM_GetState(integer $InstanceID)

Gibt den aktuellen Status der Alarmanlage zurück, 0 = aus, 1 = unscharf, 2 = scharf, 3 = alarm

About

Simple Alarm System PHP Module for IP-Symcon

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages