Updated Chords web documentation #56
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lorforlinux
reviewed
Dec 16, 2024
software/chords/chords-web/index.rst
Outdated
| @@ -1,162 +1,87 @@ | |||
| .. _chords: | |||
|
|
|||
| Chords-Web | |||
| ############ | |||
| ################# | |||
|
|
|||
| 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>`_. | |||
There was a problem hiding this comment.
Suggested change
| 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>`_. | |
| Chords-Web 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>`_. |
lorforlinux
reviewed
Dec 16, 2024
software/chords/chords-web/index.rst
Outdated
|
|
||
| - **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. | ||
| - **Board Support** : We have support for Arduino UNO R3, R4 and Maker UNO. Chords should now work for other Arduino R3 clones with CH340 USB to UART Chips as well. |
There was a problem hiding this comment.
Instead of mentioning the boards name, we should direct users to Chords Arduino Firmware repo.
lorforlinux
reviewed
Dec 16, 2024
software/chords/chords-web/index.rst
Outdated
| :align: center | ||
| :alt: Chords Filter | ||
|
|
||
| - **Pause/Play**: Control the data flow on the screen, and use the two additional buttons to move backward and forward through previous and next frames. |
There was a problem hiding this comment.
This repeats what we have under frame buffer point.
lorforlinux
reviewed
Dec 16, 2024
software/chords/chords-web/index.rst
Outdated
| :alt: Chords Filter | ||
|
|
||
| - **Pause/Play**: Control the data flow on the screen, and use the two additional buttons to move backward and forward through previous and next frames. | ||
| - **Channel**: Supports plotting of up to six channels of data simultaneously in real time where each stream is color coded differently for easy identification. |
There was a problem hiding this comment.
We should just mention "multiple" channel signal as we may increase the channel count in future.
lorforlinux
reviewed
Dec 16, 2024
software/chords/chords-web/index.rst
Outdated
Comment on lines
53
to
54
| How to Use Chords | ||
| ******************* |
There was a problem hiding this comment.
Suggested change
| How to Use Chords | |
| ******************* | |
| How to Use Chords-Web | |
| ******************* |
lorforlinux
reviewed
Dec 16, 2024
software/chords/chords-web/index.rst
Outdated
| How to Use Chords-Web | ||
| *********************** | ||
| 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. |
There was a problem hiding this comment.
Suggested change
| 2. Copy and paste the `Arduino Firmware <https://github.com/upsidedownlabs/Chords-Arduino-Firmware>`_ into the Arduino IDE. | |
| 2. Copy and paste the `Arduino Firmware <https://github.com/upsidedownlabs/Chords-Arduino-Firmware>`_ for your board into the Arduino IDE. |
lorforlinux
reviewed
Dec 16, 2024
software/chords/chords-web/index.rst
Outdated
| 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. | ||
| 2. Use the ``Zoom in/out`` button to adjust the data visualization. | ||
| 3. Use the ``Play/Pause`` button to control the data stream. |
There was a problem hiding this comment.
We should mention frame buffer feature here.
lorforlinux
reviewed
Dec 16, 2024
There was a problem hiding this comment.
ZoomIN/XoomOut looks misaligned. please recheck everything.
|
@Ritika8081 Please resolve the comments so that I can merge this. |
|
@lorforlinux I have fixed issues, please have a look and let me know if there is anything else to improve. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@lorforlinux Please review , I have updated Chords web documentation include all the latest updates and enhancements.