Chords - Python

Chords- Python is an open-source bag of tools designed to interface with Micro-controller development boards running Chords Arduino Firmware. Use Upside Down Labs bio-potential amplifiers to read data, visualize it, record data in CSV Files, and stream it via Lab Streaming Layer.

Features

• Multiple Protocols: Supports Wi-Fi, Bluetooth, and Serial communication.
• LSL Data Streaming: Once the LSL stream starts, any PC on the same Wi-Fi network can access the data using tools like BrainVision LSL Viewer.
• CSV Logging: Save raw data with Counter
• GUI: Live plotting for all channels.
• Applications: EEG/ECG/EMG/EOG-based games and utilities (e.g., Tug of War, Keystroke Emulator).

Installation

• Make sure you have the latest version of Python installed.

• Open command prompt and run:

python -m venv .venv

.venv\Scripts\activate         # For Windows
source .venv/bin/activate      # For MacOS/Linux

[!IMPORTANT] You may get an execution policy error if scripts are restricted. To fix it, run:

Set-ExecutionPolicy Unrestricted -Scope Process

pip install chordspy

Usage

Run the command and access the web interface:

chordspy  

Web Interface Preview:

[!Optional]

If you want to run the individual scripts, then follow these steps:

• Open command prompt and run:

python -m venv .venv

.venv\Scripts\activate         # For Windows
source .venv/bin/activate      # For MacOS/Linux

[!IMPORTANT] You may get an execution policy error if scripts are restricted. To fix it, run:

Set-ExecutionPolicy Unrestricted -Scope Process

pip install -r requirements.txt

Usage

Run the command and access the web interface:

python -m chordspy.app  

Run the command to start the LSL Stream only:

python -m chordspy.connection --protocol ble    # For BLE
python -m chordspy.connection --protocol wifi   # For WiFi
python -m chordspy.connection --protocol usb    # For USB

Then, in a new terminal, run any application you need:

python -m chordspy.gui       # For GUI
python -m chordspy.ffteeg    # For EEG with FFT

Key Options:

• LSL Streaming: Choose a protocol (Wi-Fi, Bluetooth, Serial).
• CSV Logging: Data saved as ChordsPy_{timestamp}.csv.
• Applications: Multiple Applications can be Launch from the Interface simultaneously(e.g., EEG Tug of War).

Connection Guide

WIFI Connection

1. Upload the NPG-Lite WIFI Code to your device.
2. Connect to the device's WIFI network.
3. Click the WIFI button in the interface, then select CONNECT.
4. Once connected, the button will change to Disconnect, and a pop-up will confirm: "Connected via Wifi!"

Bluetooth Connection

1. Ensure Bluetooth is turned ON on your system.
2. Upload the Bluetooth code to your device.
3. Click the Bluetooth button to scan for available devices.
4. Select your device from the list and click Connect.
5. Once connected, the button will change to Disconnect, and a pop-up will confirm: "Connected via Bluetooth!"

Serial Connection

1. Ensure Bluetooth is OFF and the device is connected via USB.
2. Upload the required code to your hardware.
3. Click the Serial button, then select Connect.
4. Once connected, the button will change to Disconnect, and a pop-up will confirm: "Connected via Serial!"

CSV Logging

To save sensor data for future analysis, follow these steps:

1. Start Data Streaming – Begin streaming data via WiFi, Bluetooth, or Serial.
2. Start Recording – Click the Start Recording button (it will change to Stop Recording).
3. File Saved Automatically – The data is saved as ChordsPy_{timestamp}.csv in your default folder.

Visualizing CSV Data - You can plot the recorded data using the CSV Plotter tool.

Applications

Troubleshooting

• Arduino Not Detected: Ensure the Arduino is properly connected and powered. Check the serial port and baud rate settings.
• CSV File Not Created: Ensure you have write permissions in the directory where the script is run.
• LSL Stream Issues: Ensure that the pylsl library is properly installed and configured. Additionally, confirm that Bluetooth is turned off.

How to Contribute

You can add your project to this repo:

• Add a button in apps.yaml to link your application.
• Include your script as a .py file with LSL Data Reception code. (Pull requests welcome!)

Contributors

We are thankful to our awesome contributors, the list below is alphabetically sorted.

• Aman Maheshwari
• Krishnanshu Mittal
• Payal Lakra

The audio file used in game.py is sourced from Pixabay