deploy: e0a8098

upsidedownlabs · Oct 26, 2024 · 1ff78aa · 1ff78aa
1 parent 3644c24
commit 1ff78aa
Show file tree

Hide file tree

Showing 66 changed files with 1,300 additions and 89 deletions.
diff --git a/_images/chords_connect.png b/_images/chords_connect.png
diff --git a/_images/chords_dark_mode.png b/_images/chords_dark_mode.png
diff --git a/_images/chords_delete.png b/_images/chords_delete.png
diff --git a/_images/chords_landing_page.png b/_images/chords_landing_page.png
diff --git a/_images/chords_light_mode.png b/_images/chords_light_mode.png
diff --git a/_images/chords_minus.png b/_images/chords_minus.png
diff --git a/_images/chords_pause.jpg b/_images/chords_pause.jpg
diff --git a/_images/chords_plus.png b/_images/chords_plus.png
diff --git a/_images/chords_record.png b/_images/chords_record.png
diff --git a/_images/chords_resume.png b/_images/chords_resume.png
diff --git a/_images/chords_save.png b/_images/chords_save.png
diff --git a/_images/chords_tech_stack.png b/_images/chords_tech_stack.png
diff --git a/_images/chords_zoom_in.png b/_images/chords_zoom_in.png
diff --git a/_images/chords_zoom_out.png b/_images/chords_zoom_out.png
diff --git a/_sources/index.rst b/_sources/index.rst
@@ -152,10 +152,10 @@ that you can use with our hardware.
 
    courses/index
 
-.. toctree::
-   :hidden:
-   :maxdepth: 1
-   :caption: FAQs
+.. .. toctree::
+..    :hidden:
+..    :maxdepth: 1
+..    :caption: FAQs
 
-   faq/index
+..    faq/index
    
diff --git a/_sources/software/chords/index.rst b/_sources/software/chords/index.rst
@@ -0,0 +1,184 @@
+.. _chords:
+
+Getting Started
+#################
+
+Overview
+********
+Chords is an open source web application designed for real-time signal visualization, particularly tailored for bio-potential signals like EEG, EMG, ECG and EOG. This tool serves as an advanced alternative to the standard Arduino IDE serial plotter, offering enhanced functionality for students, researchers and hobbyists alike who want to record biopotential data using  `BioAmp hardware <https://docs.upsidedownlabs.tech/hardware/index.html>`_.
+
+.. figure:: media/chords_landing_page.*
+    :align: center
+    :alt: chords landing page
+
+    chords landing page
+
+Features
+********
+- **Connection**: It is effortlessly compatible with BioAmp Hardware attached to an Arduino-compatible development board running the `Chords Arduino firmware <https://github.com/upsidedownlabs/Chords-Arduino-Firmware>`_, simplifying the setup process and ensuring a smooth and efficient workflow from data acquisition to visualization.
+- **Real-time Visualization**: Experience smooth real-time visualization of incoming data rendered with `WebGL-Plot <https://github.com/danchitnis/webgl-plot>`_. The system ensures smooth signal display, helping you monitor the flow without interruptions or lag.
+- **Recording**: You can record data in CSV format indefinitely or set a timer to stop recording automatically when it expires.
+- **Download/Delete**: Easily download or delete recorded data with just a few clicks. Manage your data efficiently, allowing for quick access to relevant data or removal of unwanted data to free up storage.
+- **Zoom**: Zoom-in and zoom-out feature, gives you more control as now you can either zoom in to look at signal or zoom out for an overall view.
+- **Theme Toggle**: Offers both light and dark themes, enabling you to switch according to your preference for a more comfortable user experience.
+- **Pause/Play**: Includes options to freeze and resume data display, allowing users to pause the visualization for detailed examination and then continue data monitoring seamlessly.
+- **Channel**: Supports plotting of up to six channels of data simultaneously in real time where each stream is color-coded differently for easy identification.
+- **Disconnect**: Terminate the connection to the development board with a simple click. This functionality ensures a hassle-free disconnection process when you’re done with data collection or visualization.
+
+Software Requirements
+*********************
+
+* You have to flash  `Chords Arduino Firmware <https://github.com/upsidedownlabs/Chords-Arduino-Firmware>`_ to your Arduino board using Arduino IDE.
+* For now the Chords web application is only compatible with Chromium-based browsers. To check your browser compatibility, see :ref:`chords-browsers-compatibility` section of this page.
+
+Hardware Requirements
+*********************
+To use Chords, you need:
+
+- Compatible Development Board : Arduino Uno R3 And R4 Minima
+- A USB cable (type depends on board)
+- BioAmp Hardware : 
+
+  - `BioAmp EXG Pill <https://docs.upsidedownlabs.tech/hardware/bioamp/bioamp-exg-pill/index.html>`_
+  - `Muscle BioAmp Biscute <https://docs.upsidedownlabs.tech/hardware/bioamp/muscle-bioamp-biscute/index.html>`_
+  - `Muscle BioAmp Candy <https://docs.upsidedownlabs.tech/hardware/bioamp/muscle-bioamp-candy/index.html>`_
+  - `Muscle BioAmp Patchy <https://docs.upsidedownlabs.tech/hardware/bioamp/muscle-bioamp-patchy/index.html>`_
+  - `Muscle BioAmp Shield <https://docs.upsidedownlabs.tech/hardware/bioamp/muscle-bioamp-shield/index.html>`_
+
+How to Use Chords
+*******************
+
+Uploading the Code
+------------------
+
+1. Connect the Arduino board to your laptop using the USB cable.
+2. Copy and paste the `Arduino Firmware  <https://github.com/upsidedownlabs/Chords-Arduino-Firmware>`_ into the Arduino IDE.
+3. Select your board from `Board` section in the tools menu.
+4. Choose the correct COM port in the tools menu (the one that disappears when you disconnect the board).
+5. Click on the `Upload` button to flash your Arduino board.
+
+Now, you are ready to use `Chords <https://chords.upsidedownlabs.tech/stream>`_.
+
+Using the Software
+------------------
+
+1. Click the ``Connect`` button to establish a connection with the Arduino and start streaming.
+2. Use the ``Play/Pause`` button to control the data stream.
+3. Click the ``Record`` button to start recording data into a CSV file.
+4. To save the recorded data, click the ``Download`` button.
+5. Click the ``Delete`` button to remove recorded data.
+6. Change the mode using the ``Mode`` button which is present in the navbar.
+7. Use the ``Zoom in/out`` button to adjust the data visualization.
+8. Adjust the number of channels by using the ``Plus/Minus`` buttons.
+
+Chords Icons
+************
+
+.. list-table::
+   :widths: 1 3
+   :header-rows: 1
+
+   * - Icons
+     - Description
+   * - .. figure:: media/chords_connect.*
+        :alt: chords Connect
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Connect
+   * - .. figure:: media/chords_zoom_in.*
+        :alt: chords zoom in
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Zoom in
+   * - .. figure:: media/chords_zoom_out.*
+        :alt: chords zoom out
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Zoom out
+   * - .. figure:: media/chords_pause.*
+        :alt: chords pause
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Pause
+   * - .. figure:: media/chords_resume.*
+        :alt: chords resume
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Resume
+   * - .. figure:: media/chords_record.*
+        :alt: chords record
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Record
+   * - .. figure:: media/chords_save.*
+        :alt: chords save
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Save
+   * - .. figure:: media/chords_delete.*
+        :alt: chords delete
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Delete
+   * - .. figure:: media/chords_plus.*
+        :alt: chords plus
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Increase Channel
+   * - .. figure:: media/chords_minus.*
+        :alt: chords minus
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Decrease Channel
+   * - .. figure:: media/chords_light_mode.*
+        :alt: chords light theme
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Light Mode
+   * - .. figure:: media/chords_dark_mode.*
+        :alt: chords dark theme
+        :align: left
+        :width: 20px
+        :height: 20px
+     - Dark Mode
+
+.. _chords-browsers-compatibility:
+
+Browser Compatibility
+*********************
+
+The web application is compatible with the **Web Serial API**, which is essential for its functionality. Supported browsers include the latest versions of:
+
+- **Google Chrome**
+- **Microsoft Edge**
+- **Opera**
+
+If the user's browser does not support the Web Serial API, a message will inform them of the incompatibility, recommending the use of a supported browser.
+
+For more information, refer to MDN Web Docs on the `Web Serial API <https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API>`_.
+
+Technologies Used
+*******************
+- **Next.js**: A framework built on top of React.js.
+- **Web Serial API**: API for serial communication with devices.
+- **Tailwind CSS**: Utility-first CSS framework.
+- **Shadcn UI**: Reusable and customizable components, built with Radix UI.
+- **WebGL Plot**: Real-time charting library.
+- **IndexedDB API**: Browser-based database for storing recorded data.
+
+.. figure:: media/chords_tech_stack.*
+    :align: center
+    :alt: chords tech stack
+
+    chords tech stack
diff --git a/_sources/software/index.rst b/_sources/software/index.rst
@@ -19,4 +19,11 @@ Software
    :caption: BioAmp Visualizer
 
    bioamp-visualizer/index
-   bioamp_visualizer_technical_doc/index
+   bioamp_visualizer_technical_doc/index
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Chords
+
+   chords/index
diff --git a/bioamp-exg-pill.pdf b/bioamp-exg-pill.pdf
diff --git a/bioamp-v1.5.pdf b/bioamp-v1.5.pdf
diff --git a/courses/index.html b/courses/index.html
@@ -54,7 +54,7 @@
     <link rel="prev" title="Contribute to Documentation" href="../guides/contribute/index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -761,7 +761,7 @@
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/courses/open-ephys/exday1-nokit.html b/courses/open-ephys/exday1-nokit.html
@@ -54,7 +54,7 @@
     <link rel="prev" title="Theory Day 4" href="theory-day-4/index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -977,7 +977,7 @@ <h2><a class="toc-backref" href="#id9" role="doc-backlink">9. Capacitive voltage
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/courses/open-ephys/exday2-nokit.html b/courses/open-ephys/exday2-nokit.html
@@ -52,7 +52,7 @@
     <link rel="prev" title="Exercises Day 1: No Hardware" href="exday1-nokit.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -888,7 +888,7 @@ <h3><a class="toc-backref" href="#id7" role="doc-backlink">Bypass capacitors</a>
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/courses/open-ephys/index.html b/courses/open-ephys/index.html
@@ -54,7 +54,7 @@
     <link rel="prev" title="Courses" href="../index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -882,7 +882,7 @@ <h2>No Hardware kit? Use these links!<a class="headerlink" href="#no-hardware-ki
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/courses/open-ephys/theory-day-1/index.html b/courses/open-ephys/theory-day-1/index.html
@@ -54,7 +54,7 @@
     <link rel="prev" title="Extracellular Electrophysiology Acquisition" href="../index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -1160,7 +1160,7 @@ <h2><a class="toc-backref" href="#id31" role="doc-backlink">References</a><a cla
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/courses/open-ephys/theory-day-2/index.html b/courses/open-ephys/theory-day-2/index.html
@@ -54,7 +54,7 @@
     <link rel="prev" title="Theory Day 1" href="../theory-day-1/index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -956,7 +956,7 @@ <h3><a class="toc-backref" href="#id13" role="doc-backlink">An op-amp as a heads
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/courses/open-ephys/theory-day-3/index.html b/courses/open-ephys/theory-day-3/index.html
@@ -54,7 +54,7 @@
     <link rel="prev" title="Theory Day 2" href="../theory-day-2/index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -970,7 +970,7 @@ <h3><a class="toc-backref" href="#id14" role="doc-backlink">High-pass filters</a
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/courses/open-ephys/theory-day-4/index.html b/courses/open-ephys/theory-day-4/index.html
@@ -53,7 +53,7 @@
     <link rel="prev" title="Theory Day 3" href="../theory-day-3/index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -809,7 +809,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Talk: Acquisition and
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/diy-neuroscience-kit-basic.pdf b/diy-neuroscience-kit-basic.pdf
diff --git a/diy-neuroscience-kit-pro.pdf b/diy-neuroscience-kit-pro.pdf
diff --git a/genindex.html b/genindex.html
@@ -50,7 +50,7 @@
     <link rel="search" title="Search" href="search.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -663,7 +663,7 @@ <h1 id="index">Index</h1>
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>
 

diff --git a/guides/contribute/index.html b/guides/contribute/index.html
@@ -53,7 +53,7 @@
     <link rel="prev" title="Using Gel Electrodes" href="../usage-guides/using-gel-electrodes/index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="Oct 19, 2024"/>
+    <meta name="docbuild:last-update" content="Oct 26, 2024"/>
   </head>
 
 
@@ -871,7 +871,7 @@ <h2>Making Changes<a class="headerlink" href="#making-changes" title="Link to th
     <div class="footer-items__end">
 
         <div class="footer-item"><p class="last-updated">
-  Last updated on Oct 19, 2024.
+  Last updated on Oct 26, 2024.
   <br/>
 </p></div>