You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is necessary to push out in the v0.6 docs even though they are a
v1.0 feature because oe/ps is shipping acq-board-v3
before the "official" gui v1.0 release is published
.. tip:: For more in-depth documentation on the Open Ephys Acquisition Board, please refer to the `Acquisition Board docs site <https://open-ephys.github.io/acq-board-docs/>`__.
23
25
24
-
.. important:: If your acquisition board was purchased after October 2022, it likely has a custom FPGA designed by Open Ephys. This requires a different plugin, called :ref:`oefpgaacquisitionboard`.
25
-
26
26
Installing and upgrading
27
27
==========================
28
28
29
-
The Acquisition Board plugin is not included by default in the Open Ephys GUI. To install, use **ctrl-P** or **⌘P** to open the Plugin Installer, browse to the "Rhythm Plugins", and click the "Install" button. After installation, *Acquisition Board* will appear in the processor list on the left side of the GUI's main window.
29
+
The Acquisition Board plugin is not included by default in the Open Ephys GUI. To install, use **ctrl-P** or **⌘P** to open the Plugin Installer, browse to the "Acquisition Board", and click the "Install" button. After installation, *Acquisition Board* will appear in the processor list on the left side of the GUI's main window.
30
30
31
31
The Plugin Installer also allows you to upgrade to the latest version of this plugin, if it's already installed. The plugin must be removed from the signal chain prior to upgrading.
32
32
@@ -37,12 +37,22 @@ Plugin configuration
37
37
Headstages
38
38
############
39
39
40
-
On the left-hand side of the module, there are slots for each of 8 possible headstages (A1, A2, B1, B2, etc.). Each row corresponds to one 12-channel Omnetics connector on the input board (from left to right, there are A, B, C, and D), and each column corresponds to one headstage on that input. Up to two headstages can be connected to each input using a dual headstage adapter. The module will automatically detect headstages that are connected, as well as whether they contain a 64- or 32-channel Intan chip. However, if you add or remove headstages after the module has been loaded, you need to press the "RESCAN" button.
40
+
On the left-hand side of the module, there are four rows with 2 slots each. Each row represents a headstage port on the acquisition board (denoted as A, B, C, & D left-to-right on the hardware). Each headstage port can accommodate up to two headstages*. When this processor is added to the signal chain, it automatically detects connected headstages, as well as whether they contain a 64- or 32-channel Intan chip, and whether or not they have an IMU (inertial measurement unit). Each slot in the row corresponding to the headstage port in use will be populated as follows:
41
+
42
+
- When a single headstage *without* an IMU is connected a port, the channel count of the Intan chip (32 or 64) will be displayed in a slot.
43
+
- When a single 3D capable headstage *with* an IMU is connected to a port, the channel count of the Intan chip (32 or 64) will be displayed in the first slot, and "IMU" will be displayed on the second slot.
44
+
- When two headstages share a port, the channel count of each Intan chip (32 or 64) will be displayed in each slot. In this case, even if either or both headstages are 3D capable, no "IMU" will be displayed, and 3D capabilities won't be available.
45
+
46
+
.. note:: Plugging two headstages into one port requires a `dual headstage adapter <https://open-ephys.github.io/acq-board-docs/Hardware-Guide/Cables.html#dual-headstage-adapter>`__. The SPI connector labelled 1 corresponds to the headstage that appears in the first slot of the row, and the the connector labelled 2, to the second slot.
47
+
48
+
If you add or remove headstages after the Acquisition Board processor has been loaded, you must press the "RESCAN" button for the hardware changes to be detected.
49
+
50
+
*Actually, each headstage port can accommodate up to two 64-channel Intan chips that can be on the same headstage, but having more than one chip per headstage is rare, so this is described per headstage.*
41
51
42
52
Using 16-channel headstages
43
53
----------------------------
44
54
45
-
Clicking on the button for one of the detected headstages will toggle it between 32-channel and 16-channel mode. This is necessary because the difference between 16-channel and 32-channel headstages cannot detected in software, and has to be selected manually.
55
+
Clicking on the slot of one of the detected headstages will toggle it between 32-channel and 16-channel mode. This is necessary because the difference between 16-channel and 32-channel headstages cannot detected in software, and has to be selected manually.
46
56
47
57
Sample rate selection
48
58
#######################
@@ -79,7 +89,7 @@ Sets the threshold for the noise slicer on the hardware audio outputs (sets any
79
89
Clock divider
80
90
##############
81
91
82
-
The BNC connector on the back of the board will send a digital pulse each time a new sample is acquired. The clock divided makes it possible to downsample this clock, so a pulse is sent every *N* samples. Note that *N* can only be one or an even number, even though this is not enforced via the settings interface.
92
+
The BNC connector on the back of the board will send a digital pulse each time a new sample is acquired. The clock divider makes it possible to downsample this clock, so a pulse is sent every *N* samples. Note that *N* can only be one or an even number, even though this is not enforced via the settings interface.
83
93
84
94
DSP button
85
95
###########
@@ -114,13 +124,28 @@ To open the impedance measurement interface, click the "window" or "tab" buttons
:alt:Updated editor with a memory usage monitor on the left
134
+
135
+
While data is waiting to be transferred from the acquisition board to the computer, it sits in the
136
+
acquisition board's buffer. The memory monitor on the left provides a visualization of how much data
137
+
has accumulated in this buffer as a percentage of its total capacity. The memory monitor should stay
138
+
at or near zero. Accumulated data in the hardware's buffer indicates an error that is causing data
139
+
to be read from the hardware too slowly. This might eventually halt the program if the buffer fills
140
+
to its capacity.
141
+
117
142
|
118
143
119
144
Closed-loop feedback
120
145
====================
121
146
122
147
123
-
Installing the "Rhythm Plugins" will also install the "Acq Board Output" plugin, which can be used to trigger the digital outputs of the acquisition board.
148
+
Installing the "Acquisition Board" will also install the "Acq Board Output" plugin, which can be used to trigger the digital outputs of the acquisition board.
:alt:Annotated settings interface for the Commutator Control plugin
13
+
14
+
.. csv-table:: Prevents twist in the tether connecting a moving animal to a stationary `Open Ephys Acquisition Board Gen 3 <https://open-ephys.org/acq-board>`__.
.. tip:: For more in-depth documentation on the commutator hardware, please refer to the `Open Ephys Commutators docs site <https://open-ephys.github.io/commutator-docs/>`__.
24
+
25
+
Installing and upgrading
26
+
==========================
27
+
28
+
The Commutator Control plugin is not included by default in the Open Ephys GUI. To install, use
29
+
**ctrl-P** or **⌘P** to open the Plugin Installer, browse to "Commutator Control", and click the
30
+
"Install" button. After installation, *Commutator Control* will appear in the processor list on the
31
+
left side of the GUI's main window.
32
+
33
+
The Plugin Installer also allows you to upgrade to the latest version of this plugin, if it's
34
+
already installed. The plugin must be removed from the signal chain prior to upgrading.
35
+
36
+
Plugin configuration
37
+
====================
38
+
39
+
Serial port selector
40
+
####################
41
+
42
+
In the top-left corner of the commutator processor, there is a dropdown menu to select the COM port
43
+
that corresponds to your commutator. To determine which COM port corresponds to your commutator:
44
+
45
+
#. Unplug your commutator.
46
+
47
+
#. Add the commutator processor into the signal chain.
48
+
49
+
#. Click the dropdown. Note the COM ports that are shown in the dropdown.
50
+
51
+
#. Plug in your commutator.
52
+
53
+
#. Remove the commutator processor from the signal chain and add it back in.
54
+
55
+
#. Click the dropdown. The COM port that appears in this step but not in step 3 is the one that corresponds to your commutator.
56
+
57
+
Stream selector
58
+
###############
59
+
60
+
In the bottom-left corner of the commutator processor, there is a dropdown menu to select which IMU
61
+
stream you would like to use to calculate commutator rotations. The options provided by the dropdown
62
+
correspond to IMUs detected in the Acquisition Board processor.
63
+
64
+
Rotation axis selector
65
+
######################
66
+
67
+
In the top-right corner of the commutator processor, there is a dropdown menu to select the relevant
68
+
rotation axis for calculating commutator rotations.
69
+
70
+
The GUI software automatically pre-maps each headstage's orientation axes such that the +Z axis
71
+
aligns along the tether where it connects to the headstage, so you shouldn't need to change this
72
+
value. However, if you do need to change this value, there is an "override" button to allow you to
73
+
do that. For more information on the headstages' axes, look at the `Headstages
Copy file name to clipboardExpand all lines: source/User-Manual/Plugins/OE-FPGA-Acquisition-Board.rst
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,12 @@
6
6
OE FPGA Acquisition Board
7
7
##########################
8
8
9
+
.. important:: If you intend to use the 3D capabilities and memory monitor features of the Acquisition Board Gen 3, refer to the :doc:`/User-Manual/Plugins/Acquisition-Board` plugin.
:alt:Annotated settings interface for the Acquisition Board plugin
11
13
12
-
.. csv-table:: Streams data from an `Open Ephys acquisition board <https://open-ephys.org/acq-board>`__ with a custom FPGA designed by Open Ephys.
14
+
.. csv-table:: Streams data from an `Open Ephys Acquisition Board Gen 2 and above <https://open-ephys.org/acq-board>`__ with a custom FPGA module designed by Open Ephys.
13
15
:widths: 18, 80
14
16
15
17
"*Plugin Type*", "Source"
@@ -115,4 +117,4 @@ To open the impedance measurement interface, click the "window" or "tab" buttons
0 commit comments