
Websocket Trigger
Der Websocket Trigger wird ausgelöst, wenn Ihre laufende Studie eine Nachricht über ihre WebSocket-Verbindung empfängt. Er ermöglicht es einem lokalen Skript, einem Aufnahmegerät oder einem externen Server, ein Ereignis in Ihrer Studie zu starten, sobald etwas außerhalb des Browsers passiert.
Inhaltsverzeichnis
Übersicht
Der Websocket Trigger ist im API/External Trigger Kategorie im Trigger-Auswahlmenü aufgeführt. Zusammen mit der Send to Websocket Action ermöglicht er einer Studie die bidirektionale Kommunikation mit Software, die außerhalb von Labvanced läuft.
Häufige Anwendungsfälle
Der Websocket Trigger wird überall dort verwendet, wo ein Signal von außerhalb der Studie das Geschehen innerhalb der Studie ändern soll.
- Empfangen von LSL-Markern: Ein lokales Python-Skript überträgt einen Marker von einem anderen Lab Streaming Layer-Gerät in die Studie, sodass die Studie diesen neben ihren eigenen Zeitstempeln aufzeichnen kann. Siehe EEG & Hardware-Integrationen für das vollständige Bild.
- Closed-Loop- und Biofeedback-Designs: Ein Skript, das ein physiologisches Signal verarbeitet, sendet eine Nachricht, wann immer ein Schwellenwert überschritten wird, und die Studie ändert den Stimulus als Reaktion darauf.
- Externe Verarbeitung: Ein Server analysiert Daten, die aus der Studie gesendet werden, und gibt ein Ergebnis zurück, wie beispielsweise eine Klassifizierung oder einen Punktestand, den die Studie dann anzeigt oder aufzeichnet.
Wie es funktioniert
Um auf die Websocket Trigger zuzugreifen, öffnen Sie das Ereignissystem im Aufgabeneditor und erstellen Sie ein neues Ereignis. Wählen Sie unter der API/External Trigger Kategorie Websocket Trigger aus.
Bevor der Trigger verwendet werden kann, aktivieren Sie die Verbindung in den Studieneinstellungen:
- Öffnen Sie die
SettingsRegisterkarte. - Öffnen Sie das
Special FeaturesDropdown-Menü und suchen Sie denWebsocket ConnectionAbschnitt. - Aktivieren Sie die Option zur Aktivierung, und geben Sie dann die
WebSocket Addressund diePortein. Die Standardwerte sindws://localhostund8081, die eine Verbindung zu einem Skript herstellen, das auf demselben Computer wie die Studie läuft.
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. |
trigger / message | Das Nachrichtenlabel, das dieses Ereignis auslöst. Der Trigger wird ausgelöst, wenn das Label einer eingehenden Nachricht genau mit diesem Text übereinstimmt. Geben Sie any ein, um auf jede eingehende Nachricht zu reagieren. |
Wenn die Studie startet, öffnet Labvanced die Verbindung zu der Adresse und dem Port, die Sie eingegeben haben. Wenn die Verbindung in den Einstellungen nicht aktiviert ist, wird keine Verbindung geöffnet und der Trigger wird niemals ausgelöst.
Der Trigger lauscht nur, während der Frame, der das Ereignis enthält, angezeigt wird. Eine Nachricht, die ankommt, während ein anderer Frame angezeigt wird, löst dieses Ereignis nicht aus. Platzieren Sie das Ereignis in jedem Frame, in dem die Studie auf die Nachricht reagieren soll.
Ein Ereignis mit any wird für jede Nachricht ausgelöst. Wenn ein anderes Ereignis im selben Frame ein spezifisches Label verwendet, werden beide Ereignisse ausgelöst, wenn eine Nachricht mit diesem Label ankommt.
Was das sendende Programm bereitstellt
Der Trigger wird nur ausgelöst, wenn ein Programm außerhalb von Labvanced ihm eine Nachricht sendet. Dieses Programm, normalerweise ein kurzes Skript auf demselben Computer, betreibt den WebSocket-Server, mit dem die Studie verbindet. Jede Nachricht, die es sendet, hat zwei Teile:
- Ein Label: Der Trigger vergleicht es mit dem
trigger / messageFeld. Wenn sie übereinstimmen, wird das Ereignis ausgelöst, und das Label ist alsMessageWert verfügbar. - Inhalt: Jeder Wert, den das Skript übermitteln möchte, z. B. einen Markerwert oder eine Messung. Er ist als
DataWert verfügbar.
Für die Person, die das Skript schreibt, ist jede Nachricht ein JSON-Objekt mit den Feldern msg für das Label und value für den Inhalt. Die Beispielscripte im Labvanced WebSocket API-Repository auf GitHub senden und empfangen LSL-Marker auf diese Weise und sind ein guter Ausgangspunkt. Für die Verbindungsherstellung siehe die WebSocket API Anleitung.
Trigger-spezifische Werte für den Websocket Trigger
Nach dem Auslösen des Triggers sind die folgenden Werte in den Aktionen des Ereignisses verfügbar. Wählen Sie sie über das Wert-Auswahlmenü unter Trigger (Websocket Trigger) aus.
| Wert | Beschreibung |
|---|---|
Message | Das Label der empfangenen Nachricht. Verwenden Sie es, um Nachrichtentypen zu unterscheiden, insbesondere in einem Ereignis, das any verwendet. |
Data | Der Inhalt der empfangenen Nachricht. Er kann jeden JSON-Wert halten, z. B. eine Zahl, einen String oder eine Liste, und kann mit der Setzen / Aufzeichnen der Variablen-Aktion in einer Variablen gespeichert werden. |
Trigger Timestamp (Unixtime) | Der Zeitpunkt, zu dem der Trigger ausgelöst wurde, in Unix-Zeit mit Millisekunden. |
Trigger Time (From Frame Onset) | Die Zeit in Millisekunden vom Beginn des Frames bis zum Zeitpunkt, an dem der Trigger ausgelöst wurde. |
Workflow-Tipps
- Starten Sie Ihr Skript, bevor Sie die Studie starten. Die Verbindung wird hergestellt, wenn die Studie gestartet wird.
- Testen Sie die Verbindung, während die Studie auf demselben Computer läuft wie das Skript, bevor Sie Daten sammeln. Der Standard
ws://localhosterreicht nur Programme auf diesem Computer. - Halten Sie die Nachrichtenlabels kurz und konsistent zwischen dem Skript und der Studie. Die Übereinstimmung ist genau, daher sind
Markerundmarkerunterschiedliche Nachrichten. - Zeichnen Sie
Trigger Time (From Frame Onset)zusammen mitDataauf, wenn das Timing der Nachricht für die Analyse wichtig ist.
Studien & Beispielszenarien
Empfangen eines Markers von einem anderen Gerät. In der LSL Receive Marker Bibliotheksstudie erreicht ein Marker, der von einem externen Gerät erzeugt wurde, ein lokales Python-Skript, das ihn über einen Websocket Trigger an die Studie übergibt. Die Studie zeichnet dann den Markerwert auf. 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 der Send to Websocket-Aktion und reagiert auf die Antworten mit diesem Trigger.
Weiterführende Literatur
Send to Websocket Action
Die zugehörige Aktion zum Senden einer Nachricht oder einer Variablen aus der Studie.
WebSocket API
Wie man eine Studie mit einem lokalen Skript oder einem externen Server verbindet.
Wert-Auswahlmenü
Wie man trigger-spezifische Werte in Ihren Aktionen referenziert.
Ereignisse Übersicht
Eine vollständige Einführung in das Trigger-und-Aktions-Logiksystem in Labvanced.