
发送到 Websocket 动作
Send To Websocket 动作从运行中的研究发送消息到监听 WebSocket 连接的程序,例如本地 Python 脚本、录音设备或外部服务器。该消息可以携带变量的值,该动作还可以发送记录的图像、音频或视频文件。
概述
Send To Websocket 动作在动作选择菜单中列在 API Actions 类别下。与 Websocket 触发器 一起,它为研究提供了与在 Labvanced 外部运行的软件的双向通信。
常见用例
Send To Websocket 动作在研究中发生的任何事情需要被外界知晓的地方使用。
- 将事件标记发送到记录系统: 在刺激开始时、响应或条件变化时,研究向本地脚本发送标记,该脚本将其转换为 Lab Streaming Layer 标记,因此它与 EEG 和眼动追踪流一起时间戳。请参见 EEG 与硬件集成。
- 将数据传递给服务器: 研究将参与者的响应或计算值发送到处理它的服务器,例如分析或机器学习过程。
- 发送记录的媒体: 记录的图像、音频或视频文件发送到存储或分析它的程序。
工作原理
要访问 Send To Websocket 动作,请在任务编辑器中打开 事件系统,并选择或创建一个事件。在动作区域中,打开 API Actions 类别并选择 Send To Websocket。
一旦连接在研究设置中启用,动作便可用。如果菜单中的 Send To Websocket 变灰,请先启用它:
- 打开
Settings标签。 - 打开
Special Features下拉菜单并找到Websocket Connection部分。 - 勾选启用该选项,然后输入
WebSocket Address和Port。默认值为ws://localhost和8081,这连接到与研究运行在同一计算机上的脚本。
该对话框包含以下内容:
| 选项 | 描述 |
|---|---|
Websocket Address | 显示来自您的研究设置的地址。此处无法编辑。 |
Port | 显示来自您的研究设置的端口。此处无法编辑。 |
Data Type | 选择该动作发送的内容。 Text / JSON 发送一条消息和一个可选的变量值。 Binary (image/audio/video) 发送一个记录的文件。 |
Trigger / message to send | 消息标签,例如 trigger1。此字段仅在 Text / JSON 时出现。 |
Send Variable | 发送其值的变量。对于 Text / JSON 是可选的,对于 Binary (image/audio/video) 是必需的。选择它会打开变量选择器。 |
对于 Binary (image/audio/video),选择一个持有录音的变量,例如音频或视频录音的变量。如果该变量此时不持有录音,则不会发送任何内容。
接收程序得到的内容
该动作仅在 Labvanced 外部的程序正在监听时才有效。该程序,通常是同一计算机上的短脚本,运行研究连接到的 WebSocket 服务器并读取研究发送的每条消息。
使用 Text / JSON,每条消息有两个部分:
- 一个标签: 来自
Trigger / message to send的文本,例如trigger1。接收程序用它区分消息类型。 - 内容: 在
Send Variable下选择的变量的当前值。如果未选择变量,则消息仅有标签。
使用 Binary (image/audio/video),该动作单独发送记录的文件,而没有标签。
对于编写接收脚本的人来说,Text / JSON 消息是一个 JSON 对象,包含用于标签的字段 msg 和内容的字段 value,而 value 在未选择变量时为 null。在 Labvanced WebSocket API GitHub 存储库 中的示例脚本接收来自研究的消息并将其作为 LSL 标记发送出去,是一个很好的起点。有关连接设置,请参见 WebSocket API 指南。
工作流程提示
- 在开始研究之前先启动您的脚本。研究开始时会打开连接。
- 在收集数据之前,测试研究与脚本在同一计算机上运行的连接。默认
ws://localhost仅可访问在该计算机上的程序。 - 在
Send Variable中发送条件标签或试验号,当接收方需要知道哪个刺激属于哪个标记时。 - 将该动作放置在您希望标记的时刻触发的事件中,例如帧开始或单击,以便在该时刻发送消息。
研究与示例场景
将标记发送到 LSL。 在 LSL 发送标记 库研究中,一个输入字段提供标记值,一个按钮单击将其通过此动作发送到本地 Python 服务器。该服务器将消息转换为 LSL 标记。在库中使用 Inspect 选项以查看事件设置。
双向消息传递。 套接字连接示例 库研究通过此动作将消息发送出研究,并使用 Websocket 触发器响应回复。