CMSIS-Pack Manager

Warnings

• gotcha Building `cmsis-pack-manager` from source on non-x86 architectures (e.g., ARM-based systems like Raspberry Pi) or with newer Python versions (e.g., Python 3.11) can encounter build failures. This is often due to underlying Rust build requirements or specific `maturin`/`cffi` interactions.
  Fix: Prefer installing pre-built wheels via `pip install cmsis-pack-manager`. If building from source is necessary, check GitHub issues for specific workarounds, which may involve installing a particular `maturin` branch or temporarily removing `cmsis-pack-manager` from `install_requires` in a `setup.py`/`setup.cfg` file for related projects (e.g., `pyocd`). Ensure a stable Rust compiler is installed and up-to-date if building from source.
• breaking Python 3.6 support has been removed in recent development versions. While PyPI metadata currently indicates `>=3.6`, newer internal releases and the Rust backend's evolution have dropped support for older Python versions.
  Fix: Ensure your project uses Python 3.7 or newer. Python 3.11 is explicitly supported in recent releases.
• deprecated The `milksnake` runtime dependency was replaced by `maturin` for building the Python bindings to the Rust backend. While this is an internal build change, users compiling from source or relying on specific older build environments might be affected.
  Fix: This is generally handled by the `pip install` process. If building from source, ensure `maturin` is correctly installed and configured in your build environment.
• gotcha The cache directory where CMSIS-Packs are stored, once set, is generally not easily changeable without manually re-downloading packs. While this warning primarily applies to GUI-based pack managers like the Eclipse plugin, the underlying principle of managing a persistent local pack repository applies. Programmatic changes to the cache location might require manual intervention or re-initialization to reflect.
  Fix: The cache location can be queried using `cmsis_pack_manager.Cache().data_path()`. If a different location is desired, the existing cache might need to be manually moved or cleared, and packs re-downloaded to the new location.

Install

• pip install cmsis-pack-manager Install stable version

Imports

• Cache

  from cmsis_pack_manager import Cache

• CmsisPackManager

  from cmsis_pack_manager.cmsis_pack_manager import CmsisPackManager

  The core manager class is nested within cmsis_pack_manager.cmsis_pack_manager.

Quickstart

This quickstart demonstrates how to initialize the CMSIS-Pack manager and access its cache path. It also shows how to list installed packs, noting that an update is required to fetch packs from online sources. The `update_pdsc_idx()` and `get_device_by_name()` calls are commented out to make the example immediately runnable without network interaction or requiring pre-installed packs, highlighting where user action would be needed.

from cmsis_pack_manager import Cache
from cmsis_pack_manager.cmsis_pack_manager import CmsisPackManager

# Initialize the cache and manager
cache = Cache(False, False) # Args: no_create, no_setup_logging
cmsis_manager = CmsisPackManager(cache)

print(f"CMSIS-Pack cache directory: {cache.data_path()}")

# Update the pack index (requires network access and can take time)
# This line is commented out for quickstart to avoid network call by default
# cmsis_manager.update_pdsc_idx()

# List some installed packs (will be empty if no packs updated/installed)
packs = cmsis_manager.get_installed_packs()
if packs:
    print("Installed Packs:")
    for pack in packs:
        print(f"  - {pack.vendor}::{pack.pack_id}@{pack.version}")
else:
    print("No CMSIS-Packs found in cache. Run `pack-manager update` or `cmsis_manager.update_pdsc_idx()` to fetch them.")

# Example: Find a device (requires packs to be installed)
# device = cmsis_manager.get_device_by_name("ATSAMD21E15A")
# if device:
#    print(f"Found device: {device.name}, Vendor: {device.vendor}")
# else:
#    print("Device not found. Ensure relevant packs are installed.")