rocket-welder-sdk 1.1.34a2__py3-none-any.whl → 1.1.34.dev7__py3-none-any.whl

rocket_welder_sdk/__init__.py

@@ -16,11 +16,22 @@ from .opencv_controller import OpenCvController
 from .periodic_timer import PeriodicTimer, PeriodicTimerSync
 from .rocket_welder_client import RocketWelderClient
 from .session_id import (
+    # Explicit URL functions (PREFERRED - set by rocket-welder2)
+    ACTIONS_SINK_URL_ENV,
+    KEYPOINTS_SINK_URL_ENV,
+    SEGMENTATION_SINK_URL_ENV,
+    # SessionId-derived URL functions (fallback for backwards compatibility)
     get_actions_url,
+    get_actions_url_from_env,
+    get_configured_nng_urls,
     get_keypoints_url,
+    get_keypoints_url_from_env,
     get_nng_urls,
+    get_nng_urls_from_env,
     get_segmentation_url,
+    get_segmentation_url_from_env,
     get_session_id_from_env,
+    has_explicit_nng_urls,
     parse_session_id,
 )
 
@@ -49,7 +60,10 @@ if _log_level:
         pass  # Invalid log level, ignore
 
 __all__ = [
+    "ACTIONS_SINK_URL_ENV",
     "FRAME_METADATA_SIZE",
+    "KEYPOINTS_SINK_URL_ENV",
+    "SEGMENTATION_SINK_URL_ENV",
     "BytesSize",
     "Client",
     "ConnectionMode",
@@ -66,11 +80,16 @@ __all__ = [
     "PeriodicTimerSync",
     "Protocol",
     "RocketWelderClient",
-    # SessionId utilities for NNG URL generation
     "get_actions_url",
+    "get_actions_url_from_env",
+    "get_configured_nng_urls",
     "get_keypoints_url",
+    "get_keypoints_url_from_env",
     "get_nng_urls",
+    "get_nng_urls_from_env",
     "get_segmentation_url",
+    "get_segmentation_url_from_env",
     "get_session_id_from_env",
+    "has_explicit_nng_urls",
     "parse_session_id",
 ]

rocket_welder_sdk/controllers.py

@@ -438,7 +438,9 @@ class OneWayShmController(IController):
                 sqrt_pixels = math.sqrt(pixels)
                 if sqrt_pixels == int(sqrt_pixels):
                     dimension = int(sqrt_pixels)
-                    logger.info(f"Pixel data size {pixel_data_size} suggests {dimension}x{dimension} RGB")
+                    logger.info(
+                        f"Pixel data size {pixel_data_size} suggests {dimension}x{dimension} RGB"
+                    )
                     pixel_data = np.frombuffer(frame.data[FRAME_METADATA_SIZE:], dtype=np.uint8)
                     return pixel_data.reshape((dimension, dimension, 3))  # type: ignore[no-any-return]
 
@@ -448,7 +450,9 @@ class OneWayShmController(IController):
                 sqrt_pixels = math.sqrt(pixels)
                 if sqrt_pixels == int(sqrt_pixels):
                     dimension = int(sqrt_pixels)
-                    logger.info(f"Pixel data size {pixel_data_size} suggests {dimension}x{dimension} RGBA")
+                    logger.info(
+                        f"Pixel data size {pixel_data_size} suggests {dimension}x{dimension} RGBA"
+                    )
                     pixel_data = np.frombuffer(frame.data[FRAME_METADATA_SIZE:], dtype=np.uint8)
                     return pixel_data.reshape((dimension, dimension, 4))  # type: ignore[no-any-return]
 

rocket_welder_sdk/rocket_welder_client.py

@@ -16,7 +16,11 @@ from .connection_string import ConnectionMode, ConnectionString, Protocol
 from .controllers import DuplexShmController, IController, OneWayShmController
 from .frame_metadata import FrameMetadata  # noqa: TC001 - used at runtime in callbacks
 from .opencv_controller import OpenCvController
-from .session_id import get_nng_urls, get_session_id_from_env
+from .session_id import (
+    get_configured_nng_urls,
+    get_nng_urls_from_env,
+    has_explicit_nng_urls,
+)
 from .transport.nng_transport import NngFrameSink
 
 if TYPE_CHECKING:
@@ -90,27 +94,33 @@ class RocketWelderClient:
         """
         return self._nng_publishers
 
-    def _create_nng_publishers(self, session_id: str) -> None:
+    def _create_nng_publishers(self) -> None:
         """Create NNG publishers for result streaming.
 
-        Args:
-            session_id: SessionId string (e.g., "ps-{guid}")
+        URLs are read from environment variables (preferred) or derived from SessionId (fallback).
+
+        Priority:
+        1. Explicit URLs: SEGMENTATION_SINK_URL, KEYPOINTS_SINK_URL, ACTIONS_SINK_URL
+        2. Derived from SessionId environment variable (backwards compatibility)
         """
         try:
-            urls = get_nng_urls(session_id)
+            urls = get_configured_nng_urls()
 
             for name, url in urls.items():
                 sink = NngFrameSink.create_publisher(url)
                 self._nng_publishers[name] = sink
                 logger.info("NNG publisher ready: %s at %s", name, url)
 
+            # Log configuration summary
             logger.info(
-                "NNG publishers created for SessionId=%s: seg=%s, kp=%s, actions=%s",
-                session_id,
-                urls["segmentation"],
-                urls["keypoints"],
-                urls["actions"],
+                "NNG publishers configured: seg=%s, kp=%s, actions=%s",
+                urls.get("segmentation", "(not configured)"),
+                urls.get("keypoints", "(not configured)"),
+                urls.get("actions", "(not configured)"),
             )
+        except ValueError as ex:
+            # No URLs configured - this is expected for containers that don't publish results
+            logger.debug("NNG publishers not configured: %s", ex)
         except Exception as ex:
             logger.warning("Failed to create NNG publishers: %s", ex)
             # Don't fail start() - NNG is optional for backwards compatibility
@@ -162,10 +172,20 @@ class RocketWelderClient:
             else:
                 raise ValueError(f"Unsupported protocol: {self._connection.protocol}")
 
-            # Auto-create NNG publishers if SessionId env var is set
-            session_id = get_session_id_from_env()
-            if session_id:
-                self._create_nng_publishers(session_id)
+            # Auto-create NNG publishers if URLs are configured
+            # (explicit URLs via SEGMENTATION_SINK_URL etc., or derived from SessionId)
+            if has_explicit_nng_urls():
+                self._create_nng_publishers()
+            else:
+                # Log that NNG is not configured (informational)
+                urls = get_nng_urls_from_env()
+                logger.info(
+                    "NNG sink URLs not configured (this is normal if not publishing AI results). "
+                    "seg=%s, kp=%s, actions=%s",
+                    urls.get("segmentation") or "(not set)",
+                    urls.get("keypoints") or "(not set)",
+                    urls.get("actions") or "(not set)",
+                )
 
             # If preview is enabled, wrap the callback to capture frames
             if self._preview_enabled:

rocket_welder_sdk/session_id.py

@@ -7,6 +7,22 @@ This module provides utilities to:
 1. Parse SessionId from environment variable
 2. Extract the Guid portion
 3. Generate NNG IPC URLs for streaming results
+4. Read explicit NNG URLs from environment variables (preferred)
+
+## URL Configuration Priority
+
+The SDK supports two ways to configure NNG URLs:
+
+1. **Explicit URLs (PREFERRED)** - Set by rocket-welder2:
+   - SEGMENTATION_SINK_URL
+   - KEYPOINTS_SINK_URL
+   - ACTIONS_SINK_URL
+
+2. **Derived from SessionId (FALLBACK)** - For backwards compatibility:
+   - SessionId env var → parse GUID → generate URLs
+
+Use `get_nng_urls_from_env()` for explicit URLs (preferred).
+Use `get_nng_urls(session_id)` for SessionId-derived URLs (fallback).
 """
 
 from __future__ import annotations
@@ -20,6 +36,11 @@ logger = logging.getLogger(__name__)
 SESSION_ID_PREFIX = "ps-"
 SESSION_ID_ENV_VAR = "SessionId"
 
+# Explicit URL environment variables (set by rocket-welder2)
+SEGMENTATION_SINK_URL_ENV = "SEGMENTATION_SINK_URL"
+KEYPOINTS_SINK_URL_ENV = "KEYPOINTS_SINK_URL"
+ACTIONS_SINK_URL_ENV = "ACTIONS_SINK_URL"
+
 
 def parse_session_id(session_id: str) -> uuid.UUID:
     """Parse SessionId (ps-{guid}) to extract Guid.
@@ -113,3 +134,105 @@ def get_actions_url(session_id: str) -> str:
     """
     guid = parse_session_id(session_id)
     return f"ipc:///tmp/rw-{guid}-actions.sock"
+
+
+# ============================================================================
+# Explicit URL functions (PREFERRED - URLs set by rocket-welder2)
+# ============================================================================
+
+
+def get_nng_urls_from_env() -> dict[str, str | None]:
+    """Get NNG URLs from explicit environment variables.
+
+    This is the PREFERRED method for getting NNG URLs. rocket-welder2
+    sets these environment variables when starting containers.
+
+    Returns:
+        Dictionary with 'segmentation', 'keypoints', 'actions' URLs.
+        Values are None if not configured.
+
+    Examples:
+        >>> os.environ["SEGMENTATION_SINK_URL"] = "ipc:///tmp/rw-abc-seg.sock"
+        >>> urls = get_nng_urls_from_env()
+        >>> urls["segmentation"]
+        'ipc:///tmp/rw-abc-seg.sock'
+    """
+    return {
+        "segmentation": os.environ.get(SEGMENTATION_SINK_URL_ENV),
+        "keypoints": os.environ.get(KEYPOINTS_SINK_URL_ENV),
+        "actions": os.environ.get(ACTIONS_SINK_URL_ENV),
+    }
+
+
+def get_segmentation_url_from_env() -> str | None:
+    """Get segmentation NNG URL from environment variable.
+
+    Returns:
+        IPC URL for segmentation stream, or None if not configured.
+    """
+    return os.environ.get(SEGMENTATION_SINK_URL_ENV)
+
+
+def get_keypoints_url_from_env() -> str | None:
+    """Get keypoints NNG URL from environment variable.
+
+    Returns:
+        IPC URL for keypoints stream, or None if not configured.
+    """
+    return os.environ.get(KEYPOINTS_SINK_URL_ENV)
+
+
+def get_actions_url_from_env() -> str | None:
+    """Get actions NNG URL from environment variable.
+
+    Returns:
+        IPC URL for actions stream, or None if not configured.
+    """
+    return os.environ.get(ACTIONS_SINK_URL_ENV)
+
+
+def has_explicit_nng_urls() -> bool:
+    """Check if explicit NNG URLs are configured.
+
+    Returns:
+        True if at least segmentation OR keypoints URL is configured.
+    """
+    urls = get_nng_urls_from_env()
+    return bool(urls["segmentation"] or urls["keypoints"])
+
+
+def get_configured_nng_urls() -> dict[str, str]:
+    """Get all configured NNG URLs (explicit or derived from SessionId).
+
+    Priority:
+    1. Explicit URLs from environment (SEGMENTATION_SINK_URL, etc.)
+    2. Derived from SessionId environment variable (fallback)
+
+    Returns:
+        Dictionary with 'segmentation', 'keypoints', 'actions' URLs.
+        Only includes URLs that are actually configured.
+
+    Raises:
+        ValueError: If no NNG URLs are configured (neither explicit nor SessionId).
+    """
+    # Try explicit URLs first (preferred)
+    explicit_urls = get_nng_urls_from_env()
+    result: dict[str, str] = {}
+
+    for name, url in explicit_urls.items():
+        if url:
+            result[name] = url
+
+    # If we have at least one explicit URL, return what we have
+    if result:
+        return result
+
+    # Fallback: derive from SessionId
+    session_id = get_session_id_from_env()
+    if session_id:
+        return get_nng_urls(session_id)
+
+    raise ValueError(
+        "No NNG URLs configured. Set SEGMENTATION_SINK_URL/KEYPOINTS_SINK_URL "
+        "environment variables, or set SessionId for URL derivation."
+    )

rocket_welder_sdk/transport/__init__.py

@@ -28,11 +28,3 @@ __all__ = [
     "UnixSocketFrameSource",
     "UnixSocketServer",
 ]
-
-# NNG transport is optional (requires pynng package)
-try:
-    from .nng_transport import NngFrameSink, NngFrameSource
-
-    __all__.extend(["NngFrameSink", "NngFrameSource"])
-except ImportError:
-    pass  # pynng not installed

{rocket_welder_sdk-1.1.34a2.dist-info → rocket_welder_sdk-1.1.34.dev7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocket-welder-sdk
-Version: 1.1.34a2
+Version: 1.1.34.dev7
 Summary: High-performance video streaming SDK for RocketWelder services using ZeroBuffer IPC
 Home-page: https://github.com/modelingevolution/rocket-welder-sdk
 Author: ModelingEvolution

{rocket_welder_sdk-1.1.34a2.dist-info → rocket_welder_sdk-1.1.34.dev7.dist-info}/RECORD

@@ -1,16 +1,16 @@
-rocket_welder_sdk/__init__.py,sha256=7jawqof-tt0S0G7CMMOmHRsVLbUf-o8sSREP1VxEeJ4,2400
+rocket_welder_sdk/__init__.py,sha256=pcYOCqqYuK8oJwkFRnWej4uNfEkuYWXP6jcUhPSLgrc,3041
 rocket_welder_sdk/bytes_size.py,sha256=Myl29-wyWCIYdbMmgaxXebT8Dz8_Fwcr3fnfaNW81P0,7463
 rocket_welder_sdk/connection_string.py,sha256=NIC6OiOXF-DeBFCWzgMFOWsenrSS45hY81j_HLMSpgo,9974
-rocket_welder_sdk/controllers.py,sha256=X7D7OyiuHhGTrmrSNG2Tljsy1_4PGRObytB4dLyvRrg,32600
+rocket_welder_sdk/controllers.py,sha256=WY3fgUUrlicA_ibDhvsfsF0ucD7RuoHuL-BWojAhjtQ,32692
 rocket_welder_sdk/frame_metadata.py,sha256=8AbCgSQ17QeCHSzdQiSN0E1KxE5rrNpOlTYZ2em8kes,3903
 rocket_welder_sdk/gst_metadata.py,sha256=jEQvZX4BdR6OR3lqp12PV-HEXZhcxfiS010diA2CbMM,14213
 rocket_welder_sdk/keypoints_protocol.py,sha256=NKiSPrevWG4_RrD6jtFxPjwftlaPWe1CqoFVKRMwp4k,21858
 rocket_welder_sdk/opencv_controller.py,sha256=MDM6_yFBB9BaMa5jnZRqw7xZZB-WuLr7EPrrfHQ2DK4,9905
 rocket_welder_sdk/periodic_timer.py,sha256=hnObybmrnf3J47QrNKJhYAytLKwria016123NvPRfQ0,9369
 rocket_welder_sdk/py.typed,sha256=0cXFZXmes4Y-vnl4lO3HtyyyWaFNw85B7tJdFeCtHDc,67
-rocket_welder_sdk/rocket_welder_client.py,sha256=2tGL98hLXU_Xl2LzjhdLpQkp9oxzb4D3WmPOcMZMyw4,17474
+rocket_welder_sdk/rocket_welder_client.py,sha256=0SNsrP9SePTHNLbfKyt-71UYs2owrZwesiwOXNglI4c,18515
 rocket_welder_sdk/segmentation_result.py,sha256=q3n8m1sooPcattfXisL9em5gZKbEZ1ueGqeXfOrdaHY,13417
-rocket_welder_sdk/session_id.py,sha256=4RVNxuMzJsJ3Me1LveTe_RSDevEUsOozlamSRMXfXGA,3114
+rocket_welder_sdk/session_id.py,sha256=sRhzQw90shqq_DJVtrsSggcGZ775kz7cRfbI-1LMeSA,7027
 rocket_welder_sdk/external_controls/__init__.py,sha256=ldOLGhLLS5BQL8m4VKFYV0SvsNNlV2tghlc7rkqadU8,699
 rocket_welder_sdk/external_controls/contracts.py,sha256=3DU6pdpteN50gF2fsS7C2279dGjDa0tZLrLntkBa2LM,2607
 rocket_welder_sdk/external_controls/contracts_old.py,sha256=XWriuXJZu5caTSS0bcTIOZcKnj-IRCm96voA4gqLBfU,2980
@@ -19,7 +19,7 @@ rocket_welder_sdk/high_level/connection_strings.py,sha256=4undnkbWZ837vY-o6ybIj1
 rocket_welder_sdk/high_level/data_context.py,sha256=Pmwsl9MgBfKA9BqmBJmAVRvnaqPdjnq2rZEA_pzzYsw,4585
 rocket_welder_sdk/high_level/schema.py,sha256=UlefNAV2UL9eO_Th2q19a7tf_eoaeLE92fYZ5LNq7-M,4849
 rocket_welder_sdk/high_level/transport_protocol.py,sha256=lvLVHikW_MNZhXqaXlyXscT68OklyMbGs8DnDEMCtgE,4515
-rocket_welder_sdk/transport/__init__.py,sha256=L-wl0YWhVbSrof94Zt4g7SIM-wTPzujdVOsEfJHiJT4,978
+rocket_welder_sdk/transport/__init__.py,sha256=DYmZpohGPU7RhS6EdVT_BwCy5MZzyTQ6Eymm8TpmxJ8,751
 rocket_welder_sdk/transport/frame_sink.py,sha256=16dUefZF1QJv62Ig0ezPR6nEho_7A3WJu4M9_PPMqJM,2164
 rocket_welder_sdk/transport/frame_source.py,sha256=G1rBAQS1AgOOdtASB0_CYon8g20hUGXpP2exCp5hlhk,2169
 rocket_welder_sdk/transport/nng_transport.py,sha256=o-qgcmHCGnwtdPe-mwwrC-a9H0rgS-VdH2QvU-6kFlI,5838
@@ -32,7 +32,7 @@ rocket_welder_sdk/ui/icons.py,sha256=DcDklZkPmiEzlOD4IR7VTJOtGPCuuh_OM_WN7ScghWE
 rocket_welder_sdk/ui/ui_events_projection.py,sha256=siiNhjLEBOPfTKw1ZhOPGkwIN5rLDH7V9VCZTNrhEtQ,7836
 rocket_welder_sdk/ui/ui_service.py,sha256=uRdpyJGoCQmtOli_HKSrxLwhZYG-XRuHIYdkmFz1zNk,12026
 rocket_welder_sdk/ui/value_types.py,sha256=f7OA_9zgXEDPoITc8v8SfAR23I4XeFhE3E2_GcAbR6k,1616
-rocket_welder_sdk-1.1.34a2.dist-info/METADATA,sha256=XlxEOkkIEDYqUlxlPbBv3ZhWNeiqo9cXjnHm8yY_16A,24849
-rocket_welder_sdk-1.1.34a2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rocket_welder_sdk-1.1.34a2.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
-rocket_welder_sdk-1.1.34a2.dist-info/RECORD,,
+rocket_welder_sdk-1.1.34.dev7.dist-info/METADATA,sha256=qUlyc_-dz2TRBVvqqV6N38UvFF9Gb6r-Vw1PsqppeYw,24852
+rocket_welder_sdk-1.1.34.dev7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rocket_welder_sdk-1.1.34.dev7.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
+rocket_welder_sdk-1.1.34.dev7.dist-info/RECORD,,