Skip to content

Latest commit

 

History

History
executable file
·
172 lines (127 loc) · 6.94 KB

README.md

File metadata and controls

executable file
·
172 lines (127 loc) · 6.94 KB
Raw

Image

LOQED Webhooks

Dieses Modul integriert ein LOQED Smart Lock in IP-Symcon mittels Webhooks.

Das einzige Schloss, das Ihre Tür mit einer Berührung öffnet.

Für dieses Modul besteht kein Anspruch auf Fehlerfreiheit, Weiterentwicklung, sonstige Unterstützung oder Support.
Bevor das Modul installiert wird, sollte unbedingt ein Backup von IP-Symcon durchgeführt werden.
Der Entwickler haftet nicht für eventuell auftretende Datenverluste oder sonstige Schäden.
Der Nutzer stimmt den o.a. Bedingungen, sowie den Lizenzbedingungen ausdrücklich zu.

Inhaltverzeichnis

  1. Funktionsumfang
  2. Voraussetzungen
  3. Software-Installation
  4. Einrichten der Instanzen in IP-Symcon
  5. Statusvariablen und Profile
  6. WebFront
  7. PHP-Befehlsreferenz

1. Funktionsumfang

  • Schloss zu- und aufsperren inkl. weiterer Funktionen
  • Gerätestatus anzeigen (diverse)
  • Protokoll

2. Voraussetzungen

  • IP-Symcon ab Version 6.0
  • LOQED Smart Lock
  • Aktivierte Webhooks im LOQED Web Portal
  • Internetverbindung
  • IP-Symcon Subskription (für automatische Statusaktualisierungen)

3. Software-Installation

  • Bei kommerzieller Nutzung (z.B. als Einrichter oder Integrator) wenden Sie sich bitte zunächst an den Autor.
  • Über den Module Store das Loqed-Modul installieren.

4. Einrichten der Instanzen in IP-Symcon

  • In IP-Symcon an beliebiger Stelle Instanz hinzufügen auswählen und Loqed Webhooks auswählen, welches unter dem Hersteller Loqed aufgeführt ist.
  • Es wird eine neue Loqed Webhooks Instanz angelegt.

Konfigurationsseite:

Name Beschreibung
LOQED Webhooks Dokumentation
Lock ID (old) Lock ID (old)
API Key API Key
API Token API Token
Local Key ID Local Key ID
Lock ID Lock ID
Tägliche Statusaktualisierung verwenden Tägliche Statusaktualisierung verwenden
Tägliche Aktualisierung um Uhrzeit der Statusaktualisierung
Tägliches Zusperren verwenden Tägliches Zusperren verwenden
Zusperren um Uhrzeit Zusperren
Tägliches Aufsperren verwenden Tägliches Aufsperren verwenden
Aufsperren um Uhrzeit Aufsperren
Protokoll verwenden Protokoll verwenden
Anzahl der maximalen Protokolleinträge Anzahl der maximalen Protokolleinträge

Schaltflächen im Aktionsbereich:

Name Beschreibung
Webhook URL
LOQED Webhooks Portal
Entwicklerbereich
Status aktualisieren Aktualisiert den Status

Vorgehensweise:

Registrieren Sie sich bitte im LOQED Web Portal für die benötigten Webhooks.
Geben Sie Ihre Daten für das Smart Lock an und übernehmen Sie anschließend die Änderungen.

5. Statusvariablen und Profile

Die Statusvariablen/Kategorien werden automatisch angelegt.
Das Löschen einzelner kann zu Fehlfunktionen führen.

Statusvariablen
Name Typ Beschreibung
SmartLock integer Smart Lock Aktionen (auf- und zusperren + weitere Funktionen)
OnlineState integer Onlinestatus
DeviceState integer Gerätestatus (diverse)
BatteryCharge integer Batterieladung (in %)
BatteryType integer Batterietyp
GuestAccess integer Gastzugang
TwistAssist integer Drehunterstützung
TouchToOpen integer Touch To Open
ActivityLog string Protokoll
Profile:

LOQED.InstanzID.Name

Name Typ
SmartLock integer
OnlineState integer
DeviceState integer
BatteryCharge integer
BatteryType integer
GuestAccess integer
TwistAssist integer
TouchToOpen integer

Wird die Loqed Instanz gelöscht, so werden automatisch die oben aufgeführten Profile gelöscht.

6. WebFront

Die Funktionalität, die das Modul im WebFront bietet:

Image

Image

  • Smart Lock Aktionen (auf- und zusperren + weitere Funktionen)
  • Gerätestatus anzeigen (diverse)
  • Protokoll

7. PHP-Befehlsreferenz

Smart Lock schalten:  

LOQED_SetSmartLockAction(integer $InstanzID, int $Aktion);

Schaltet eine bestimmte Aktion des Smart Locks.  
Gibt bei Erfolg als Rückgabewert true zurück, andernfalls false.  

$InstanzID:     Instanz ID des Smart Locks
$Aktion:        Führt eine Aktion für das Smart Lock gemäss Tabelle aus:
Wert Smart Lock Aktion Smart Lock Aktion (deutsch)
0 lock zusperren
1 unlock aufsperren
2 open öffnen 
Beispiel:  
//Smart Lock zusperren
$setAction = LOQED_SetSmartLockAction(12345, 0); 
//Gibt den Rückgabewert aus
echo $setAction;      

//Smart Lock aufsperren
$setAction = LOQED_SetSmartLockAction(12345, 1);
//Gibt den Rückgabewert aus
echo $setAction;      

Status aktualisieren:  

LOQED_UpdateDeviceState(integer $InstanzID);  

Fragt den aktuellen Status des Smart Locks ab und aktualisiert die Werte der entsprechenden Variablen.  
Gibt bei Erfolg als Rückgabewert true zurück, andernfalls false. 

Beispiel:  
LOQED_UpdateDeviceState(12345);