Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add image of memory monitor in acquisition board plugin
  • Loading branch information
bparks13 committed May 9, 2025
commit 092c843c6de9f098972813b86b3c116947cf1db1
10 changes: 9 additions & 1 deletion source/User-Manual/Plugins/Acquisition-Board.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,15 @@ Memory Monitor

.. attention:: This only pertains to hardware Gen2/Gen3 with firmware 1.5.1+

While data is waiting to be transferred from the acquisition board to the computer, it sits in the acquisition board's buffer. The memory monitor on the left provides a visualization of how much data has accumulated in this buffer as a percentage of its total capacity. The memory monitor should stay at or near zero. Accumulated data in the hardware's buffer indicates an error that is causing data to be read from the hardware too slowly. This might eventually halt the program if the buffer fills to its capacity.
.. image:: ../../_static/images/plugins/acquisitionboard/acquisitionboard-04.png
:alt: Updated editor with a memory usage monitor on the left

While data is waiting to be transferred from the acquisition board to the computer, it sits in the
acquisition board's buffer. The memory monitor on the left provides a visualization of how much data
has accumulated in this buffer as a percentage of its total capacity. The memory monitor should stay
at or near zero. Accumulated data in the hardware's buffer indicates an error that is causing data
to be read from the hardware too slowly. This might eventually halt the program if the buffer fills
to its capacity.

|

Expand Down
6 changes: 3 additions & 3 deletions source/User-Manual/Plugins/Network-Events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,16 @@ The primary purpose of the Network Events module is to add TTL events to one or

:code:`TTL [Line=1-256] [State=0/1]` – Sends an **ON** (1) or **OFF** (0) TTL event on the specified TTL line.

:code:`TTL [Word=unsigned_int64_value]` – Sends TTL event with the states of the first 64 lines combined to form the TTL word. Each line represents a different bit in the given unsigned 64-bit integer. For more information on how TTL words work, refer to :ref:`undertanding-ttl-events`.
:code:`TTL [Word=unsigned_int64_value]` – Sends TTL event with the states of the first 64 lines combined to form the TTL word. Each line represents a different bit in the given unsigned 64-bit integer. For more information on how TTL words work, refer to :ref:`understanding-ttl-events`.

Other commands
---------------

The Network Events module can also respond to commands related to starting/stopping acquisition and recording. However, these commands are also available via the Open Ephys HTTP Server (added in GUI version 0.6.0). It's recommended to use the HTTP Server commands whenever possible, as these do not rely on a specific plugin.

:code:`StartAcquisition` – Starts data aquisition
:code:`StartAcquisition` – Starts data acquisition

:code:`StopAcquisition` – Stops data aquisition
:code:`StopAcquisition` – Stops data acquisition

:code:`StartRecord [RecordNode=record_node_id] [CreateNewDir=1] [RecDir=recording_directory_path] [PrependText=some_text] [AppendText=some_text]` – Starts recording of data

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
144 changes: 112 additions & 32 deletions source/_static/images/plugins/acquisitionboard/acquisitionboard.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.