Skip to content

Commit d49d32b

Browse files
committed
Update open-ephys-acq documentation
1 parent b96e127 commit d49d32b

3 files changed

Lines changed: 10 additions & 6 deletions

File tree

content/docs/modules/open-ephys-acq.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,6 @@ This module streams electrophysiology data from the [Open Ephys Acquisition Boar
77
Check out [Differences Between Generations](https://open-ephys.github.io/acq-board-docs/User-Manual/Generations-differences.html)
88
to see which hardware you have.
99

10-
{{< callout type="warning" >}}
11-
This module is currently in **beta** and made available only for testing purposes.
12-
For example, time synchronization is not yet fully implemented in a reliable way.
13-
Use it only for testing purposes until this note is removed!
14-
{{< /callout >}}
15-
1610

1711
## Usage
1812

@@ -42,6 +36,14 @@ module that emits `LineCommand` events, and the module fires the
4236
board's digital output lines accordingly. Only `WriteDigitalPulse`
4337
commands on lines 0–15 are honoured; other command kinds are ignored.
4438

39+
### Wiring example
40+
41+
![Wiring example for the OpenEphys AcqBoard Module](/images/modules/openephys-acq-wiring1.avif)
42+
43+
The live plotted signals in a [Plot Time Series]({{< ref "plot-timeseries" >}}) module may look like this:
44+
45+
![Plotting example for the OpenEphys AcqBoard](/images/modules/openephys-acq-signalplot1.avif)
46+
4547

4648
## Output Data Format
4749

@@ -73,6 +75,7 @@ headstage is replugged.
7375
| Headstage *<prefix>* 🠺 | Out | `SignalBlockU16` | Electrode samples for one headstage. |
7476
| Headstage *<prefix>* – AUX 🠺 | Out | `SignalBlockU16` | AUX channels for one headstage (when enabled). |
7577
| Board ADC 🠺 | Out | `SignalBlockU16` | Data from the on-board ADC inputs (when enabled). |
78+
| TTL Input 🠺 | Out | `LineReading` | Data from the on-board TTL inputs (when enabled). |
7679

7780

7881
## Stream Metadata
@@ -88,3 +91,4 @@ All output ports carry the
8891
| `data_unit` | `µV` (the unit after the affine transform). |
8992
| `data_scale` | The board's per-LSB conversion factor for this channel kind. |
9093
| `data_offset` | `0.0`. |
94+
| `is_digital` | `true`, only set for the digital TTL `LineReading` output. |
11 KB
Binary file not shown.
19.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)