cleaned up code,updated comments

Made the logic more intuitive from not true to just false inside the while loop.
Added comments
Added a very basic over view of the code to the file

Author: xanthium-enterprises

Python_PC_Side/ard_11_March_2024_08h_05m_41s_daq_log.csv

@@ -0,0 +1,14 @@
+No,Date,Time,Unix Time,Humidity,Soil Moisture,Temperature,Light Intensity
+1,11 March 2024,08:05:42,1710124542,47,39,43,42
+2,11 March 2024,08:05:43,1710124543,70,42,64,510
+3,11 March 2024,08:05:44,1710124544,63,39,40,85
+4,11 March 2024,08:05:45,1710124545,82,32,27,839
+5,11 March 2024,08:05:46,1710124546,67,39,80,340
+6,11 March 2024,08:05:47,1710124547,43,39,49,773
+7,11 March 2024,08:05:48,1710124548,50,43,89,470
+8,11 March 2024,08:05:49,1710124549,56,45,87,146
+9,11 March 2024,08:05:50,1710124550,52,37,70,65
+10,11 March 2024,08:05:51,1710124551,69,39,69,741
+11,11 March 2024,08:05:52,1710124552,57,42,83,712
+12,11 March 2024,08:05:53,1710124553,75,35,38,331
+13,11 March 2024,08:05:54,1710124554,84,47,71,129

Python_PC_Side/ard_11_March_2024_08h_47m_58s_daq_log.csv

@@ -0,0 +1,7 @@
+No,Date,Time,Unix Time,Humidity,Soil Moisture,Temperature,Light Intensity
+1,11 March 2024,08:47:58,1710127078,47,39,43,42
+2,11 March 2024,08:47:59,1710127079,70,42,64,510
+3,11 March 2024,08:48:00,1710127080,63,39,40,85
+4,11 March 2024,08:48:01,1710127081,82,32,27,839
+5,11 March 2024,08:48:02,1710127082,67,39,80,340
+6,11 March 2024,08:48:03,1710127083,43,39,49,773

Python_PC_Side/python-ttkbootstrap-data-logger.py

@@ -1,30 +1,73 @@
-#requires pyserial installed 
-#requires ttkbootstrap installed
+'''
+GUI Tkinter (ttkbootstrap) program to read data from arduino or DAQ and log into a CSV file.
+CSV file name automatically generated using current date and time
 
+
+requires: pyserial installed 
+        : ttkbootstrap installed
+
+Author  : Rahul.S
+
+(c) www.xanthium.in (2024)
+
+
+#============================ Very Basic Overview of the Code ==========================================#
+
+#below function runs inside a thread,all action takes place inside this 
+
+def acquire_arduino_data(serialport_name,baud_rate,logging_interval):
+    #(log_count) logging count = 1
+    #Create the Serial port object inside try catch
+    #Create a file name using Current Date and time,create_filename_current_date_time()
+    #Create CSV file,Write header to CSV file
+    
+    while True:
+
+        if start_logging_event.is_set() == True:
+            # Read Data from Arduino using SerialPort,read_arduino_sensors(serialport_obj)
+            # Get time stamp using time.time()
+            # Create a List to write to CSV file 
+            # Write list to CSV file
+            # Wait here, based on logging_interval
+            #increment logging count (log_count = log_count +1)
+
+        elif start_logging_event.is_set() == False:
+            # Close SerialPort 
+            # break ,Exit from While loop
+
+
+
+
+start_logging_event set     by def start_log_btn_handler(): of start_log_btn
+start_logging_event cleared by def stop_log_btn_handler():  of stop_log_btn
+
+'''
+
+#GUI Library Imports for Tkinter and ttkbootsrap
 from tkinter import *
 import ttkbootstrap as ttkb
 from ttkbootstrap.dialogs  import Messagebox
 from ttkbootstrap.scrolled import ScrolledText
 import tkinter as tk
 
 
-import serial
-import threading
-import time
-import csv
-import webbrowser
-import os
+import serial         # for serial communication
+import threading      # for creating threads
+import time           # for delays and getting timestamps for data logging
+import csv            # creating CSV files
+import webbrowser     # for opening tutorial webpage using button in a web browser
+import os             # for getting current working directory
 
 
-baud_rate        = 0
-
-csv_delimiter    = ','
-log_int = 0
+baud_rate        =  0
+csv_delimiter    = ',' # changing this would change the delimiter in CSV file Eg : ; |
+log_int          =  0  # logging interval global value
 
 
 #create Dropdown options
-baudrates    = [0,600,1200,2400,4800,9600,19200,38400]
-log_interval = [0,0.5,1,1.5,2,2.5,3,4,5,10,20,30,60,120]
+baudrates    = [0,600,1200,2400,4800,9600,19200,38400]    # dropdown for standard baudrates
+log_interval = [0,0.5,1,1.5,2,2.5,3,4,5,10,20,30,60,120]  # dropdown for logging interval in seconds,0 means maximum speed
+
 
 tutorial_text = ''' Tutorial
 
@@ -38,35 +81,49 @@
   
   Data saved in disk\n'''
 
+
+#All Action takes place here
+#function to read data from arduino,create csv file,process button options
+#function runs inside thread t1
+
 def acquire_arduino_data(serialport_name,baud_rate,logging_interval):
 
     serialport_obj = None #declared here so accessible inside and outside try/catch
     log_count      = 1
 
-    
-    
+   
     #Create the Serial port object
     try:
         serialport_obj = serial.Serial(serialport_name,baud_rate)       #open the serial port
+        
         text_log.insert(END,f'{serialport_name} selected,at {baud_rate} ,\n')
         text_log.insert(END,f'Logging Interval = {logging_interval} seconds,\n')
         text_log.insert(END,f'Wait for Arduino to Reset,\n')
+
         time.sleep(2)                                                   #Some time for Arduino board to reset
+        
         text_log.insert(END,f'Arduino Ready Now ,\n\n')
 
     except serial.SerialException as var :                              #In case of error
+        
         text_log.insert(END,f'{var} ,\n')
 
-    log_file_name = create_filename_current_date_time()
 
+
+    log_file_name = create_filename_current_date_time()  # create a file name using current date and time
+                                                         # Eg ard_11_March_2024_07h_29m_00s_daq_log.csv
 
 
+    #create CSV header to write once into the created file 
+
     csv_header =['No','Date','Time','Unix Time','Humidity','Soil Moisture','Temperature','Light Intensity']
 
+    # write csv header into the createdfile
     with open(log_file_name,'a',newline ='') as File_obj:
         csvwriter_obj = csv.writer(File_obj, delimiter = csv_delimiter)
         csvwriter_obj.writerow(csv_header)
-        
+    
+    #Write info into scrolled text  box    
     text_log.insert(END,f'Log file -> {log_file_name}\n\n')
     text_log.insert(END,f'Starting Logging @{logging_interval} interval\n\n')
     text_log.insert(END,f'{csv_header}\n')
@@ -75,59 +132,84 @@ def acquire_arduino_data(serialport_name,baud_rate,logging_interval):
     csv_filename_loc.insert(END,f'{log_file_name}\n')
 
 
+    #infinite loop,that constantly checks for (start_logging_event) status set or clear
+    #(start_logging_event) controlled by buttons
     while True:
 
-        #print(start_logging_event.is_set())
+        
         if start_logging_event.is_set() == True:
 
-            arduino_sensor_data_list = read_arduino_sensors(serialport_obj)
-            #print(arduino_sensor_data_list)
-            unix_timestamp = int(time.time()) #get current unix time to time stamp data
+            arduino_sensor_data_list = read_arduino_sensors(serialport_obj) #communicate with arduino and get data
+            
+            unix_timestamp = int(time.time())                         #get current unix time to time stamp data
 
             log_time_date  = time.localtime(unix_timestamp)          #Convert epoch time to human readable time,date format
             log_time       = time.strftime("%H:%M:%S",log_time_date) #hh:mm:ss
             log_date       = time.strftime("%d %B %Y",log_time_date) #dd MonthName Year
 
-           
+            #arduino_sensor_data_list[]
+            #
+            #arduino_sensor_data_list[0] = humidity_value
+            #arduino_sensor_data_list[1] = soil_value
+            #arduino_sensor_data_list[2] = temp_value
+            #arduino_sensor_data_list[3] = light_value
 
             arduino_sensor_data_list.insert(0,str(log_count))
             arduino_sensor_data_list.insert(1,str(log_date))
             arduino_sensor_data_list.insert(2,str(log_time))
             arduino_sensor_data_list.insert(3,str(unix_timestamp))
 
+            #arduino_sensor_data_list[] after insert()
+            #
+            #arduino_sensor_data_list[0] = log_count
+            #arduino_sensor_data_list[1] = log_date
+            #arduino_sensor_data_list[3] = log_time
+            #arduino_sensor_data_list[4] = light_value
+            #arduino_sensor_data_list[5] = unix_timestamp
+            #arduino_sensor_data_list[6] = soil_value
+            #arduino_sensor_data_list[7] = temp_value
+            #arduino_sensor_data_list[8] = light_value
+            #
+            #makes it easier to write into CSV file
+
             #print(arduino_sensor_data_list)
+            
             text_log.insert(END,f'{arduino_sensor_data_list} ,\n')
             text_log.see(tk.END) #for auto  scrolling
 
+            #write arduino_sensor_data_list to CSV file 
+
             with open(log_file_name,'a',newline='') as File_obj:
                 csvwriter_obj = csv.writer(File_obj, delimiter = csv_delimiter)
-                csvwriter_obj.writerow(arduino_sensor_data_list)
+                csvwriter_obj.writerow(arduino_sensor_data_list)                 # write one row
 
-            #print('data acquiring')
-            log_count = log_count + 1
+            
+            log_count = log_count + 1    #increment logging count
 
             time.sleep(logging_interval)
 
 
-        elif start_logging_event.is_set() != True:
+        elif start_logging_event.is_set() == False:
+            
             serialport_obj.close()
             text_log.insert(END,f'+==================================================+ \n')
             text_log.insert(END,f'Logging Ended \n')
-            break
+            
+            break # exit from infinite loop
 
 
 
 
 
-
+#Function sends and receive data from arduino connected to PC
 def read_arduino_sensors(serialport_obj):
 
     return_list =[0,0,0,0]
 
     polling_interval = 0.010 #In seconds,to give time for arduino to respond
 
-    serialport_obj.write(b'@')
-    time.sleep(polling_interval)
+    serialport_obj.write(b'@')            #Send @ to Arduino  to get humidity value
+    time.sleep(polling_interval)          #wait some time,to give arduino to respond
     humidity_value = serialport_obj.readline()
     humidity_value = humidity_value.strip()
 
@@ -148,11 +230,18 @@ def read_arduino_sensors(serialport_obj):
 
     #print(humidity_value,soil_value,temp_value,light_value)
 
-    return_list[0] = humidity_value.decode()
+    return_list[0] = humidity_value.decode() #.decode is used to remove the byte 'b',convert to string
     return_list[1] = soil_value.decode()
     return_list[2] = temp_value.decode()
     return_list[3] = light_value.decode()
 
+    #return_list[]
+    #
+    #return_list[0] = humidity_value
+    #return_list[1] = soil_value
+    #return_list[2] = temp_value
+    #return_list[3] = light_value
+
     return return_list
 
 def create_filename_current_date_time():
@@ -164,6 +253,8 @@ def create_filename_current_date_time():
     return filename
 
 
+#========================== Button Handlers ================================#
+
 def tutorial_btn_handler():
     webbrowser.open_new(r'https://www.xanthium.in/multithreading-serial-port-data-acquisition-to-csv-file-using-producer-consumer-pattern-python')
 
@@ -180,6 +271,7 @@ def stop_log_btn_handler():
     start_logging_event.clear()
 
 
+#========================== Drop Down Menu Handlers ================================#
 
 def on_select_option_bind_baudrates(e):
     global baud_rate
@@ -189,14 +281,14 @@ def on_select_option_bind_baudrates(e):
 def on_select_option_bind_log_interval(e):
     global log_int
     log_int  = float(log_interval_combo_box.get())
-    print(log_int)
+    #print(log_int)
 
 
 
-    
-start_logging_event    = threading.Event()
+start_logging_event    = threading.Event() #Event Creation
+
+#============================== Main Window Creation=======================================#
 
-# Main Window Creation
 root = ttkb.Window(themename = 'superhero')        # theme = superhero
 root.title('SerialPort Datalogging to CSV file')
 root.geometry('650x660') # Width X Height