DoorLine Snap / CAM
DoorLine Snap / CAM
Breadcrumbs

API-Funktionen

Die DoorLine Snap / Cam unterstützt einfache Integrationen zu kompatiblen Systemen und Komponenten.

Zusätzlich werden für alle Tekkies, Tüftler, Bastler, Maker und Entwickler werden die API-Schnittstellen nachfolgend beschrieben.

HTTP Rest-API (zur DoorLine)

Diese API-Spezifikation gilt ab Firmware v1.6.0

siehe alternativ API-Spezifikation für Firmware bis einschließlich v1.5.x

Die DoorLine unterstützt eingehende HTTP GET-Requests.

Die URL ist nach diesem Schema aufgebaut:

http://{ip-address}/api/{endpoint}?pin={pin}&{parameter}={value}&{parameter}={value}

Dabei sind die Platzhalter entsprechend zu ersetzen:

{ip-address} = IP-Adresse der DoorLine im Netzwerk

{pin} = Konfigurierter PIN der DoorLine

{endpoint}, {parameter}, {value} = je nach gewünschter Aktion - siehe nachfolgende Beschreibung

Aktionen auslösen

Endpoint

Parameter


cmd/mon_ping


Verbindungstest

cmd/io_out01_trigger

duration (500 - 60000)

Relaiskontakt 1 für Dauer in Millisekunden einschalten

cmd/io_out01_set

state (true / false)

Relaiskontakt 1 schalten

cmd/io_out02_trigger

duration (500 - 60000)

Relaiskontakt 2 für Dauer in Millisekunden einschalten

cmd/io_out02_set

state (true / false)

Relaiskontakt 2 einschalten

cmd/hmi_backlight_trigger

duration (100 - 60000)

Beleuchtung der Klingeltaste für Dauer in Millisekunden umschalten

cmd/hmi_beep_trigger

duration (100 - 60000)
frequency (200 - 10000)

Piep mit Dauer von duration Millisekunden und Frequenz frequency ausgeben (Angabe frequency ist optional - default 900)

HTTP-Response

Bei erfolgreicher Auslösung der jeweiligen Aktion antwortet die DoorLine mit HTTP Status 200.

Beispiele

Als IP-Adresse für die DoorLine wird 192.168.178.30 und 0000 als PIN angenommen

Relais 1 für 2 Sekunden einschalten

URL: http://192.168.178.30/api/cmd/io_out01_trigger?pin=0000&duration=2000

Relais 2 einschalten

URL: http://192.168.178.30/api/cmd/io_out02_set?pin=0000&state=true

Relais 2 abschalten

URL: http://192.168.178.30/api/cmd/io_out02_set?pin=0000&state=false

Piep ausgeben

URL: http://192.168.178.30/api/cmd/hmi_beep_trigger?pin=0000&duration=500&frequency=1200

Werte abfragen

Endpoint

Beschreibung

Typ Rückgabewert

Beispiel Response

hmi_button01_elapsed

Zeit in Sekunden seit letzter Auslösung der Klingeltaste 1

String

{"hmi_button01_elapsed": 3243332}

hmi_button01_count

Anzahl Auslösungen der Klingeltaste 1 seit Systemstart

Integer

{"hmi_button01_count": 5}

hmi_button02_elapsed

Zeit in Sekunden seit letzter Auslösung der Klingeltaste 2

Integer

{"hmi_button02_elapsed": 9949}

hmi_button02_count

Anzahl Auslösungen der Klingeltaste 2 seit Systemstart

Integer

{"hmi_button02_count": 0}

io_in01

Status Schalteingang
(false = offen, true = geschlossen)

Boolean

{"io_in01": false}

io_out01

Schaltzustand Relaiskontakt 1

Boolean

{"io_out01": false}

io_out02

Schaltzustand Relaiskontakt 2

Boolean

{"io_out02": true}

io_sensor_light

Helligkeit Kamerabild in Lux
(grober Wert in Lux im Bereich 0 bis ca. 60)

Integer

{"io_sensor_light": 60}

x_sip_lastresult

Statuscode letzte SIP-Verbindung

String

{"x_sip_lastresult": "Undefined"}

wlan_rssi

WLAN Signalstärke

Integer

{"wlan_rssi": -39}

sys_uptime

Zeit in Sekunden seit Systemstart

Integer

{"sys_uptime": 2980}

sys_type

Bezeichnung des Geräts

String

{"sys_type": "DoorLine Snap 1"}

sys_fw_version

Installierte Firmware-Version

String

{"sys_fw_version": "1.6.0"}

Jeder Wert muss in einem separaten HTTP GET-Request abgefragt werden.

Zwischen den einzelnen HTTP-Requests die zur DoorLine geschickt werden, muss eine Pause von mindestens einer Sekunde eingehalten werden

HTTP-Response

Im Erfolgsfall antwortet die DoorLine mit HTTP Status 200. Der Rückgabewert wird als Content-Type: application/json geliefert.

Beispiele

Als IP-Adresse für die DoorLine wird 192.168.178.30 und 0000 als PIN angenommen

Anzahl Auslösungen Taste 1

URL: http://192.168.178.30/api/hmi_button01_count?pin=0000

Response: {"hmi_button01_count": 0}

Sekunden seit Systemstart

URL: http://192.168.178.30/api/sys_uptime?pin=0000

Response: {"sys_uptime": 10380}

OpenAPI-Spezifikation

zur Rest-API bieten wir auch diese OpenAPI-Spezifikation für die einfache Integration: dlsnap_openapi_1.6.0.yaml

HTTP Push-Benachrichtigungen von der DoorLine

In der Konfigurationsoberfläche der DoorLine können “API-Aktionen” konfiguriert werden.

Dabei können vier getrennte Aktionen (Auslöser) konfiguriert werden und dazu jeweils eine HTTP-URL eingestellt werden. Auf die konfigurierte URL wird bei eintreten der Aktion ein HTTP GET-Request abgesetzt.

Für zeitkritische Ereignisse, wie das Türklingeln oder das Auslösen eines Türöffners sollten immer die Push-Benachrichtigungen bevorzugt werden. Damit erreicht man kürzere Verzögerungszeiten und werden weniger Ressourcen benötigt als beim Polling der Abfragewerte