Updated Readme according to the new changes

Author: PayalLakra

README.md

@@ -28,27 +28,21 @@ Chords Python script is designed to interface with an Arduino-based bioamplifier
 ## Installation
 
 1. Ensure you have Python 3.x installed.
-2. Install the required Python libraries:
+2. Create Virtual Environment
+  ```bash
+   python -m venv venv      #Create Virtual Environment
+   .\venv\Scripts\activate  #to activate environment 
+3. Install the required Python libraries:
     ```bash
     pip install -r requirements.txt
     ```
 
 ## Usage
 
 To use the script, run it from the command line with various options:
-
-First Create Virtual Environment
-
-  ```bash
-   python -m venv venv      #Create Virtual Environment
-   .\venv\Scripts\activate  #to activate environment 
-  ```
-Then,
-
   ```bash
   python chords.py [options]
   ```
-
 ### Options
 
 - `-p`, `--port` <port>: Specify the serial port to use (e.g., COM5, /dev/ttyUSB0).
@@ -58,72 +52,91 @@ Then,
 - `-v`, `--verbose`: Enable verbose output with detailed statistics and error reporting.
 - `-t` : Enable the timer to run program for a set time in seconds.
 
-## Applications
+### Data Logging
 
-### GUI
+- **CSV Output**: The script saves the processed data in a CSV file with a timestamped name.
+  - The CSV file contains the following columns:
+    - `Counter`: The sample counter from the Arduino.
+    - `Channel1` to `Channel6`: The data values from each channel.
 
-- `python gui.py`: Enable the real-time data plotting GUI.
+- **Log Intervals**: The script logs data counts every second and provides a summary every 10 minutes, including the sampling rate and drift in seconds per hour.
 
-### FORCE BALL GAME
+### LSL Streaming
 
-- `python game.py`: Enable a GUI to play game using EEG Signal.
+- **Stream Name**: `BioAmpDataStream`
+- **Stream Type**: `EXG`
+- **Channel Count**: `6`
+- **Sampling Rate**: `UNO-R3 : 250 Hz` , `UNO-R4 : 500 Hz`
+- **Data Format**: `float32`
 
-## Script Functions
 
- `auto_detect_arduino(baudrate, timeout=1)`
+### Script Functions
 
-Detects an Arduino connected via serial port. Returns the port name if detected.
+`auto_detect_arduino(baudrate, timeout=1)`: Detects an Arduino connected via serial port. Returns the port name if detected.
 
-`read_arduino_data(ser, csv_writer=None)`
+`read_arduino_data(ser, csv_writer=None)`: Reads and processes data from the Arduino. Writes data to CSV and/or LSL stream if enabled.
 
-Reads and processes data from the Arduino. Writes data to CSV and/or LSL stream if enabled.
+`start_timer()`: Initializes timers for 1-second and 10-minute intervals.
 
- `start_timer()`
+`log_one_second_data(verbose=False)`: Logs and resets data for the 1-second interval.
 
-Initializes timers for 1-second and 10-minute intervals.
+`log_ten_minute_data(verbose=False)`: Logs data and statistics for the 10-minute interval.
 
- `log_one_second_data(verbose=False)`
+`parse_data(port,baudrate,lsl_flag=False,csv_flag=False,verbose=False)`: Parses data from Arduino and manages logging, streaming, and GUI updates.
 
-Logs and resets data for the 1-second interval.
+`cleanup()`: Handles all the cleanup tasks.
 
- `log_ten_minute_data(verbose=False)`
+`main()`: Handles command-line argument parsing and initiates data processing.
 
-Logs data and statistics for the 10-minute interval.
+## Applications
 
- `parse_data(port, baudrate, lsl_flag=False, csv_flag=False, gui_flag=False, verbose=False)`
+[!IMPORTANT] : Before using the below Applications make sure you are in Application folder.
 
-Parses data from Arduino and manages logging, streaming, and GUI updates.
+### GUI
 
- `init_gui()`
+- `python gui.py`: Enable the real-time data plotting GUI.
 
-Initializes and displays the GUI with six real-time plots, one for each bio-signal channel.
+#### Script Functions
 
-`cleanup()`
+`init_gui()`: Initializes and displays the GUI with six real-time plots, one for each bio-signal channel.
 
-Handles all the cleanup tasks.
+`update_plots()`: Updates the plot data by pulling new samples from the LSL stream and shifting the existing buffer.
 
- `main()`
+### FORCE BALL GAME
 
-Handles command-line argument parsing and initiates data processing.
+- `python game.py`: Enable a GUI to play game using EEG Signal.
 
-## Data Logging
+#### Script Functions
 
-- **CSV Output**: The script saves the processed data in a CSV file with a timestamped name.
-  - The CSV file contains the following columns:
-    - `Counter`: The sample counter from the Arduino.
-    - `Channel1` to `Channel6`: The data values from each channel.
+Here are the important functions from your Pygame script summarized in one line each:
 
-- **Log Intervals**: The script logs data counts every second and provides a summary every 10 minutes, including the sampling rate and drift in seconds per hour.
+`bandpower(data, sf, band, window_sec=None, relative=False)`: Calculates the band power of EEG data in a specified frequency band using the Welch method.
 
-## LSL Streaming
+`eeg_data_thread(eeg_queue)`: Continuously retrieves EEG data from an LSL stream and computes power ratios for Player A and Player B.
 
-- **Stream Name**: `BioAmpDataStream`
-- **Stream Type**: `EXG`
-- **Channel Count**: `6`
-- **Sampling Rate**: `UNO-R3 : 250 Hz` , `UNO-R4 : 500 Hz`
-- **Data Format**: `float32`
+`reset_game()`: Resets the game state and initializes the ball and player forces.
+
+`update_ball_position(force_player1, force_player2)`: Updates the ball's position based on the net force exerted by both players.
+
+`check_win_condition()`: Determines if either player has won based on the ball's position.
+
+### Heart Rate
+
+- `python heartbeat.ecg.py`:Enable a GUI with real-time ECG and heart rate
+
+#### Script Functions
+
+`butter_filter(cutoff, fs, order=4, btype='low')`: Designs a Butterworth filter to remove unwanted frequencies from the ECG signal.
+
+`apply_filter(data, b, a)`: Applies the designed Butterworth filter to the ECG data for noise reduction.
+
+`detect_heartbeats(ecg_data, sampling_rate)`: Detects heartbeats in the ECG signal using peak detection.
+
+`run(self)`: Collects ECG data from the LSL stream, applies filtering, and emits the filtered data for real-time plotting.
+
+`update_plot(self, ecg_data)`: Updates the plot with the latest ECG data and detects heartbeats to display on the GUI.
 
-If GUI is not enabled, you can use an LSL viewer (e.g., BrainVision LSL Viewer) to visualize the streamed data in real-time.
+`update_heart_rate(self)`: Calculates and updates the heart rate based on detected R-peaks in the ECG signal.
 
 ## Troubleshooting