Added perform_DAQ() into Arduino class. Ditched current_date_time_strings()

Dennis-van-Gils · Dennis-van-Gils · commit 0b3a3fbe366a · 2024-06-11T20:30:50.000+02:00
diff --git a/WaveGeneratorArduino.py b/WaveGeneratorArduino.py
@@ -9,10 +9,12 @@
 __version__ = "9.0"
 
 import time
+import datetime
 
 from qtpy import QtCore
 import numpy as np
 
+from dvg_debug_functions import dprint, print_fancy_traceback as pft
 from dvg_devices.Arduino_protocol_serial import Arduino
 
 # ------------------------------------------------------------------------------
@@ -65,6 +67,35 @@ def set_waveform_to_sawtooth(self):
         """Send the instruction to the Arduino to change to a sawtooth wave."""
         self.write("sawtooth")
 
+    def perform_DAQ(self) -> bool:
+        """Query the Arduino for new readings, parse them and update the
+        corresponding variables of its `state` member.
+
+        Returns: True if successful, False otherwise.
+        """
+        # Query the Arduino for its state
+        success, reply = self.query_ascii_values("?", delimiter="\t")
+        if not success:
+            dprint(
+                f"'{self.name}' reports IOError @ "
+                f"{datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
+            )
+            return False
+
+        # Parse readings into separate state variables
+        try:
+            self.state.time, self.state.reading_1 = reply
+            self.state.time /= 1000
+        except Exception as err:  # pylint: disable=broad-except
+            pft(err, 3)
+            dprint(
+                f"'{self.name}' reports IOError @ "
+                f"{datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
+            )
+            return False
+
+        return True
+
 
 # ------------------------------------------------------------------------------
 #   FakeWaveGeneratorArduino
@@ -114,23 +145,25 @@ def set_waveform_to_sawtooth(self):
         """Send the instruction to the Arduino to change to a sine wave."""
         self.wave_type = "sawtooth"
 
-    def query_ascii_values(self, *args, **kwargs):
-        """Query the Arduino for new readings and return them as a list."""
+    def perform_DAQ(self) -> bool:
+        """Query the Arduino for new readings, parse them and update the
+        corresponding variables of its `state` member.
+
+        Returns: True if successful, False otherwise.
+        """
         t = time.perf_counter()
 
         if self.wave_type == "sine":
             value = np.sin(2 * np.pi * self.wave_freq * t)
-
         elif self.wave_type == "square":
             value = 1 if np.mod(self.wave_freq * t, 1.0) > 0.5 else -1
-
         elif self.wave_type == "sawtooth":
             value = 2 * np.mod(self.wave_freq * t, 1.0) - 1
 
-        success = True
-        readings = [t * 1000, value]
+        self.state.time = t * 1000
+        self.state.reading_1 = value
 
-        return success, readings
+        return True
 
     def close(self):
         """Close the serial connection to the Arduino."""
diff --git a/demo_A_GUI_full.py b/demo_A_GUI_full.py
@@ -13,6 +13,7 @@
 import os
 import sys
 import time
+import datetime
 
 import qtpy
 from qtpy import QtCore, QtGui, QtWidgets as QtWid
@@ -21,7 +22,7 @@
 import psutil
 import pyqtgraph as pg
 
-from dvg_debug_functions import tprint, dprint, print_fancy_traceback as pft
+from dvg_debug_functions import tprint
 from dvg_pyqtgraph_threadsafe import HistoryChartCurve, PlotManager
 from dvg_pyqt_filelogger import FileLogger
 import dvg_pyqt_controls as controls
@@ -72,19 +73,6 @@
 # pg.setConfigOptions(leftButtonPan=False)
 pg.setConfigOption("foreground", "#EEE")
 
-# ------------------------------------------------------------------------------
-#   current_date_time_strings
-# ------------------------------------------------------------------------------
-
-
-def current_date_time_strings():
-    cur_date_time = QtCore.QDateTime.currentDateTime()
-    return (
-        cur_date_time.toString("dd-MM-yyyy"),  # Date
-        cur_date_time.toString("HH:mm:ss"),  # Time
-    )
-
-
 # ------------------------------------------------------------------------------
 #   MainWindow
 # ------------------------------------------------------------------------------
@@ -354,10 +342,11 @@ def process_qpbt_running(self, state: bool):
 
     @Slot()
     def update_GUI(self):
-        str_cur_date, str_cur_time = current_date_time_strings()
         state = self.qdev.dev.state  # Shorthand
 
-        self.qlbl_cur_date_time.setText(f"{str_cur_date}    {str_cur_time}")
+        self.qlbl_cur_date_time.setText(
+            f"{datetime.datetime.now().strftime('%d-%m-%Y    %H:%M:%S')}"
+        )
         self.qlbl_update_counter.setText(f"{self.qdev.update_counter_DAQ}")
         self.qlbl_DAQ_rate.setText(
             f"DAQ: {self.qdev.obtained_DAQ_rate_Hz:.1f} Hz"
@@ -435,27 +424,14 @@ def update_chart(self):
     # --------------------------------------------------------------------------
 
     def DAQ_function() -> bool:
-        # Query the Arduino for its state
-        success, tmp_state = ard.query_ascii_values("?", delimiter="\t")
-        if not success:
-            str_cur_date, str_cur_time = current_date_time_strings()
-            dprint(
-                f"'{ard.name}' reports IOError @ "
-                f"{str_cur_date} {str_cur_time}"
-            )
-            return False
-
-        # Parse readings into separate state variables
-        try:
-            ard.state.time, ard.state.reading_1 = tmp_state
-            ard.state.time /= 1000
-        except Exception as err:  # pylint: disable=broad-except
-            pft(err, 3)
-            str_cur_date, str_cur_time = current_date_time_strings()
-            dprint(
-                f"'{ard.name}' reports IOError @ "
-                f"{str_cur_date} {str_cur_time}"
-            )
+        """Perform a single data acquisition and append this data to the chart
+        and log.
+
+        Returns: True if successful, False otherwise.
+        """
+        # Query the Arduino for new readings, parse them and update the
+        # corresponding variables of its `state` member.
+        if not ard.perform_DAQ():
             return False
 
         # Use Arduino time or PC time?
@@ -474,7 +450,6 @@ def DAQ_function() -> bool:
         # Add readings to the log
         log.update()
 
-        # Return success
         return True
 
     ard_qdev = WaveGeneratorArduino_qdev(
@@ -535,8 +510,10 @@ def notify_connection_lost():
         stop_running()
 
         window.qlbl_title.setText("! ! !    LOST CONNECTION    ! ! !")
-        str_cur_date, str_cur_time = current_date_time_strings()
-        str_msg = f"{str_cur_date} {str_cur_time}\nLost connection to Arduino."
+        str_msg = (
+            f"{datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}\n"
+            "Lost connection to Arduino."
+        )
         print(f"\nCRITICAL ERROR @ {str_msg}")
         reply = QtWid.QMessageBox.warning(
             window, "CRITICAL ERROR", str_msg, QtWid.QMessageBox.Ok
diff --git a/demo_B_GUI_minimal.py b/demo_B_GUI_minimal.py
@@ -21,7 +21,6 @@
 import psutil
 import pyqtgraph as pg
 
-from dvg_debug_functions import dprint, print_fancy_traceback as pft
 from dvg_pyqtgraph_threadsafe import HistoryChartCurve
 
 from WaveGeneratorArduino import WaveGeneratorArduino, FakeWaveGeneratorArduino
@@ -69,19 +68,6 @@
 # pg.setConfigOptions(leftButtonPan=False)
 pg.setConfigOption("foreground", "#EEE")
 
-# ------------------------------------------------------------------------------
-#   current_date_time_strings
-# ------------------------------------------------------------------------------
-
-
-def current_date_time_strings():
-    cur_date_time = QtCore.QDateTime.currentDateTime()
-    return (
-        cur_date_time.toString("dd-MM-yyyy"),  # Date
-        cur_date_time.toString("HH:mm:ss"),  # Time
-    )
-
-
 # ------------------------------------------------------------------------------
 #   MainWindow
 # ------------------------------------------------------------------------------
@@ -173,27 +159,13 @@ def __init__(self, parent=None, **kwargs):
     # --------------------------------------------------------------------------
 
     def DAQ_function() -> bool:
-        # Query the Arduino for its state
-        success, tmp_state = ard.query_ascii_values("?", delimiter="\t")
-        if not success:
-            str_cur_date, str_cur_time = current_date_time_strings()
-            dprint(
-                f"'{ard.name}' reports IOError @ "
-                f"{str_cur_date} {str_cur_time}"
-            )
-            return False
+        """Perform a single data acquisition and append this data to the chart.
 
-        # Parse readings into separate state variables
-        try:
-            ard.state.time, ard.state.reading_1 = tmp_state
-            ard.state.time /= 1000
-        except Exception as err:  # pylint: disable=broad-except
-            pft(err, 3)
-            str_cur_date, str_cur_time = current_date_time_strings()
-            dprint(
-                f"'{ard.name}' reports IOError @ "
-                f"{str_cur_date} {str_cur_time}"
-            )
+        Returns: True if successful, False otherwise.
+        """
+        # Query the Arduino for new readings, parse them and update the
+        # corresponding variables of its `state` member.
+        if not ard.perform_DAQ():
             return False
 
         # Use Arduino time or PC time?
@@ -209,7 +181,6 @@ def DAQ_function() -> bool:
             ard.state.time, ard.state.reading_1
         )
 
-        # Return success
         return True
 
     ard_qdev = WaveGeneratorArduino_qdev(
diff --git a/demo_C_singlethread_for_comparison.py b/demo_C_singlethread_for_comparison.py
@@ -20,6 +20,7 @@
 import os
 import sys
 import time
+import datetime
 from typing import Union
 
 import qtpy
@@ -30,7 +31,7 @@
 import numpy as np
 import pyqtgraph as pg
 
-from dvg_debug_functions import tprint, dprint, print_fancy_traceback as pft
+from dvg_debug_functions import tprint
 from dvg_pyqtgraph_threadsafe import HistoryChartCurve, PlotManager
 from dvg_pyqt_filelogger import FileLogger
 import dvg_pyqt_controls as controls
@@ -91,19 +92,6 @@
 QET_rate = QtCore.QElapsedTimer()
 rate_accumulator = 0
 
-# ------------------------------------------------------------------------------
-#   current_date_time_strings
-# ------------------------------------------------------------------------------
-
-
-def current_date_time_strings():
-    cur_date_time = QtCore.QDateTime.currentDateTime()
-    return (
-        cur_date_time.toString("dd-MM-yyyy"),  # Date
-        cur_date_time.toString("HH:mm:ss"),  # Time
-    )
-
-
 # ------------------------------------------------------------------------------
 #   MainWindow
 # ------------------------------------------------------------------------------
@@ -348,10 +336,11 @@ def process_qpbt_running(self, state: bool):
 
     @Slot()
     def update_GUI(self):
-        str_cur_date, str_cur_time = current_date_time_strings()
         state = self.dev.state  # Shorthand
 
-        self.qlbl_cur_date_time.setText(f"{str_cur_date}    {str_cur_time}")
+        self.qlbl_cur_date_time.setText(
+            f"{datetime.datetime.now().strftime('%d-%m-%Y    %H:%M:%S')}"
+        )
         self.qlbl_update_counter.setText(f"{update_counter_DAQ}")
         self.qlbl_DAQ_rate.setText(f"DAQ: {obtained_DAQ_rate_Hz:.1f} Hz")
         self.qlbl_recording_time.setText(
@@ -370,6 +359,7 @@ def update_GUI(self):
     def update_chart(self):
         if not self.allow_GUI_update_of_readings:
             return
+
         if DEBUG:
             tprint("update_curve")
 
@@ -453,12 +443,14 @@ def write_data_to_log():
 
     @Slot()
     def DAQ_function():
+        """Perform a single data acquisition and append this data to the chart
+        and log.
+        """
+        # Keep track of the obtained DAQ rate
         global update_counter_DAQ, rate_accumulator, obtained_DAQ_rate_Hz
 
-        state = ard.state  # Shorthand
         update_counter_DAQ += 1
 
-        # Keep track of the obtained DAQ rate
         if not QET_rate.isValid():
             QET_rate.start()
         else:
@@ -475,37 +467,23 @@ def DAQ_function():
 
                 rate_accumulator = 0
 
-        # Query the Arduino for its state
-        success, tmp_state = ard.query_ascii_values("?", delimiter="\t")
-        if not success:
-            str_cur_date, str_cur_time = current_date_time_strings()
-            dprint(
-                f"'{ard.name}' reports IOError @ {str_cur_date} {str_cur_time}"
-            )
-            sys.exit(0)
-
-        # Parse readings into separate state variables
-        try:
-            state.time, state.reading_1 = tmp_state
-            state.time /= 1000
-        except Exception as err:  # pylint: disable=broad-except
-            pft(err, 3)
-            str_cur_date, str_cur_time = current_date_time_strings()
-            dprint(
-                f"'{ard.name}' reports IOError @ {str_cur_date} {str_cur_time}"
-            )
+        # Query the Arduino for new readings, parse them and update the
+        # corresponding variables of its `state` member.
+        if not ard.perform_DAQ():
             sys.exit(0)
 
         # Use Arduino time or PC time?
-        now = time.perf_counter() if USE_PC_TIME else state.time
+        now = time.perf_counter() if USE_PC_TIME else ard.state.time
         if update_counter_DAQ == 1:
-            state.time_0 = now
-            state.time = 0
+            ard.state.time_0 = now
+            ard.state.time = 0
         else:
-            state.time = now - state.time_0
+            ard.state.time = now - ard.state.time_0
 
         # Add readings to chart history
-        window.history_chart_curve.appendData(state.time, state.reading_1)
+        window.history_chart_curve.appendData(
+            ard.state.time, ard.state.reading_1
+        )
 
         # Add readings to the log
         log.update()
diff --git a/demo_D_no_GUI.py b/demo_D_no_GUI.py
diff --git a/demo_E_no_GUI.py b/demo_E_no_GUI.py
