Milestone v0.4.3 - minor update, bit size variables and enhancements (#96)

* removed arguments from class Variable
  - Class Variable needs VariableInfo parameter and LNet to get instantiated.
  - Instead of adding more parameters to the constructor, we store the VariableInfo as a member.
* moved set_value to Variable class, added _set_value as abstract function 
  - moved call to checking value_range to parent class
  - enables generic processing before moving to specific processing
* reading bit-size variables under unions / structs regardless variable's byte size
* writing bit-size variables regardless byte size
* increasing number of variables on generic_gui
* changed default generic_gui logger level from warning  to error
  - this avoids minor level messages showing up on terminal
* fixed behavior when variable name is not found
  If the variable does not exist in elf file, we log message "Variable '{name} not found!" and return None
  If the variable is found, but an error occurred when parsing, we log the error message and return None
* Changing prints over the code to logging.debug
* Changed contact information
* ruff check
* bump version

---------

Co-authored-by: Edras Pacola <[email protected]>

Author: edras

pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pyx2cscope"
-version = "0.4.2"
+version = "0.4.3"
 description = "python implementation of X2Cscope"
 authors = [
-  "Yash Agarwal <[email protected]>",
-  "Edras Pacola",
+  "Yash Agarwal",
+  "Edras Pacola <[email protected]>",
   "Christoph Baumgartner",
   "Mark Wendler",
 ]
@@ -28,6 +28,7 @@ pyx2cscope = 'pyx2cscope.__main__:main'
 python = "^3.10"
 pyserial = "^3.5"
 pyelftools = "^0.31"
+pyyaml ="^6.0.1"
 numpy = "^1.26.0"
 matplotlib = "^3.7.2"
 PyQt5 = "^5.15.9"

pyx2cscope/__init__.py

@@ -1,11 +1,11 @@
 """This module contains the pyx2cscope package.
 
-Version: 0.4.2
+Version: 0.4.3
 """
 
 import logging
 
-__version__ = "0.4.2"
+__version__ = "0.4.3"
 
 
 def set_logger(

pyx2cscope/examples/demo.py

@@ -1,7 +1,7 @@
 """Demo scripting for user to get started."""
 from pyx2cscope.x2cscope import X2CScope
 
-elf_file =r"C:\Users\m67250\OneDrive - Microchip Technology Inc\Desktop\Training_Domel\motorbench_demo_domel.X\dist\default\production\motorbench_demo_domel.X.production.elf"
+elf_file =r"path to your elf file.elf"
 
 x2cscope = X2CScope(port="COM39", elf_file=elf_file)
 

pyx2cscope/gui/generic_gui/detachable_gui.py

@@ -38,7 +38,7 @@
 from pyx2cscope.gui import img as img_src
 from pyx2cscope.x2cscope import TriggerConfig, X2CScope
 
-logging.basicConfig(level=logging.DEBUG)
+logging.basicConfig(level=logging.ERROR)
 
 matplotlib.use("QtAgg")
 
@@ -100,9 +100,9 @@ def initialize_variables(self):
         self.plot_window_open = False
         self.settings = QSettings("MyCompany", "MyApp")
         self.file_path: str = self.settings.value("file_path", "", type=str)
-        self.initi_variables()
+        self.init_variables()
 
-    def initi_variables(self):
+    def init_variables(self):
         """Some extra variables define."""
         self.selected_var_indices = [
             0,
@@ -355,11 +355,12 @@ def create_variable_selection_group(self):
 
         grid_layout_variable = QGridLayout()
         variable_layout.addLayout(grid_layout_variable)
+        number_of_variables = 8
 
-        self.scope_var_lines = [QLineEdit() for _ in range(7)]
-        self.trigger_var_checkbox = [QCheckBox() for _ in range(7)]
-        self.scope_channel_checkboxes = [QCheckBox() for _ in range(7)]
-        self.scope_scaling_boxes = [QLineEdit("1") for _ in range(7)]
+        self.scope_var_lines = [QLineEdit() for _ in range(number_of_variables)]
+        self.trigger_var_checkbox = [QCheckBox() for _ in range(number_of_variables)]
+        self.scope_channel_checkboxes = [QCheckBox() for _ in range(number_of_variables)]
+        self.scope_scaling_boxes = [QLineEdit("1") for _ in range(number_of_variables)]
 
         for checkbox in self.scope_channel_checkboxes:
             checkbox.setChecked(True)
@@ -434,7 +435,7 @@ def handle_scope_checkbox_change(self, state, index):
                 if i != index:
                     checkbox.setChecked(False)
             self.triggerVariable = self.scope_var_combos[index].currentText()
-            print(f"Checked variable: {self.scope_var_combos[index].currentText()}")
+            logging.debug(f"Checked variable: {self.scope_var_combos[index].currentText()}")
         else:
             self.triggerVariable = None
 
@@ -1309,7 +1310,7 @@ def configure_trigger(self):
                 else:
                     try:
                         trigger_level = float(trigger_level_text)
-                        print(trigger_level)
+                        logging.debug(trigger_level)
                     except ValueError:
                         logging.error(
                             f"Invalid trigger level value: {trigger_level_text}"

pyx2cscope/gui/generic_gui/generic_gui.py

@@ -2,7 +2,7 @@
 
 import logging
 
-logging.basicConfig(level=logging.DEBUG)
+logging.basicConfig(level=logging.ERROR)
 import json
 import os
 import sys
@@ -487,11 +487,11 @@ def create_variable_selection_group(self):
 
         grid_layout_variable = QGridLayout()
         variable_layout.addLayout(grid_layout_variable)
-
-        self.scope_var_lines = [QLineEdit() for _ in range(7)]
-        self.trigger_var_checkbox = [QCheckBox() for _ in range(7)]
-        self.scope_channel_checkboxes = [QCheckBox() for _ in range(7)]
-        self.scope_scaling_boxes = [QLineEdit("1") for _ in range(7)]
+        number_of_variables = 8
+        self.scope_var_lines = [QLineEdit() for _ in range(number_of_variables)]
+        self.trigger_var_checkbox = [QCheckBox() for _ in range(number_of_variables)]
+        self.scope_channel_checkboxes = [QCheckBox() for _ in range(number_of_variables)]
+        self.scope_scaling_boxes = [QLineEdit("1") for _ in range(number_of_variables)]
 
         for checkbox in self.scope_channel_checkboxes:
             checkbox.setChecked(True)
@@ -568,7 +568,7 @@ def handle_scope_checkbox_change(self, state, index):
                 if i != index:
                     checkbox.setChecked(False)
             self.triggerVariable = self.scope_var_lines[index].text()
-            print(f"Checked variable: {self.scope_var_lines[index].text()}")
+            logging.debug(f"Checked variable: {self.scope_var_lines[index].text()}")
         else:
             self.triggerVariable = None
 
@@ -1563,9 +1563,7 @@ def start_sampling(self):
                 self.real_sampletime = self.x2cscope.scope_sample_time(
                     scope_sample_time_us
                 )
-                print(
-                    f"Real sample time: {self.real_sampletime} µs"
-                )  # Check this value
+                logging.debug(f"Real sample time: {self.real_sampletime} µs")  # Check this value
 
                 # Update the Total Time display
                 self.total_time_value.setText(str(self.real_sampletime))
@@ -1579,7 +1577,7 @@ def start_sampling(self):
                     single_shot=self.single_shot_checkbox.isChecked()
                 )
             b = time.time()
-            print("time execution", b - a)
+            logging.debug(f"time execution '{b - a}'")
         except Exception as e:
             error_message = f"Error starting sampling: {e}"
             logging.error(error_message)
@@ -1603,7 +1601,7 @@ def configure_trigger(self):
                 else:
                     try:
                         trigger_level = int(trigger_level_text)  # YA
-                        print(trigger_level)
+                        logging.debug(trigger_level)
                     except ValueError:
                         logging.error(
                             f"Invalid trigger level value: {trigger_level_text}"
@@ -2287,7 +2285,7 @@ def eventFilter(self, source, event):  # noqa: N802 #Overriding 3rd party functi
                                 ],
                             )
                         except Exception as e:
-                            print(e)
+                            logging.debug(e)
 
         return super().eventFilter(source, event)
 

pyx2cscope/utils.py

@@ -5,7 +5,7 @@
     get_elf_file_path(key="path") -> str: Gets the path to the ELF file from the configuration.
     get_com_port(key="com_port") -> str: Gets the COM port from the configuration.
 """
-
+import logging
 import os
 from configparser import ConfigParser
 
@@ -28,7 +28,7 @@ def get_config_file() -> ConfigParser:
         config["COM_PORT"] = default_com
         with open(config_file, "w") as configfile:
             config.write(configfile)
-        print(f"Config file '{config_file}' created with default values")
+        logging.debug(f"Config file '{config_file}' created with default values")
     return config