Rhythm Plugins

A set of plugins for streaming data from devices running Intan's Rhythm firmware.

These devices are currently supported:

• Open Ephys Acquisition Board
• Intan RHD USB Interface Board

Plugins for the following devices are coming soon:

• Intan 512 and 1024 Recording Controllers
• Intan RHS Recording/Stimulation Controller

Installation

These plugins can be added via the Open Ephys GUI's built-in Plugin Installer. Press ctrl-P or ⌘P to open the Plugin Installer, browse to "Rhythm Plugins," and click the "Install" button. The Acquisition Board, Intan RHD USB, and Acq. Board Output plugins should now be available to use.

Usage

Instructions for using the Rhythm Plugins are available here.

Building from source

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

Important: This plugin is intended for use with the latest version of the GUI (0.6.0 and higher). The GUI should be compiled from the main branch, rather than the former 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
│   └── rhythm-plugins
│       ├── Build
│       ├── Source
│       └── ...

Windows

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_rhythm-plugins.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 new plugins should be available.

Linux

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 compiled version of the GUI, the new plugins should be available.

macOS

Requirements: Xcode and CMake

From the Build directory, enter:

cmake -G "Xcode" ..

Next, launch Xcode and open the rhythm-plugins.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 new plugins should be available the next time you launch the GUI from Xcode.

Attribution

This plugin has been collaboratively developed by Josh Siegle and Aarón Cuevas López. It is currently being maintained at the Allen Institute.