sima-cli 0.0.17__py3-none-any.whl → 0.0.19__py3-none-any.whl

sima_cli/__version__.py

@@ -1,2 +1,2 @@
 # sima_cli/__version__.py
-__version__ = "0.0.17"
+__version__ = "0.0.19"

sima_cli/auth/login.py

@@ -61,14 +61,14 @@ def login_internal():
     click.echo(f"✅ Identity token is valid")
 
     # Step 2: Exchange for a short-lived access token (default: 7 days)
-    access_token, user_name = exchange_identity_token(identity_token, exchange_url, expires_in=604800)
+    access_token, user_name = exchange_identity_token(identity_token, exchange_url, expires_in=1209600)
 
     if not access_token:
         return click.echo("❌ Failed to acquire short-lived access token.")
 
     # Step 3: Save token to internal auth config
     set_auth_token(access_token, internal=True)
-    click.echo(f"💾 Short-lived access token saved successfully for {user_name} (valid for 7 days).")
+    click.echo(f"💾 Short-lived access token saved successfully for {user_name} (valid for 14 days).")
 
 
 def _login_external():

sima_cli/cli.py

@@ -7,6 +7,8 @@ from sima_cli.utils.config_loader import internal_resource_exists
 from sima_cli.mla.meminfo import monitor_simaai_mem_chart
 from sima_cli.__version__ import __version__ 
 from sima_cli.utils.config import CONFIG_PATH
+from sima_cli.install.optiview import install_optiview
+from sima_cli.install.hostdriver import install_hostdriver
 
 # Entry point for the CLI tool using Click's command group decorator
 @click.group()
@@ -150,9 +152,6 @@ def update(ctx, version_or_url, ip, yes, passwd):
     version_or_url: The version string (e.g. '1.5.0') or a direct URL to the firmware package.
     """
     internal = ctx.obj.get("internal", False)
-    if not internal:
-        click.echo("External environment is not supported yet.")
-        exit(0)
     perform_update(version_or_url, ip, internal, passwd=passwd, auto_confirm=yes)
 
 # ----------------------
@@ -167,7 +166,7 @@ def modelzoo(ctx, ver):
     ctx.obj['ver'] = ver
     internal = ctx.obj.get("internal", False)
     if not internal:
-        click.echo(f"external environment is not supported yet..")
+        click.echo(f"Public developer portal environment is not supported yet..")
         exit(0)
 
     pass
@@ -220,6 +219,84 @@ def show_mla_memory_usage(ctx):
     monitor_simaai_mem_chart()
     pass
 
+
+# ----------------------
+# bootimg Command
+# ----------------------
+@main.command(name="bootimg")
+@click.option("-v", "--version", required=True, help="Firmware version to download and write (e.g., 1.6.0)")
+@click.option("--boardtype", type=click.Choice(["modalix", "mlsoc"], case_sensitive=False), default="mlsoc", show_default=True, help="Target board type.")
+@click.pass_context
+def bootimg_cmd(ctx, version, boardtype):
+    """
+    Download and burn a bootable image onto removable media (e.g., SD card or USB stick).
+
+    Examples:
+      sima-cli bootimg -v 1.6.0
+      sima-cli bootimg -v 1.6.0 --boardtype mlsoc
+      sima-cli bootimg -v 1.6.0 --boardtype modalix
+    """
+
+    from sima_cli.update.bootimg import write_image
+
+    internal = ctx.obj.get("internal", False)
+
+    click.echo(f"📦 Preparing boot image:")
+    click.echo(f"   🔹 Version   : {version}")
+    click.echo(f"   🔹 Board Type: {boardtype}")
+    
+    try:
+        boardtype = boardtype if boardtype != 'mlsoc' else 'davinci'
+        write_image(version, boardtype, 'yocto', internal)
+        click.echo("✅ Boot image successfully written.")
+    except Exception as e:
+        click.echo(f"❌ Failed to write boot image: {e}", err=True)
+        ctx.exit(1)
+
+# ----------------------
+# install Command
+# ----------------------
+SDK_DEPENDENT_COMPONENTS = {"palette", "hostdriver"}
+SDK_INDEPENDENT_COMPONENTS = {"optiview"}
+ALL_COMPONENTS = SDK_DEPENDENT_COMPONENTS | SDK_INDEPENDENT_COMPONENTS
+
+@main.command(name="install")
+@click.argument("component", type=click.Choice(ALL_COMPONENTS, case_sensitive=False))
+@click.option("-v", "--version", help="SDK version (required for SDK-dependent components)")
+@click.pass_context
+def install_cmd(ctx, component, version):
+    """
+    Install supported components such as SDKs or tools.
+
+    Examples:
+      cli install palette -v 1.6.0
+      cli install hostdriver -v 1.6.0
+
+      cli install optiview
+    """
+    component = component.lower()
+    internal = ctx.obj.get("internal", False)
+
+    if component in SDK_DEPENDENT_COMPONENTS and not version:
+        click.echo(f"❌ The component '{component}' requires a specific SDK version. Please provide one using -v.")
+        ctx.exit(1)
+
+    if component in SDK_INDEPENDENT_COMPONENTS and version:
+        click.echo(f"ℹ️ The component '{component}' does not require an SDK version. Ignoring -v {version}.")
+
+    # Perform the installation logic
+    if component == "palette":
+        click.echo(f"🔧 Installing SDK component 'palette' for version {version} is not implemented yet...")
+    elif component == "hostdriver":
+        click.echo(f"🔧 Installing SDK component 'hostdriver' for version {version}...")
+        install_hostdriver(version=version, internal=internal)
+    elif component == "optiview":
+        click.echo("🔧 Installing tool 'optiview'...")
+        install_optiview()
+
+    click.echo("✅ Installation complete.")
+    
+
 # ----------------------
 # App Zoo Subcommands
 # ----------------------

sima_cli/data/resources_public.yaml

@@ -6,4 +6,4 @@ auth:
   validate_url: "artifactory/api/security/encryptedPassword"
 
 download:
-  download_url: "artifactory/"
+  download_url: "https://docs.sima.ai/pkg_downloads/"

sima_cli/download/downloader.py

@@ -127,6 +127,7 @@ def download_file_from_url(url: str, dest_folder: str = ".", internal: bool = Fa
 
     except Exception as e:
         raise RuntimeError(f"Download failed: {e}")
+    
 
     return dest_path
 

sima_cli/install/hostdriver.py

@@ -0,0 +1,152 @@
+import sys
+import click
+import os
+import subprocess
+from pathlib import Path
+
+from sima_cli.update.updater import download_image
+from sima_cli.utils.env import is_pcie_host
+
+def _check_driver_installation():
+    """
+    Checks whether the PCIe host driver (sima_mla_drv) and related components are correctly installed.
+
+    Returns:
+        dict: A dictionary with validation results for gstreamer, kernel module, and PCI device.
+    """
+    results = {}
+
+    # 1. Check GStreamer plugin
+    try:
+        gst_output = subprocess.check_output(["gst-inspect-1.0", "pciehost"], stderr=subprocess.STDOUT, text=True)
+        if "pciehost" in gst_output:
+            results["gstreamer"] = {
+                "success": True,
+                "message": "✅ GStreamer plugin 'pciehost' is installed."
+            }
+        else:
+            results["gstreamer"] = {
+                "success": False,
+                "message": "❌ GStreamer plugin 'pciehost' not found."
+            }
+    except subprocess.CalledProcessError as e:
+        results["gstreamer"] = {
+            "success": False,
+            "message": f"❌ GStreamer check failed: {e.output.strip()}"
+        }
+
+    # 2. Check kernel module
+    try:
+        modinfo_output = subprocess.check_output(["modinfo", "sima_mla_drv"], stderr=subprocess.STDOUT, text=True)
+        if "filename:" in modinfo_output and "sima_mla_drv" in modinfo_output:
+            results["kernel_module"] = {
+                "success": True,
+                "message": "✅ Kernel module 'sima_mla_drv' is installed."
+            }
+        else:
+            results["kernel_module"] = {
+                "success": False,
+                "message": "❌ Kernel module 'sima_mla_drv' not found."
+            }
+    except subprocess.CalledProcessError as e:
+        results["kernel_module"] = {
+            "success": False,
+            "message": f"❌ Kernel module check failed: {e.output.strip()}"
+        }
+
+    # 3. Check PCI device presence
+    try:
+        lspci_output = subprocess.check_output(["lspci", "-vd", "1f06:abcd"], stderr=subprocess.STDOUT, text=True)
+        if "sima_mla_drv" in lspci_output or "1f06:abcd" in lspci_output:
+            results["pci_device"] = {
+                "success": True,
+                "message": "✅ PCIe device (1f06:abcd) detected and bound to 'sima_mla_drv'."
+            }
+        else:
+            results["pci_device"] = {
+                "success": False,
+                "message": "❌ PCIe device not detected."
+            }
+    except subprocess.CalledProcessError as e:
+        results["pci_device"] = {
+            "success": False,
+            "message": f"❌ PCIe device check failed: {e.output.strip()}"
+        }
+
+    return results
+
+def _print_driver_validation_table(results: dict):
+    """
+    Prints the driver validation results in a table format with fixed-width columns.
+    """
+    print("\nDriver Installation Validation:\n")
+    print(f"{'Component':<20} | {'Status':<10} | {'Details'}")
+    print("-" * 60)
+
+    for section, result in results.items():
+        component = section.replace("_", " ").title()
+        status = "PASS" if result["success"] else "FAIL"
+        message = result["message"]
+        print(f"{component:<20} | {status:<10} | {message}")
+
+def install_hostdriver(version: str, internal: bool = False):
+    """
+    Install PCIe host driver on supported platforms.
+
+    This function is only valid on PCIe host machines. It downloads the appropriate image
+    package and installs the host driver script if present.
+
+    Args:
+        version (str): Firmware version string (e.g., "1.6.0").
+        internal (bool): Whether to use internal sources for the download.
+
+    Raises:
+        RuntimeError: If the platform is not supported or the driver script is missing.
+    """
+    if not is_pcie_host():
+        click.echo("❌ This command is only supported on PCIe host Linux machines.")
+        sys.exit(1)
+
+    try:
+        # Step 1: Install system dependencies
+        click.echo("🔧 Installing required system packages...")
+        try:
+            subprocess.run([
+                "sudo", "apt-get", "update"
+            ], check=True)
+            subprocess.run([
+                "sudo", "apt-get", "install", "-y",
+                "make", "cmake", "gcc", "g++", "dkms", "doxygen",
+                "libjson-c-dev", "libjsoncpp-dev", "build-essential", "linux-headers-generic"
+            ], check=True)
+            click.echo("✅ Dependencies installed successfully.")
+        except subprocess.CalledProcessError as e:
+            raise RuntimeError(f"❌ Failed to install dependencies: {e}")
+
+        # Step 2: Download driver package which is part of the firmware release.
+        click.echo(f"⬇️  Downloading host driver package for version {version}...")
+        extracted_files = download_image(version_or_url=version, board="davinci", swtype="yocto", internal=internal)
+
+        # Find the host driver script in extracted files
+        script_path = next((f for f in extracted_files if f.endswith("sima_pcie_host_pkg.sh")), None)
+
+        if not script_path or not os.path.isfile(script_path):
+            raise RuntimeError("sima_pcie_host_pkg.sh not found in the downloaded package.")
+
+        click.echo(f"📦 Host driver script found: {script_path}")
+        click.confirm("⚠️  This will install drivers on your system using sudo. Continue?", abort=True)
+
+        # Make sure the script is executable
+        os.chmod(script_path, 0o755)
+
+        # Run the script with sudo
+        subprocess.run(["sudo", script_path], check=True)
+
+        click.echo("✅ Host driver installation completed.")
+
+        results = _check_driver_installation()
+        _print_driver_validation_table(results)
+
+    except Exception as e:
+        raise RuntimeError(f"❌ Failed to install host driver: {e}")
+

sima_cli/install/optiview.py

@@ -0,0 +1,80 @@
+import sys
+import platform
+import click
+import urllib
+import json
+import tempfile
+import tarfile
+import os
+import subprocess
+from pathlib import Path
+from sima_cli.download import download_file_from_url
+from sima_cli.utils.env import is_sima_board
+from sima_cli.utils.config_loader import load_resource_config
+
+def install_optiview():
+    try:
+        # Special path for SiMa DevKit
+        if is_sima_board():
+            click.echo("🛠 Detected SiMa DevKit. Cleaning up existing installation...")
+            subprocess.run(["sudo", "pip3", "uninstall", "-y", "optiview"], check=True)
+            click.echo("📦 Installing Optiview via pip...")
+            subprocess.run(["sudo", "pip3", "install", "optiview"], check=True)
+            click.echo("✅ Optiview installed successfully on DevKit.")
+            return
+
+        cfg = load_resource_config()
+        download_url_base = cfg.get('public').get('download').get('download_url')
+
+        # Normal flow for other platforms
+        click.echo("📥 Fetching Optiview version info...")
+        version_url = f"{download_url_base}optiview/metadata.json"
+        downloads_dir = Path.home() / "Downloads" / "optiview-installer"
+        downloads_dir.mkdir(parents=True, exist_ok=True)
+        metadata_path = download_file_from_url(version_url, dest_folder=downloads_dir, internal=False)
+
+        with open(metadata_path, "r") as f:
+            version_data = json.load(f)
+            latest_version = version_data.get("latest")
+
+        if not latest_version:
+            raise Exception("Unable to retrieve latest version info.")
+
+        # Determine architecture
+        system = platform.system().lower()
+        machine = platform.machine().lower()
+
+        if system == "darwin" and machine == "arm64":
+            arch = "aarch64"
+        else:
+            arch = "x86_64"
+
+        pkg_url = f"{download_url_base}optiview/optiview-installation-{arch}-{latest_version}.tar.gz"
+        click.echo(f"🌐 Downloading Optiview ({arch} v{latest_version})...")
+
+        archive_path = download_file_from_url(pkg_url, dest_folder=downloads_dir)
+
+        click.echo(f"📦 Extracting to {downloads_dir}...")
+        with tarfile.open(archive_path, "r:gz") as tar:
+            tar.extractall(path=downloads_dir)
+
+        install_script = "install.bat" if system == "windows" else "install.sh"
+        script_path = os.path.join(downloads_dir, install_script)
+
+        if not os.path.isfile(script_path):
+            raise Exception(f"Installation script not found: {script_path}")
+
+        click.echo(f"🚀 Running installer: {install_script}")
+        if system == "windows":
+            subprocess.run(["cmd", "/c", os.path.basename(script_path)], check=True, cwd=downloads_dir)
+        else:
+            subprocess.run(["bash", os.path.basename(script_path)], check=True, cwd=downloads_dir)
+
+        click.echo(f"✅ Optiview installed successfully. Run {downloads_dir}/run.sh to start optiview")
+
+    except Exception as e:
+        click.echo(f"❌ Installation failed: {e}")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    install_optiview()

sima_cli/install/palette.py

@@ -0,0 +1,87 @@
+import sys
+import platform
+import click
+import json
+import tarfile
+import os
+import subprocess
+from pathlib import Path
+from sima_cli.download import download_file_from_url
+from sima_cli.utils.env import is_sima_board
+from sima_cli.utils.config_loader import load_resource_config
+
+def build_internal_url(download_url_base, latest_filename):
+    """Build the URL for internal Palette package."""
+    return f"{download_url_base}palette/{latest_filename}"
+
+def build_external_url(download_url_base, latest_filename, version):
+    """Build the URL for external Palette package from SDKx.y.z folder."""
+    return f"{download_url_base}palette/SDK{version}/{latest_filename}"
+
+def install_palette(internal=False):
+    try:
+        # Check for unsupported platforms
+        system = platform.system().lower()
+        if is_sima_board():
+            click.echo("❌ Palette installation is not supported on SiMa DevKit, please install on Ubuntu 22.04 or Windows 10/11.")
+            sys.exit(1)
+        if system == "darwin":
+            click.echo("❌ Palette installation is not supported on macOS, please install on Ubuntu 22.04 or Windows 10/11.")
+            sys.exit(1)
+
+        # Load configuration for resources
+        cfg = load_resource_config()
+        download_url_base = cfg.get('internal' if internal else 'public').get('download').get('download_url')
+
+        # Fetch Palette version info
+        click.echo(f"📥 Fetching Palette version info ({'internal' if internal else 'external'})...")
+        version_url = f"{download_url_base}palette/metadata.json"
+        downloads_dir = Path.home() / "Downloads" / "palette-installer"
+        downloads_dir.mkdir(parents=True, exist_ok=True)
+        metadata_path = download_file_from_url(version_url, dest_folder=downloads_dir, internal=internal)
+
+        # Read version data
+        with open(metadata_path, "r") as f:
+            version_data = json.load(f)
+            latest_filename = version_data.get("latest")
+
+        if not latest_filename:
+            raise Exception("Unable to retrieve latest filename info.")
+
+        # Extract version from filename (assuming format like palette-installation-<arch>-x.y.z.tar.gz)
+        version = latest_filename.split('-')[-1].replace('.tar.gz', '')
+
+        # Build package URL based on internal or external
+        pkg_url = build_internal_url(download_url_base, latest_filename) if internal else build_external_url(download_url_base, latest_filename, version)
+        click.echo(f"🌐 Downloading Palette ({'internal' if internal else 'external'}: {latest_filename})...")
+
+        # Download the package
+        archive_path = download_file_from_url(pkg_url, dest_folder=downloads_dir, internal=internal)
+
+        # Extract the package
+        click.echo(f"📦 Extracting to {downloads_dir}...")
+        with tarfile.open(archive_path, "r:gz") as tar:
+            tar.extractall(path=downloads_dir)
+
+        # Determine installation script based on platform
+        install_script = "install.bat" if system == "windows" else "install.sh"
+        script_path = os.path.join(downloads_dir, install_script)
+
+        if not os.path.isfile(script_path):
+            raise Exception(f"Installation script not found: {script_path}")
+
+        # Run the installer
+        click.echo(f"🚀 Running installer: {install_script}")
+        if system == "windows":
+            subprocess.run(["cmd", "/c", os.path.basename(script_path)], check=True, cwd=downloads_dir)
+        else:
+            subprocess.run(["bash", os.path.basename(script_path)], check=True, cwd=downloads_dir)
+
+        click.echo(f"✅ Palette installed successfully ({'internal' if internal else 'external'}). Run {downloads_dir}/run.sh to start palette")
+
+    except Exception as e:
+        click.echo(f"❌ {'Internal' if internal else 'External'} installation failed: {e}")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    install_palette(internal=False)

sima_cli/update/bmaptool.py

@@ -0,0 +1,137 @@
+import subprocess
+import sys
+import os
+import urllib.request
+import tarfile
+import tempfile
+import json
+import shutil
+
+def run_command(command, check=True, shell=False, cwd=None):
+    """Run a shell command and return its output or raise an exception if it fails."""
+    try:
+        result = subprocess.run(
+            command,
+            check=check,
+            shell=shell,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True,
+            cwd=cwd
+        )
+        return result.stdout.strip(), result.stderr.strip()
+    except subprocess.CalledProcessError as e:
+        if check:
+            print(f"Error running command {command}: {e.stderr}")
+            raise
+        return "", str(e)
+
+def is_bmaptool_installed():
+    """Check if bmaptool is installed and callable from the shell."""
+    try:
+        result = subprocess.run(
+            ["bmaptool", "--version"],
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True,
+            timeout=5
+        )
+        if result.returncode == 0:
+            print(f"✅ bmaptool is installed: {result.stdout.strip()}")
+            return True
+        else:
+            print(f"⚠️ bmaptool returned non-zero exit: {result.stderr.strip()}")
+            return False
+    except (FileNotFoundError, subprocess.TimeoutExpired) as e:
+        print(f"❌ bmaptool is not installed or not in PATH: {e}")
+        return False
+
+def clone_bmaptool_repo(temp_dir, branch_or_tag="main"):
+    """Clone the bmaptool repository to a temporary directory."""
+    repo_url = "https://github.com/yoctoproject/bmaptool.git"
+    print(f"Cloning bmaptool from {repo_url} (branch/tag: {branch_or_tag})...")
+    try:
+        subprocess.run(
+            ["git", "clone", "--depth", "1", "--branch", branch_or_tag, repo_url, temp_dir],
+            check=True,
+            capture_output=True,
+            text=True
+        )
+        print(f"Cloned bmaptool to {temp_dir}")
+        return temp_dir
+    except subprocess.CalledProcessError as e:
+        print(f"Failed to clone repository: {e.stderr}")
+        sys.exit(1)
+
+def get_python_and_pip_bins():
+    """Get the Python and pip binaries from the active virtual environment or system."""
+    if "VIRTUAL_ENV" in os.environ:
+        venv_dir = os.environ["VIRTUAL_ENV"]
+        print(f"Using existing virtual environment: {venv_dir}")
+        if sys.platform == "win32":
+            python_bin = os.path.join(venv_dir, "Scripts", "python.exe")
+            pip_bin = os.path.join(venv_dir, "Scripts", "pip.exe")
+        else:
+            python_bin = os.path.join(venv_dir, "bin", "python3")
+            pip_bin = os.path.join(venv_dir, "bin", "pip3")
+    else:
+        print("No virtual environment detected; using system Python.")
+        python_bin = shutil.which("python3") or sys.executable
+        pip_bin = shutil.which("pip3") or "pip3"
+    return python_bin, pip_bin
+
+def install_bmaptool(temp_dir):
+    """Install bmaptool from the cloned repository."""
+    try:
+        subprocess.run(
+            [sys.executable, "-m", "pip", "install", temp_dir],
+            check=True,
+            capture_output=True,
+            text=True
+        )
+        print("Installed bmaptool successfully")
+    except subprocess.CalledProcessError as e:
+        print(f"Failed to install bmaptool: {e.stderr}")
+        sys.exit(1)
+
+def verify_installation(python_bin):
+    """Verify bmaptool installation by running python -m bmaptool --version."""
+    stdout, stderr = run_command([python_bin, "-m", "bmaptool", "--version"])
+    if stdout:
+        print(f"bmaptool installation verified: {stdout}")
+    else:
+        print(f"Verification failed: {stderr}")
+        sys.exit(1)
+
+def check_bmap_and_install():
+    # Get Python and pip binaries from the active virtual environment or system
+    python_bin, _ = get_python_and_pip_bins()
+    
+    # Check if bmaptool is already installed
+    if is_bmaptool_installed():
+        return
+    
+    # Create a temporary directory
+    temp_dir = "bmaptool_temp"
+    with tempfile.TemporaryDirectory() as temp_dir:            
+        if os.path.exists(temp_dir):
+            shutil.rmtree(temp_dir)
+        os.makedirs(temp_dir)
+        
+        clone_bmaptool_repo(temp_dir, branch_or_tag="main")  # Or specify a tag like "v3.8"
+        install_bmaptool(temp_dir)
+        
+        # Verify installation
+        verify_installation(python_bin)
+        
+        # Provide usage instructions
+        if "VIRTUAL_ENV" in os.environ:
+            print(f"\nbmaptool is installed in the virtual environment at {os.environ['VIRTUAL_ENV']}")
+            print("The virtual environment is already active.")
+            print("Run 'bmaptool --help' to see available commands.")
+        else:
+            print("\nbmaptool is installed in the system Python environment.")
+            print("Run 'bmaptool --help' to see available commands.")
+
+if __name__ == "__main__":
+    check_bmap_and_install()