sima-cli 0.0.18__py3-none-any.whl → 0.0.20__py3-none-any.whl

sima_cli/__version__.py

@@ -1,2 +1,2 @@
 # sima_cli/__version__.py
-__version__ = "0.0.18"
+__version__ = "0.0.20"

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,10 +7,13 @@ 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
+from sima_cli.serial.serial import connect_serial
 
 # Entry point for the CLI tool using Click's command group decorator
 @click.group()
-@click.option('-i', '--internal', is_flag=True, help="Use internal Artifactory resources.")
+@click.option('-i', '--internal', is_flag=True, help="Use internal Artifactory resources, Authorized Sima employees only")
 @click.pass_context
 def main(ctx, internal):
     """
@@ -164,7 +167,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
@@ -217,6 +220,112 @@ 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.option("--netboot", is_flag=True, default=False, show_default=True, help="Prepare image for network boot and launch TFTP server.")
+@click.option("--autoflash", is_flag=True, default=False, show_default=True, help="Net boot the DevKit and automatically flash the internal storage")
+@click.pass_context
+def bootimg_cmd(ctx, version, boardtype, netboot, autoflash):
+    """
+    Download and burn a removable media or setup TFTP boot.
+
+    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
+      sima-cli bootimg -v 1.6.0 --boardtype modalix --netboot
+      sima-cli bootimg -v 1.6.0 --boardtype modalix --autoflash
+    """
+
+    from sima_cli.update.bootimg import write_image
+    from sima_cli.update.netboot import setup_netboot
+
+    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'
+        if netboot or autoflash:
+            setup_netboot(version, boardtype, internal, autoflash)
+            click.echo("✅ Netboot image prepared and TFTP server is running.")
+        else:
+            write_image(version, boardtype, 'yocto', internal)
+            click.echo("✅ Boot image successfully written.")
+        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:
+
+        sima-cli install hostdriver -v 1.6.0
+
+        sima-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.")
+
+# ----------------------
+# Serial Subcommands
+# ----------------------
+@main.command(name="serial")
+@click.option("-b", "--baud", default=115200, show_default=True, help="Baud rate for the serial connection")
+@click.pass_context
+def serial_cmd(ctx, baud):
+    """
+    Connect to the UART serial console of the DevKit.
+
+    Automatically detects the serial port and launches a terminal emulator:
+
+    - macOS: uses 'picocom'
+    
+    - Linux: uses 'picocom'
+    
+    - Windows: shows PuTTY/Tera Term setup instructions
+    """
+    connect_serial(ctx, baud)
 # ----------------------
 # App Zoo Subcommands
 # ----------------------

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,85 @@
+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 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)
+
+        # Always redownload the metadata file to get the latest version
+        metadata_path = downloads_dir / "metadata.json"
+        if metadata_path.exists():
+            metadata_path.unlink()
+
+        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)
+
+        script_name = "run.bat" if platform.system() == "Windows" else "run.sh"
+        click.echo(f"✅ Optiview installed successfully. Run {downloads_dir}/{script_name} 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/serial/serial.py

@@ -0,0 +1,114 @@
+import platform
+import subprocess
+import shutil
+import click
+from sima_cli.utils.env import is_sima_board
+
+def connect_serial(ctx, baud):
+    """
+    Connect to the UART serial console of the DevKit.
+    Automatically installs required tools if missing.
+    """
+    if is_sima_board():
+        click.echo("🚫 This command is not supported on the DevKit. Please run it from your host machine.")
+        ctx.exit(1)
+
+    system = platform.system()
+    internal = ctx.obj.get("internal", False)
+
+    if system == "Darwin":
+        _connect_mac(baud)
+    elif system == "Linux":
+        _connect_linux(baud)
+    elif system == "Windows":
+        _print_windows_instructions()
+    else:
+        click.echo(f"⚠️ Unsupported OS: {system}. Only macOS, Linux, and Windows are supported.")
+        ctx.exit(1)
+
+    click.echo("✅ Serial session ended.")
+
+
+def _connect_mac(baud):
+    terminal = "picocom"
+    if not shutil.which(terminal):
+        click.echo("⚙️ 'picocom' is not installed. Attempting to install with Homebrew...")
+        if shutil.which("brew"):
+            subprocess.run(["brew", "install", "picocom"], check=True)
+        else:
+            click.echo("❌ Homebrew not found. Please install Homebrew first: https://brew.sh/")
+            raise SystemExit(1)
+
+    ports = sorted(
+        subprocess.getoutput("ls /dev/tty.usbserial-* /dev/cu.usbserial-* 2>/dev/null").splitlines()
+    )
+    if not ports:
+        click.echo("❌ No USB serial device found.")
+        raise SystemExit(1)
+
+    click.echo(f"Connecting to device with picocom ({baud} baud)...")
+    click.echo("🧷 To exit: Press Ctrl + A, then Ctrl + X")
+    click.echo("📜 Scrollback will work in your terminal as expected.\n")
+    
+    if not click.confirm("Proceed to connect?", default=True):
+        click.echo("❎ Connection aborted by user.")
+        return
+
+    port = ports[0]
+    click.echo(f"🔌 Connecting to {port} with picocom (115200 8N1)...")
+    try:
+        subprocess.run([
+            terminal,
+            "-b", f"{baud}",
+            "--databits", "8",
+            "--parity", "n",
+            "--stopbits", "1",
+            port
+        ])
+    except KeyboardInterrupt:
+        click.echo("\n❎ Serial connection interrupted by user.")
+
+
+def _connect_linux(baud):
+    terminal = "picocom"
+    if not shutil.which(terminal):
+        click.echo("⚙️ 'picocom' is not installed. Attempting to install via apt...")
+        if shutil.which("apt-get"):
+            subprocess.run(["sudo", "apt-get", "update"], check=True)
+            subprocess.run(["sudo", "apt-get", "install", "-y", "picocom"], check=True)
+        else:
+            click.echo("❌ 'apt-get' not found. Please install picocom manually.")
+            raise SystemExit(1)
+
+    ports = sorted(
+        subprocess.getoutput("ls /dev/ttyUSB* 2>/dev/null").splitlines()
+    )
+    if not ports:
+        click.echo("❌ No USB serial device found.")
+        raise SystemExit(1)
+
+    port = ports[0]
+    click.echo(f"🔌 Connecting to {port} with picocom ({baud} 8N1)...")
+    try:
+        subprocess.run(
+            ["sudo", terminal, "-b", f"{baud}", "--databits", "8", "--parity", "n", "--stopbits", "1", port]
+        )
+    except KeyboardInterrupt:
+        click.echo("\n❎ Serial connection interrupted by user.")
+
+
+def _print_windows_instructions():
+    click.echo("📘 To connect to the DevKit via a serial terminal on Windows, follow these steps:\n")
+
+    click.echo("1. Identify the COM Port:")
+    click.echo("   • Open **Device Manager** → Expand **Ports (COM & LPT)**.")
+    click.echo("   • Look for an entry like **USB Serial Port (COMx)**.\n")
+
+    click.echo("2. Install and Open a Serial Terminal:")
+    click.echo("   • Use **PuTTY** (Download from https://www.putty.org/) or **Tera Term**.")
+    click.echo("   • Set the **Connection Type** to **Serial**.")
+    click.echo("   • Enter the correct **COM Port** (e.g., COM3).")
+    click.echo("   • Set **Baud Rate** to **115200**.")
+    click.echo("   • Click **Open** to start the connection.\n")
+
+    click.echo("🔌 You are now ready to connect to the DevKit over serial.")