DoorLine Snap / CAM
DoorLine Snap / CAM
Breadcrumbs

HTTP Rest API - bis FW 1.5.x

Ab Firmware v1.6.0 wurde die Rest-API grundlegend angepasst - siehe HTTP Rest API

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


out01/trigger

duration (500 - 60000)

Relaiskontakt 1 für Dauer in Millisekunden einschalten

out01/on


Relaiskontakt 1 einschalten

out01/off


Relaiskontakt 1 abschalten

out02/trigger

duration (500 - 60000)

Relaiskontakt 2 für Dauer in Millisekunden einschalten

out02/on


Relaiskontakt 2 einschalten

out02/off


Relaiskontakt 2 abschalten

button_backlight/trigger

duration (100 - 60000)

Beleuchtung der Klingeltaste für Dauer in Millisekunden umschalten

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

http://192.168.178.30/api/out01/trigger?pin=0000&duration=2000

Relais 2 einschalten

http://192.168.178.30/api/out02/on?pin=0000

Relais 2 abschalten

http://192.168.178.30/api/out02/off?pin=0000

Piep ausgeben

http://192.168.178.30/api/beep/trigger?pin=0000&duration=500&frequency=1200

Werte abfragen

Endpoint

Beschreibung

Typ Rückgabewert

Beispiel Response

button01/since_ring

Zeit seit letzter Auslösung der Klingeltaste 1

String

{"since_ring": "13:57:39 h:min:s"}

button01/count

Anzahl Auslösungen der Klingeltaste 1 seit Systemstart

Integer

{"count": 5}

button02/since_ring

Zeit seit letzter Auslösung der Klingeltaste 2

Integer

{"since_ring": "13:58:37 h:min:s"}

button02/count

Anzahl Auslösungen der Klingeltaste 2 seit Systemstart

Integer

{"count": 0}

in01/status

Status Schalteingang
(0 = offen, 1 = geschlossen)

Boolean

{"status": false}

light_sensor/value

Status Helligkeit Kamerabild
(0 = dunkel, 1 = hell)

Boolean

{"value": true}

sip/status

Statuscode letzte SIP-Verbindung

String

{"status": "Undefined"}

out01/status

Schaltzustand Relaiskontakt 1

Boolean

{"status": false}

out02/status

Schaltzustand Relaiskontakt 2

Boolean

{"status": true}

system/uptime

Zeit seit Systemstart in Sekunden

String

{"uptime": "14:03:27 h:min:s"}

system/firmware

Installierte Firmware-Version

String

{"firmware": "V1.5.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

http://192.168.178.30/api/button01/count?pin=0000

{"count": 0}

Sekunden seit Systemstart

http://192.168.178.30/api/system/uptime?pin=0000