WebSocket API
有关WebSocket API如何与Lab Streaming Layer和硬件(如EEG)结合使用的信息,请参见EEG & Hardware Integrations。
自定义的WebSocket API允许您在运行时在Labvanced和任何其他服务器之间建立连接。这基本上允许在Labvanced服务器和您指定的其他服务器之间双向发送数据的可能性。如果您只需要单向发送数据(即直接保存到您的服务器),请参阅Webhook API.的文档。
可以利用WebSocket API的一些实验示例包括:
- 一个实验,您希望从Labvanced向EEG系统、眼动追踪系统或其他本地数据记录设备发送/接收实验触发事件(例如试验/刺激开始或参与者响应)。
- 一个实验,您希望通过互联网将在线记录的数据发送到其他服务器/API进行处理(例如某些AI/机器学习过程或实时数据分析)。
- 一个实验,您希望在Labvanced和可以在本地或远程运行的其他进程之间创建双向通信(例如用于BCI、生物反馈或其他闭环系统)。
在将Labvanced与本地服务器连接的情况下(例如连接设备),您当前可以通过简单的脚本(如下所述)以及在Labvanced研究编辑器中设置事件来实现此目的。在未来,Labvanced桌面应用程序中将提供集成解决方案,您可以通过单击按钮建立此连接。
Script Solution
使用脚本,您可以自定义基本的Python代码,要求您运行该脚本,并最终允许灵活满足研究需求。通过运行单独的Python脚本,Labvanced与WebSocket API进行通信,而Python与外部设备进行通信。
WebSocket API配置通过指向特定端口和IP来工作。然后,这在Python代码中反映出来。通过相互指向,通过WebSocket API建立了一条通信线。
NOTE: 为了查看连接,可以使用GUI进行此半自动化过程。
我们之前的方法(直接嵌入Labvanced程序)有点受限,难以在不同操作系统中运行。因此,现在,使用这些新的Python脚本应该可以在所有平台上(Linux、MacOS、Windows)运行,并且应能够双向发送和接收LSL流数据。
您需要执行以下操作来尝试:
- 使用类似 pip install -r requirements.txt 的方法安装所需的4个库
- 然后,您可以在与Labvanced实验将启动的同一台机器上后台启动(以接收Labvanced中的LSL标记) python3 lsl_marker_receive.py 或(将LSL标记从Labvanced发送) python3 lsl_marker_send.py.
NOTE: 如果您想要特定的LSL参数或流名称,您也可以轻松调整这些脚本。
在我们的GitHub WebSocket API repository, 您可以在 Lab Streaming Layer 文件夹中找到两个示例Python脚本,用于从Labvanced实验发送或接收LSL标记,以及有关如何设置此项的更详细说明。
您还可以从我们的公共实验库中 import 这个 Socket Connection Sample Study 并查看事件是如何设置的。
Examples of Experiments Utilizing WebSocket API for LSL Integration
在Labvanced研究库中有两个示例研究与上述内容相对应:
Sending LSL Markers (lsl_marker_send.py): https://www.labvanced.com/page/library/53231
Receiving LSL Markers (lsl_marker_receive.py): https://www.labvanced.com/page/library/53230
请注意,在导入或检查这些示例研究时,您会看到在其“研究设置”下的“实验特性”子部分中,"WebSocket Connection"的复选框已选中,并提供连接详细信息,以确保Labvanced实验可以连接到同一计算机上运行的Python脚本,如下图所示:
