Merge pull request #35 from bhawnasehgal/main

Update hardware content, add guides menu

conf.py

@@ -33,9 +33,11 @@
 extensions = [
     "sphinx_design",
     "sphinxcontrib.youtube",
-    "sphinx_copybutton"
+    "sphinx_copybutton",
+    "sphinx.ext.todo",
 ]
 
+todo_include_todos = False
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'env', ".venv"]
 
@@ -87,7 +89,7 @@
             "name": "GeM India",
         }
     ],
-    "header_links_before_dropdown": 4,
+    "header_links_before_dropdown": 5,
     "show_prev_next": True,
     "icon_links": [
         {

guides/index.rst

@@ -0,0 +1,11 @@
+.. _upsidedownlabs-guides:
+
+Guides
+######################
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   usage-guides/skin-preparation/index
+   usage-guides/using-bioamp-bands/index

guides/usage-guides/skin-preparation/index.rst

@@ -0,0 +1,87 @@
+.. _skin-preparation:
+
+Skin Preparation Guide
+##########################
+
+Why skin preparation is important?
+***********************************
+
+Proper skin preparation is crucial before recording any biopotential signal be it Electrocardiography (ECG), Electromyography (EMG), Electroencephalography (EEG), or Electrooculography (EOG).
+
+- ``Clear recording surface`` Removes dead skin cells, oils, & other substances that increases skin impedance.
+- ``Improve impedance`` Improves the conduction of electrical signals from the body to the recording equipment and minimizes impedance.
+- ``Electrode-skin contact`` Ensures optimal contact between the electrodes and the skin surface.
+- ``Signal quality`` Enhances the overall quality of recorded signals, providing clear & reliable data for analysis & improves the ability to capture subtle variations in biopotential signals.
+- ``Consistency in recordings`` Reduces variability in signal quality, making it easier to make any Human-Computer Interface (HCI), Brain-Computer Interface (BCI) project or a real-world application.
+- ``Long term adhesion`` Facilitates long-term adhesion & stable placement of electrodes to the skin during extended signal monitoring.
+
+Requirements
+**************
+
++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **NuPrep Gel**                      | Mildly abrasive, highly conductive gel that should be applied before placing the electrodes on the skin to improve signal quality & enhances the performance of monitoring electrodes.                |
++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **Electrode Gel**                   | Highly conductive gel that acts as a coupling agent between electrodes and the skin to aid the transmission of biopotential signals like ECG, EMG, EOG, or EEG.                                       |
++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **Ten20 Paste**                     | Contains the right balance of adhesiveness and conductivity, enabling the dry electrodes to remain in place while allowing the transmittance of biopotential signals.                                 |
++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **Alcohol Swabs/Wet wipes**         | Soft & non-woven pads that helps in cleaning the skin surface and does not leave any residue.                                                                                                         |
++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Steps to follow
+*****************
+
+You can follow the steps given below to do the skin preparation properly:
+
+Step 1: Identify the targeted area
+=====================================
+
+Identify the target area where the gel electrodes will be placed for recording ECG, EMG, EEG, or EOG.
+
+.. image:: media/skin-prep-eog.*
+
+.. image:: media/skin-prep-emg.*
+
+.. image:: media/skin-prep-ecg.*
+
+.. image:: media/skin-prep-eeg.*
+
+Step 2: Apply the gel
+======================
+
+Apply a drop of NuPrep gel to your targeted area where the electrodes will be placed.
+
+.. image:: media/step-2.*
+
+Step 3
+=======
+
+Use gentle, circular motions to rub the gel on the skin surface. This removes all the dead skin cells & improves conductivity.
+
+.. warning:: Do not rub the gel for too long as it has abrasive properties and may cause skin redness and irritation.
+
+Step 4
+========
+
+Wipe away excess gel with the alcohol swabs or wet wipes.
+
+.. warning:: Close your eyes while using the alcohol swabs for EOG recording else it may cause eye redness & irritation.
+
+Step 5
+========
+
+Now you can either use gel electrodes or the BioAmp bands for the signal recording.
+
+Using gel electrodes
+----------------------
+
+  Connect the BioAmp cable to gel electrodes, peel the plastic backing from electrodes and place the IN+, IN-, REF cables according to your specific biopotential recording.
+
+Using BioAmp bands
+----------------------
+
+  Connect the BioAmp cable to your BioAmp band. Now apply a small amount of electrode gel or Ten20 conductive paste on the dry electrodes between the skin and metallic part of BioAmp cable. This improves the signal conductivity, enhancing overall signal quality.
+
+Now you are all set! Make all the connections correctly and start recording your biopotential signals.
+
+.. note:: NuPrep gel, Ten20 paste and the alcohol swabs shouldn't be used if you have a history of skin allergies to lotions and cosmetics.

guides/usage-guides/using-bioamp-bands/index.rst

@@ -0,0 +1,4 @@
+.. _using-bioamp-bands:
+
+Using BioAmp Bands
+##################

hardware/bioamp/bioamp-v1.5/index.rst

@@ -3,15 +3,15 @@
 BioAmp v1.5
 ############
 
-Small-size portable biopotential amplifier with a no code setup for non-invasive EMG recording!
+:bdg-danger:`2023 Edition`
 
 Overview
 *********
 
 It is a small size portable biopotential amplifier with a no code setup to record and listen to your muscle signals (EMG) non 
 invasively. The best part is that it doesn’t require any microcontroller (like Arduino) to sample the signal. You just plug a 9V 
 battery into the board, electrodes to the body, and an audio jack to a mobile/laptop, and you are ready to record signals from
-muscles (EMG) using audacity or Backyard Brain’s spike recorder app.
+muscles (EMG) using softwares like audacity or Backyard Brain’s spike recorder app.
 
 .. figure:: media/bioamp-v1.5.*
     :width: 800
@@ -39,8 +39,6 @@ Features & Specifications
 | Open Source           | Hardware + Software                                                                                                                                              |
 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
-
-
 Hardware
 **********
 Images below shows a quick overview of the hardware design.
@@ -66,13 +64,36 @@ Images below shows a quick overview of the hardware design.
                 .. figure:: media/back-pcb.*            
 
 
-.. figure:: media/front-assembled-with-wires-1.*
+.. figure:: media/Assembly/16.*
     :align: center
+    :width: 70%
+
+    Assembled BioAmp v1.5
+
+Contents of the kit
+********************
+
+.. image:: media/kit-contents.*
+
+Software requirements
+**********************
 
-Assemblying the kit
+Before you start using the kit, download Backyard Brains' `Spike Recorder <https://backyardbrains.com/products/spikerecorder>`_ or `Audacity <https://www.audacityteam.org/download/>`_ according to the operating system you are using (Windows, OSX, Linux).
+
+.. figure:: ../../../kits/diy-neuroscience/basic/media/byb.*
+
+    **Backyard Brains Spike Recorder**
+
+.. figure:: media/audacity.*
+
+    **Audacity (An easy-to-use, multi-track audio editor and recorder)**
+
+Assembling the kit
 ********************
 
-You can get your own Bioamp v1.5 bag of parts from `our store <https://store.upsidedownlabs.tech/product/bioamp-v1-5-2023-edition/>`_ or `Tindie <https://www.tindie.com/products/upsidedownlabs/bioamp-v15-2023-edition-biopotential-amplifier/>`_ or the step by step guide below. 
+You can get your own BioAmp v1.5 bag of parts from our `online stores <https://linktr.ee/Upside_Down_Labs_stores>`_ (shipping worldwide) and for assembling the board you can take a look at the step by step guide given below.
+
+**Note:** Follow the highlighted yellow shapes to assemble your BioAmp v1.5!
 
 .. grid:: 1 1 3 3
     :margin: 2 2 0 0 
@@ -169,25 +190,134 @@ You can get your own Bioamp v1.5 bag of parts from `our store <https://store.ups
             **Step 15 - Headphone jack** 
 
 
-Connections
-*************************
+Using the kit
+*****************
+
+.. image:: media/bioamp-v1-5-connections.*
+
+The image above shows the possibilities of using BioAmp v1.5. Seems complicated? Don't worry, we'll explain each and every step in detail. So follow along to create your own setup.
+
+Step 1: Connecting the cables
+==================================
+
+.. image:: media/board-with-cables.*
+
+Connect the BioAmp cable, 9V snap cable and BioAmp AUX cable to BioAmp v1.5 by inserting the cable ends in the respective JST PH connectors as shown above.
+
+Step 2: Skin Preparation
+==========================
+
+Apply Nuprep Skin Preparation Gel on the skin surface where electrodes would be placed to remove dead skin cells and clean the skin from dirt. After rubbing the skin surface thoroughly, clean it with a wet wipe.
+
+For more information, please check out detailed step by step :ref:`skin-preparation`.
+
+Step 3: Electrode placements
+===========================================
+
+We have 2 options to measure the EMG signals, either using the gel electrodes or using dry electrode based Muscle BioAmp Band. You can try both of them one by one.
+
+- **Using gel electrodes:**
+
+1. Connect the BioAmp cable to gel electrodes.
+2. Peel the plastic backing from the electrodes.
+3. Place the IN+ and IN- cables on the arm near the ulnar nerve & REF (reference) at the back of your hand as shown in the connection diagram.
+
+.. image:: media/bioamp-v1-5-emg.*
+
+- **Using Muscle BioAmp Band:**
+
+1. Connect the BioAmp cable to Muscle BioAmp Band in a way such that IN+ and IN- are placed on the arm near the ulnar nerve & REF (reference) on the far side of the band.
+2. Now put a small drop of electrode gel between the skin and metallic part of BioAmp cable to get the best results.
+
+.. note:: These BioAmp Cable connections to gel electrodes/band are specifically for this version of BioAmp v1.5 only. The connections for other BioAmp hardware can be different.
+
+.. tip:: In this demonstration we are recording EMG signals from the ulnar nerve, but you can record EMG from other areas as well (biceps, triceps, legs, jaw etc) as per your project requirements. Just make sure to place the IN+, IN- electrodes on the targeted muscle and REF on a bony part.
+
+Step 4: Connecting 9V battery
+===============================
+
+Connect any 9V battery to BioAmp v1.5 using the 9V snap cable. Now activate the board by flipping ON the power switch, and you'll notice an LED light up, showing that the board is ready to use.
+
+.. image:: media/9v-battery.*
+
+Step 5: Listen to Your Muscle Signals
+======================================
+
+You can either listen to the muscle signals (EMG) on a speaker or wired earphones/headphones. Let's try both of them.
+
+Listening EMG on speakers
+-----------------------------
+
+1. Connect the BioAmp AUX cable on a bluetooth speaker that have 3.5mm jack support.
+2. Switch on the speaker and turn the volume to maximum.
+3. Flex and listen to your muscles.
+
+.. image:: media/listening-emg-2.*
+
+Listening EMG on a wired earphones/headphones
+----------------------------------------------
+
+1. Plug your wired earphones or headphones on the 3.5mm jack of BioAmp v1.5.
+2. Plug it in your ears.
+3. Flex and listen to your muscles.
+
+.. image:: media/listening-emg-3.*
+
+Step 6: Visualize the EMG signals on mobile phone
+===================================================
+
+Connect the BioAmp AUX cable to your mobile phone/tablet that has 3.5mm jack support.
+
+Now there are various options to visualize the EMG signals:
+
+Using Phone Recorder
+--------------------------
+
+1. Open any audio recorder app on your mobile tablet.
+2. Flex your muscle to be able to record the muscle signals.
+3. If you want to extract that data then it will be saved by default as a .wav file but you can convert it in any other format according to your project requirements.
+
+.. image:: media/emg-in-mobile-2.*
+
+Using Backyard Brains' Spike Recorder
+--------------------------------------
+
+1. Download the `Spike Recorder App <https://play.google.com/store/apps/details?id=com.backyardbrains&pli=1>`_ from playstore.
+2. Open the app, click the setting icon on the top right corner and set the recording type to EMG.
+3. Apply the 50Hz or 60Hz notch filter depending on the country you are living in. For example if you are in India then the AC current oscillates at a frequency of 50Hz but it oscillates at 60Hz frequency in USA. This AC current acts as a noise in the signals so we have to remove it by applying this notch filter.
+4. Again click on the setting icon to close it and you are ready.
+5. Flex your muscles to be able to visualize the muscle signals (EMG).
+6. You can record the EMG data as a .wav file by pressing the record button on the top right corner of the app and then convert it in any other format as per your project requirements.
+
+.. image:: media/emg-in-mobile.*
+
+Step 7: Visualize the EMG signals on laptop
+============================================
+
+Connect the BioAmp AUX cable to your laptop that has 3.5mm jack support.
+
+Now there are various options to visualize the EMG signals:
+
+Using Backyard Brains' Spike Recorder
+--------------------------------------------
 
-To measure the EMG signals, just connect BioAmp Cable v3 with the hardware as shown in the image below, and get started.
+1. Install the spike recorder software that you downloaded earlier.
+2. Open the software, click the setting icon on the top right corner and set the low band pass filter to 72Hz and high band pass filter to 720Hz.
+3. Apply the 50Hz or 60Hz notch filter depending on the country you are living in. For example if you are in India then the AC current oscillates at a frequency of 50Hz but it oscillates at 60Hz frequency in USA. This AC current acts as a noise in the signals so we have to remove it by applying this notch filter.
+4. Again click on the setting icon to close it and you are ready.
+5. Flex your muscles to be able to visualize the muscle signals (EMG)
+6. You can record the EMG data as a .wav file by pressing the record button on the top right corner of the app and then convert it in any other format as per your project requirements.
 
-.. figure:: media/connections.*
+.. image:: media/emg-in-laptop.*
 
-Using the Sensor
-*******************
+Using Audacity
+----------------
 
-.. .. youtube:: ujFsAE0E0nk
-..     :align: center
-..     :width: 100%
+1. Install the audacity software that you downloaded earlier.
+2. Open the software and set the recording device to microphone.
+3. Flex your muscles to be able to visualize the muscle signals (EMG)
+4. By default the EMG data would be recorded as a .wav file but you can convert it in any other format as per your project requirements.
 
-Some project ideas
-************************
+.. image:: media/emg-in-audacity.*
 
-.. We have curated a playlist for you which consists some awesome project ideas for you to get started with your next HCI project.
 
-.. .. youtube:: https://youtube.com/playlist?list=PLtkEloJ7UnkQIoz1HK4IXWujCB8hKdiKU&si=osloTX71TE7AJ3CF
-..     :width: 100%
-..     :align: center