This is an Open Ephys GUI data thread plugin for LSL streams.
In order to try it out, download a release and follow the manual installation steps from the release archive.
This plugin was generated from the Open Ephys "data thread template" by Josh Siegle and the Allen Institute for Brain Science. Specialization for LSL data consumption was developed and opened to the community with ❤️ by AE Studio and Chadwick Boulay.
Before starting the data acquisition process a data stream needs to be selected. The list of available data streams (and marker streams) is updated every time the button Refresh streams is pressed. During data acquisition samples can be scaled in real time by adjusting the Scale factor.
A marker stream can be optionally selected. The list of marker streams only shows streams that have an irregular rate and a single channel. When a marker is received it is broadcasted to the entire signal chain. For a marker to be shown in the LFP view, a markers to TTL mapping is required. This is a json file that should contain a set of Key-Value pairs of markers and corresponding TTL values, for example:
{
"Marker_1": 1,
"Marker_2": 2
}
Please read the guide regarding compiling plugins from open-ephys and install cmake.
The plugin repo needs to be cloned inside a directory (e.g. MyPlugins) that is at the same level as plugin-GUI, for example:
/Users/foo/plugin-GUI
/Users/foo/MyPlugins/lsl-inlet
A debug version of the plugin will not work with a release version of Open Ephys GUI and a release version of the plugin will not work with a debug version of Open Ephys GUI. Keep this in mind when deciding how to generate the makefiles.
Download liblsl:
mkdir liblsl
cd liblsl
curl -OL https://github.com/sccn/liblsl/releases/download/v1.16.0/liblsl-1.16.0-OSX_amd64.tar.bz2
tar xvf liblsl-1.16.0-OSX_amd64.tar.bz2
On macOS either "Xcode" or "Unix Makefiles" can be generated and used to successfully build the plugin. If you prefer to work with VSCode then "Unix Makefiles" should be used. Generate the Makefile using:
cd Build
cmake .. -DCMAKE_OSX_ARCHITECTURES="x86_64" -G "Unix Makefiles"
For a release build run:
cd Build
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES="x86_64" -G "Unix Makefiles"
Build a binary:
cd Build
cmake --build .
Install the plugin:
cd Build
cmake --build . --target install
This will copy the plugin (OpenEphysLSL-Inlet.bundle) to the $HOME/Application Support/open-ephys/plugins-api8/ folder
and will available the next time Open Ephys GUI is launched.
Copy liblsl to the plugin's search path:
mkdir mkdir ~/Library/Application\ Support/open-ephys/shared
cp ../liblsl/lib/*.dylib* ~/Library/Application\ Support/open-ephys/shared/
The build was tested on a machine running Fedora 37. Clone liblsl inside the plugin's directory and build it:
git clone https://github.com/sccn/liblsl.git
cd liblsl
cmake -S . -B cmake -G "Unix Makefiles"
cmake --build cmake -j --config Release
Back in the plugin's directory generate the Makefile using:
cd Build
cmake .. -G "Unix Makefiles"
For a release build run:
cd Build
cmake .. -DCMAKE_BUILD_TYPE=Release -G "Unix Makefiles"
Build a binary:
cd Build
cmake --build .
To install the plugin copy the file OpenEphysLSL-Inlet.so to the open-ephys plugins folder and copy
the LSL binaries lsl.so* to the open-ephys shared folder.
The plugin will load the next time Open Ephys GUI is launched.
The build was tested using Visual Studio 2022 Community Edition. First, download liblsl from GitHub and extract it inside the plugin directory. The folder structure can be:
OpenEphysLSL-Inlet
|
|--liblsl
|
|-- bin
|-- include
|-- lib
Open Developer Command Prompt for VS 2022 and generate the Makefile using cmake:
cd Build
cmake -G "Visual Studio 17 2022" -A x64 ..
You can now open the ALL_BUILD.vcxproj file from the Build folder with Visual Studio and build a binary.
To install the plugin copy the file OpenEphysLSL-Inlet.dll to the C:\ProgramData\Open Ephys\plugins-api8 folder and copy
the file lsl.dll to the C:\ProgramData\Open Ephys\shared-api8 folder.
The plugin will load the next time Open Ephys GUI is launched.