Acquisition Board Plugins

A source that can stream data from any version of the Open Ephys Acquisition Board, plus a sink that can trigger board outputs.

Installation

This plugin can be added via the Open Ephys GUI Plugin Installer. To access the Plugin Installer, press ctrl-P or ⌘P from inside the GUI. Once the installer is loaded, browse to the "Acquisition Board" plugin and click "Install."

Usage

Instructions for using the Acquisition Board plugin are available here.

Building from source

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

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

Code
├── plugin-GUI
│   ├── Build
│   ├── Source
│   └── ...
├── OEPlugins
│   └── acquisition-board
│       ├── Build
│       ├── Source
│       └── ...

When first cloning the repository, use git clone --recurse-submodules to fetch the liboni submodule as well.

For existing clones of the repo, run git submodule update --init --recursive to initialize the submodule and update it in the same command.

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_acquisition-board.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 acquisition-board.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-api10. 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.