Update documentation

open-ephys · Apr 22, 2024 · 43c4c0d · 43c4c0d
1 parent 407d58a
commit 43c4c0d
Show file tree

Hide file tree

Showing 42 changed files with 876 additions and 13 deletions.
diff --git a/Hardware Guide/Datasheets/memory-usage.html b/Hardware Guide/Datasheets/memory-usage.html
@@ -573,7 +573,7 @@ <h2>Register Programming<a class="headerlink" href="#register-programming" title
 </table>
 </section>
 <section id="device-to-host-data-frames">
-<h2>Device To Host Data Frames<a class="headerlink" href="#device-to-host-data-frames" title="Link to this heading">#</a></h2>
+<span id="onidatasheet-memory-usage-d2h"></span><h2>Device To Host Data Frames<a class="headerlink" href="#device-to-host-data-frames" title="Link to this heading">#</a></h2>
 <p>Each frame transmitted to the host is structured as follows:</p>
 
 <div style="overflow-x:auto">

diff --git a/Software Guide/Bonsai.ONIX/Bonsai Examples/CameraSync.html b/Software Guide/Bonsai.ONIX/Bonsai Examples/CameraSync.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="../Nodes/index.html">Nodes</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../Nodes/MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Bonsai Examples/Commutator.html b/Software Guide/Bonsai.ONIX/Bonsai Examples/Commutator.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="../Nodes/index.html">Nodes</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../Nodes/MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Bonsai Examples/Headstage64.html b/Software Guide/Bonsai.ONIX/Bonsai Examples/Headstage64.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="../Nodes/index.html">Nodes</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../Nodes/MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Bonsai Examples/HeadstageNP1e.html b/Software Guide/Bonsai.ONIX/Bonsai Examples/HeadstageNP1e.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="../Nodes/index.html">Nodes</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../Nodes/MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Bonsai Examples/LatencyTest.html b/Software Guide/Bonsai.ONIX/Bonsai Examples/LatencyTest.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="../Nodes/index.html">Nodes</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../Nodes/MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Bonsai Examples/index.html b/Software Guide/Bonsai.ONIX/Bonsai Examples/index.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="../Nodes/index.html">Nodes</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../Nodes/MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../Nodes/ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/GettingStarted.html b/Software Guide/Bonsai.ONIX/GettingStarted.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="Nodes/index.html">Nodes</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="Nodes/MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Installation.html b/Software Guide/Bonsai.ONIX/Installation.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="Nodes/index.html">Nodes</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="Nodes/MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Nodes/ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Nodes/AnalogIODevice.html b/Software Guide/Bonsai.ONIX/Nodes/AnalogIODevice.html
@@ -47,7 +47,7 @@
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
     <link rel="next" title="DigitalIODevice" href="DigitalIODevice.html" />
-    <link rel="prev" title="HeartbeatDevice" href="HeartbeatDevice.html" />
+    <link rel="prev" title="MemoryUsageDevice" href="MemoryUsageDevice.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -375,6 +375,7 @@
 <li class="toctree-l2 current active has-children"><a class="reference internal" href="index.html">Nodes</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3 current active"><a class="current reference internal" href="#">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="ClockOutputDevice.html">ClockOutputDevice</a></li>
@@ -578,12 +579,12 @@ <h2>Loading Scripts<a class="headerlink" href="#loading-scripts" title="Link to
     <div class="footer-article-item"><!-- Previous / next buttons -->
 <div class="prev-next-area">
     <a class="left-prev"
-       href="HeartbeatDevice.html"
+       href="MemoryUsageDevice.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">HeartbeatDevice</p>
+        <p class="prev-next-title">MemoryUsageDevice</p>
       </div>
     </a>
     <a class="right-next"

diff --git a/Software Guide/Bonsai.ONIX/Nodes/BNO055Device.html b/Software Guide/Bonsai.ONIX/Nodes/BNO055Device.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 current active has-children"><a class="reference internal" href="index.html">Nodes</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Nodes/ClockOutputDevice.html b/Software Guide/Bonsai.ONIX/Nodes/ClockOutputDevice.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 current active has-children"><a class="reference internal" href="index.html">Nodes</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3 current active"><a class="current reference internal" href="#">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Nodes/DigitalIODevice.html b/Software Guide/Bonsai.ONIX/Nodes/DigitalIODevice.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 current active has-children"><a class="reference internal" href="index.html">Nodes</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3 current active"><a class="current reference internal" href="#">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Nodes/ElectricalStimulationDevice.html b/Software Guide/Bonsai.ONIX/Nodes/ElectricalStimulationDevice.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 current active has-children"><a class="reference internal" href="index.html">Nodes</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Nodes/HeadstagePortControlDevice.html b/Software Guide/Bonsai.ONIX/Nodes/HeadstagePortControlDevice.html
@@ -375,6 +375,7 @@
 <li class="toctree-l2 current active has-children"><a class="reference internal" href="index.html">Nodes</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3"><a class="reference internal" href="HeartbeatDevice.html">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="ClockOutputDevice.html">ClockOutputDevice</a></li>

diff --git a/Software Guide/Bonsai.ONIX/Nodes/HeartbeatDevice.html b/Software Guide/Bonsai.ONIX/Nodes/HeartbeatDevice.html
@@ -46,7 +46,7 @@
     <link rel="icon" href="../../../_static/favicon.png"/>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="AnalogIODevice" href="AnalogIODevice.html" />
+    <link rel="next" title="MemoryUsageDevice" href="MemoryUsageDevice.html" />
     <link rel="prev" title="ONIContext" href="ONIContext.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -375,6 +375,7 @@
 <li class="toctree-l2 current active has-children"><a class="reference internal" href="index.html">Nodes</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="ONIContext.html">ONIContext</a></li>
 <li class="toctree-l3 current active"><a class="current reference internal" href="#">HeartbeatDevice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MemoryUsageDevice.html">MemoryUsageDevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="AnalogIODevice.html">AnalogIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="DigitalIODevice.html">DigitalIODevice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="ClockOutputDevice.html">ClockOutputDevice</a></li>
@@ -543,11 +544,11 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Link to this
       </div>
     </a>
     <a class="right-next"
-       href="AnalogIODevice.html"
+       href="MemoryUsageDevice.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">AnalogIODevice</p>
+        <p class="prev-next-title">MemoryUsageDevice</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>