
Enviar a la Acción Websocket
La acción Send To Websocket envía un mensaje desde su estudio en ejecución a un programa que escucha en una conexión WebSocket, como un script de Python local, un dispositivo de grabación o un servidor externo. El mensaje puede llevar el valor de una variable y la acción también puede enviar una imagen grabada, audio o un archivo de video.
Tabla de Contenidos
Descripción General
La acción Send To Websocket se encuentra listada bajo la categoría API Actions en el menú de selección de acciones. Junto con el Activador Websocket, proporciona a un estudio comunicación bidireccional con software que se ejecuta fuera de Labvanced.
Casos de Uso Comunes
La acción Send To Websocket se utiliza donde quiera que algo que ocurre en el estudio deba conocerse fuera de él.
- Enviar marcadores de eventos a sistemas de grabación: al inicio del estímulo, una respuesta o un cambio de condición, el estudio envía un marcador a un script local que lo convierte en un marcador de Lab Streaming Layer, para que tenga una marca de tiempo junto a las secuencias de EEG y seguimiento ocular. Ver Integraciones de EEG y Hardware.
- Pasar datos a un servidor: el estudio envía la respuesta de un participante o un valor calculado a un servidor que lo procesa, como un proceso de análisis o aprendizaje automático.
- Enviar medios grabados: se envía una imagen grabada, un archivo de audio o de video a un programa que lo almacena o lo analiza.
Cómo Funciona
Para acceder a la acción Send To Websocket, abra el Sistema de Eventos en el Editor de Tareas y seleccione o cree un evento. En el área de acciones, abra la categoría API Actions y seleccione Send To Websocket.
La acción está disponible una vez que la conexión está habilitada en la configuración del estudio. Si Send To Websocket está atenuado en el menú, habilítelo primero:
- Abra la pestaña
Settings. - Abra el menú desplegable
Special Featuresy encuentre la secciónWebsocket Connection. - Marque la opción para habilitarlo, luego ingrese el
WebSocket Addressy elPort. Los valores predeterminados sonws://localhosty8081, que se conectan a un script que se ejecuta en la misma computadora que el estudio.
El diálogo contiene lo siguiente:
| Opción | Descripción |
|---|---|
Websocket Address | Muestra la dirección de sus configuraciones de estudio. No se puede editar aquí. |
Port | Muestra el puerto de sus configuraciones de estudio. No se puede editar aquí. |
Data Type | Elige lo que la acción envía. Text / JSON envía un mensaje y un valor de variable opcional. Binary (image/audio/video) envía un archivo grabado. |
Trigger / message to send | La etiqueta del mensaje, por ejemplo trigger1. Este campo aparece solo para Text / JSON. |
Send Variable | La variable cuyo valor se envía. Es opcional para Text / JSON y requerida para Binary (image/audio/video). Seleccionarlo abre el selector de variables. |
Para Binary (image/audio/video), seleccione una variable que contenga una grabación, como la variable de una grabación de audio o video. Si la variable no contiene una grabación en ese momento, no se envía nada.
Lo que Obtiene el Programa Receptor
La acción solo tiene efecto si un programa fuera de Labvanced está escuchando. Ese programa, generalmente un script corto en la misma computadora, ejecuta el servidor WebSocket al que el estudio se conecta y lee cada mensaje que el estudio envía.
Con Text / JSON, cada mensaje tiene dos partes:
- Una etiqueta: el texto de
Trigger / message to send, por ejemplotrigger1. El programa receptor lo utiliza para distinguir entre tipos de mensajes. - Contenido: el valor actual de la variable elegida en
Send Variable. Si no se elige ninguna variable, el mensaje solo tiene una etiqueta.
Con Binary (image/audio/video), la acción envía el archivo grabado por sí solo, sin una etiqueta.
Para la persona que escribe el script receptor, un mensaje Text / JSON es un objeto JSON con los campos msg para la etiqueta y value para el contenido, y value es null cuando no se elige ninguna variable. Los scripts de ejemplo en el repositorio de API de WebSocket de Labvanced en GitHub reciben mensajes de un estudio y los envían como marcadores LSL, y son un buen punto de partida. Para la configuración de la conexión, consulte la guía de API de WebSocket.
Consejos para el flujo de trabajo
- Inicie su script antes de comenzar el estudio. El estudio abre la conexión cuando comienza.
- Pruebe la conexión con el estudio ejecutándose en la misma computadora que el script antes de recopilar datos. El valor predeterminado
ws://localhostsolo llega a programas en esa computadora. - Envíe una etiqueta de condición o número de prueba en
Send Variablecuando el lado receptor necesite saber a qué estímulo pertenece un marcador. - Coloque la acción en el evento que se activa en el momento que desea marcar, como el inicio de un cuadro o un clic, para que el mensaje se envíe en ese momento.
Estudios y Escenarios de Ejemplo
Enviar un marcador a LSL. En el estudio de la biblioteca LSL Send Marker, un campo de entrada proporciona el valor del marcador y un clic en un botón lo envía con esta acción a un servidor Python local. El servidor convierte el mensaje en un marcador LSL. Use la opción Inspect en la biblioteca para ver la configuración del evento.
Mensajería bidireccional. El estudio de la biblioteca Socket Connection Example envía un mensaje fuera del estudio con esta acción y reacciona a las respuestas con el Activador Websocket.
Lectura Adicional
Activador Websocket
El activador emparejado para reaccionar a mensajes que llegan de un programa externo.
API de WebSocket
Cómo conectar un estudio a un script local o a un servidor externo.
Menú de Selección de Valores
Cómo referenciar valores en los diálogos de sus acciones.
Descripción General de Eventos
Una introducción completa al sistema de lógica de activación y acción en Labvanced.