Streams continuous data, events, and spikes via ZeroMQ.

(Coming soon)

(add link to documentation)

First, follow the instructions on this page to build the Open Ephys GUI.

Important: This plugin is intended for use with the pre-release core application, version 0.6.0. The GUI should be compiled from the development-juce6 branch, rather than the master branch.

Then, clone this repository into a directory at the same level as the plugin-GUI, e.g.:

Code
├── plugin-GUI
│   ├── Build
│   ├── Source
│   └── ...
├── OEPlugins
│   └── zmq-interface
│       ├── Build
│       ├── Source
│       └── ...

Requirements: Visual Studio and CMake

From the Build directory, enter:

cmake -G "Visual Studio 17 2022" -A x64 ..

Next, launch Visual Studio and open the OE_PLUGIN_zmq-interface.sln file that was just created. Select the appropriate configuration (Debug/Release) and build the solution.

Selecting the INSTALL project and manually building it will copy the .dll and any other required files into the GUI's plugins directory. The next time you launch the GUI from Visual Studio, the ZMQ Interface plugin should be available.

Requirements: CMake

From the Build directory, enter:

cmake -G "Unix Makefiles" ..
cd Debug
make -j
make install

This will build the plugin and copy the .so file into the GUI's plugins directory. The next time you launch the GUI compiled version of the GUI, the ZMQ Interface plugin should be available.

Requirements: Xcode and CMake

From the Build directory, enter:

cmake -G "Xcode" ..

Next, launch Xcode and open the zmq-interface.xcodeproj file that now lives in the “Build” directory.

Running the ALL_BUILD scheme will compile the plugin; running the INSTALL scheme will install the .bundle file to /Users/<username>/Library/Application Support/open-ephys/plugins-api. The ZMQ Interface plugin should be available the next time you launch the GUI from Xcode.

This plugin was originally developed by Francesco Battaglia at Memory Dynamics Lab, and was later updated by András Széll. It is now being maintained by the Allen Institute.