
Envoyer à l'action Websocket
L'action Send To Websocket envoie un message de votre étude en cours à un programme à l'écoute sur une connexion WebSocket, comme un script Python local, un dispositif d'enregistrement ou un serveur externe. Le message peut contenir la valeur d'une variable, et l'action peut également envoyer une image, un audio ou un fichier vidéo enregistré.
Aperçu
L'action Send To Websocket est répertoriée sous la catégorie API Actions dans le menu de sélection des actions. Avec le Déclencheur Websocket, elle permet à une étude de communiquer dans les deux sens avec un logiciel fonctionnant en dehors de Labvanced.
Cas d'utilisation communs
L'action Send To Websocket est utilisée chaque fois que quelque chose qui se produit dans l'étude doit être connu à l'extérieur.
- Envoi de marqueurs d'événement aux systèmes d'enregistrement : au début du stimulus, à une réponse ou à un changement de condition, l'étude envoie un marqueur à un script local qui le transforme en marqueur Lab Streaming Layer, de sorte qu'il soit horodaté avec les flux EEG et de suivi oculaire. Voir Intégrations EEG et matériel.
- Transmission de données à un serveur : l'étude envoie une réponse du participant ou une valeur calculée à un serveur qui la traite, comme un processus d'analyse ou d'apprentissage automatique.
- Envoi de médias enregistrés : une image, un audio ou un fichier vidéo enregistré est envoyé à un programme qui le stocke ou l'analyse.
Comment ça fonctionne
Pour accéder à l'action Send To Websocket, ouvrez le Système d'événements dans l'Éditeur de tâches et sélectionnez ou créez un événement. Dans la zone d'action, ouvrez la catégorie API Actions et sélectionnez Send To Websocket.
L'action est disponible une fois la connexion activée dans les paramètres de l'étude. Si Send To Websocket est grisé dans le menu, activez-le d'abord :
- 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 | Montre l'adresse de vos paramètres d'étude. Elle ne peut pas être modifiée ici. |
Port | Montre le port de vos paramètres d'étude. Elle ne peut pas être modifiée ici. |
Data Type | Choisit ce que l'action envoie. Text / JSON envoie un message et une valeur variable optionnelle. Binary (image/audio/video) envoie un fichier enregistré. |
Trigger / message to send | L'étiquette du message, par exemple trigger1. Ce champ apparaît uniquement pour Text / JSON. |
Send Variable | La variable dont la valeur est envoyée. Elle est facultative pour Text / JSON et obligatoire pour Binary (image/audio/video). La sélection ouvre le sélecteur de variable. |
Pour Binary (image/audio/video), sélectionnez une variable qui contient un enregistrement, tel que la variable d'un enregistrement audio ou vidéo. Si la variable ne contient pas un enregistrement à ce moment-là, rien n'est envoyé.
Ce que le programme récepteur obtient
L'action n'a d'effet que si un programme en dehors de Labvanced écoute. Ce programme, généralement un court script sur le même ordinateur, exécute le serveur WebSocket auquel l'étude se connecte et lit chaque message que l'étude envoie.
Avec Text / JSON, chaque message a deux parties :
- Une étiquette : le texte de
Trigger / message to send, par exempletrigger1. Le programme récepteur l'utilise pour différencier les types de messages. - Contenu : la valeur actuelle de la variable choisie sous
Send Variable. Si aucune variable n'est choisie, le message n'a qu'une étiquette.
Avec Binary (image/audio/video), l'action envoie le fichier enregistré par lui-même, sans étiquette.
Pour la personne écrivant le script récepteur, un message Text / JSON est un objet JSON avec les champs msg pour l'étiquette et value pour le contenu, et value est null lorsque aucune variable n'est choisie. Les scripts d'exemple dans le dépôt de l'API WebSocket de Labvanced sur GitHub reçoivent des messages d'une étude et les envoient sous forme de marqueurs LSL, et constituent un bon point de départ. Pour la configuration de la connexion, consultez le guide API WebSocket.
Conseils de workflow
- Démarrez votre script avant de commencer l'étude. L'étude ouvre la connexion lorsqu'elle commence.
- Testez la connexion avec l'étude en cours d'exécution sur le même ordinateur que le script avant de collecter des données. Le
ws://localhostpar défaut n'atteint que les programmes sur cet ordinateur. - Envoyez une étiquette de condition ou un numéro d'essai dans
Send Variablelorsque le côté récepteur doit savoir à quel stimulus un marqueur appartient. - Placez l'action dans l'événement qui se déclenche au moment où vous souhaitez marquer, tel que le début de la trame ou un clic, afin que le message soit envoyé à ce moment-là.
Études et scénarios d'exemple
Envoi d'un marqueur à LSL. Dans l'étude de la bibliothèque LSL Send Marker, un champ d'entrée fournit la valeur du marqueur et un clic sur un bouton l'envoie avec cette action à un serveur Python local. Le serveur transforme le message en un marqueur LSL. Utilisez l'option Inspect dans la bibliothèque pour voir la configuration de l'événement.
Messaging bidirectionnel. L'étude de la bibliothèque Exemple de connexion Socket envoie un message en dehors de l'étude avec cette action et réagit aux réponses avec le Déclencheur Websocket.
Lectures complémentaires
Déclencheur Websocket
Le déclencheur associé pour réagir aux messages qui arrivent d'un programme externe.
API WebSocket
Comment connecter une étude à un script local ou un serveur externe.
Menu de sélection de valeur
Comment référencer les valeurs dans les boîtes de dialogue de vos actions.
Aperçu des événements
Une introduction complète au système de logique déclencheur-et-action dans Labvanced.