Skip to content

Commit f824233

Browse files
authored
Merge pull request #71 from harshitmishra13/main
Replaced Spike Recorder with Chords Web for BioAmp EXG Pill Doc
2 parents ca67eda + 49e7362 commit f824233

File tree

6 files changed

+139
-127
lines changed

6 files changed

+139
-127
lines changed

hardware/bioamp/bioamp-exg-pill/index.rst

Lines changed: 76 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,25 @@ Software requirements
7777

7878
.. figure:: ../../../kits/diy-neuroscience/basic/media/arduino-ide.*
7979

80-
- Download Backyard Brains' `Spike Recorder <https://backyardbrains.com/products/spikerecorder>`_ according to the operating system you are using (Windows, OSX, Linux).
80+
- Visit Upside Down Labs `Chords Web <https://chords.upsidedownlabs.tech>`_ to visualize your biosignals directly in the browser.
8181

82-
.. figure:: ../../../kits/diy-neuroscience/basic/media/byb.*
82+
.. figure:: ../../../software/chords/chords-web/media/chords_landing_page.*
83+
84+
.. grid:: 1 1 1 1
85+
:margin: 4 4 0 0
86+
:gutter: 2
87+
88+
.. grid-item::
89+
90+
.. card::
91+
92+
**Getting started with Chords Web**
93+
94+
.. youtube:: IVIPnk9z75g
95+
:align: center
96+
:width: 100%
97+
98+
.. tip:: To know more about Chords Web :ref:`click here<chords>`.
8399

84100
Using the Hardware
85101
*********************
@@ -93,13 +109,15 @@ Insert the provided BioAmp cable's JST PH connector and header pins from top as
93109

94110
.. figure:: media/assembly-step1.*
95111
:align: center
112+
:alt: Soldering the connector & header pins on BioAmp EXG Pill
96113

97-
`Soldering the connector & header pins on BioAmp EXG Pill`
114+
Soldering the connector & header pins on BioAmp EXG Pill
98115

99116
.. figure:: media/bioamp-exg-pill-soldered.*
100117
:align: center
118+
:alt: After soldering, BioAmp EXG Pill should look like this
101119

102-
`After soldering, BioAmp EXG Pill should look like this`
120+
After soldering, BioAmp EXG Pill should look like this
103121

104122
Step 2 (optional): Configure for ECG/EMG
105123
==========================================
@@ -132,8 +150,9 @@ For all the examples provided, we are using the A0 pin of Arduino UNO R3. Connec
132150

133151
.. figure:: media/connections-with-arduino.*
134152
:align: center
153+
:alt: Connections with Arduino UNO R3
135154

136-
`Connections with Arduino UNO R3`
155+
Connections with Arduino UNO R3
137156

138157
.. warning:: Take precautions while connecting to power, if power pins are to be swapped, your BioAmp EXG Pill will be fried and it’ll become unusable (DIE).
139158

@@ -144,8 +163,9 @@ Connect the BioAmp cable to BioAmp EXG Pill by inserting the cable end in the JS
144163

145164
.. figure:: media/connection-with-cable.*
146165
:align: center
166+
:alt: Connections with BioAmp Cable v3
147167

148-
`Connections with BioAmp Cable v3`
168+
Connections with BioAmp Cable v3
149169

150170
Step 5: Skin Preparation
151171
===========================
@@ -215,15 +235,28 @@ the EMG signals.
215235

216236
After opening the serial plotter make sure to select the baud rate to 115200.
217237

238+
.. tip:: Visit the complete documentation on how to :ref:`How to upload the code <muscle-bioamp-arduino-firmware-code-upload>`.
239+
218240
.. important:: Make sure your laptop is not connected to a charger and sit 5m away from any AC appliances for best signal acquisition.
219241

220242
Visualizing the EMG signals
221243
----------------------------
222244

245+
For visualizing the EMG signals, use `Chords Web <https://chords.upsidedownlabs.tech/>`_ for quick and hassle-free real-time biosignal visualization—right from your browser, without installing any software.
246+
247+
.. figure:: ../../../software/chords/chords-web/media/chords_emg_signal.*
248+
:align: center
249+
:alt: Visualizing EMG signals on Chords Web
250+
251+
Visualizing EMG signals on Chords Web
252+
223253
Now flex your arm to visualize the muscle signals in real time on your laptop.
224254

225255
.. figure:: media/EMGEnvelop.*
226256
:align: center
257+
:alt: Visualizing EMG signals on Arduino IDE v1.8.x
258+
259+
Visualizing EMG signals on Arduino IDE v1.8.x
227260

228261
Step 6: Measuring ElectroCardioGraphy (ECG)
229262
=============================================
@@ -277,15 +310,29 @@ the signals.
277310

278311
After opening the serial plotter make sure to select the baud rate to 115200.
279312

313+
.. tip:: Visit the complete documentation on how to :ref:`How to upload the code <heart-bioamp-arduino-firmware-code-upload>`.
314+
280315
.. important:: Make sure your laptop is not connected to a charger and sit 5m away from any AC appliances for best signal acquisition.
281316

282317
Visualizing the ECG signals
283318
-----------------------------
284319

320+
For visualizing the ECG signals, use `Chords Web <https://chords.upsidedownlabs.tech/>`_ for quick and hassle-free real-time biosignal visualization—right from your browser, without installing any software.
321+
322+
.. figure:: ../../../software/chords/chords-web/media/chords_ecg_signal.*
323+
:align: center
324+
:alt: Visualizing ECG signals on Chords Web
325+
326+
Visualizing ECG signals on Chords Web
327+
328+
285329
Sit back, relax and see your ECG signals in real time on your laptop.
286330

287331
.. figure:: media/bioamp-Exg-Pill-ECG.*
288332
:align: center
333+
:alt: Visualizing ECG signals on Arduino IDE v1.8.x
334+
335+
Visualizing ECG signals on Arduino IDE v1.8.x
289336

290337
Step 7: Measuring Electrooculography (EOG)
291338
================================================
@@ -337,15 +384,29 @@ the signals.
337384

338385
After opening the serial plotter make sure to select the baud rate to 115200.
339386

387+
.. tip:: Visit the complete documentation on how to :ref:`How to upload the code <eye-bioamp-arduino-firmware-code-upload>`.
388+
340389
.. important:: Make sure your laptop is not connected to a charger and sit 5m away from any AC appliances for best signal acquisition.
341390

342391
Visualizing the EOG signals
343392
------------------------------
344393

394+
For visualizing the EOG signals, use `Chords Web <https://chords.upsidedownlabs.tech/>`_ for quick and hassle-free real-time biosignal visualization—right from your browser, without installing any software.
395+
396+
.. figure:: ../../../software/chords/chords-web/media/chords_eog_signal.*
397+
:align: center
398+
:alt: Visualizing EOG signals on Chords Web
399+
400+
Visualizing EOG signals on Chords Web
401+
402+
345403
Move your eyes up-down or left-right to see your EOG signals in real time on your laptop.
346404

347405
.. figure:: media/bioamp-exg-pill-eog.*
348406
:align: center
407+
:alt: Visualizing EOG signals on Arduino IDE v1.8.x
408+
409+
Visualizing EOG signals on Arduino IDE v1.8.x
349410

350411
Step 8: Measuring Electroencephalography (EEG)
351412
===================================================
@@ -397,51 +458,34 @@ Uploading the code
397458

398459
Connect Arduino 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:
399460

400-
:fab:`github;pst-color-primary` `Spike recorder arduino code <https://raw.githubusercontent.com/BackyardBrains/SpikerShield/master/Muscle/Arduino%20Code/SpikeRecorder/SpikeRecorderSpikerShield_V1_1.ino>`_
461+
:fab:`github;pst-color-primary` `EEG Filter Code <https://github.com/upsidedownlabs/Brain-BioAmp-Arduino-Firmware/blob/main/02-eeg-filter/02-eeg-filter.ino>`_
401462

402463
Go to ``tools`` from the menu bar, select ``board`` option then select Arduino UNO. In the same menu,
403464
select the COM port on which your development board is connected. To find out the right COM port, screen
404465
disconnect your board and reopen the menu. The entry that disappears should be the
405466
right COM port. Now upload the code.
406467

407-
.. important:: Make sure your laptop is not connected to a charger and sit 5m away from any AC appliances for best signal acquisition.
468+
.. tip:: Visit the complete documentation on how to :ref:`How to upload the code <brain-bioamp-arduino-firmware-code-upload>`.
408469

470+
.. important:: Make sure your laptop is not connected to a charger and sit 5m away from any AC appliances for best signal acquisition.
471+
409472
Visualizing the EEG signals
410473
-------------------------------
411474

412-
Open the Spike Recorder software. When the Spike Recorder starts, it will start recording from your microphone. To change that, go to the settings by clicking
413-
the first icon on the top left corner of the screen, select the COM port on which your Arduino UNO is connected and click on connect.
414-
415-
.. figure:: ../../../kits/diy-neuroscience/basic/media/spike-recorder-configurations.*
416-
:align: center
417-
418-
`Spike Recorder settings`
419-
420-
Mute the speakers and apply the 50Hz notch filter by clicking on the checkbox as shown in the screenshot above. You should
421-
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
422-
these frequencies.
423-
424-
Now everything is configured and connected. So close the settings window and start recording EEG signals.
475+
For visualizing the EEG signals, use `Chords Web <https://chords.upsidedownlabs.tech/>`_ for quick and hassle-free real-time biosignal visualization—right from your browser, without installing any software.
425476

426-
.. figure:: ../../../kits/diy-neuroscience/basic/media/bioamp-exg-pill-eeg.*
477+
.. figure:: ../../../software/chords/chords-web/media/chords_eeg_signal.*
427478
:align: center
479+
:alt: Visualizing EEG signals on Chords Web
428480

429-
`EEG signals being visualised in Spike Recorder`
481+
Visualizing EEG signals on Chords Web
430482

431483
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.
432484

433-
To record these EEG signals, you have placed the electrodes on the forehead (Fp1 & Fp2), then BioAmp EXG Pill is amplifying those signals so that we can detect it and finally sending it to the ADC (Analog to Digital Convertor) of your Arduino Uno. Ultimately the signals are being visualized in Spike Recorder software.
485+
You have placed the electrodes on the forehead (Fp1 & Fp2), the BioAmp EXG Pill is amplifying those signals so that we can detect it and finally sending it to the ADC (Analog to Digital Convertor) of your Arduino Uno and the signals are being visualized in Chords Web.
434486

435487
We hope everything is clear now and you understand how the signals are propagating from your brain to the screen of the laptop.
436488

437-
**Features of Spike Recorder that you can explore:**
438-
439-
- Increase or decrease the scale of the Y axis by clicking on the + and - icons respecitively that is present on the left side of the graph.
440-
- Increase or decrease the X axis timescale by sliding up and down on the scroll wheel of the mouse.
441-
- Visualize the FFT graph by clicking on the FFT icon on top left size of the screen.
442-
- Record the data in .wav format by clicking the record icon on the top right corner. You can convert this data in any other format according to your project requirements.
443-
- Listen to the signals by clicking the volume icon on the top right corner. No don't smile right now, that's how your brain sounds like :P
444-
445489
Glimpses of previous versions
446490
*******************************
447491

@@ -558,33 +602,3 @@ Project ideas & tutorials
558602

559603
These are some of the project ideas but the possibilities are endless. So create your own Human Computer Interface (HCI) and
560604
Brain Computer Interface (BCI) projects and share them with us at [email protected]
561-
562-
Software tutorials
563-
********************
564-
565-
.. grid:: 1 1 1 1
566-
:margin: 4 4 0 0
567-
:gutter: 2
568-
569-
.. grid-item::
570-
571-
.. card::
572-
573-
**1. Getting started with Backyard Brains' Spike Recorder**
574-
^^^^
575-
576-
.. youtube:: QzZh243-Ac8
577-
:align: center
578-
:width: 100%
579-
580-
.. card::
581-
582-
**2. Getting started with Brainbay**
583-
^^^^
584-
585-
.. youtube:: 8vKYAg9C8Jg
586-
:align: center
587-
:width: 100%
588-
589-
590-

software/bioamp/brain-bioamp-arduino-firmware/index.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Before you start using the kit, please download or open the following:
7575
- We will use Chords Website to visualize the Brain Signals!
7676
- Open this website: `Chords Web <https://chords.upsidedownlabs.tech>`_
7777

78-
.. _Connect Your Hardware:
78+
.. _brain-bioamp-arduino-firmware-connect-hardware:
7979

8080
Step 3: Connect Your Hardware
8181
===============================
@@ -132,7 +132,7 @@ Make sure the sticky side of electrodes touches your skin firmly.
132132

133133
- **Using BioAmp Band:** For BioAmp Band, refer to the following documentation: :ref:`Using BioAmp Bands <using-bioamp-bands>`
134134

135-
.. _How to upload the Code to Arduino:
135+
.. _brain-bioamp-arduino-firmware-code-upload:
136136

137137
Step 5: How to upload the Code to Arduino
138138
============================================
@@ -148,7 +148,7 @@ Step 5: How to upload the Code to Arduino
148148
- To try filtered signal: open ``02-eeg-filter.ino``
149149

150150
.. note::
151-
You'll find all the experiments listed below, each with :ref:`step-by-step instructions<experiments step by step>`. Just scroll to the one you're working on to get started with the right setup.
151+
You'll find all the experiments listed below, each with :ref:`step-by-step instructions<brain-bioamp-arduino-firmware-exp-list>`. Just scroll to the one you're working on to get started with the right setup.
152152

153153
5. Connect Your Arduino
154154

@@ -187,7 +187,7 @@ Step 5: How to upload the Code to Arduino
187187

188188
- Remember to close the **Serial Monitor & Serial Plotter** in **Arduino IDE** before starting the Chords Visualizer.
189189

190-
.. _Visualize Your Brain Signals!:
190+
.. _brain-bioamp-arduino-firmware-visualize-signals:
191191

192192
Step 6: Visualize Your Brain Signals!
193193
============================================
@@ -205,7 +205,7 @@ Step 6: Visualize Your Brain Signals!
205205

206206
🎉 Now sit still and let your mind wander—or blink and shift your gaze—you’ll see real‑time EEG waves on the screen!
207207

208-
.. _experiments step by step:
208+
.. _brain-bioamp-arduino-firmware-exp-list:
209209

210210
Let's explore all the experiments step by step
211211
***********************************************
@@ -241,16 +241,16 @@ Let's explore all the experiments step by step
241241

242242
**3. Perform the Hardware**
243243

244-
- Refer to wiring as per instructions given in :ref:`Connect Your Hardware<Connect Your Hardware>`
244+
- Refer to wiring as per instructions given in :ref:`Connect Your Hardware<brain-bioamp-arduino-firmware-connect-hardware>`
245245

246246
**4. Firmware Upload**
247247

248248
- For this project, navigate to the repository folder (Brain-BioAmp-Arduino-Firmware/01-fixed-sampling) and select ``01-fixed-sampling.ino``.
249-
- To upload firmware, refer to :ref:`How to upload the Code to Arduino<How to upload the Code to Arduino>`
249+
- To upload firmware, refer to :ref:`How to upload the Code to Arduino<brain-bioamp-arduino-firmware-code-upload>`
250250

251251
**5. Visualize your signal**
252252

253-
- Follow the steps given in :ref:`Visualize Your Brain Signals!<Visualize Your Brain Signals!>`
253+
- Follow the steps given in :ref:`Visualize Your Brain Signals!<brain-bioamp-arduino-firmware-visualize-signals>`
254254

255255
**6. Running & Observing Results**
256256

@@ -321,16 +321,16 @@ Let's explore all the experiments step by step
321321

322322
**3. Perform the Hardware**
323323

324-
- Refer to wiring as per instructions given in :ref:`Connect Your Hardware<Connect Your Hardware>`
324+
- Refer to wiring as per instructions given in :ref:`Connect Your Hardware<brain-bioamp-arduino-firmware-connect-hardware>`
325325

326326
**4. Firmware Upload**
327327

328328
- For this project, go to the repository folder (Brain-BioAmp-Arduino-Firmware/02-eeg-filter) and select ``02-eeg-filter.ino``.
329-
- To upload firmware, refer to :ref:`How to upload the Code to Arduino<How to upload the Code to Arduino>`
329+
- To upload firmware, refer to :ref:`How to upload the Code to Arduino<brain-bioamp-arduino-firmware-code-upload>`
330330

331331
**5. Visualize your signal**
332332

333-
- Follow the steps given in :ref:`Visualize Your Brain Signals!<Visualize Your Brain Signals!>`
333+
- Follow the steps given in :ref:`Visualize Your Brain Signals!<brain-bioamp-arduino-firmware-visualize-signals>`
334334
- You’ll see a smooth EEG waveform updating at 256 Hz, free of drift and high‑frequency spikes.
335335

336336
**6. Running & Observing Results**

0 commit comments

Comments
 (0)