Final Changes

Author: PayalLakra

bioamptool.py

@@ -26,13 +26,14 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from pylsl import StreamInfo, StreamOutlet
-import argparse
-import serial
-import time
-import csv
-from datetime import datetime
-import serial.tools.list_ports
+
+from pylsl import StreamInfo, StreamOutlet  # Import LSL stream classes for data streaming
+import argparse  # Import argparse for command-line argument parsing
+import serial  # Import serial for serial communication with Arduino
+import time  # Import time for handling time-related functions
+import csv  # Import csv for handling CSV file operations
+from datetime import datetime  # Import datetime for date and time operations
+import serial.tools.list_ports  # Import tools for listing available serial ports
 
 # Initialize global variables
 total_packet_count = 0  # Total number of packets received
@@ -46,11 +47,16 @@
 SYNC_BYTE1 = 0xA5  # First sync byte value
 SYNC_BYTE2 = 0x5A  # Second sync byte value
 END_BYTE = 0x01  # End byte value for the packet
+verbose_mode = False  # Flag for verbose output
 
 # LSL Stream Setup
 lsl_outlet = None  # LSL outlet for streaming data
 
-def auto_detect_arduino(baudrate, timeout=1):    #    Auto-detect Arduino by checking all available serial ports.
+# Initialize global variables for 10-second data counting
+data_count_10_sec = 0  # Count of data points in the last 10 seconds
+last_10_sec_time = None  # Last time when the 10-second count was logged
+
+def auto_detect_arduino(baudrate, timeout=1):  # Auto-detect Arduino by checking all available serial ports.
     ports = serial.tools.list_ports.comports()  # List all available serial ports
     for port in ports:
         try:
@@ -67,8 +73,8 @@ def auto_detect_arduino(baudrate, timeout=1):    #    Auto-detect Arduino by che
     print("Arduino not detected")  # Print message if no Arduino is found
     return None  # Return None if no Arduino is detected
 
-def read_arduino_data(ser, csv_writer=None):    #Read data from Arduino, process it, and optionally write to CSV and LSL stream.
-    global total_packet_count, previous_sample_number, missing_samples, buffer
+def read_arduino_data(ser, csv_writer=None):  # Read data from Arduino, process it, and optionally write to CSV and LSL stream.
+    global total_packet_count, previous_sample_number, missing_samples, buffer, data_count_10_sec
     raw_data = ser.read(ser.in_waiting or 1)  # Read data from the serial port
     buffer.extend(raw_data)  # Append the read data to the buffer
 
@@ -91,6 +97,7 @@ def read_arduino_data(ser, csv_writer=None):    #Read data from Arduino, process
 
                 previous_sample_number = counter  # Update the previous sample number
                 total_packet_count += 1  # Increment the total packet count
+                data_count_10_sec += 1  # Increment 10-second data count
 
                 channel_data = []  # List to store channel data
                 for i in range(4, 16, 2):  # Extract channel data from the packet
@@ -108,22 +115,24 @@ def read_arduino_data(ser, csv_writer=None):    #Read data from Arduino, process
             else:
                 del buffer[:sync_index + 1]  # Remove invalid data from the buffer
 
-def start_timer():     # Initialize timers for minute and ten-minute intervals and reset packet count.
-    global start_time, last_ten_minute_time, total_packet_count
+def start_timer():  # Initialize timers for minute and ten-minute intervals and reset packet count.
+    global start_time, last_ten_minute_time, total_packet_count, last_10_sec_time, data_count_10_sec
     time.sleep(0.5)  # Ensure LSL stream setup is complete
     current_time = time.time()  # Get the current time
     start_time = current_time  # Set the start time
     last_ten_minute_time = current_time  # Set the time for the last ten-minute interval
+    last_10_sec_time = current_time  # Set the start time for the 10-second interval
     total_packet_count = 0  # Reset total packet count
+    data_count_10_sec = 0  # Reset 10-second data count
 
-def log_minute_data():   #Logs and resets data count per minute
+def log_minute_data():  # Logs and resets data count per minute
     global total_packet_count
     count_for_minute = total_packet_count  # Get the data count for the current minute
     print(f"Data count for this minute: {count_for_minute} samples")  # Print the data count
     total_packet_count = 0  # Reset total packet count for the next minute
     return count_for_minute  # Return the count for further use
 
-def log_ten_minute_data():    #Logs data count for every 10 minutes and computes sampling rate and drift.
+def log_ten_minute_data():  # Logs data count for every 10 minutes and computes sampling rate and drift.
     global total_data_received, last_ten_minute_time
 
     print(f"Total data count after 10 minutes: {total_data_received} samples")  # Print total data count
@@ -137,23 +146,24 @@ def log_ten_minute_data():    #Logs data count for every 10 minutes and computes
     total_data_received = 0  # Reset total data received for the next 10-minute interval
     last_ten_minute_time = time.time()  # Update the last ten-minute interval start
 
-def parse_data(port, baudrate, lsl_flag=False, csv_flag=False):   # Main function to process data from the Arduino.
+def parse_data(port, baudrate, lsl_flag=False, csv_flag=False, verbose_flag=False):  # Main function to process data from the Arduino.
     global total_packet_count, start_time, total_data_received, lsl_outlet, last_ten_minute_time
+    global data_count_10_sec, last_10_sec_time, verbose_mode
+
+    verbose_mode = verbose_flag  # Set the verbose mode flag
 
     csv_writer = None  # CSV writer is initially None
-    csv_filename = None
+    csv_filename = None  # CSV filename is initially None
 
     # Check if LSL stream is enabled
     if lsl_flag:
         lsl_stream_info = StreamInfo('BioAmpDataStream', 'EXG', 6, 250, 'float32', 'UpsideDownLabs')  # Define LSL stream info
         lsl_outlet = StreamOutlet(lsl_stream_info)  # Create LSL outlet
         print("LSL stream started")  # Print message indicating LSL stream has started
-        time.sleep(0.5)  # Delay to ensure that LSL stream setup is complete
 
     # If CSV logging is requested
     if csv_flag:
-        # Generate the filename dynamically based on current date and time
-        csv_filename = f"data_{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}.csv"
+        csv_filename = f"data_{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}.csv"  # Generate the filename dynamically based on current date and time
         print(f"CSV recording started. Data will be saved to {csv_filename}")  # Print CSV recording message
 
     # Open the serial port and CSV file
@@ -165,18 +175,26 @@ def parse_data(port, baudrate, lsl_flag=False, csv_flag=False):   # Main functio
             csv_writer.writerow(['Counter', 'Channel1', 'Channel2', 'Channel3', 'Channel4', 'Channel5', 'Channel6'])  # Write CSV header
 
         # Delay to account for initial data and ensure accurate timing
-        start_timer()
+        start_timer()  # Initialize timers and reset counters
 
         try:
             while True:
-                read_arduino_data(ser, csv_writer)  # Read and process data from Arduino
-
                 current_time = time.time()  # Get the current time
 
+                # Read and process data from Arduino
+                read_arduino_data(ser, csv_writer)
+
+                # Check if 10 seconds have passed and log data count
+                if current_time - last_10_sec_time >= 10:
+                    if verbose_mode:
+                        print(f"Verbose: Data count in the last 10 seconds: {data_count_10_sec}")  # Print verbose data count
+                    data_count_10_sec = 0  # Reset 10-second data count
+                    last_10_sec_time = current_time  # Update 10-second interval start
+
                 # Check if a minute has passed and log minute data
                 if current_time - start_time >= 60:
                     total_data_received += log_minute_data()  # Update total data received
-                    start_time += 60  # Adjust the start time to handle next interval accurately
+                    start_time += 60  # Adjust the start time to handle the next interval accurately
 
                 # Check if 10 minutes have passed and log ten-minute data
                 if current_time - last_ten_minute_time >= 600:
@@ -197,8 +215,9 @@ def parse_data(port, baudrate, lsl_flag=False, csv_flag=False):   # Main functio
     parser.add_argument('-b', '--baudrate', type=int, default=57600, help="Set baud rate for the serial communication")
     parser.add_argument('--csv', action='store_true', help="Create and write to a CSV file")
     parser.add_argument('--lsl', action='store_true', help="Start LSL stream")
+    parser.add_argument('-v', '--verbose', action='store_true', help="Verbose mode for data count every 10 seconds")
 
-    args = parser.parse_args()
+    args = parser.parse_args()  # Parse command-line arguments
 
     # Determine port and start data parsing based on arguments
     if args.lsl:
@@ -210,6 +229,6 @@ def parse_data(port, baudrate, lsl_flag=False, csv_flag=False):   # Main functio
         if port is None:
             print("Arduino port not specified or detected. Exiting.")  # Print message if no port detected
         else:
-            parse_data(port, args.baudrate, lsl_flag=args.lsl, csv_flag=args.csv)  # Start data parsing
+            parse_data(port, args.baudrate, lsl_flag=args.lsl, csv_flag=args.csv, verbose_flag=args.verbose)  # Start data parsing
     else:
         parser.print_help()  # Print help message if no valid arguments are provided