diff --git a/_static/latex/bioamp-v1.5.rst b/_static/latex/bioamp-v1.5.rst new file mode 100644 index 00000000..48c1d4f0 --- /dev/null +++ b/_static/latex/bioamp-v1.5.rst @@ -0,0 +1,26 @@ +:orphan: + +.. _bioamp-v1.5-datasheet: + +BioAmp v1.5 +############## + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../hardware/bioamp/bioamp-v1.5/index + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/skin-preparation/index.rst + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/using-bioamp-bands/index.rst diff --git a/_static/latex/diy-neuroscience-kit-basic.rst b/_static/latex/diy-neuroscience-kit-basic.rst new file mode 100644 index 00000000..4a8c569d --- /dev/null +++ b/_static/latex/diy-neuroscience-kit-basic.rst @@ -0,0 +1,28 @@ +:orphan: + +.. _diy-neuroscience-kit-basic-datasheet: + +DIY Neuroscience Kit Basic +########################### + +.. toctree:: + :hidden: + :maxdepth: 4 + + ../../../kits/diy-neuroscience/basic/index + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/skin-preparation/index.rst + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/using-bioamp-bands/index.rst + + diff --git a/_static/latex/muscle-bioamp-biscute.rst b/_static/latex/muscle-bioamp-biscute.rst new file mode 100644 index 00000000..493a43f3 --- /dev/null +++ b/_static/latex/muscle-bioamp-biscute.rst @@ -0,0 +1,26 @@ +:orphan: + +.. _muscle-bioamp-biscute-datasheet: + +Muscle BioAmp Biscute +####################### + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../hardware/bioamp/muscle-bioamp-biscute/index + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/skin-preparation/index.rst + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/using-bioamp-bands/index.rst diff --git a/_static/latex/muscle-bioamp-blip.rst b/_static/latex/muscle-bioamp-blip.rst new file mode 100644 index 00000000..d35aed61 --- /dev/null +++ b/_static/latex/muscle-bioamp-blip.rst @@ -0,0 +1,26 @@ +:orphan: + +.. _muscle-bioamp-blip-datasheet: + +Muscle BioAmp Blip +#################### + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../hardware/bioamp/muscle-bioamp-blip/index + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/skin-preparation/index.rst + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/using-bioamp-bands/index.rst diff --git a/_static/latex/muscle-bioamp-candy.rst b/_static/latex/muscle-bioamp-candy.rst new file mode 100644 index 00000000..606dbe38 --- /dev/null +++ b/_static/latex/muscle-bioamp-candy.rst @@ -0,0 +1,26 @@ +:orphan: + +.. _muscle-bioamp-candy-datasheet: + +Muscle BioAmp Candy +#################### + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../hardware/bioamp/muscle-bioamp-candy/index + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/skin-preparation/index.rst + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/using-bioamp-bands/index.rst diff --git a/_static/latex/muscle-bioamp-patchy.rst b/_static/latex/muscle-bioamp-patchy.rst new file mode 100644 index 00000000..3b9fe598 --- /dev/null +++ b/_static/latex/muscle-bioamp-patchy.rst @@ -0,0 +1,20 @@ +:orphan: + +.. _muscle-bioamp-patchy-datasheet: + +Muscle BioAmp Patchy +#################### + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../hardware/bioamp/muscle-bioamp-patchy/index + + +.. toctree:: + :hidden: + :maxdepth: 3 + + ../../../guides/usage-guides/skin-preparation/index.rst + diff --git a/conf.yml b/conf.yml index e60c91e8..175d390f 100644 --- a/conf.yml +++ b/conf.yml @@ -7,7 +7,7 @@ # name1, name2, name3: If you want to build PDF for specific hardware, guides, experiments, etc. # Example: pdf_build: BioAmp EXG Pill, BioAmp v1.5 -pdf_build: DIY Neuroscience Kit Pro +pdf_build: all # Hardware # @@ -23,22 +23,25 @@ PDFs: pdf: _static/latex/bioamp-exg-pill BioAmp v1.5: path: hardware/bioamp/bioamp-v1.5 - pdf: True + pdf: _static/latex/bioamp-v1.5 Muscle BioAmp BisCute: path: hardware/bioamp/muscle-bioamp-biscute - pdf: True + pdf: _static/latex/muscle-bioamp-biscute Muscle BioAmp Blip: path: hardware/bioamp/muscle-bioamp-blip - pdf: True + pdf: _static/latex/muscle-bioamp-blip Muscle BioAmp Candy: path: hardware/bioamp/muscle-bioamp-candy - pdf: True + pdf: _static/latex/muscle-bioamp-candy Muscle BioAmp Patchy: path: hardware/bioamp/muscle-bioamp-patchy - pdf: True + pdf: _static/latex/muscle-bioamp-patchy Muscle BioAmp Shield: path: hardware/bioamp/muscle-bioamp-shield pdf: _static/latex/muscle-bioamp-shield DIY Neuroscience Kit Pro: path: kits/diy-neuroscience/pro pdf: _static/latex/diy-neuroscience-kit-pro + DIY Neuroscience Kit Basic: + path: kits/diy-neuroscience/basic + pdf: _static/latex/diy-neuroscience-kit-basic diff --git a/guides/usage-guides/skin-preparation/index.rst b/guides/usage-guides/skin-preparation/index.rst index 8079d395..c56152ef 100644 --- a/guides/usage-guides/skin-preparation/index.rst +++ b/guides/usage-guides/skin-preparation/index.rst @@ -8,12 +8,12 @@ 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). -- ``Clean skin 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. +- ``Clean skin 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. Kit Contents ************** diff --git a/hardware/bioamp/bioamp-v1.5/index.rst b/hardware/bioamp/bioamp-v1.5/index.rst index cf16bd53..926e1f52 100644 --- a/hardware/bioamp/bioamp-v1.5/index.rst +++ b/hardware/bioamp/bioamp-v1.5/index.rst @@ -80,13 +80,13 @@ Software requirements Before you start using the kit, download Backyard Brains' `Spike Recorder `_ or `Audacity `_ according to the operating system you are using (Windows, OSX, Linux). -.. figure:: ../../../kits/diy-neuroscience/basic/media/byb.* +.. .. figure:: ../../../kits/diy-neuroscience/basic/media/byb.* - **Backyard Brains Spike Recorder** +.. **Backyard Brains Spike Recorder** -.. figure:: media/audacity.* +.. .. figure:: media/audacity.* - **Audacity (An easy-to-use, multi-track audio editor and recorder)** +.. **Audacity (An easy-to-use, multi-track audio editor and recorder)** Assembling the kit ******************** @@ -103,91 +103,91 @@ You can get your own BioAmp v1.5 bag of parts from our `online stores `. Step 4: Connecting 9V battery =============================== @@ -241,6 +255,7 @@ 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. .. figure:: media/9v-battery.* + :align: center Step 5: Listen to your muscle signals ====================================== @@ -255,6 +270,7 @@ Using speakers 3. Flex and listen to your muscles. .. figure:: media/listening-emg-2.* + :align: center Using wired earphones/headphones ---------------------------------------------- @@ -264,6 +280,8 @@ Using wired earphones/headphones 3. Flex and listen to your muscles. .. figure:: media/listening-emg-3.* + :align: center + :width: 80% Step 6: Visualize EMG signals on mobile phone =================================================== @@ -278,6 +296,8 @@ Using Phone Recorder app 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. .. figure:: media/emg-in-mobile-2.* + :align: center + :width: 80% Using Backyard Brains' Spike Recorder mobile app ------------------------------------------------ @@ -287,7 +307,7 @@ Using Backyard Brains' Spike Recorder mobile app 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. .. figure:: media/spike-recorder-mobile.* - :width: 80% + :width: 60% :align: center 4. Again click on the setting icon to close it and you are ready. @@ -295,6 +315,8 @@ Using Backyard Brains' Spike Recorder mobile app 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/emg-in-mobile.* + :width: 80% + :align: center Step 7: Visualize the EMG signals on laptop ============================================ @@ -309,12 +331,14 @@ Using Backyard Brains' Spike Recorder 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. .. figure:: media/spike-recorder-laptop.* + :align: center 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/emg-in-laptop.* + :align: center Using Audacity ---------------- @@ -325,5 +349,6 @@ Using Audacity 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. .. figure:: media/emg-in-audacity.* + :align: center diff --git a/hardware/bioamp/bioamp-v1.5/media/spike-recorder-mobile.jpg b/hardware/bioamp/bioamp-v1.5/media/spike-recorder-mobile.jpg index b6d5abd0..56627fd3 100644 Binary files a/hardware/bioamp/bioamp-v1.5/media/spike-recorder-mobile.jpg and b/hardware/bioamp/bioamp-v1.5/media/spike-recorder-mobile.jpg differ diff --git a/hardware/bioamp/muscle-bioamp-biscute/index.rst b/hardware/bioamp/muscle-bioamp-biscute/index.rst index 2efc01fc..7298dc0f 100644 --- a/hardware/bioamp/muscle-bioamp-biscute/index.rst +++ b/hardware/bioamp/muscle-bioamp-biscute/index.rst @@ -44,45 +44,60 @@ Hardware ********** Images below shows a quick overview of the hardware design. -.. grid:: 1 1 2 2 - :margin: 4 4 0 0 - :gutter: 2 +.. only:: html - .. grid-item:: - - .. card:: + .. grid:: 1 1 2 2 + :margin: 4 4 0 0 + :gutter: 2 - **PCB Front** - ^^^^^ - .. figure:: media/front.* + .. grid-item:: + + .. card:: + + PCB Front + ^^^^^ + .. figure:: media/front.* + + .. grid-item:: + + .. card:: - .. grid-item:: - - .. card:: + PCB Back + ^^^^^ + .. figure:: media/back.* - **PCB Back** - ^^^^^ - .. figure:: media/back.* +.. only:: latex + + .. figure:: media/front.* + :width: 50% + + .. figure:: media/back.* + :width: 50% .. figure:: media/assembled.* :align: center + :width: 50% - **Assembled PCB** + Assembled PCB .. figure:: media/dimensions.* :align: center + :width: 100% - **PCB Layout** + PCB Layout .. figure:: media/schematic.* :align: center + :width: 90% - **Schematic Diagram** + Schematic Diagram Contents of the kit ******************** .. figure:: media/kit-contents.* + :align: center + :width: 60% Software requirements ********************** @@ -98,100 +113,172 @@ You can get Muscle BioAmp BisCute from our `online stores ` or follow the youtube video given below. + **Tutorial on how to use the band:** -.. youtube:: xYZdw0aesa0 - :align: center - :width: 100% + .. youtube:: xYZdw0aesa0 + :align: center + :width: 100% .. note:: 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. @@ -261,9 +353,9 @@ Uploading the code Connect your Arduino UNO to your laptop using the USB cable (Type A to Type B). Copy paste any one of the arduino sketches given below in Arduino IDE v1.8.19 that you downloaded earlier: -EMG Filter: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/2_EMGFilter/2_EMGFilter.ino +:fab:`github;pst-color-primary` `EMG Filter `_ -EMG Envelope: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/3_EMGEnvelope/3_EMGEnvelope.ino +:fab:`github;pst-color-primary` `EMG Envelope `_ Go to ``tools`` from the menu bar, select ``board`` option then select Arduino UNO. In the same menu, select the COM port on which your Arduino Uno is connected. To find out the right COM port, @@ -281,8 +373,8 @@ Visualizing the EMG signals Now flex your arm to visualize the muscle signals in real time on your laptop. .. figure:: media/using-biscute.* + :align: center - **Video tutorial:** .. youtube:: ujFsAE0E0nk diff --git a/hardware/bioamp/muscle-bioamp-blip/index.rst b/hardware/bioamp/muscle-bioamp-blip/index.rst index bbe87f3a..3bc804a5 100644 --- a/hardware/bioamp/muscle-bioamp-blip/index.rst +++ b/hardware/bioamp/muscle-bioamp-blip/index.rst @@ -46,43 +46,66 @@ Hardware Images below shows a quick overview of the hardware design. -.. grid:: 1 1 2 2 - :margin: 4 4 0 0 - :gutter: 2 +.. .. only:: html - .. grid-item:: +.. .. grid:: 1 1 2 2 +.. :margin: 4 4 0 0 +.. :gutter: 2 - .. card:: +.. .. grid-item:: - **PCB Front** - ^^^^^ - .. figure:: media/muscle-bioamp-blip-front.* +.. .. card:: - .. grid-item:: - - .. card:: +.. **PCB Front** +.. ^^^^^ +.. .. figure:: media/muscle-bioamp-blip-front.* - **PCB Back** - ^^^^^ - .. figure:: media/muscle-bioamp-blip-front.* +.. .. grid-item:: + +.. .. card:: + +.. **PCB Back** +.. ^^^^^ +.. .. figure:: media/muscle-bioamp-blip-front.* + +.. .. only:: latex + +.. .. figure:: media/muscle-bioamp-blip-front.* +.. :align: center .. figure:: media/muscle-bioamp-blip-assembled.* :align: center - :width: 400 + :width: 60% Assembled PCB Contents of the kit ******************** ++---------------------+-----+ +| Contents of the kit | Qty | ++=====================+=====+ +| Muscle BioAmp Blip | 1 | ++---------------------+-----+ +| BioAmp Cable v3 | 1 | ++---------------------+-----+ +| Muscle BioAmp Band | 1 | ++---------------------+-----+ +| Boxy gel electrodes | 6 | ++---------------------+-----+ + .. figure:: media/blip-kit-contents.* + :align: center + :width: 80% Software requirements ********************** -- Before you start using the kit, please download `Arduino IDE v1.8.19 (legacy IDE) `_. Using this you'll be able to upload the arduino sketches on your development board and visualise the data on your laptop. +Before you start using the kit, please download `Arduino IDE v1.8.19 (legacy IDE) `_. Using this you'll be able to upload the arduino sketches on your development board and visualise the data on your laptop. -.. figure:: ../../../kits/diy-neuroscience/basic/media/arduino-ide.png +.. figure:: ../../../kits/diy-neuroscience/basic/media/arduino-ide.* + :align: center + :width: 80% Using the kit **************** @@ -93,6 +116,8 @@ Step 1: Soldering connector & header pins Solder the header pins and JST Ph 2.0mm connector on the Muscle BioAmp Blip as shown below. If you ordered assembled kit then you can skip this step and directly move to step 2. .. figure:: media/soldering-blip.* + :width: 80% + :align: center Step 2: Connections with the sensor ======================================== @@ -105,6 +130,8 @@ Directly connecting jumper cables You can directly connect the male to female jumper cables on the header pins of Muscle BioAmp Blip at ``5V``, ``GND``, ``AN``. .. figure:: media/blip-with-jumper-cables.* + :width: 80% + :align: center Connecting on breadboard --------------------------- @@ -112,6 +139,8 @@ Connecting on breadboard If you are thinking to connect more components/sensors and want to integrate Muscle BioAmp Blip in the complete circuit then it will be better to use a breadboard. Snap the Muscle BioAmp Blip on the breadboard and connect the jumper cables (male to male) at ``5V``, ``GND``, ``AN``. .. figure:: media/blip-with-breadboard.* + :width: 80% + :align: center Connecting via mikroBUS port ----------------------------- @@ -119,6 +148,8 @@ Connecting via mikroBUS port You can also connect the Muscle BioAmp Blip to any hardware that has mikroBUS™ port like mikroBUS™ shuttle, mikroBUS™ Arduino UNO Click Shield to name a few. .. figure:: media/blip-with-shuttle.* + :width: 80% + :align: center Step 3: Connecting with Arduino UNO R3 ======================================= @@ -126,6 +157,7 @@ Step 3: Connecting with Arduino UNO R3 Connect ``5V`` of the sensor to ``5V`` of your Arduino UNO, ``GND`` to ``GND``, and ``AN`` to ``Analog pin A0`` via other end of the jumper cables. If you are connecting ``AN`` to any other analog pin, then you will have to change the `INPUT PIN` in the example arduino sketch accordingly. .. figure:: media/blip-arduino-connections.* + :align: center .. note:: For demonstration purposes we are showing connections of the sensor with Arduino UNO R3 but you can use any other development board or a standalone ADC of your choice. @@ -135,6 +167,7 @@ Step 4: Connecting electrode cable Connect the BioAmp cable to Muscle BioAmp Blip by inserting the cable end in the JST PH connector as shown. .. figure:: media/blip-bioamp-cable.* + :align: center Step 5: Skin Preparation =============================================== @@ -155,13 +188,20 @@ Using gel electrodes 2. Peel the plastic backing from 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. -.. figure:: media/emg-connections-1.* +.. only:: latex - Muscle BioAmp Blip with breadboard + .. figure:: media/emg-connections-1.* + :align: center + :width: 60% -.. figure:: media/emg-connections-2.* + Muscle BioAmp Blip with breadboard - Muscle BioAmp Blip directly connected via jumper cables +.. only:: html + + .. figure:: media/emg-connections-1.* + :align: center + + Muscle BioAmp Blip with breadboard Using Muscle BioAmp Band --------------------------- @@ -169,11 +209,12 @@ 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. +.. tip:: Visit the complete documentation on how to :ref:`assemble and use the BioAmp Bands ` or follow the youtube video given below. **Tutorial on how to use the band:** -.. youtube:: xYZdw0aesa0 - :align: center - :width: 100% + .. youtube:: xYZdw0aesa0 + :align: center + :width: 100% .. note:: 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. @@ -182,9 +223,9 @@ Step 7: Uploading the code Connect your Arduino UNO R3 to your laptop using the USB cable (Type A to Type B). Copy paste any one of the arduino sketches given below in Arduino IDE v1.8.19 that you downloaded earlier: -EMG Filter: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/2_EMGFilter/2_EMGFilter.ino +:fab:`github;pst-color-primary` `EMG Filter `_ -EMG Envelope: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/3_EMGEnvelope/3_EMGEnvelope.ino +:fab:`github;pst-color-primary` `EMG Envelope `_ Go to ``tools`` from the menu bar, select ``board`` option then select Arduino UNO. In the same menu, select the COM port on which your Arduino Uno is connected. To find out the right COM port, @@ -202,6 +243,7 @@ Step 8: Visualizing the EMG signals Now flex your arm to visualize the muscle signals in real time on your laptop. .. figure:: media/emg-recording.* + :align: center .. rubric:: Footnotes diff --git a/hardware/bioamp/muscle-bioamp-blip/media/blip-kit-contents-2.png b/hardware/bioamp/muscle-bioamp-blip/media/blip-kit-contents-2.png new file mode 100644 index 00000000..23535272 Binary files /dev/null and b/hardware/bioamp/muscle-bioamp-blip/media/blip-kit-contents-2.png differ diff --git a/hardware/bioamp/muscle-bioamp-blip/media/blip-with-breadboard.png b/hardware/bioamp/muscle-bioamp-blip/media/blip-with-breadboard.png old mode 100755 new mode 100644 index fe267973..e46dbc8a Binary files a/hardware/bioamp/muscle-bioamp-blip/media/blip-with-breadboard.png and b/hardware/bioamp/muscle-bioamp-blip/media/blip-with-breadboard.png differ diff --git a/hardware/bioamp/muscle-bioamp-blip/media/blip-with-jumper-cables.png b/hardware/bioamp/muscle-bioamp-blip/media/blip-with-jumper-cables.png old mode 100755 new mode 100644 index 23f6f76b..96dd7aa2 Binary files a/hardware/bioamp/muscle-bioamp-blip/media/blip-with-jumper-cables.png and b/hardware/bioamp/muscle-bioamp-blip/media/blip-with-jumper-cables.png differ diff --git a/hardware/bioamp/muscle-bioamp-candy/index.rst b/hardware/bioamp/muscle-bioamp-candy/index.rst index 9273168a..ef51dc69 100644 --- a/hardware/bioamp/muscle-bioamp-candy/index.rst +++ b/hardware/bioamp/muscle-bioamp-candy/index.rst @@ -45,33 +45,49 @@ Hardware Images below shows a quick overview of the hardware design. -.. grid:: 1 1 2 2 - :margin: 4 4 0 0 - :gutter: 2 +.. only:: html - .. grid-item:: - - .. card:: + .. grid:: 1 1 2 2 + :margin: 4 4 0 0 + :gutter: 2 - **PCB Front** - ^^^^^ - .. figure:: media/PCBfront.* + .. grid-item:: + + .. card:: - .. grid-item:: - - .. card:: + **PCB Front** + ^^^^^ + .. figure:: media/PCBfront.* - **PCB Back** - ^^^^^ - .. figure:: media/PCBback.* + .. grid-item:: + + .. card:: + + **PCB Back** + ^^^^^ + .. figure:: media/PCBback.* + +.. only:: latex + + .. figure:: media/PCBfront.* + :width: 60% + + PCB Front + + .. figure:: media/PCBback.* + :width: 60% + + PCB Back .. figure:: media/muscle-bioamp-candy-front.* :align: center + :width: 60% Assembled PCB - Front .. figure:: media/muscle-bioamp-candy-back.* :align: center + :width: 60% Assembled PCB - Back @@ -88,14 +104,34 @@ Images below shows a quick overview of the hardware design. Contents of the kit ******************** ++--------------------------+-----+ +| Contents of the kit | Qty | ++==========================+=====+ +| Muscle BioAmp Candy | 1 | ++--------------------------+-----+ +| BioAmp Cable v3 | 1 | ++--------------------------+-----+ +| Jumper cables (set of 3) | 1 | ++--------------------------+-----+ +| Muscle BioAmp Band | 1 | ++--------------------------+-----+ +| Boxy gel electrodes | 3 | ++--------------------------+-----+ + .. figure:: media/kit-contents.* + :align: center + + Kit contents Software requirements ********************** -- Before you start using the kit, please download `Arduino IDE v1.8.19 (legacy IDE) `_. Using this you'll be able to upload the arduino sketches on your development board and visualise the data on your laptop. +Before you start using the kit, please download `Arduino IDE v1.8.19 (legacy IDE) `_. Using this you'll be able to upload the arduino sketches on your development board and visualise the data on your laptop. -.. figure:: ../../../kits/diy-neuroscience/basic/media/arduino-ide.png +.. figure:: ../../../kits/diy-neuroscience/basic/media/arduino-ide.* + :align: center + + Arduino IDE v1.8.19 Using the kit **************** @@ -103,10 +139,12 @@ Using the kit Step 1: Connect Arduino UNO R3 ================================= -.. figure:: media/arduino-candy-connection.* - Connect ``VCC`` to either ``5V`` or ``3.3V``, ``GND`` to ``GND``, and ``OUT`` to ``Analog pin A0`` of your Arduino UNO via jumper cables provided by us. If you are connecting ``OUT`` to any other analog pin, then you will have to change the `INPUT PIN` in the example arduino sketch accordingly. +.. figure:: media/arduino-candy-connection.* + :align: center + :width: 70% + .. note:: For demonstration purposes we are showing connections of the sensor with Arduino UNO R3 but you can use any other development board or a standalone ADC of your choice. .. warning:: Take precautions while connecting to power, if power pins (GND & VCC) are to be swapped, your sensor will be fried and it’ll become unusable (DIE). @@ -114,9 +152,11 @@ Connect ``VCC`` to either ``5V`` or ``3.3V``, ``GND`` to ``GND``, and ``OUT`` to Step 2: Connecting electrode cable ======================================== -.. figure:: media/candy-cable-connection.* +Connect the BioAmp cable to Muscle BioAmp Candy by inserting the cable end in the JST PH connector as shown. -Connect the BioAmp cable to Muscle BioAmp Candy by inserting the cable end in the JST PH connector as shown above. +.. figure:: media/candy-cable-connection.* + :width: 70% + :align: center Step 3: Skin Preparation =============================================== @@ -140,17 +180,20 @@ We have 2 options to measure the EMG signals, either using the gel electrodes or 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. .. figure:: media/candy-emg.* + :align: center - **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. +.. tip:: Visit the complete documentation on how to :ref:`assemble and use the BioAmp Bands ` or follow the youtube video given below. + **Tutorial on how to use the band:** -.. youtube:: xYZdw0aesa0 - :align: center - :width: 100% + .. youtube:: xYZdw0aesa0 + :align: center + :width: 100% .. note:: 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. @@ -159,9 +202,9 @@ Uploading the code Connect your Arduino UNO R3 to your laptop using the USB cable (Type A to Type B). Copy paste any one of the arduino sketches given below in Arduino IDE v1.8.19 that you downloaded earlier: -EMG Filter: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/2_EMGFilter/2_EMGFilter.ino +:fab:`github;pst-color-primary` `EMG Filter `_ -EMG Envelope: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/3_EMGEnvelope/3_EMGEnvelope.ino +:fab:`github;pst-color-primary` `EMG Envelope `_ Go to ``tools`` from the menu bar, select ``board`` option then select Arduino UNO. In the same menu, select the COM port on which your Arduino Uno is connected. To find out the right COM port, @@ -179,6 +222,7 @@ Visualizing the EMG signals Now flex your arm to visualize the muscle signals in real time on your laptop. .. figure:: media/using-candy.* + :align: center **Video tutorial:** diff --git a/hardware/bioamp/muscle-bioamp-patchy/index.rst b/hardware/bioamp/muscle-bioamp-patchy/index.rst index 38e9b29b..c6513e67 100644 --- a/hardware/bioamp/muscle-bioamp-patchy/index.rst +++ b/hardware/bioamp/muscle-bioamp-patchy/index.rst @@ -14,6 +14,7 @@ powerful BioAmp sensing technology for precise muscle signal recording. This ena based Human-Computer Interface (HCI) easily. .. figure:: media/Patchy-All-Colors.* + :align: center Features & Specifications ************************** @@ -70,6 +71,7 @@ Contents of the kit ******************** .. figure:: media/kit-contents.* + :align: center We have made a complete unboxing video of the kit. Please find the link below: @@ -82,7 +84,8 @@ Software requirements Before you start using the kit, please download `Arduino IDE v1.8.19 (legacy IDE) `_. Using this you'll be able to upload the arduino sketches on your development board and visualise the data on your laptop. -.. figure:: ../../../kits/diy-neuroscience/basic/media/arduino-ide.png +.. figure:: ../../../kits/diy-neuroscience/basic/media/arduino-ide.* + :align: center Using the kit **************** @@ -93,6 +96,7 @@ Step 1: Connect reference cable Connect the reference cable to the Muscle BioAmp Patchy as shown in the diagram. .. figure:: media/ref-cable-connection.* + :align: center Step 2: Connecting sensor to gel electrodes ================================================ @@ -116,6 +120,7 @@ Step 4: Electrode Placements Now peel off the plastic backing from the gel electrodes and place the Muscle BioAmp Patchy on the targeted muscle and the reference on the bony part of your elbow as shown in the diagram. .. figure:: media/patchy-on-hand.* + :align: center .. note:: 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. @@ -125,6 +130,9 @@ Step 5: Connect Arduino UNO R3 Connect ``VCC`` to ``5V``, ``GND`` to ``GND``, and ``OUT`` to ``Analog pin A0`` of your Arduino UNO via jumper cables provided by us. If you are connecting ``OUT`` to any other analog pin, then you will have to change the INPUT PIN in the arduino sketch accordingly. .. figure:: media/pathcy-arduino-connections.* + :align: center + + Connections with Arduino UNO R3 .. note:: For demonstration purposes we are showing connections of the sensor with Arduino UNO R3 but you can use any other development board or a standalone ADC of your choice. @@ -133,11 +141,12 @@ Step 6: Upload the code Connect your Arduino UNO to your laptop using the USB cable (Type A to Type B). Copy paste any one of the arduino sketches given below in Arduino IDE v1.8.19 that you downloaded earlier: -EMG Filter: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/2_EMGFilter/2_EMGFilter.ino +:fab:`github;pst-color-primary` `EMG Filter `_ -EMG Envelope: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/3_EMGEnvelope/3_EMGEnvelope.ino +:fab:`github;pst-color-primary` `EMG Envelope `_ .. figure:: media/setup.* + :align: center Go to ``tools`` from the menu bar, select ``board`` option then select Arduino UNO. In the same menu, select the COM port on which your Arduino Uno is connected. To find out the right COM port, @@ -155,6 +164,7 @@ Step 7: Visualizing the EMG signals Now flex your arm to visualize the muscle signals in real-time on your laptop. .. figure:: media/patchy-emg.* + :align: center **Video tutorial:** diff --git a/kits/diy-neuroscience/basic/index.rst b/kits/diy-neuroscience/basic/index.rst index 40c8ed69..12534521 100644 --- a/kits/diy-neuroscience/basic/index.rst +++ b/kits/diy-neuroscience/basic/index.rst @@ -35,10 +35,16 @@ Software requirements - Before you start using the kit, please download `Arduino IDE v1.8.19 (legacy IDE) `_. Using this you'll be able to upload the arduino sketches in Maker UNO and visualise the data on your laptop. .. figure:: media/arduino-ide.* + :align: center + + Arduino IDE v1.8.19 (legacy IDE) - Download Backyard Brains' `Spike Recorder `_ according to the operating system you are using (Windows, OSX, Linux). .. figure:: media/byb.* + :align: center + + BYB spike recorder Using the kit ************** @@ -49,6 +55,7 @@ Step 1 (optional): Configure for EMG/ECG ========================================= .. figure:: media/configuration-emg-ecg.* + :align: center BioAmp EXG Pill is by default configured for recording EEG or EOG, so if you are recording any of the two signals you can skip this step. But if you want to record good quality ECG or EMG, then it is recommended to configure it @@ -60,6 +67,7 @@ Step 2: Connect Maker UNO ========================== .. figure:: media/connection-with-maker-uno.* + :align: center Connect ``VCC`` to ``5V``, ``GND`` to ``GND``, and ``OUT`` to ``Analog pin A0`` of your Maker UNO via jumper cables provided by us. If you are connecting OUT to any other analog pin, then you will have to change the INPUT PIN in the arduino sketch accordingly. @@ -69,6 +77,7 @@ Step 3: Connecting electrode cable =============================================== .. figure:: media/bioamp-cable.* + :align: center Connect the BioAmp cable to BioAmp EXG Pill by inserting the cable end in the JST PH connector as shown above. @@ -80,7 +89,7 @@ Apply Nuprep Skin Preparation Gel on the skin surface where electrodes would be For more information, please check out detailed step by step :ref:`skin-preparation`. Step 5: Measuring EMG (ElectroMyoGraphy) -=============================================== +=========================================== Electrodes placement ---------------------- @@ -94,17 +103,20 @@ We have 2 options to measure the EMG signals, either using the gel electrodes or 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. .. figure:: media/emg.* + :align: center - **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. +.. tip:: Visit the complete documentation on how to :ref:`assemble and use the BioAmp Bands ` or follow the youtube video given below. + **Tutorial on how to use the band:** -.. youtube:: xYZdw0aesa0 - :align: center - :width: 100% + .. youtube:: xYZdw0aesa0 + :align: center + :width: 100% .. note:: 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. @@ -113,9 +125,9 @@ Uploading the code Connect the Maker Uno to your laptop using the USB cable (Type A to Type B). Copy paste any one of the Arduino Sketches given below in Arduino IDE v1.8.19 that you downloaded earlier: -EMG Filter: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/2_EMGFilter/2_EMGFilter.ino +:fab:`github;pst-color-primary` `EMG Filter `_ -EMG Envelope: https://github.com/upsidedownlabs/Muscle-BioAmp-Arduino-Firmware/blob/main/3_EMGEnvelope/3_EMGEnvelope.ino +:fab:`github;pst-color-primary` `EMG Envelope `_ Go to ``tools`` from the menu bar, select ``board`` option then select Arduino UNO. In the same menu, select the COM port on which your Maker Uno is connected. To find out the right COM port, @@ -133,6 +145,7 @@ Visualizing the EMG signals Now flex your arm to visualize the muscle signals in real time on your laptop. .. figure:: media/EMGEnvelop.* + :align: center Step 6: Measuring ECG (ElectroCardioGraphy) =============================================== @@ -149,6 +162,7 @@ We have 2 options to measure the ECG signals, either using the gel electrodes or 3. Place the IN- cable on the left side, IN+ in the middle and REF (reference) on the far right side as shown in the diagram. .. figure:: media/ecg.* + :align: center - **Using Heart BioAmp Band:** @@ -156,18 +170,20 @@ We have 2 options to measure the ECG signals, either using the gel electrodes or 2. Place the IN- cable on the left side, IN+ in the middle and REF (reference) on the far right side. 3. Now put a small drop of electrode gel between the skin and metallic part of BioAmp cable to get the best results. -**Tutorial on how to use the band:** +.. tip:: Visit the complete documentation on how to :ref:`assemble and use the BioAmp Bands ` or follow the youtube video given below. -.. youtube:: fr5iORsVyUM - :align: center - :width: 100% + **Tutorial on how to use the band:** + + .. youtube:: fr5iORsVyUM + :align: center + :width: 100% Uploading the code --------------------- Connect the Maker Uno to your laptop using the USB cable (Type A to Type B). Copy paste the Arduino Sketch given below in Arduino IDE v1.8.19 that you downloaded earlier: -ECG Filter: https://github.com/upsidedownlabs/Heart-BioAmp-Arduino-Firmware/blob/main/2_ECGFilter/2_ECGFilter.ino +:fab:`github;pst-color-primary` `ECG Filter `_ Go to ``tools`` from the menu bar, select ``board`` option then select Arduino UNO. In the same menu, select the COM port on which your Maker Uno is connected. To find out the right COM port, @@ -183,6 +199,7 @@ Visualizing the ECG signals ----------------------------- .. figure:: media/bioamp-Exg-Pill-ECG.* + :align: center Step 7: Measuring EOG (ElectroOculoGraphy) ============================================= @@ -195,6 +212,7 @@ We have 2 ways to measure the EOG signals, either record the horizontal eye move - **Horizontal EOG recording:** .. figure:: media/eog-horizontal.* + :align: center 1. Connect the BioAmp cable to gel electrodes. 2. Peel the plastic backing from electrodes. @@ -203,6 +221,7 @@ We have 2 ways to measure the EOG signals, either record the horizontal eye move - **Vertical EOG recording:** .. figure:: media/eog-vertical.* + :align: center 1. Connect the BioAmp cable to gel electrodes. 2. Peel the plastic backing from electrodes. @@ -213,7 +232,7 @@ Uploading the code Connect the Maker Uno to your laptop using the USB cable (Type A to Type B). Copy paste the Arduino Sketch given below in Arduino IDE v1.8.19 that you downloaded earlier: -EOG Filter: https://github.com/upsidedownlabs/Eye-BioAmp-Arduino-Firmware/blob/main/2_EOGFilter/2_EOGFilter.ino +:fab:`github;pst-color-primary` `EOG Filter `_ Go to ``tools`` from the menu bar, select ``board`` option then select Arduino UNO. In the same menu, select the COM port on which your Maker Uno is connected. To find out the right COM port, @@ -229,6 +248,7 @@ Visualizing the EOG signals ------------------------------ .. figure:: media/bioamp-exg-pill-eog.* + :align: center Step 8: Measuring EEG (ElectroEncephaloGraphy) =============================================== @@ -237,6 +257,7 @@ Let's understand the electrode placements before moving forward in this project. different parts of the brain, you have to place the electrodes according to the `International 10-20 system for recording EEG `_. .. figure:: media/10-20-system.* + :align: center :width: 80% Electrodes placement @@ -247,6 +268,7 @@ We have 2 options to measure the EEG signals, either using the gel electrodes or - **Using gel electrodes to record from prefrontal cortex part of brain:** .. figure:: media/eeg.* + :align: center 1. Connect the BioAmp cable to gel electrodes. 2. Peel the plastic backing from electrodes. @@ -260,11 +282,13 @@ We have 2 options to measure the EEG signals, either using the gel electrodes or .. note:: Similarly you can use the band to record EEG signals from the visual cortex part of brain by placing the dry electrodes on O1 and O2 instead of Fp1 and Fp2. Everything else will remain the same. -**Tutorial on how to use the band:** +.. tip:: Visit the complete documentation on how to :ref:`assemble and use the BioAmp Bands ` or follow the youtube video given below. -.. youtube:: O6qp7teT-sM - :align: center - :width: 100% + **Tutorial on how to use the band:** + + .. youtube:: O6qp7teT-sM + :align: center + :width: 100% Uploading the code ----------------------- @@ -287,6 +311,7 @@ Open up your BackyardBrains Spike Recorder software. At first, it will monitor s the :fas:`gear` icon on the top left corner of the screen, select the COM port on which the Maker UNO is connected and click on connect. .. figure:: media/spike-recorder-configurations.* + :align: center Mute the speakers and apply the 50Hz notch filter by clicking on the checkbox as shown in the screenshot above. You should set the low band pass filter to 1Hz and high bandpass filter to 40Hz as we are only recording the EEG signals which range between @@ -295,6 +320,7 @@ these frequencies. Now everything is configured and connected. So close the settings window and start recording EEG signals. .. figure:: media/bioamp-exg-pill-eeg.* + :align: center The signals that you can see on the screen right now are originating from prefrontal cortex part of your brain and propagating through all the layers to the surface of your skin.