
Send to Websocket Action
Die Send To Websocket-Aktion sendet eine Nachricht von Ihrer laufenden Studie an ein Programm, das über eine WebSocket-Verbindung lauscht, wie beispielsweise ein lokales Python-Skript, ein Aufzeichnungsgerät oder einen externen Server. Die Nachricht kann den Wert einer Variablen enthalten, und die Aktion kann auch eine aufgezeichnete Bild-, Audio- oder Videodatei senden.
Inhaltsverzeichnis
Überblick
Die Send To Websocket-Aktion ist im API Actions-Kategorie im Aktionsauswahlmenü aufgeführt. Zusammen mit dem Websocket Trigger ermöglicht sie einer Studie die bidirektionale Kommunikation mit Software, die außerhalb von Labvanced läuft.
Häufige Anwendungsfälle
Die Send To Websocket-Aktion wird überall dort verwendet, wo etwas, das in der Studie passiert, außerhalb davon bekannt sein soll.
- Senden von Ereignismarkern an Aufzeichnungssysteme: beim Stimulusbeginn, einer Antwort oder einem Bedingungswechsel sendet die Studie einen Marker an ein lokales Skript, das ihn in einen Lab Streaming Layer-Marker umwandelt, sodass er zusammen mit EEG- und Eye-Tracking-Streams zeitgestempelt wird. Siehe EEG & Hardware-Integrationen.
- Daten an einen Server übermitteln: die Studie sendet die Antwort eines Teilnehmers oder einen berechneten Wert an einen Server, der diesen verarbeitet, beispielsweise einen Analyse- oder Maschinenlernprozess.
- Aufgezeichnete Medien senden: eine aufgezeichnete Bild-, Audio- oder Videodatei wird an ein Programm gesendet, das sie speichert oder analysiert.
Wie es funktioniert
Um auf die Send To Websocket-Aktion zuzugreifen, öffnen Sie das Event-System im Task-Editor und wählen Sie ein Ereignis aus oder erstellen Sie eines. Im Aktionsbereich öffnen Sie die API Actions-Kategorie und wählen Send To Websocket.
Die Aktion ist verfügbar, sobald die Verbindung in den Studieneinstellungen aktiviert ist. Wenn Send To Websocket im Menü ausgegraut ist, aktivieren Sie es zuerst:
- Öffnen Sie den
Settings-Reiter. - Öffnen Sie das
Special Features-Drop-down und suchen Sie denWebsocket Connection-Abschnitt. - Aktivieren Sie die Option, um es zu aktivieren, und geben Sie dann den
WebSocket Addressund denPortein. Die Standardwerte sindws://localhostund8081, die mit einem Skript auf demselben Computer wie die Studie verbunden sind.
Der Dialog enthält Folgendes:
| Option | Beschreibung |
|---|---|
Websocket Address | Zeigt die Adresse aus Ihren Studieneinstellungen an. Sie kann hier nicht bearbeitet werden. |
Port | Zeigt den Port aus Ihren Studieneinstellungen an. Er kann hier nicht bearbeitet werden. |
Data Type | Wählt aus, was die Aktion sendet. Text / JSON sendet eine Nachricht und einen optionalen Variablenwert. Binary (image/audio/video) sendet eine aufgezeichnete Datei. |
Trigger / message to send | Das Nachrichtenlabel, zum Beispiel trigger1. Dieses Feld erscheint nur für Text / JSON. |
Send Variable | Die Variable, deren Wert gesendet wird. Sie ist optional für Text / JSON und erforderlich für Binary (image/audio/video). Die Auswahl öffnet den Variablenpicker. |
Für Binary (image/audio/video) wählen Sie eine Variable aus, die eine Aufnahme enthält, wie die Variable einer Audio- oder Videoaufnahme. Wenn die Variable in diesem Moment keine Aufnahme enthält, wird nichts gesendet.
Was das empfangende Programm erhält
Die Aktion hat nur Auswirkungen, wenn ein Programm außerhalb von Labvanced lauscht. Dieses Programm, normalerweise ein kurzes Skript auf demselben Computer, führt den WebSocket-Server aus, mit dem die Studie verbunden ist, und liest jede Nachricht, die die Studie sendet.
Mit Text / JSON hat jede Nachricht zwei Teile:
- Ein Label: der Text von
Trigger / message to send, zum Beispieltrigger1. Das empfangende Programm verwendet es, um Nachrichtentypen zu unterscheiden. - Inhalt: der aktuelle Wert der unter
Send Variablegewählten Variable. Wenn keine Variable gewählt ist, hat die Nachricht nur ein Label.
Mit Binary (image/audio/video) sendet die Aktion die aufgezeichnete Datei eigenständig, ohne ein Label.
Für die Person, die das empfangende Skript schreibt, ist eine Text / JSON-Nachricht ein JSON-Objekt mit den Feldern msg für das Label und value für den Inhalt, und value ist null, wenn keine Variable gewählt ist. Die Beispielskripte im Labvanced WebSocket-API-Repository auf GitHub empfangen Nachrichten von einer Studie und senden sie als LSL-Marker weiter und sind ein guter Ausgangspunkt. Für die Verbindungsherstellung siehe den WebSocket API Leitfaden.
Workflow-Tipps
- Starten Sie Ihr Skript, bevor Sie die Studie beginnen. Die Studie öffnet die Verbindung, wenn sie startet.
- Testen Sie die Verbindung mit der Studie, die auf demselben Computer wie das Skript läuft, bevor Sie Daten sammeln. Der Standard
ws://localhosterreicht nur Programme auf diesem Computer. - Senden Sie ein Bedingungslabel oder eine Versuchsnr. in
Send Variable, wenn die empfangende Seite wissen muss, zu welchem Stimulus ein Marker gehört. - Platzieren Sie die Aktion im Ereignis, das im Moment, in dem Sie markieren möchten, ausgelöst wird, zum Beispiel beim Start des Frames oder einem Klick, sodass die Nachricht in diesem Moment gesendet wird.
Studien & Beispielszenarien
Einen Marker an LSL senden. In der LSL Send Marker Bibliotheksstudie liefert ein Eingabefeld den Markerwert und ein Button-Klick sendet ihn mit dieser Aktion an einen lokalen Python-Server. Der Server wandelt die Nachricht in einen LSL-Marker um. Verwenden Sie die Inspect-Option in der Bibliothek, um das Ereignis-Setup zu sehen.
Zwei-Wege-Nachrichtenübertragung. Die Socket Connection Example Bibliotheksstudie sendet eine Nachricht aus der Studie mit dieser Aktion und reagiert auf die Antworten mit dem Websocket Trigger.
Weiterführende Literatur
Websocket Trigger
Der gekoppelte Trigger, um auf Nachrichten zu reagieren, die von einem externen Programm eintreffen.
WebSocket API
Wie man eine Studie mit einem lokalen Skript oder einem externen Server verbindet.
Wertauswahlmenü
Wie man Werte in den Dialogen Ihrer Aktionen referenziert.
Ereignisse Übersicht
Eine vollständige Einführung in das Trigger- und Aktionslogiksystem in Labvanced.