pyhubbledemo 0.0.2__tar.gz → 0.0.4__tar.gz

{pyhubbledemo-0.0.2 → pyhubbledemo-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyhubbledemo
-Version: 0.0.2
+Version: 0.0.4
 Summary: Hubble demo functionality for flashing and provisioning boards
 Author-email: Paul Buckley <paul@hubble.com>
 License-Expression: Apache-2.0
@@ -9,6 +9,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9
 Requires-Dist: click
+Requires-Dist: intelhex
 Requires-Dist: petname
 Requires-Dist: pyelftools
 Requires-Dist: pyhubblenetwork

{pyhubbledemo-0.0.2 → pyhubbledemo-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyhubbledemo"
-version = "0.0.2"
+version = "0.0.4"
 requires-python = ">=3.9"
 authors = [
   { name="Paul Buckley", email="paul@hubble.com" },
@@ -22,6 +22,7 @@ dependencies = [
   "petname",
   "pylink-square",
   "pyelftools",
+  "intelhex",
   "pyhubblenetwork",
 ]
 

pyhubbledemo-0.0.4/src/hubbledemo/__init__.py

@@ -0,0 +1,13 @@
+# hubbledemo/__init__.py
+
+from .elfmgr import flash_elf, patch_elf, probe_device, convert_elf_to_hex
+from .cloud import fetch_elf, fetch_metadata
+
+__all__ = [
+    "flash_elf",
+    "fetch_elf",
+    "patch_elf",
+    "probe_device",
+    "fetch_metadata",
+    "convert_elf_to_hex",
+]

{pyhubbledemo-0.0.2 → pyhubbledemo-0.0.4}/src/hubbledemo/cli.py

@@ -1,16 +1,10 @@
 from __future__ import annotations
-
+from typing import Optional
 import click
 import os
-import json
-import time
-import base64
-import sys
 import petname
-from datetime import timezone, datetime
-from typing import Optional
-from hubblenetwork import Organization, Credentials
-from hubbledemo import flash_elf, fetch_elf, patch_elf, probe_device
+import hubbledemo
+from hubblenetwork import Organization
 
 
 def _get_env_or_fail(name: str) -> str:
@@ -40,7 +34,7 @@ def cli() -> None:
 
 @cli.command("probe")
 def probe() -> None:
-    if probe_device():
+    if hubbledemo.probe_device():
         click.echo("[SUCCESS] Device detected.")
     else:
         click.secho(
@@ -70,7 +64,16 @@ def probe() -> None:
     help="Token (if not using HUBBLE_API_TOKEN env var)",
 )
 def flash(board: str, name: str = None, org_id: str = None, token: str = None) -> None:
-    if not probe_device():
+    click.secho("[INFO] Getting metadata... ", nl=False)
+    metadata = hubbledemo.fetch_metadata()
+    click.secho("[SUCCESS]")
+
+    if board not in metadata:
+        click.secho("[ERROR] Unsupported board selected!", fg="red",err=True)
+        return 2
+
+    # If using jlink, we want to make sure early on that a device is connected
+    if metadata[board]["method"] == "jlink-flash" and not hubbledemo.probe_device():
         click.secho(
             "[ERROR] Failed to connect to device. Check your connection.",
             fg="red",
@@ -79,15 +82,15 @@ def flash(board: str, name: str = None, org_id: str = None, token: str = None) -
         return 2
 
     org_id, token = _get_org_and_token(org_id, token)
-    org = Organization(Credentials(org_id=org_id, api_token=token))
+    org = Organization(org_id=org_id, api_token=token)
 
-    click.secho(f"[INFO] Organization info acquired:")
+    click.secho("[INFO] Organization info acquired:")
     click.secho(f"\tID: {org.credentials.org_id}")
     click.secho(f"\tName: {org.name}")
     click.secho(f"\tEnvironment: {org.env.name}")
 
-    click.secho(f'[INFO] Registering new device"... ', nl=False)
-    device = org.register_device()
+    click.secho('[INFO] Registering new device"... ', nl=False)
+    device = org.register_device(encryption=metadata[board]["encryption"] if "encryption" in metadata[board] else None)
     click.secho("[SUCCESS]")
     click.secho(f"\tDevice ID:  {device.id}")
     click.secho(f"\tDevice Key: {device.key}")
@@ -95,24 +98,39 @@ def flash(board: str, name: str = None, org_id: str = None, token: str = None) -
     if not name:
         name = petname.generate(words=3)
         click.secho(f'[INFO] No name supplied. Naming device "{name}"')
-    click.secho(f"[INFO] Setting device name... ", nl=False)
+    click.secho("[INFO] Setting device name... ", nl=False)
     org.set_device_name(device_id=device.id, name=name)
     click.secho("[SUCCESS]")
 
     click.secho(f"[INFO] Retrieving binary for {board}... ", nl=False)
-    buf = fetch_elf(board=board)
+    buf = hubbledemo.fetch_elf(board=board)
     click.secho("[SUCCESS]")
 
     click.secho("[INFO] Patching key + UTC into binary... ", nl=False)
-    patch_elf(buf, device)
-    click.secho("[SUCCESS]")
-
-    click.secho("[INFO] Flashing binary onto device... ", nl=False)
-    flash_elf(board=board, buf=buf)
+    hubbledemo.patch_elf(buf, device)
     click.secho("[SUCCESS]")
 
-    click.secho(f"\n{board} successfully flashed and provisioned!")
-
+    # Depending on method, deliver how we will do provisioning.
+    if metadata[board]["method"] == "jlink-flash":
+        click.secho("[INFO] Flashing binary onto device... ", nl=False)
+        hubbledemo.flash_elf(board=board, buf=buf, jlink_device=metadata[board]["jlink_device"])
+        click.secho("[SUCCESS]")
+
+        click.secho(f"\n{board} successfully flashed and provisioned!")
+    elif metadata[board]["method"] == "generate-hex":
+        click.secho("[INFO] Generating hex file... ", nl=False)
+        hubbledemo.convert_elf_to_hex(buf=buf, filename=name)
+        click.secho("[SUCCESS]")
+        click.secho(
+            f"\nHex file written to \"{os.getcwd()}/{name}.hex\"",
+            bg='blue', fg='white')
+    else:
+        click.secho(
+            "[ERROR] Unknown method for provisioning board.",
+            fg="red",
+            err=True,
+        )
+        return 2
 
 def main(argv: Optional[list[str]] = None) -> int:
     """
@@ -130,7 +148,6 @@ def main(argv: Optional[list[str]] = None) -> int:
         return 2
     return 0
 
-
 if __name__ == "__main__":
     # Forward command-line args (excluding the program name) to main()
     raise SystemExit(main())

pyhubbledemo-0.0.4/src/hubbledemo/cloud.py

@@ -0,0 +1,154 @@
+from typing import Optional, Any
+import io
+import os
+import requests
+import json
+import time
+from pathlib import Path
+
+_ARTIFACT_BASE_URL = (
+    "https://raw.githubusercontent.com/HubbleNetwork/hubble-tldm/master/merge"
+)
+
+_METADATA_FILENAME = "md.json"
+
+def fetch_elf(board: str, timeout: float = 20.0) -> io.BytesIO:
+    """
+    Download the board-specific ELF from HubbleNetwork/hubble-tldm/merge and
+    return it as an io.BytesIO.
+
+    Parameters
+    ----------
+    board_name : str
+        Board identifier (e.g. 'nrf21540dk', 'xg24_ek2703a', 'xg22_ek4108a').
+    timeout : float
+        Requests timeout in seconds (connect + read).
+
+    Returns
+    -------
+    io.BytesIO
+        Raw bytes of the .elf file
+
+    Raises
+    ------
+    ValueError
+        If the board is not supported or name is malformed.
+    FileNotFoundError
+        If the expected ELF file does not exist in the merge directory.
+    ConnectionError
+        On network, HTTP, or parsing failures.
+    """
+    if not isinstance(board, str) or not board.strip():
+        raise ValueError("board must be a non-empty string")
+
+    # If we have a local override, just use that
+    local_file = os.getenv("HUBBLE_DEMO_ELF_FILE")
+    if local_file:
+        return io.BytesIO(Path(local_file).read_bytes())
+
+    # Give option (for development) to pull binary from elsewhere
+    val = os.getenv("HUBBLE_DEMO_URL_OVERRIDE")
+    if val:
+        base_url = val
+    else:
+        base_url = _ARTIFACT_BASE_URL
+
+    url = f"{base_url}/{board}.elf"
+
+    _RETRY_STATUS = {429, 500, 502, 503, 504}
+    retries = 5
+
+    last_err: Optional[Exception] = None
+    for attempt in range(1, max(1, retries) + 1):
+        try:
+            resp = requests.get(url, timeout=5)
+
+            if resp.status_code == 404:
+                # Not found is definitive; don't bother retrying
+                raise FileNotFoundError(f"No ELF for board '{board}' at {url}")
+
+            # Retry transient status codes (unless it's the final attempt)
+            if resp.status_code in _RETRY_STATUS and attempt < retries:
+                sleep_s = (2 ** (attempt - 1))
+                time.sleep(sleep_s)
+                continue
+
+            # Raise for other non-OK codes
+            resp.raise_for_status()
+
+            # Basic sanity checks: content-type and size
+            ctype = (resp.headers.get("Content-Type") or "").lower()
+            if "html" in ctype:
+                raise ValueError(f"Expected ELF bytes, got {ctype} from {url}")
+
+            return io.BytesIO(resp.content)
+
+        except (requests.Timeout, requests.ConnectionError) as e:
+            last_err = e
+            if attempt < retries:
+                sleep_s = (2 ** (attempt - 1))
+                time.sleep(sleep_s)
+                continue
+            raise ConnectionError(f"Failed to download ELF from {url}: {e}") from e
+
+        except Exception:
+            raise
+
+    # Should not reach here; defensive:
+    raise ConnectionError(f"Failed to download ELF from {url}: {last_err}")
+
+def fetch_metadata() -> Any:
+    """
+    Downloads the metadata about devices and returns it
+    """
+    # If we have a local override, just use that
+    local_file = os.getenv("HUBBLE_DEMO_METADATA_FILE")
+    if local_file:
+        with open(local_file, "r", encoding="utf-8") as f:
+            return json.load(f)
+
+    # Give option (for development) to pull binary from elsewhere
+    val = os.getenv("HUBBLE_DEMO_URL_OVERRIDE")
+    if val:
+        base_url = val
+    else:
+        base_url = _ARTIFACT_BASE_URL
+
+    url = f"{base_url}/{_METADATA_FILENAME}"
+
+    _RETRY_STATUS = {429, 500, 502, 503, 504}
+    retries = 5
+
+    last_err: Optional[Exception] = None
+    for attempt in range(1, max(1, retries) + 1):
+        try:
+            resp = requests.get(url, timeout=5)
+
+            if resp.status_code == 404:
+                # Not found is definitive; don't bother retrying
+                raise FileNotFoundError("No metadata file found for devices")
+
+            # Retry transient status codes (unless it's the final attempt)
+            if resp.status_code in _RETRY_STATUS and attempt < retries:
+                sleep_s = 2 ** (attempt - 1)
+                time.sleep(sleep_s)
+                continue
+
+            # Raise for other non-OK codes
+            resp.raise_for_status()
+
+            return json.loads(resp.text)
+
+        except (requests.Timeout, requests.ConnectionError) as e:
+            last_err = e
+            if attempt < retries:
+                sleep_s = (2 ** (attempt - 1))
+                time.sleep(sleep_s)
+                continue
+            raise ConnectionError(f"Failed to download metadata file from {url}: {e}") from e
+
+        except Exception:
+            raise
+
+    # Should not reach here; defensive:
+    raise ConnectionError(f"Failed to download metadata from {url}: {last_err}")

{pyhubbledemo-0.0.2 → pyhubbledemo-0.0.4}/src/hubbledemo/elfmgr.py

@@ -5,28 +5,12 @@ from hubblenetwork import Device
 import io
 import os
 import base64
-import requests
 import time
 import tempfile
 import pylink
-from pathlib import Path
-from typing import Dict
 from elftools.elf.elffile import ELFFile
 from elftools.elf.sections import SymbolTableSection
-
-
-_ELF_BASE_URL = (
-    "https://raw.githubusercontent.com/HubbleNetwork/hubble-tldm/master/merge"
-)
-
-# Map boards to J-Link "device" strings (extend as needed)
-_BOARD_TO_JLINK_DEVICE: Dict[str, str] = {
-    "nrf52dk": "nRF52832_xxAA",
-    "nrf52840dk": "nRF52840_xxAA",
-    "nrf21540dk": "nRF52840_xxAA",
-    "xg24_ek2703a": "EFR32MG24BxxxF1536",
-    "xg22_ek4108a": "EFR32MG22CxxxF512",
-}
+from intelhex import IntelHex
 
 
 def _compute_file_offset(sym, sec) -> int:
@@ -116,7 +100,7 @@ def probe_device() -> bool:
     return jlink.num_connected_emulators() > 0
 
 
-def flash_elf(buf: io.BytesIO, board: str) -> None:
+def flash_elf(buf: io.BytesIO, board: str, jlink_device) -> None:
     """
     Flash an ELF image (held in a BytesIO) to an nRF52832_xxAA using pylink.
     Creates a temporary .elf on disk (needed by jlink.flash_file) and deletes it afterwards.
@@ -130,7 +114,6 @@ def flash_elf(buf: io.BytesIO, board: str) -> None:
         RuntimeError: on J-Link connection or flashing failure.
     """
     speed_khz = 4000
-    device = _BOARD_TO_JLINK_DEVICE.get(board.strip().lower())
 
     # Write the buffer to a real temp file so flash_file can read it (works on all OSes)
     tmp_path = None
@@ -154,7 +137,7 @@ def flash_elf(buf: io.BytesIO, board: str) -> None:
         try:
             jlink.open()
             jlink.set_tif(pylink.enums.JLinkInterfaces.SWD)
-            jlink.connect(device, speed=speed_khz)
+            jlink.connect(jlink_device, speed=speed_khz)
 
             jlink.halt()
             jlink.flash_file(tmp_path, addr=None)  # ELF contains its own load addresses
@@ -174,88 +157,23 @@ def flash_elf(buf: io.BytesIO, board: str) -> None:
             except OSError:
                 pass
 
+def convert_elf_to_hex(buf: io.BytesIO, filename: str):
+    ih = IntelHex()
 
-def fetch_elf(board: str, timeout: float = 20.0) -> io.BytesIO:
-    """
-    Download the board-specific ELF from HubbleNetwork/hubble-tldm/merge and
-    return it as an io.BytesIO.
-
-    Parameters
-    ----------
-    board_name : str
-        Board identifier (e.g. 'nrf21540dk', 'xg24_ek2703a', 'xg22_ek4108a').
-    timeout : float
-        Requests timeout in seconds (connect + read).
-
-    Returns
-    -------
-    io.BytesIO
-        Raw bytes of the .elf file
-
-    Raises
-    ------
-    ValueError
-        If the board is not supported or name is malformed.
-    FileNotFoundError
-        If the expected ELF file does not exist in the merge directory.
-    ConnectionError
-        On network, HTTP, or parsing failures.
-    """
-    if not isinstance(board, str) or not board.strip():
-        raise ValueError("board must be a non-empty string")
-
-    # If we have a local override, just use that
-    local_file = os.getenv("HUBBLE_DEMO_ELF_FILE")
-    if local_file:
-        return io.BytesIO(Path(local_file).read_bytes())
-
-    # Give option (for development) to pull binary from elsewhere
-    val = os.getenv("HUBBLE_DEMO_ELF_URL_OVERRIDE")
-    if val:
-        base_url = val
-    else:
-        base_url = _ELF_BASE_URL
-
-    url = f"{base_url}/{board}.elf"
-
-    _RETRY_STATUS = {429, 500, 502, 503, 504}
-    retries = 5
-
-    last_err: Optional[Exception] = None
-    for attempt in range(1, max(1, retries) + 1):
-        try:
-            resp = requests.get(url, timeout=timeout)
-
-            if resp.status_code == 404:
-                # Not found is definitive; don't bother retrying
-                raise FileNotFoundError(f"No ELF for board '{board}' at {url}")
-
-            # Retry transient status codes (unless it's the final attempt)
-            if resp.status_code in _RETRY_STATUS and attempt < retries:
-                sleep_s = backoff * (2 ** (attempt - 1))
-                time.sleep(sleep_s)
-                continue
-
-            # Raise for other non-OK codes
-            resp.raise_for_status()
-
-            # Basic sanity checks: content-type and size
-            ctype = (resp.headers.get("Content-Type") or "").lower()
-            if "html" in ctype:
-                raise ValueError(f"Expected ELF bytes, got {ctype} from {url}")
+    buf.seek(0)
+    elf = ELFFile(buf)
 
-            return io.BytesIO(resp.content)
+    for segment in elf.iter_segments():
+        if segment["p_type"] != "PT_LOAD":
+            continue
 
-        except (requests.Timeout, requests.ConnectionError) as e:
-            last_err = e
-            if attempt < retries:
-                sleep_s = backoff * (2 ** (attempt - 1))
-                time.sleep(sleep_s)
-                continue
-            raise ConnectionError(f"Failed to download ELF from {url}: {e}") from e
+        data = segment.data()
+        # Prefer physical address if present, otherwise virtual
+        addr = segment['p_paddr'] if segment['p_paddr'] != 0 else segment['p_vaddr']
 
-        except Exception as e:
-            raise
+        # Store bytes into IntelHex at the proper address
+        for offset, b in enumerate(data):
+            ih[addr + offset] = b
+        #ih.frombytes(data, offset=addr)
 
-    # Should not reach here; defensive:
-    raise ConnectionError(f"Failed to download ELF from {url}: {last_err}")
+    ih.write_hex_file(str(filename + ".hex"))

pyhubbledemo-0.0.2/src/hubbledemo/__init__.py

@@ -1,10 +0,0 @@
-# hubbledemo/__init__.py
-
-from .elfmgr import flash_elf, fetch_elf, patch_elf, probe_device
-
-__all__ = [
-    "flash_elf",
-    "fetch_elf",
-    "patch_elf",
-    "probe_device",
-]