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 デスクトップアプリで、この接続をボタンクリックで確立できる統合ソリューションが提供される予定です。
スクリプトソリューション
スクリプトを使用することで、基本的な Python コードをカスタマイズでき、スクリプトを実行する必要があり、最終的には研究ニーズに応じた柔軟性が提供されます。別の Python スクリプトを実行することで、Labvanced は WebSocket API と通信し、Python は外部デバイスと通信します。
WebSocket API の構成は、特定のポートと IP を指すことによって機能します。次に、これが Python コードに反映されます。お互いを指すことで、WebSocket API を介した通信のラインが確立されます。
注意: 接続を表示するために、この半自動プロセスには GUI を使用できます。
以前のアプローチ (Labvanced プログラムに直接埋め込むこと) は、異なるオペレーティングシステムで動作させるには少し限られていて難しかったです。したがって、これらの新しい Python スクリプトを使用すれば、すべてのプラットフォーム (Linux、MacOS、Windows) で動作し、双方向で LSL ストリームデータを送受信できるはずです。
試してみるために必要なこと:
- pip install -r requirements.txt のようなもので、4つの必要なライブラリをインストールします。
- その後、Labvanced 実験が開始される同じマシンでバックグラウンドで (Labvanced に LSL マーカーを受信するために) python3 lsl_marker_receive.py または (Labvanced から LSL マーカーを送信するために) python3 lsl_marker_send.py を実行できます。
注意: 特定の LSL パラメータやストリーム名が必要な場合、これらのスクリプトを簡単に適応させることもできます。
私たちの GitHub WebSocket API repository, から、Labvanced 実験に対して LSL マーカーを送受信するための2つの例 Python スクリプトを Lab Streaming Layer フォルダに見つけることができるほか、設定方法に関する詳細な説明もあります。
また、私たちの公開実験ライブラリからこの Socket Connection Sample Study を インポート し、イベントがどのように設定されているかを見ることができます。
WebSocket API を利用した LSL 統合の実験例
上記に対応する Labvanced スタディ ライブラリには 2 つの例示的な研究があります。
LSLマーカーを送信する実験 (lsl_marker_send.py): https://www.labvanced.com/page/library/53231
LSLマーカーを受信する実験 (lsl_marker_receive.py): https://www.labvanced.com/page/library/53230
これらの例示的な研究をインポートまたは検査する際には、彼らの「スタディ設定」の「実験機能」サブセクションにあるチェックボックスの「WebSocket接続」がチェックされており、Labvanced 実験が同じコンピュータ上で実行されている Python スクリプトに接続できるようになっていることを確認してください。以下の画像に示されている通りです。
