
Websocket 触发器
当您的运行实验通过其 WebSocket 连接接收到消息时,Websocket Trigger 被触发。它允许本地脚本、录音设备或外部服务器在浏览器外部发生事件时启动您实验中的事件。
概述
Websocket Trigger 在触发器选择菜单的 API/External Trigger 类别下列出。结合 发送到 Websocket 动作,它使实验与运行在 Labvanced 外部的软件实现双向通信。
常见用例
Websocket Trigger 在实验外部的信号需要改变实验中发生的事情时会被使用。
- 接收 LSL 标记: 本地 Python 脚本将来自其他 Lab Streaming Layer 设备的标记传递到实验中,以便实验可以将其记录在自己的时间戳旁边。请参阅 EEG 和硬件集成 以获得完整的图景。
- 闭环和生物反馈设计: 处理生理信号的脚本在超过某个阈值时发送消息,实验根据该消息改变刺激。
- 外部处理: 服务器分析从实验发送的数据并返回结果,例如分类或分数,然后实验将其显示或记录。
工作原理
要访问 Websocket Trigger,请在任务编辑器中打开 事件系统 并创建一个新事件。在 API/External Trigger 类别下,选择 Websocket Trigger。
在触发器可以使用之前,请在实验设置中启用连接:
- 打开
Settings标签。 - 打开
Special Features下拉菜单并找到Websocket Connection部分。 - 勾选启用该选项,然后输入
WebSocket Address和Port。默认值为ws://localhost和8081,它们连接到与实验在同一台计算机上运行的脚本。
该对话框包含以下内容:
| 选项 | 描述 |
|---|---|
Websocket Address | 显示您实验设置中的地址。这里无法编辑。 |
Port | 显示您实验设置中的端口。这里无法编辑。 |
trigger / message | 触发此事件的消息标签。当传入消息的标签与该文本完全匹配时,触发器将被触发。输入 any 以在每条传入消息上触发。 |
当实验开始时,Labvanced 会打开到您输入的地址和端口的连接。如果在设置中未启用连接,则不会打开连接,并且触发器永远不会触发。
触发器仅在包含事件的框架显示时监听。在显示其他框架时到达的消息不会启动此事件。请将事件放在每个实验需要对消息作出反应的框架上。
使用 any 的事件将在每条消息上触发。如果同一框架上的另一个事件使用特定标签,则在带有该标签的消息到达时,两个事件都会触发。
发送程序提供的内容
只有当 Labvanced 以外的程序向其发送消息时,触发器才会触发。该程序通常是同一台计算机上的一个短脚本,运行着实验所连接的 WebSocket 服务器。它发送的每条消息有两个部分:
- 标签: 触发器将其与
trigger / message字段进行比较。当它们匹配时,事件会被触发,并且该标签作为Message值可用。 - 内容: 脚本希望传递的任何值,例如标记值或测量。它作为
Data值可用。
对于编写脚本的人来说,每条消息都是带有 msg 字段(用于标签)和 value 字段(用于内容)的 JSON 对象。 Labvanced WebSocket API GitHub 仓库 中的示例脚本以这种方式发送和接收 LSL 标记,是一个很好的起点。有关连接设置,请参见 WebSocket API 指南。
触发器特定值
触发器触发后,以下值将在事件的操作中可用。通过 Trigger (Websocket Trigger) 下的 值选择菜单 选择它们。
| 值 | 描述 |
|---|---|
Message | 接收到的消息的标签。使用它区分消息类型,尤其是在使用 any 的事件中。 |
Data | 接收到的消息的内容。它可以保存任何 JSON 值,例如数字、字符串或列表,并且可以使用 设置 / 记录变量动作 存储在变量中。 |
Trigger Timestamp (Unixtime) | 触发器触发的时间,以 Unix 时间戳表示,包含毫秒。 |
Trigger Time (From Frame Onset) | 从框架开始到触发器触发的时间,单位为毫秒。 |
工作流程提示
- 在开始实验之前先启动您的脚本。当实验开始时,连接会被打开。
- 在与脚本运行在同一计算机上的实验一起运行时测试连接,然后再收集数据。默认
ws://localhost仅能到达该计算机上的程序。 - 保持消息标签简短且在脚本和实验之间一致。匹配是精确的,因此
Marker和marker是不同的消息。 - 在消息的时间对于分析很重要的情况下,一起记录
Trigger Time (From Frame Onset)和Data。
研究与示例场景
接收来自其他设备的标记。 在 LSL 接收标记 库实验中,由外部设备生成的标记通过一个本地 Python 脚本到达,脚本通过 Websocket Trigger 将它传递到实验中。实验然后记录标记值。使用库中的 Inspect 选项查看事件设置。
双向消息传递。 Socket 连接示例 库实验通过发送到 Websocket 动作向外发送消息,并通过此触发器对回复做出反应。