nisyscfg auto-discovery, remove lv_path, PostGenerateBitfile --config fix

Author: Salvador Santoluctio

README.md

@@ -64,7 +64,6 @@ def pre_all(context):
     config = context.config
 
     # Tools
-    config.set_lv_path("C:/Program Files/National Instruments/LabVIEW 2024")
     config.set_vivado_tools_path("C:/NIFPGA/programs/Vivado2021_1")
     config.set_vivado_tcl_scripts_folder("../common/TCL")
 
@@ -115,7 +114,6 @@ def pre_create_project(context):
 
 | Setter | Description |
 | --- | --- |
-| `set_lv_path(value)` | LabVIEW installation root path. |
 | `set_vivado_tools_path(value)` | Vivado installation root containing bin/vivado(.bat). |
 | `set_vivado_tcl_scripts_folder(value)` | Folder with Vivado TCL Mako templates/scripts. |
 | `set_modelsim_tools_path(value)` | ModelSim installation root directory. |
@@ -256,7 +254,7 @@ The current CLI surface is defined in labview_fpga_hdl_tools/__main__.py.
 | launch-vivado | `vivado_tools_path`, `vivado_project_path` | Also requires existing project .xpr file. |
 | create-modelsim | `top_level_entity`, `hdl_file_lists`, `modelsim_tools_path` | Uses `modelsim_file_lists` if set, otherwise `hdl_file_lists`. |
 | launch-modelsim | `top_level_entity`, `modelsim_tools_path` | Requires existing ModelSim project directory (run create-modelsim first). |
-| create-lvbitx | `lv_path` | Uses `top_level_entity` to derive filenames. |
+| create-lvbitx | `top_level_entity` | Auto-discovers LabVIEW via nisyscfg. Uses `top_level_entity` to derive filenames. |
 | install-deps | `dependencies` | Does not use other settings. |
 | gen-guid | None | Does not use any settings. |
 

labview_fpga_hdl_tools/common.py

@@ -119,9 +119,6 @@ class FileConfiguration:
     skip_vivado: bool = False  # Skip launching Vivado (validation only)
     skip_modelsim: bool = False  # Skip launching ModelSim (validation only)
 
-    # ----- TOOL PATH SETTINGS (loaded from [Tools] section) -----
-    lv_path: Optional[str] = None  # Path to LabVIEW installation
-
     # --- General Settings setters ---
 
     def set_target_family(self, value):
@@ -138,10 +135,6 @@ def set_dependencies(self, value):
 
     # --- Tool Settings setters ---
 
-    def set_lv_path(self, value):
-        """Set the LabVIEW installation path (resolved to absolute)."""
-        self.lv_path = resolve_path(value)
-
     # --- Vivado Project Settings setters ---
 
     def set_top_level_entity(self, value):

labview_fpga_hdl_tools/create_lvbitx.py

@@ -5,11 +5,74 @@
 # SPDX-License-Identifier: MIT
 #
 import os  # For file and directory operations
+import re
 import subprocess  # For executing external programs
 
 from . import common  # For shared utilities across tools
 
 
+def _get_sw_attr(obj, names):
+    """Return the first non-empty string attribute from *names*, or empty string."""
+    for name in names:
+        value = getattr(obj, name, None)
+        if value is not None:
+            text = str(value).strip()
+            if text:
+                return text
+    return ""
+
+
+def _find_createbitfile_exe():
+    """Auto-discover createBitfile.exe from the latest installed LabVIEW using nisyscfg.
+
+    Queries NI System Configuration for installed LabVIEW versions, then
+    checks the standard installation directories for createBitfile.exe,
+    preferring the latest version.
+
+    Returns:
+        str or None: Absolute path to createBitfile.exe, or None if not found.
+    """
+    try:
+        import nisyscfg
+    except ImportError:
+        print("Warning: nisyscfg package not available, cannot auto-discover LabVIEW")
+        return None
+
+    labview_years = set()
+    try:
+        with nisyscfg.Session() as session:
+            for sw in session.get_installed_software_components():
+                title = _get_sw_attr(sw, ["title", "display_name", "name", "product_name", "id"])
+                if re.match(r"^(NI\s+)?LabVIEW\s+\d{4}", title, re.IGNORECASE):
+                    year_match = re.search(r"(\d{4})", title)
+                    if year_match:
+                        labview_years.add(int(year_match.group(1)))
+    except Exception as exc:
+        print(f"Warning: Failed to query NI System Configuration: {exc}")
+        return None
+
+    if not labview_years:
+        return None
+
+    # Try each LabVIEW version from latest to oldest
+    program_files = os.environ.get("ProgramFiles", r"C:\Program Files")
+    for year in sorted(labview_years, reverse=True):
+        candidate = os.path.join(
+            program_files,
+            "National Instruments",
+            f"LabVIEW {year}",
+            "vi.lib",
+            "rvi",
+            "CDR",
+            "createBitfile.exe",
+        )
+        if os.path.isfile(candidate):
+            print(f"Found createBitfile.exe from LabVIEW {year}")
+            return candidate
+
+    return None
+
+
 def _create_lv_bitfile(config=None):
     """Create the LabVIEW FPGA .lvbitx file by executing the createBitfile.exe tool."""
     if os.name != "nt":
@@ -21,7 +84,22 @@ def _create_lv_bitfile(config=None):
     path_parts = [part.lower() for part in os.path.normpath(vivado_impl_folder).split(os.sep)]
     if "impl_1" not in path_parts:
         print(
-            "WARNING: This function must be run from within the implementation folder of a Vivado project.\n(e.g. C:\\dev\\github\\flexrio\\targets\\pxie-7903\\VivadoProject\\MySasquatchProj.runs\\impl_1)"
+            "\n"
+            "************************************************************\n"
+            "***                     WARNING                          ***\n"
+            "************************************************************\n"
+            "* This function must be run from within the implementation\n"
+            "* folder of a Vivado project.\n"
+            "*\n"
+            "* Expected CWD example:\n"
+            "*   C:\\dev\\flexrio\\targets\\pxie-7903\\VivadoProject\\MyProj.runs\\impl_1\n"
+            "*\n"
+            "* When called from that folder, use --config to\n"
+            "* point back to the target's nihdlsettings.py:\n"
+            "*\n"
+            "*   nihdl create-lvbitx --config=../../../nihdlsettings.py\n"
+            "*\n"
+            "************************************************************\n"
         )
 
     # This script is run by a TCL script in Vivado after the bitstream is generated and the
@@ -33,19 +111,6 @@ def _create_lv_bitfile(config=None):
     if config is None:
         config = common.FileConfiguration()
 
-    # Check if LV path is set
-    if config.lv_path is None:
-        print("Error: LabVIEW path not set in configuration")
-        return 1
-
-    # Construct path to createBitfile.exe
-    createbitfile_exe = os.path.join(config.lv_path, "vi.lib", "rvi", "CDR", "createBitfile.exe")
-
-    # Check if the executable exists
-    if not os.path.exists(createbitfile_exe):
-        print(f"Error: createBitfile.exe not found at {createbitfile_exe}")
-        return 1
-
     # Determine path to CodeGenerationResults.lvtxt based on UseGeneratedLVWindowFiles setting
     if config.use_gen_lv_window_files:
         # Check if window folder is set
@@ -62,8 +127,14 @@ def _create_lv_bitfile(config=None):
         code_gen_results_path = os.path.join(window_folder, "CodeGenerationResults.lvtxt")
     else:
         print("Using default LV window files")
-        # Use the path from configuration
         code_gen_results_path = config.code_generation_results_stub
+        if code_gen_results_path is None:
+            print("Error: code_generation_results_stub not set in configuration")
+            return 1
+
+    if config.top_level_entity is None:
+        print("Error: top_level_entity not set in configuration")
+        return 1
 
     print(f"LabVIEW code generation results path: {code_gen_results_path}")
 
@@ -73,6 +144,21 @@ def _create_lv_bitfile(config=None):
     lvbitx_output_path = os.path.abspath(f"objects/bitfiles/{config.top_level_entity}.lvbitx")
     print(f"Output .lvbitx path: {lvbitx_output_path}")
 
+    # In skip_vivado mode, create a mock file without needing createBitfile.exe
+    if config.skip_vivado:
+        print("SKIP VIVADO: Validation successful, skipping createBitfile.exe launch")
+        os.makedirs(os.path.dirname(lvbitx_output_path), exist_ok=True)
+        with open(lvbitx_output_path, "w") as f:
+            f.write("# Mock LVBITX file created for testing\n")
+        print(f"Created mock LVBITX file at: {lvbitx_output_path}")
+        return 0
+
+    # Auto-discover createBitfile.exe from the latest installed LabVIEW
+    createbitfile_exe = _find_createbitfile_exe()
+    if createbitfile_exe is None:
+        print("Error: Could not find createBitfile.exe. Is LabVIEW installed?")
+        return 1
+
     # Create the directory for the new file if it doesn't exist
     os.makedirs(os.path.dirname(lvbitx_output_path), exist_ok=True)
 
@@ -86,17 +172,6 @@ def _create_lv_bitfile(config=None):
 
     print(f"Executing: {' '.join(cmd)}")
 
-    # In skip_vivado mode, stop here after validation
-    if config.skip_vivado:
-        print("SKIP VIVADO: Validation successful, skipping createBitfile.exe launch")
-
-        # Create a mock LVBITX file for testing
-        os.makedirs(os.path.dirname(lvbitx_output_path), exist_ok=True)
-        with open(lvbitx_output_path, "w") as f:
-            f.write("# Mock LVBITX file created for testing\n")
-        print(f"Created mock LVBITX file at: {lvbitx_output_path}")
-        return 0
-
     # Execute the command
     result = subprocess.run(cmd, capture_output=True, text=True, check=False)
 

labview_fpga_hdl_tools/nihdlsettings_default.py

@@ -36,7 +36,7 @@ def pre_all(context):
 Available setters (grouped by section):
 
     Tools:
-        set_lv_path, set_vivado_tools_path, set_vivado_tcl_scripts_folder,
+        set_vivado_tools_path, set_vivado_tcl_scripts_folder,
         set_modelsim_tools_path, set_xilinx_sim_lib_path
 
     General Settings:
@@ -85,7 +85,6 @@ def pre_all(context):
     config = context.config
 
     # --- Tools ---
-    config.set_lv_path("C:/Program Files/National Instruments/LabVIEW 2024")
     config.set_vivado_tools_path("C:/NIFPGA/programs/Vivado2021_1")
     config.set_vivado_tcl_scripts_folder("../common/TCL")
     # config.set_modelsim_tools_path("")

poetry.lock

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "labview-fpga-hdl-tools"
-version = "0.4.1"
+version = "0.4.2"
 description = "LabVIEW FPGA HDL Tools"
 authors = [
   "Salvador Santolucito <salvador.santolucito@gmail.com>"
@@ -20,6 +20,7 @@ python = ">=3.8,<4.0"
 mako = ">=1.3.10"
 click = ">=8.1.8,<8.2"
 packaging = ">=21.0"
+nisyscfg = {version = ">=0.2.1", python = ">=3.9"}
 tomli = {version = ">=1.1.0", python = "<3.11"}
 
 [tool.poetry.group.test.dependencies]
@@ -46,5 +47,9 @@ disallow_incomplete_defs = false
 module = "mako.*"
 ignore_missing_imports = true
 
+[[tool.mypy.overrides]]
+module = "nisyscfg.*"
+ignore_missing_imports = true
+
 [tool.bandit]
 exclude_dirs = ["tests"]

pyproject.toml

@@ -4,11 +4,7 @@
 set env(PYTHONPATH) ""
 set env(PYTHONHOME) ""
 
-pwd
-
-cd ../../../
-
-pwd
-
 # Execute the Python script
-exec nihdl create-lvbitx
+# This TCL script runs from inside the Vivado impl_1 directory, so we point
+# --config back up to the target folder's nihdlsettings.py.
+exec nihdl create-lvbitx --config=../../../nihdlsettings.py

tests/test-project/targets/pxie-7903/TCL/PostGenerateBitfile.tcl

@@ -6,7 +6,6 @@ def pre_all(context):
     config = context.config
 
     # --- Tools ---
-    config.set_lv_path("../../../bad_labview_path")
     config.set_vivado_tools_path("../../../bad_vivado_path")
     # config.set_vivado_tcl_scripts_folder("")
     config.set_modelsim_tools_path("../../../bad_modelsim_path")

tests/test-project/targets/pxie-7903/badsettings.py

@@ -6,12 +6,15 @@ def pre_all(context):
     config = context.config
 
     # --- Tools ---
-    config.set_lv_path("../../../test-LabVIEW")
     config.set_vivado_tools_path("../../../test-vivado")
     config.set_vivado_tcl_scripts_folder("TCL")
     config.set_modelsim_tools_path("../../../test-modelsim")
     # config.set_xilinx_sim_lib_path("")
 
+    # --- Runtime ---
+    config.set_skip_vivado(True)
+    config.set_skip_modelsim(True)
+
     # --- General Settings ---
     config.set_target_family("FlexRIO")
     config.set_base_target("PXIe-7903")