RemoteRF 2.0.15__py3-none-any.whl → 2.1.0.dev7__py3-none-any.whl

remoteRF/common/grpc/__init__.py

@@ -13,4 +13,4 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-from . import grpc_pb2, grpc_pb2_grpc
+from . import grpc_pb2, grpc_pb2_grpc

remoteRF/common/grpc/deployment_capabilities.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+package remote_rf;
+import "grpc.proto";
+
+// Optional discovery. Existing GenericRPC/IDL/device protocols are unchanged.
+service DeploymentCapabilitiesV1 {
+  rpc GetCapabilities (DeploymentCapabilitiesRequest) returns (DeploymentCapabilitiesResponse);
+}
+message DeploymentCapabilitiesRequest {
+  string protocol_version = 1;
+}
+message DeploymentCapabilitiesResponse {
+  string capabilities_json = 1;
+  ErrorEnvelope error = 2;
+}

remoteRF/common/grpc/deployment_capabilities_pb2.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: deployment_capabilities.proto
+# Protobuf Python Version: 6.31.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    6,
+    31,
+    1,
+    '',
+    'deployment_capabilities.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from . import grpc_pb2 as grpc__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1d\x64\x65ployment_capabilities.proto\x12\tremote_rf\x1a\ngrpc.proto\"9\n\x1d\x44\x65ploymentCapabilitiesRequest\x12\x18\n\x10protocol_version\x18\x01 \x01(\t\"d\n\x1e\x44\x65ploymentCapabilitiesResponse\x12\x19\n\x11\x63\x61pabilities_json\x18\x01 \x01(\t\x12\'\n\x05\x65rror\x18\x02 \x01(\x0b\x32\x18.remote_rf.ErrorEnvelope2\x82\x01\n\x18\x44\x65ploymentCapabilitiesV1\x12\x66\n\x0fGetCapabilities\x12(.remote_rf.DeploymentCapabilitiesRequest\x1a).remote_rf.DeploymentCapabilitiesResponseb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'deployment_capabilities_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_DEPLOYMENTCAPABILITIESREQUEST']._serialized_start=56
+  _globals['_DEPLOYMENTCAPABILITIESREQUEST']._serialized_end=113
+  _globals['_DEPLOYMENTCAPABILITIESRESPONSE']._serialized_start=115
+  _globals['_DEPLOYMENTCAPABILITIESRESPONSE']._serialized_end=215
+  _globals['_DEPLOYMENTCAPABILITIESV1']._serialized_start=218
+  _globals['_DEPLOYMENTCAPABILITIESV1']._serialized_end=348
+# @@protoc_insertion_point(module_scope)

remoteRF/common/grpc/deployment_capabilities_pb2_grpc.py

@@ -0,0 +1,100 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+from . import deployment_capabilities_pb2 as deployment__capabilities__pb2
+
+GRPC_GENERATED_VERSION = '1.74.0'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in deployment_capabilities_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class DeploymentCapabilitiesV1Stub(object):
+    """Optional discovery. Existing GenericRPC/IDL/device protocols are unchanged.
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.GetCapabilities = channel.unary_unary(
+                '/remote_rf.DeploymentCapabilitiesV1/GetCapabilities',
+                request_serializer=deployment__capabilities__pb2.DeploymentCapabilitiesRequest.SerializeToString,
+                response_deserializer=deployment__capabilities__pb2.DeploymentCapabilitiesResponse.FromString,
+                _registered_method=True)
+
+
+class DeploymentCapabilitiesV1Servicer(object):
+    """Optional discovery. Existing GenericRPC/IDL/device protocols are unchanged.
+    """
+
+    def GetCapabilities(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_DeploymentCapabilitiesV1Servicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'GetCapabilities': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetCapabilities,
+                    request_deserializer=deployment__capabilities__pb2.DeploymentCapabilitiesRequest.FromString,
+                    response_serializer=deployment__capabilities__pb2.DeploymentCapabilitiesResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'remote_rf.DeploymentCapabilitiesV1', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('remote_rf.DeploymentCapabilitiesV1', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class DeploymentCapabilitiesV1(object):
+    """Optional discovery. Existing GenericRPC/IDL/device protocols are unchanged.
+    """
+
+    @staticmethod
+    def GetCapabilities(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/remote_rf.DeploymentCapabilitiesV1/GetCapabilities',
+            deployment__capabilities__pb2.DeploymentCapabilitiesRequest.SerializeToString,
+            deployment__capabilities__pb2.DeploymentCapabilitiesResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

remoteRF/common/grpc/v2_codec.py

@@ -48,7 +48,7 @@ def _json_safe(value):
     if hasattr(value, "as_payload"):
         return _json_safe(value.as_payload())
     if isinstance(value, np.generic):
-        return _json_safe(value.item())
+        return value.item()
     if isinstance(value, complex):
         return {
             _JSON_TYPE_KEY: "complex",

remoteRF/common/utils/banner.py

@@ -47,7 +47,7 @@ COMPACT_BANNER = "RemoteRF"
 ASCII_WORDMARK_WIDTH = max(len(line) for line in ASCII_BANNER.splitlines())
 ASCII_BANNER_WIDTH = max(len(line) for line in BRANDED_ASCII_BANNER.splitlines())
 ASCII_BANNER_MIN_COLUMNS = ASCII_BANNER_WIDTH + 1
-PANEL_CONTENT_WIDTH = 35
+PANEL_CONTENT_WIDTH = 39
 PANEL_INNER_WIDTH = PANEL_CONTENT_WIDTH + 2
 PANEL_WIDTH = PANEL_INNER_WIDTH + 2
 PANEL_GAP = 1
@@ -111,12 +111,15 @@ def _panel_lines(
     marker = "◆" if unicode_supported else "*"
     label = f"{horizontal} REMOTERF CLIENT "
     top = f"{top_left}{label}{horizontal * (PANEL_INNER_WIDTH - len(label))}{top_right}"
-    content = (
+    content = [
         f"{marker} www.remoterf.net",
-        "Created by the Wireless Lab at UCLA",
+        "Created by https://wireless.ee.ucla.edu",
         f"VERSION  {version}",
-        f"SERVER   {server or 'NA'}",
-    )
+    ]
+    # Before a target is chosen there is no server to name; an "NA" row would
+    # only say so twice.
+    if server:
+        content.append(f"SERVER   {server}")
     body = [
         f"{vertical} {_fit_panel_text(line):<{PANEL_CONTENT_WIDTH}} {vertical}"
         for line in content
@@ -169,12 +172,12 @@ def _compact_lines(
         heading = COMPACT_BANNER[:width]
 
     short_version = str(version).split(maxsplit=1)[0]
-    server = str(server or "NA")
+    server = str(server or "")
     detail_options = (
-        f"v{version} {separator} {server}",
-        f"v{short_version} {separator} {server}",
-        f"v{short_version}",
-    )
+        (f"v{version} {separator} {server}", f"v{short_version} {separator} {server}")
+        if server
+        else (f"v{version}",)
+    ) + (f"v{short_version}",)
     details = next((line for line in detail_options if len(line) <= width), "")
     if not details:
         details = detail_options[-1][:width]

remoteRF/common/utils/process_arg.py

@@ -30,6 +30,31 @@ _MAX_NDARRAY_DIMENSIONS = 8
 _SUPPORTED_NDARRAY_KINDS = {"b", "i", "u", "f", "c"}
 
 
+# Gate I slice 3: complex samples as interleaved int16 IQ, a quarter of the
+# complex128 bytes, decoded to complex64. Only exact for integer-valued data
+# within int16 range (a 12-bit ADC's, say); map_iq16 refuses anything else.
+IQ16 = "ci16"
+
+
+def fits_iq16(array: np.ndarray) -> bool:
+    if not (isinstance(array, np.ndarray) and np.iscomplexobj(array)):
+        return False
+    parts = np.stack((array.real, array.imag))
+    return bool(np.all(np.abs(parts) <= 32767) and np.array_equal(parts, np.round(parts)))
+
+
+def map_iq16(array: np.ndarray) -> grpc_pb2.Argument:
+    if not fits_iq16(array):
+        raise ValueError("samples are not integer-valued int16 IQ")
+    iq = np.empty(array.shape + (2,), dtype=np.int16)
+    iq[..., 0], iq[..., 1] = array.real, array.imag
+    arg = grpc_pb2.Argument()
+    arg.ndarray_value.dtype = IQ16
+    arg.ndarray_value.shape.extend(array.shape)
+    arg.ndarray_value.data = np.ascontiguousarray(iq).tobytes(order="C")
+    return arg
+
+
 def _validate_ndarray(dtype: np.dtype, shape) -> int:
     """Return the expected payload length for a safe numeric ndarray."""
     if dtype.hasobject or dtype.kind not in _SUPPORTED_NDARRAY_KINDS:
@@ -49,18 +74,22 @@ def _validate_ndarray(dtype: np.dtype, shape) -> int:
 
 
 def _decode_ndarray(descriptor: grpc_pb2.NDArrayValue) -> np.ndarray:
+    iq16 = descriptor.dtype == IQ16
     try:
-        dtype = np.dtype(descriptor.dtype)
+        dtype = np.dtype(np.int16) if iq16 else np.dtype(descriptor.dtype)
     except (TypeError, ValueError) as exc:
         raise ValueError(f"invalid ndarray dtype: {descriptor.dtype!r}") from exc
 
     shape = tuple(int(item) for item in descriptor.shape)
-    expected = _validate_ndarray(dtype, shape)
+    expected = _validate_ndarray(dtype, shape + (2,) if iq16 else shape)
     actual = len(descriptor.data)
     if actual != expected:
         raise ValueError(
             f"ndarray byte length mismatch: expected {expected}, got {actual}"
         )
+    if iq16:
+        iq = np.frombuffer(descriptor.data, dtype=dtype).reshape(shape + (2,))
+        return (iq[..., 0].astype(np.float32) + 1j * iq[..., 1].astype(np.float32)).astype(np.complex64)
     return np.frombuffer(descriptor.data, dtype=dtype).reshape(shape).copy()
 
 

remoteRF/config/cert_fetcher.py

@@ -20,6 +20,7 @@ from __future__ import annotations
 import hashlib
 import os
 import socket
+import urllib.error
 import urllib.request
 from pathlib import Path
 from typing import Optional
@@ -38,6 +39,26 @@ def _ensure_parent_dir(p: Path) -> None:
 def _looks_like_pem_cert(data: bytes) -> bool:
     return b"BEGIN CERTIFICATE" in data and b"END CERTIFICATE" in data
 
+
+def looks_like_pem_cert(data: bytes) -> bool:
+    """Public alias of `_looks_like_pem_cert` for generic callers."""
+    return _looks_like_pem_cert(data)
+
+
+def fetch_ca_bytes(host: str, port: int, *, timeout_sec: float = 3.0) -> bytes:
+    """Fetch raw CA certificate bytes (HTTP first, then raw-TCP fallback),
+    without writing anything to disk. Shared by direct-mode's
+    `fetch_and_save_ca_cert` below.
+    """
+    try:
+        return _fetch_http(host, port, timeout_sec)
+    except urllib.error.URLError as exc:
+        if isinstance(exc.reason, (OSError, socket.timeout)):
+            raise  # nothing answered: a raw retry would only wait the timeout again
+        return _fetch_raw_tcp(host, port, timeout_sec)
+    except Exception:
+        return _fetch_raw_tcp(host, port, timeout_sec)
+
 def sha256_fingerprint_pem(pem_bytes: bytes) -> str:
     h = hashlib.sha256(pem_bytes).hexdigest()
     return ":".join(h[i:i+2] for i in range(0, len(h), 2))
@@ -48,9 +69,16 @@ def _fetch_http(host: str, port: int, timeout_sec: float) -> bytes:
     with urllib.request.urlopen(req, timeout=timeout_sec) as resp:
         return resp.read()
 
+def _bare_host(host: str) -> str:
+    """Strip IPv6 literal brackets (e.g. '[::1]' -> '::1') for raw-socket use."""
+    host = host.strip()
+    if host.startswith("[") and host.endswith("]"):
+        return host[1:-1]
+    return host
+
 def _fetch_raw_tcp(host: str, port: int, timeout_sec: float) -> bytes:
     chunks: list[bytes] = []
-    with socket.create_connection((host, port), timeout=timeout_sec) as s:
+    with socket.create_connection((_bare_host(host), port), timeout=timeout_sec) as s:
         s.settimeout(timeout_sec)
         while True:
             try:
@@ -164,10 +192,7 @@ def fetch_and_save_ca_cert(
             return True
 
         # Fetch (HTTP first, then raw TCP fallback)
-        try:
-            data = _fetch_http(host, port, timeout_sec)
-        except Exception:
-            data = _fetch_raw_tcp(host, port, timeout_sec)
+        data = fetch_ca_bytes(host, port, timeout_sec=timeout_sec)
 
         if not data or not _looks_like_pem_cert(data):
             return False

remoteRF/config/config.py

@@ -18,6 +18,7 @@
 from __future__ import annotations
 
 import os
+import socket
 import sys
 import shutil
 from pathlib import Path
@@ -68,6 +69,27 @@ def _parse_hostport(s: str) -> Tuple[str, int]:
         raise ValueError("Port out of range")
     return host, port
 
+
+def _bare_host(host: str) -> str:
+    """Strip IPv6 literal brackets (e.g. '[::1]' -> '::1') for name/address
+    resolution and raw-socket use. IPv4 addresses and DNS hostnames
+    (including plain multi-label names such as ucla.global.remoterf.net)
+    are returned unchanged.
+    """
+    host = host.strip()
+    if host.startswith("[") and host.endswith("]"):
+        return host[1:-1]
+    return host
+
+
+def _host_resolves(host: str) -> bool:
+    """Return True if `host` (an IPv4/IPv6 literal or DNS hostname) resolves."""
+    try:
+        socket.getaddrinfo(_bare_host(host), None)
+        return True
+    except socket.gaierror:
+        return False
+
 def _write_env_kv(path: Path, kv: dict[str, str]) -> None:
     path.parent.mkdir(parents=True, exist_ok=True)
     lines: list[str] = []
@@ -151,21 +173,57 @@ def _print_config_summary(host: str, grpc_port: int, cert_port: int, ca_out: Pat
     _print_separator()
 
 
-def _confirm_tos() -> bool:
+def _confirm_tos(question: str = "Continue with configuration? [y/N]: ",
+                 cancelled: str = "Configuration cancelled.") -> bool:
     _print_separator()
     _print_tos_notice()
     _print_separator()
     try:
-        reply = input("Continue with configuration? [y/N]: ").strip().lower()
-    except KeyboardInterrupt:
-        print("\nConfiguration cancelled.")
-        return False
-    except EOFError:
-        print("\nConfiguration cancelled.")
+        reply = input(question).strip().lower()
+    except (KeyboardInterrupt, EOFError):
+        print(f"\n{cancelled}")
         return False
     print()
     return reply in {"y", "yes"}
 
+
+# The one remembered agreement, for logins. A registration always asks anew
+# and forgets this first, so a declined or abandoned `-r` means the next
+# login asks again.
+def _tos_agreement_path():
+    from ..deployment.state import root
+
+    return root() / "tos-agreed.json"
+
+
+def tos_agreed() -> bool:
+    return _tos_agreement_path().exists()
+
+
+def remember_tos_agreement() -> None:
+    from datetime import datetime, timezone
+
+    from ..deployment.state import private_write
+
+    private_write(_tos_agreement_path(), {"agreed_at": datetime.now(timezone.utc).isoformat()})
+
+
+def forget_tos_agreement() -> None:
+    try:
+        _tos_agreement_path().unlink()
+    except FileNotFoundError:
+        pass
+
+
+def require_tos_for_login() -> bool:
+    """Ask once, then remember -- until a registration clears it."""
+    if tos_agreed():
+        return True
+    if not _confirm_tos("Do you agree to the RemoteRF Terms of Service? [y/N]: ", "Login cancelled."):
+        return False
+    remember_tos_agreement()
+    return True
+
 def configure(host: str, port: int, cert_port: int) -> int:
     # Basic validation
     host = (host or "").strip()
@@ -176,6 +234,16 @@ def configure(host: str, port: int, cert_port: int) -> int:
         print("Error: port out of range", file=sys.stderr)
         return 2
 
+    if not _host_resolves(host):
+        print(
+            "Error: Could not resolve RemoteRF server hostname:\n"
+            f"  {host}\n"
+            "Check the address and your network/DNS connection, then re-run:\n"
+            "  remoterf --config --addr <host:port>",
+            file=sys.stderr,
+        )
+        return 1
+
     grpc_port = int(port)
     cert_port = int(cert_port)
 
@@ -208,6 +276,15 @@ def configure(host: str, port: int, cert_port: int) -> int:
         "REMOTERF_CA_CERT": str(ca_out),
         "REMOTERF_PROFILE": profile,
     })
+    # This profile is what the "default" home was adopted from. A new address
+    # or a re-fetched CA makes that adoption stale (its pin would now refuse
+    # this very server), so drop it and let the next login adopt this one.
+    try:
+        from ..deployment import homes
+
+        homes.forget_home(profile)
+    except Exception:  # noqa: BLE001 - never fail configuration over bookkeeping
+        pass
 
     _print_config_summary(host, grpc_port, cert_port, ca_out, env_file)
 

remoteRF/core/acc_login.py

@@ -13,7 +13,14 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-from . import app as client
-
-def main():
-    pass
+def main(*, register=False, enrollment_code=None, server_label=None, show_banner=True,
+         home=None, route=None):
+    from .app import run
+    return run(
+        register=register,
+        enrollment_code=enrollment_code,
+        server_label=server_label,
+        show_banner=show_banner,
+        home=home,
+        route=route,
+    )