WebSocket API
Wie die WebSocket-API mit Lab Streaming Layer und Geräten wie EEG zusammenpasst, erfahren Sie in EEG & Hardware Integrations.
Die benutzerdefinierte WebSocket-API ermöglicht es Ihnen, während der Laufzeit eine Verbindung zwischen Labvanced und einem anderen Server herzustellen. Dies ermöglicht im Wesentlichen die Möglichkeit, Daten in beide Richtungen zwischen dem Labvanced-Server und dem anderen Server, den Sie angeben, zu senden. Wenn Sie Daten nur in eine Richtung senden müssen (d.h. sie direkt auf Ihren Server zu speichern), lesen Sie die Dokumentation für die Webhook API.
Einige Beispiele für Experimente, bei denen die WebSocket-API verwendet werden kann, sind die folgenden:
- Ein Experiment, bei dem Sie experimentelle Trigger (z.B. Versuch-/Stimulusbeginn oder Teilnehmerantwort) von Labvanced an ein EEG-System, ein Eye-Tracking-System oder ein anderes lokales Datenaufzeichnungsgerät senden/empfangen möchten.
- Ein Experiment, bei dem Sie online aufgezeichnete Daten über das Internet an einen anderen Server/API senden möchten, der sie verarbeitet (z.B. einen KI-/Maschinenlernprozess oder eine Echtzeitanalyse von Daten).
- Ein Experiment, bei dem Sie eine bidirektionale Kommunikation zwischen Labvanced und einem anderen Prozess, der lokal oder remote ausgeführt werden kann, herstellen möchten (z.B. für BCI, Biofeedback oder andere geschlossene Steuerungssysteme).
Falls Sie Labvanced mit einem lokalen Server (z.B. zur Verbindung von Geräten) verbinden möchten, können Sie dies derzeit über einfache Skripte (unten beschrieben) und durch das Einrichten von Ereignissen im Labvanced-Studieneditor erreichen. In Zukunft wird eine integrierte Lösung in der Labvanced-Desktop-App verfügbar sein, mit der Sie diese Verbindung mit einem einfachen Klick auf eine Schaltfläche herstellen können.
Skriptlösung
Mit Skripten können Sie grundlegenden Python-Code anpassen, der erfordert, dass Sie das Skript ausführen, und letztendlich die Flexibilität bietet, um Forschungsbedürfnisse zu erfüllen. Durch das Ausführen eines separaten Python-Skripts kommuniziert Labvanced mit der WebSocket-API, und Python kommuniziert mit dem externen Gerät.
Die WebSocket-API-Konfiguration funktioniert, indem sie auf einen bestimmten Port und eine IP verweist. Dies wird dann im Python-Code reflektiert. Indem sie aufeinander verweisen, wird eine Kommunikationslinie über die WebSocket-API hergestellt.
HINWEIS: Um die Verbindung zu sehen, kann eine GUI für diesen halbautomatischen Prozess verwendet werden.
Unser vorheriger Ansatz (es direkt im Labvanced-Programm einzubetten) war etwas zu eingeschränkt und schwer zum Laufen zu bringen über verschiedene Betriebssysteme. Mit diesen neuen Python-Skripten sollte es jetzt auf allen Plattformen (Linux, MacOS, Windows) funktionieren und es sollte möglich sein, LSL-Stream-Daten bidirektional zu senden und zu empfangen.
Was Sie tun müssen, um es auszuprobieren:
- Installieren Sie die 4 erforderlichen Bibliotheken mit etwas wie pip install -r requirements.txt
- Dann können Sie im Hintergrund auf demselben Computer, auf dem das Labvanced-Experiment gestartet wird, entweder (um LSL-Marker in Labvanced zu empfangen) python3 lsl_marker_receive.py oder (um LSL-Marker von Labvanced zu senden) python3 lsl_marker_send.py.
HINWEIS: Sie können diese Skripte auch leicht anpassen, falls Sie spezifische LSL-Parameter oder Stream-Namen wünschen.
In unserem GitHub WebSocket API-Repository finden Sie zwei Beispielfa-GitScripts, um LSL-Marker von/ein Labvanced-Experiment im Lab Streaming Layer Ordner zu senden oder zu empfangen, sowie detailliertere Anweisungen, wie Sie dies einrichten können.
Sie können auch diese Socket Connection Sample Study aus unserer öffentlichen Experimentbibliothek importieren und sehen, wie die Ereignisse eingerichtet sind.
Beispiele für Experimente, die die WebSocket-API zur LSL-Integration nutzen
Es gibt zwei Beispielstudien in der Labvanced-Studienbibliothek, die den oben genannten entsprechen:
Senden von LSL-Markern (lsl_marker_send.py): https://www.labvanced.com/page/library/53231
Empfangen von LSL-Markern (lsl_marker_receive.py): https://www.labvanced.com/page/library/53230
Bitte beachten Sie, dass Sie beim Importieren oder Überprüfen dieser Beispielstudien in ihren „Studieneinstellungen“ im Abschnitt „Experimentfeatures“ sehen, dass das Kontrollkästchen für die "WebSocket-Verbindung" aktiviert ist, mit Verbindungsdetails, um sicherzustellen, dass das Labvanced-Experiment mit dem auf demselben Computer ausgeführten Python-Skript verbunden werden kann, wie im Bild unten dargestellt:
