Milestone v0.5.0 (#102)

* Websockets for webx2c (#101)

* fixed html files name pattern on webx2cscope
* convert to bootstrap 5
* update mchplnet pointer main@v0.2.2
* fixed bug removing variables from scope view web
* visual fix on mobile view
* fixed overlay of dropdown and header of table
* variable hide on scope_view.js
* adding variable legends to the chart. when you click on the legend item, it hides or shows the line chart.
* fixing demos
* websockets for watch-view and scope-view
* pointing to mchplnet v0.3.0
* bug fix - trigger_level

trigger_level must be in range of variable
if trigger_level is outside this range, it
clamps to max or min accordingly

* removing prints
* fix doc misspelling
* fixing example readability
* when adding a variable on watch-view, read the value before
* fixed labels on x-axis on webview
* fix views when connect/disconnect
* default log level for x2cscope is error
* enhancing serial_stub.py for get_ram and put_ram
* included test for thread safety
* fixing interface on mchplnet
* enhancing examples
* enhancing existing tests
* enhancing github actions documentation.yml
- if the merging branch is the main, check if we have a new version
* fixing to default snake_case on mchplnet
* update mchplnet pointer
* fix docstrings
* fix imports format
* fix docstring on tests
* removing elf16 parser
- elf16_parser.py was deprecated on previous versions and now it was removed.
- The current elf parser implementation handles both 16 and 32 bit architectures and is based on pyelftools.

* include linter ignore.
- generic gui needs to be refactored.

* removing debug prints
* including version check and auto-update of version on __init__.py on pre commit
* update mchplnet to version 0.3.0
* fix mchplnet dependency
* enhancing enum_variables

added specific methods for enum:
- get_enum_list
- set_enum_value
- get_enum_value

* importing eventlet in case webinterface is called

---------

Co-authored-by: Edras Pacola <edras.pacola@gmail.com>
Co-authored-by: Edras Pacola <edras.pacola@microchip.com>

Author: 3 people

.github/workflows/documentation.yml

@@ -96,4 +96,41 @@ jobs:
         run: |
           sphinx-build -M html doc build --keep-going 
 
+  version-check:
+    runs-on: ubuntu-latest
+    if: github.base_ref == 'main'
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
 
+    - name: Check version consistency
+      run: |
+        # Get version from pyproject.toml
+        PYPROJECT_VERSION=$(grep -oP 'version\s*=\s*"\K[^"]+' pyproject.toml)
+        # Get version from __init__.py
+        INIT_VERSION=$(grep -oP '__version__\s*=\s*["\x27]\K[^"\x27]+' pyx2cscope/__init__.py)
+        
+        if [ "$PYPROJECT_VERSION" != "$INIT_VERSION" ]; then
+          echo "❌ Version mismatch between pyproject.toml ($PYPROJECT_VERSION) and __init__.py ($INIT_VERSION)"
+          echo "Run 'python scripts/update_version.py' to synchronize versions"
+          exit 1
+        fi
+        echo "✅ Version consistency verified: $PYPROJECT_VERSION"
+
+    - name: Check version has been updated
+      if: github.base_ref == 'main'
+      run: |
+        # Get PR version
+        PR_VERSION=$(grep -oP 'version\s*=\s*"\K[^"]+' pyproject.toml)
+        
+        # Get main branch version
+        git fetch origin main:main
+        MAIN_VERSION=$(git show main:pyproject.toml | grep -oP 'version\s*=\s*"\K[^"]+')
+        
+        if [ "$PR_VERSION" == "$MAIN_VERSION" ]; then
+          echo "❌ ERROR: Version in PR ($PR_VERSION) is the same as in main branch ($MAIN_VERSION)"
+          echo "Please update the version in pyproject.toml"
+          exit 1
+        fi
+        echo "✅ Version check passed: $PR_VERSION (PR) vs $MAIN_VERSION (main)"

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+-   repo: local
+    hooks:
+    -   id: update-version
+        name: Update version in __init__.py
+        entry: python scripts/update_version.py
+        language: python
+        files: ^pyproject.toml$
+        types: [toml]
+        always_run: true

doc/conf.py

@@ -54,7 +54,7 @@
     ("py:class", "mchplnet.lnet.LNet"),
     ("py:class", "mchplnet.services.scope.ScopeChannel"),
     ("py:class", "mchplnet.interfaces.factory.InterfaceType"),
-    ("py:class", "mchplnet.interfaces.abstract_interface.InterfaceABC"),   
+    ("py:class", "mchplnet.interfaces.abstract_interface.Interface"),
 ]
 
 intersphinx_mapping = {

doc/install.rst

@@ -12,7 +12,7 @@ Create a virtual environment and install pyx2cscope using the following commands
 
 It is highly recommended to install python libraries underneath a virtual environment.
 
-Nevertheless, to install at system level, we advise to install it on user area. (Global insallation may not work.) 
+Nevertheless, to install at system level, we advise to install it on user area. (Global installation may not work.)
 Execute the following lines:
 
 .. code-block:: python

mchplnet

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pyx2cscope"
-version = "0.4.4"
+version = "0.5.0"
 description = "python implementation of X2Cscope"
 authors = [
   "Yash Agarwal",
@@ -33,7 +33,7 @@ numpy = "^1.26.0"
 matplotlib = "^3.7.2"
 PyQt5 = "^5.15.9"
 pyqtgraph= "^0.13.7"
-mchplnet = "0.2.1"
+mchplnet = "0.3.0"
 flask = "^3.0.3"
 
 
@@ -49,6 +49,6 @@ lint.select = ["D"]
 # PL - pylint
 lint.extend-select = ["I", "N", "F", "PL", "D"]
 exclude = ["mchplnet/*"]
-lint.ignore = ["I001", "PLW0603", "PLW0602", "PLR0913"] #TODO fix the import issue. no errors on local machine and errors on github action.
+lint.ignore = ["PLR0913"]
 
 

pyproject.toml

@@ -1,11 +1,18 @@
 """This module contains the pyx2cscope package.
 
-Version: 0.4.4
+Version: 0.5.0
 """
 
+# Apply eventlet monkey patch before any other imports if web interface is requested
+import sys
+
+if "-w" in sys.argv or "--web" in sys.argv:
+    import eventlet
+    eventlet.monkey_patch()
+
 import logging
 
-__version__ = "0.4.4"
+__version__ = "0.5.0"
 
 
 def set_logger(

pyx2cscope/__init__.py

@@ -11,8 +11,7 @@
 import argparse
 
 import pyx2cscope
-from pyx2cscope import utils
-from pyx2cscope import gui
+from pyx2cscope import gui, utils
 
 
 def parse_arguments():

pyx2cscope/__main__.py

@@ -3,9 +3,10 @@
 import logging
 import time
 
+from variable.variable import VariableInfo
+
 from pyx2cscope.utils import get_com_port, get_elf_file_path
 from pyx2cscope.x2cscope import X2CScope
-from variable.variable import VariableInfo
 
 # Configuration for serial port communication
 serial_port = get_com_port()  # Select COM port

pyx2cscope/examples/SFR_Example.py

@@ -1,9 +1,11 @@
 """Demo scripting for user to get started."""
+import time
+
 from pyx2cscope.x2cscope import X2CScope
 
 elf_file =r"path to your elf file.elf"
 
-x2cscope = X2CScope(port="COM39", elf_file=elf_file)
+x2cscope = X2CScope(port="COM4", elf_file=elf_file)
 
 phase_current = x2cscope.get_variable("motor.iabc.a")
 phase_voltage = x2cscope.get_variable("motor.vabc.a")
@@ -15,4 +17,6 @@
 
 while True:
     if x2cscope.is_scope_data_ready():
-        print(x2cscope.get_scope_channel_data())
+        print(x2cscope.get_scope_channel_data())
+        x2cscope.request_scope_data()
+    time.sleep(0.1)