HTTP API

Die BlinkEasy App bietet Ihnen eine einfache Möglichkeit Ihre eigenen Anwendungen über HTTP anzusteuern. Diese fortgeschrittene Option kann aktiviert werden, um benutzerdefinierte Analysen zu implementieren oder IOT-Geräte zu steuern. Ein denkbares Einsatzfeld wäre beispielsweise die Beleuchtung in einem Smart-Home-Szenario zu regeln (Beispielcode auf github).

Um diesese Feature zu aktivieren geben Sie auf der Einstellungsseite unter "API" die gewünschte URL (http oder https) ein.

HTTP-Requests werden gesendet sobald ein Ereignis auftritt. Statistiken wie die aktuelle Lidschlagfrequenz werden periodisch übermittelt.
Um den Datenschutz zu gewährleisten, ist das HTTP-Modul auf verallgemeinerte Daten beschränkt und kann weder Videobilder noch personenbezogene Informationen senden.
Benutzerdefinierte URL-Parameter werden unterstützt. Beispielsweise um Anmeldeinformationen zu übermitteln oder zwischen Geräten unterscheiden zu können.

Parameters send with every request:

event	ID of the event. Possible values: BLINK, START, END, BPM, ALERT, BREAK
timestamp	Milliseconds elapsed since Jan 01 1970 (UTC).

Example:


http://localhost:3000/myscript.php?event=START&timestamp=1723321032811

Possible events:

BLINK

Send when a blink was detected.

Parameters:

duration	Blink duration in milliseconds
bpm	Current Blinkrate (blinks per minute)

Example:


http://localhost:3000/myscript.php?event=BLINK&bpm=13.2&duration=185&timestamp=1723321032811

START

Send when a face was detected for the first time, starting the session.

Example:


http://localhost:3000/myscript.php?event=START&timestamp=1723321032811

END

Send when for timeout milliseconds no faces were detected, ending the current session.

Parameters:

timeout

Current session timeout in milliseconds. The last time a face was recognized is the events timestamp minus the timeout.

Example:


http://localhost:3000/myscript.php?event=END&timeout=60&timestamp=1723321032811

BPM

Periodic event

Parameters:

bpm	Current blink rate in blinks per minute.

Example:


http://localhost:3000/myscript.php?event=BPM&bpm=13.2&timestamp=1723321032811

ALERT

Send when the user's blink rate has fallen under the given threshold. This event will also be send when blink reminders are disabled.

Parameters:

bpm	Current blink rate in blinks per minute.
target	The threshold that the current blink rate has fallen below.
duration	Number of milliseconds below the target until the alert was issued.

Example:


http://localhost:3000/myscript.php?event=ALERT&bpm=13.2&target=15.0&duration=12&timestamp=1723321032811

BREAK

A break reminder was issued.

Parameters:

none

Example:


http://localhost:3000/myscript.php?event=BREAK&timestamp=1723321032811