
Déclencheur Websocket
Le Websocket Trigger s'active lorsque votre étude en cours reçoit un message via sa connexion WebSocket. Il permet à un script local, un appareil d'enregistrement ou un serveur externe de démarrer un événement dans votre étude au moment où quelque chose se produit en dehors du navigateur.
Table des Matières
Aperçu
Le Websocket Trigger est listé sous la catégorie API/External Trigger dans le menu de sélection du déclencheur. Avec l'Action Envoyer au Websocket, il permet à une étude d'avoir une communication bidirectionnelle avec un logiciel fonctionnant en dehors de Labvanced.
Cas d'Utilisation Commun
Le Websocket Trigger est utilisé chaque fois qu'un signal provenant de l'extérieur de l'étude doit modifier ce qui se passe dans l'étude.
- Réception de marqueurs LSL : un script Python local passe un marqueur d'un autre dispositif Lab Streaming Layer dans l'étude, afin que l'étude puisse l'enregistrer à côté de ses propres horodatages. Voir EEG & Intégrations Matérielles pour l'image complète.
- Conceptions en boucle fermée et biofeedback : un script qui traite un signal physiologique envoie un message chaque fois qu'un seuil est franchi, et l'étude modifie le stimulus en réponse.
- Traitement Externe : un serveur analyse les données envoyées par l'étude et renvoie un résultat, comme une classification ou un score, que l'étude affiche ou enregistre ensuite.
Comment ça Marche
Pour accéder au Websocket Trigger, ouvrez le Système d'Événements dans l'éditeur de tâches et créez un nouvel événement. Sous la catégorie API/External Trigger, sélectionnez Websocket Trigger.
Avant que le déclencheur puisse être utilisé, activez la connexion dans les paramètres de l'étude :
- Ouvrez l'onglet
Settings. - Ouvrez le menu déroulant
Special Featureset trouvez la sectionWebsocket Connection. - Cochez l'option pour l'activer, puis entrez
WebSocket AddressetPort. Les valeurs par défaut sontws://localhostet8081, qui se connectent à un script fonctionnant sur le même ordinateur que l'étude.
La boîte de dialogue contient les éléments suivants :
| Option | Description |
|---|---|
Websocket Address | Affiche l'adresse de vos paramètres d'étude. Elle ne peut pas être modifiée ici. |
Port | Affiche le port de vos paramètres d'étude. Il ne peut pas être modifié ici. |
trigger / message | L'étiquette du message qui déclenche cet événement. Le déclencheur s'active lorsque l'étiquette d'un message entrant correspond exactement à ce texte. Entrez any pour déclencher à chaque message entrant. |
Lorsque l'étude commence, Labvanced ouvre la connexion à l'adresse et au port que vous avez entrés. Si la connexion n'est pas activée dans les paramètres, aucune connexion n'est établie et le déclencheur ne s'active jamais.
Le déclencheur écoute uniquement pendant que le cadre contenant l'événement est affiché. Un message qui arrive pendant qu'un autre cadre est affiché ne déclenche pas cet événement. Placez l'événement sur chaque cadre où l'étude doit réagir au message.
Un événement avec any s'active pour chaque message. Si un autre événement sur le même cadre utilise une étiquette spécifique, les deux événements se déclenchent lorsqu'un message avec cette étiquette arrive.
Ce que le Programme d'Envoi Fournit
Le déclencheur ne s'active que si un programme externe à Labvanced lui envoie un message. Ce programme, généralement un court script sur le même ordinateur, exécute le serveur WebSocket auquel l'étude se connecte. Chaque message qu'il envoie a deux parties :
- Une étiquette : le déclencheur la compare avec le champ
trigger / message. Lorsqu'ils correspondent, l'événement se déclenche, et l'étiquette est disponible en tant que valeurMessage. - Contenu : toute valeur que le script souhaite transmettre, telle qu'une valeur de marqueur ou une mesure. Elle est disponible en tant que valeur
Data.
Pour la personne écrivant le script, chaque message est un objet JSON avec les champs msg pour l'étiquette et value pour le contenu. Les exemples de scripts dans le dépôt API WebSocket de Labvanced sur GitHub envoient et reçoivent des marqueurs LSL de cette manière et constituent un bon point de départ. Pour la configuration de la connexion, consultez le guide API WebSocket.
Valeurs Spécifiques au Déclencheur pour Déclencheur Websocket
Après que le déclencheur s'est activé, les valeurs suivantes sont disponibles dans les actions de l'événement. Sélectionnez-les dans le Menu de Sélection de Valeurs sous Trigger (Websocket Trigger).
| Valeur | Description |
|---|---|
Message | L'étiquette du message reçu. Utilisez-la pour différencier les types de messages, surtout dans un événement qui utilise any. |
Data | Le contenu du message reçu. Il peut contenir toute valeur JSON, telle qu'un nombre, une chaîne ou une liste, et peut être stocké dans une variable avec l'Action Définir / Enregistrer Variable. |
Trigger Timestamp (Unixtime) | Le temps auquel le déclencheur s'est activé, en temps Unix avec des millisecondes. |
Trigger Time (From Frame Onset) | Le temps en millisecondes depuis le début du cadre jusqu'au moment où le déclencheur s'est activé. |
Conseils de Flux de Travail
- Démarrez votre script avant de commencer l'étude. La connexion est ouverte lorsque l'étude commence.
- Testez la connexion avec l'étude fonctionnant sur le même ordinateur que le script avant de collecter des données. Le
ws://localhostpar défaut ne peut atteindre que les programmes sur cet ordinateur. - Gardez les étiquettes de message courtes et cohérentes entre le script et l'étude. La correspondance est exacte, donc
Markeretmarkersont des messages différents. - Enregistrez
Trigger Time (From Frame Onset)avecDatalorsque le timing du message est important pour l'analyse.
Études & Scénarios Exemples
Réception d'un marqueur d'un autre dispositif. Dans l'étude de bibliothèque LSL Receive Marker, un marqueur produit par un dispositif externe atteint un script Python local, qui le transmet à l'étude via un Websocket Trigger. L'étude enregistre ensuite la valeur du marqueur. Utilisez l'option Inspect dans la bibliothèque pour voir la configuration de l'événement.
Messagerie bidirectionnelle. L'étude de bibliothèque Exemple de Connexion Socket envoie un message hors de l'étude avec l'action Envoyer au Websocket et réagit aux réponses avec ce déclencheur.
Lectures Complémentaires
Action Envoyer au Websocket
L'action associée pour envoyer un message ou une variable hors de l'étude.
API WebSocket
Comment connecter une étude à un script local ou à un serveur externe.
Menu de Sélection de Valeurs
Comment référencer les valeurs spécifiques au déclencheur dans vos actions.
Aperçu des Événements
Une introduction complète au système logique de déclencheur et d'action dans Labvanced.