remoteRF-server 0.2.4__tar.gz → 1.0.1__tar.gz

{remoterf_server-0.2.4 → remoterf_server-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: remoteRF-server
-Version: 0.2.4
+Version: 1.0.1
 Summary: RemoteRF server-side control package
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown

{remoterf_server-0.2.4 → remoterf_server-1.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "remoteRF-server"
-version = "0.2.4"
+version = "1.0.1"
 description = "RemoteRF server-side control package"
 requires-python = ">=3.8"
 dependencies = [

{remoterf_server-0.2.4 → remoterf_server-1.0.1}/src/remoteRF_server/common/grpc/grpc_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: grpc.proto
-# Protobuf Python Version: 5.29.0
+# Protobuf Python Version: 5.27.1
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,8 +12,8 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    29,
-    0,
+    27,
+    1,
     '',
     'grpc.proto'
 )
@@ -24,7 +24,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\ngrpc.proto\x12\tremote_rf\"\xa2\x01\n\x11GenericRPCRequest\x12\x15\n\rfunction_name\x18\x01 \x01(\t\x12\x34\n\x04\x61rgs\x18\x02 \x03(\x0b\x32&.remote_rf.GenericRPCRequest.ArgsEntry\x1a@\n\tArgsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\"\n\x05value\x18\x02 \x01(\x0b\x32\x13.remote_rf.Argument:\x02\x38\x01\"\x96\x01\n\x12GenericRPCResponse\x12;\n\x07results\x18\x01 \x03(\x0b\x32*.remote_rf.GenericRPCResponse.ResultsEntry\x1a\x43\n\x0cResultsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\"\n\x05value\x18\x02 \x01(\x0b\x32\x13.remote_rf.Argument:\x02\x38\x01\"\x19\n\nArrayShape\x12\x0b\n\x03\x64im\x18\x01 \x03(\x05\"+\n\rComplexNumber\x12\x0c\n\x04real\x18\x01 \x01(\x02\x12\x0c\n\x04imag\x18\x02 \x01(\x02\"a\n\x11\x43omplexNumpyArray\x12$\n\x05shape\x18\x01 \x01(\x0b\x32\x15.remote_rf.ArrayShape\x12&\n\x04\x64\x61ta\x18\x02 \x03(\x0b\x32\x18.remote_rf.ComplexNumber\"D\n\x0eRealNumpyArray\x12$\n\x05shape\x18\x01 \x01(\x0b\x32\x15.remote_rf.ArrayShape\x12\x0c\n\x04\x64\x61ta\x18\x02 \x03(\x02\"\xd7\x01\n\x08\x41rgument\x12\x16\n\x0cstring_value\x18\x01 \x01(\tH\x00\x12\x15\n\x0bint64_value\x18\x02 \x01(\x03H\x00\x12\x15\n\x0b\x66loat_value\x18\x03 \x01(\x02H\x00\x12\x14\n\nbool_value\x18\x04 \x01(\x08H\x00\x12\x35\n\rcomplex_array\x18\x05 \x01(\x0b\x32\x1c.remote_rf.ComplexNumpyArrayH\x00\x12/\n\nreal_array\x18\x06 \x01(\x0b\x32\x19.remote_rf.RealNumpyArrayH\x00\x42\x07\n\x05value2Q\n\nGenericRPC\x12\x43\n\x04\x43\x61ll\x12\x1c.remote_rf.GenericRPCRequest\x1a\x1d.remote_rf.GenericRPCResponseB\x1e\n\x10\x63om.example.demoB\nDemoProtosb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\ngrpc.proto\x12\tremote_rf\"\xa2\x01\n\x11GenericRPCRequest\x12\x15\n\rfunction_name\x18\x01 \x01(\t\x12\x34\n\x04\x61rgs\x18\x02 \x03(\x0b\x32&.remote_rf.GenericRPCRequest.ArgsEntry\x1a@\n\tArgsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\"\n\x05value\x18\x02 \x01(\x0b\x32\x13.remote_rf.Argument:\x02\x38\x01\"\x96\x01\n\x12GenericRPCResponse\x12;\n\x07results\x18\x01 \x03(\x0b\x32*.remote_rf.GenericRPCResponse.ResultsEntry\x1a\x43\n\x0cResultsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\"\n\x05value\x18\x02 \x01(\x0b\x32\x13.remote_rf.Argument:\x02\x38\x01\"\x19\n\nArrayShape\x12\x0b\n\x03\x64im\x18\x01 \x03(\x05\"+\n\rComplexNumber\x12\x0c\n\x04real\x18\x01 \x01(\x02\x12\x0c\n\x04imag\x18\x02 \x01(\x02\"a\n\x11\x43omplexNumpyArray\x12$\n\x05shape\x18\x01 \x01(\x0b\x32\x15.remote_rf.ArrayShape\x12&\n\x04\x64\x61ta\x18\x02 \x03(\x0b\x32\x18.remote_rf.ComplexNumber\"D\n\x0eRealNumpyArray\x12$\n\x05shape\x18\x01 \x01(\x0b\x32\x15.remote_rf.ArrayShape\x12\x0c\n\x04\x64\x61ta\x18\x02 \x03(\x02\"\xed\x01\n\x08\x41rgument\x12\x16\n\x0cstring_value\x18\x01 \x01(\tH\x00\x12\x15\n\x0bint64_value\x18\x02 \x01(\x03H\x00\x12\x15\n\x0b\x66loat_value\x18\x03 \x01(\x02H\x00\x12\x14\n\nbool_value\x18\x04 \x01(\x08H\x00\x12\x35\n\rcomplex_array\x18\x05 \x01(\x0b\x32\x1c.remote_rf.ComplexNumpyArrayH\x00\x12/\n\nreal_array\x18\x06 \x01(\x0b\x32\x19.remote_rf.RealNumpyArrayH\x00\x12\x14\n\njson_value\x18\x07 \x01(\tH\x00\x42\x07\n\x05value2Q\n\nGenericRPC\x12\x43\n\x04\x43\x61ll\x12\x1c.remote_rf.GenericRPCRequest\x1a\x1d.remote_rf.GenericRPCResponseB\x1e\n\x10\x63om.example.demoB\nDemoProtosb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -53,7 +53,7 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_REALNUMPYARRAY']._serialized_start=514
   _globals['_REALNUMPYARRAY']._serialized_end=582
   _globals['_ARGUMENT']._serialized_start=585
-  _globals['_ARGUMENT']._serialized_end=800
-  _globals['_GENERICRPC']._serialized_start=802
-  _globals['_GENERICRPC']._serialized_end=883
+  _globals['_ARGUMENT']._serialized_end=822
+  _globals['_GENERICRPC']._serialized_start=824
+  _globals['_GENERICRPC']._serialized_end=905
 # @@protoc_insertion_point(module_scope)

remoterf_server-1.0.1/src/remoteRF_server/common/idl/pluto_mimo_schema.py

@@ -0,0 +1,6 @@
+# Built-in import shim for the packaged ADALM Pluto MIMO schema.
+
+from remoteRF_server.drivers.adalm_pluto.pluto_mimo_schema import (  # noqa: F401
+    PlutoMIMOSchema,
+    connect_pluto_mimo,
+)

{remoterf_server-0.2.4 → remoterf_server-1.0.1}/src/remoteRF_server/common/idl/pluto_schema.py

@@ -1,15 +1,14 @@
-# ~/.config/remoterf/drivers/pluto_schema.py
-#
-# Admin-written schema for ADALM-Pluto devices.
-# Drop this file into the drivers folder, restart the server. Done.
+# SAMPLE schema for ADI Pluto SDR.
+# Place into -> ~/.config/remoterf/drivers and restart server to utilize!
 
-from . import *
+
+from remoteRF_server.common.idl import DeviceSchema, idl_register, idl_expose
 
 import subprocess
 import re
 import adi
 
-# ========================= PLUTO Connection Logic =========================
+# == PLUTO Connection Logic ==
 
 def connect_pluto(*, serial: str):
     serial = (serial or "").strip()
@@ -46,10 +45,11 @@ def connect_pluto(*, serial: str):
 
 # ========================= PLUTO Schema =========================
 
-@idl_register("pluto")
+@idl_register("adalm_pluto")
 class PlutoSchema(DeviceSchema):
 
-    device_type = "pluto"
+    device_type = "adalm_pluto"
+    client_class = "Pluto"
     driver_version = "0.0.1"
 
     @staticmethod
@@ -85,11 +85,13 @@ class PlutoSchema(DeviceSchema):
 
     @idl_expose(kind="get")
     def get_rx_hardwaregain_chan0(self):
-        return self.device.rx_hardwaregain_chan0
+        """RX hardware gain (dB). pyadi-iio attribute: hardwaregain_chan0"""
+        return self.device.hardwaregain_chan0
 
     @idl_expose(kind="set")
     def set_rx_hardwaregain_chan0(self, value):
-        self.device.rx_hardwaregain_chan0 = value
+        """RX hardware gain (dB). pyadi-iio attribute: hardwaregain_chan0"""
+        self.device.hardwaregain_chan0 = value
 
     @idl_expose(kind="get")
     def get_tx_hardwaregain_chan0(self):
@@ -171,4 +173,57 @@ class PlutoSchema(DeviceSchema):
 
     @idl_expose(kind="call")
     def call_tx_destroy_buffer(self):
-        self.device.tx_destroy_buffer()
+        self.device.tx_destroy_buffer()
+
+    @idl_expose(kind="call")
+    def call_disable_dds(self):
+        """Disable the internal DDS tone generator."""
+        self.device.disable_dds()
+
+    # endregion
+
+    # region ip / repr
+
+    @idl_expose(kind="call")
+    def call_ip(self):
+        """Return a connection identifier for this device (ping / verify)."""
+        try:
+            return str(self.device.uri)
+        except AttributeError:
+            return str(self.device._uri_auto)
+
+    @idl_expose(kind="get")
+    def get_repr(self):
+        """Return repr() of the underlying device object."""
+        return repr(self.device)
+
+    # endregion
+
+    # region _dec_int_fpga_filter
+
+    @idl_expose(kind="get")
+    def get_rx_dec8_filter_en(self):
+        """rx_dec8_filter_en: Enable decimate-by-8 filter in FPGA"""
+        return bool(self.device.rx_dec8_filter_en)
+
+    @idl_expose(kind="set")
+    def set_rx_dec8_filter_en(self, value):
+        """rx_dec8_filter_en: Enable decimate-by-8 filter in FPGA"""
+        self.device.rx_dec8_filter_en = value
+
+    @idl_expose(kind="get")
+    def get_tx_int8_filter_en(self):
+        """tx_int8_filter_en: Enable interpolate-by-8 filter in FPGA"""
+        return bool(self.device.tx_int8_filter_en)
+
+    @idl_expose(kind="set")
+    def set_tx_int8_filter_en(self, value):
+        """tx_int8_filter_en: Enable interpolate-by-8 filter in FPGA"""
+        self.device.tx_int8_filter_en = value
+
+    @idl_expose(kind="get")
+    def get_rates(self):
+        """Get decimation/interpolation rates from the FPGA filter block."""
+        return self.device._get_rates(self.device._rxadc, False)
+
+    # endregion

{remoterf_server-0.2.4 → remoterf_server-1.0.1}/src/remoteRF_server/common/idl/schema.py

@@ -24,6 +24,7 @@ That's it. The server never needs to be modified.
 from __future__ import annotations
 
 import hashlib
+import inspect
 import importlib.util
 import json
 import sys
@@ -259,11 +260,13 @@ class DeviceSchema:
             if ex.kind == "get":
                 getters[name] = entry
             elif ex.kind == "set":
+                entry["args"] = self._args_metadata(ex, skip_self=True)
                 setters[name] = entry
             elif ex.kind == "call":
+                entry["args"] = self._args_metadata(ex, skip_self=True)
                 calls[name] = entry
 
-        return {
+        body = {
             "schema_version": "1.0",
             "device_type": self.device_type,
             "driver_version": self.driver_version,
@@ -272,6 +275,104 @@ class DeviceSchema:
             "calls": calls,
         }
 
+        client_class = getattr(self, "client_class", "")
+        if client_class:
+            body["client_class"] = str(client_class)
+
+        return body
+
+    def _args_metadata(self, ex: "_Exposed", *, skip_self: bool) -> list[dict]:
+        sig = inspect.signature(ex.fn)
+        args = []
+        for pname, param in sig.parameters.items():
+            if skip_self and pname == "self":
+                continue
+            if param.kind is inspect.Parameter.POSITIONAL_ONLY:
+                raise TypeError(
+                    f"{self.device_type}.{ex.name} cannot expose positional-only "
+                    f"parameter {pname!r}"
+                )
+            if param.kind in (inspect.Parameter.VAR_POSITIONAL, inspect.Parameter.VAR_KEYWORD):
+                raise TypeError(
+                    f"{self.device_type}.{ex.name} cannot be exposed with "
+                    f"{param.kind.description} parameter {pname!r}"
+                )
+
+            item = {
+                "name": pname,
+                "required": param.default is inspect.Parameter.empty,
+                "type": self._annotation_name(param.annotation),
+                "kind": (
+                    "keyword_only"
+                    if param.kind is inspect.Parameter.KEYWORD_ONLY
+                    else "positional_or_keyword"
+                ),
+            }
+            if param.default is not inspect.Parameter.empty:
+                item["default"] = self._json_default(ex, pname, param.default)
+            args.append(item)
+        return args
+
+    @staticmethod
+    def _annotation_name(annotation: Any) -> str:
+        if annotation is inspect.Parameter.empty:
+            return "any"
+        if isinstance(annotation, str):
+            return annotation
+        name = getattr(annotation, "__name__", None)
+        if name:
+            return str(name)
+        return str(annotation).replace("typing.", "")
+
+    def _json_default(self, ex: "_Exposed", pname: str, value: Any) -> Any:
+        try:
+            json.dumps(value)
+            return value
+        except TypeError as exc:
+            raise TypeError(
+                f"{self.device_type}.{ex.name} default for {pname!r} is not JSON serializable"
+            ) from exc
+
+    def _bind_exposed_args(
+        self,
+        ex: "_Exposed",
+        args: dict,
+        *,
+        allow_value_alias: bool,
+        allow_first_arg: bool = False,
+    ) -> dict:
+        sig = inspect.signature(ex.fn)
+        bound = {}
+        params = [
+            (pname, param)
+            for pname, param in sig.parameters.items()
+            if pname != "self"
+        ]
+
+        for pname, param in params:
+            if param.kind is inspect.Parameter.POSITIONAL_ONLY:
+                raise TypeError(
+                    f"{self.device_type}.{ex.name} cannot be dispatched with "
+                    f"positional-only parameter {pname!r}"
+                )
+            if param.kind in (inspect.Parameter.VAR_POSITIONAL, inspect.Parameter.VAR_KEYWORD):
+                raise TypeError(
+                    f"{self.device_type}.{ex.name} cannot be dispatched with "
+                    f"{param.kind.description} parameter {pname!r}"
+                )
+
+            if pname in args:
+                bound[pname] = args[pname]
+            elif allow_value_alias and len(params) == 1 and "value" in args:
+                bound[pname] = args["value"]
+            elif allow_first_arg and len(params) == 1 and args:
+                first_key = next(iter(args))
+                bound[pname] = args[first_key]
+            elif param.default is inspect.Parameter.empty:
+                raise TypeError(f"missing required argument {pname!r} for {ex.name}")
+
+        return bound
+
     # ── Dispatch (server RPC layer calls this) ────────────────────
 
     def dispatch(self, method_name: str, args: dict) -> Any:
@@ -297,32 +398,19 @@ class DeviceSchema:
             return ex.fn(self)
 
         elif ex.kind == "set":
-            value = args.get("value")
-            if value is None and "value" not in args:
-                # Also check first positional-style arg key
-                for k, v in args.items():
-                    value = v
-                    break
-            return ex.fn(self, value)
+            call_args = self._bind_exposed_args(
+                ex,
+                args,
+                allow_value_alias=True,
+                allow_first_arg=True,
+            )
+            if not call_args:
+                raise TypeError(f"missing required setter value for {ex.name}")
+            return ex.fn(self, **call_args)
 
         elif ex.kind == "call":
-            # Calls can have 0 or more args
-            # Simple convention: if the function takes 'value', pass it
-            import inspect
-            sig = inspect.signature(ex.fn)
-            params = [p for p in sig.parameters if p != "self"]
-
-            if len(params) == 0:
-                return ex.fn(self)
-            elif len(params) == 1:
-                # Single arg — pull from args dict by param name or "value"
-                pname = params[0]
-                val = args.get(pname, args.get("value"))
-                return ex.fn(self, val)
-            else:
-                # Multi-arg — match by name
-                call_args = {p: args.get(p) for p in params if p in args}
-                return ex.fn(self, **call_args)
+            call_args = self._bind_exposed_args(ex, args, allow_value_alias=True)
+            return ex.fn(self, **call_args)
         else:
             raise ValueError(f"unknown kind '{ex.kind}' on {method_name}")
 
@@ -355,4 +443,4 @@ class _Exposed:
         self.name = name
         self.fn = fn
         self.kind = kind
-        self.doc = doc
+        self.doc = doc

remoterf_server-1.0.1/src/remoteRF_server/common/utils/process_arg.py

@@ -0,0 +1,153 @@
+from ..grpc import grpc_pb2, grpc_pb2_grpc
+import json
+import numpy as np
+
+_JSON_TYPE_KEY = "__remoterf_json_type__"
+
+def _json_safe(value):
+    if isinstance(value, np.ndarray):
+        if value.dtype == object:
+            raise ValueError(f"Cannot JSON-map object-dtype array: {value!r}")
+        array = np.asarray(value)
+        if np.iscomplexobj(array):
+            data = [[float(num.real), float(num.imag)] for num in array.ravel()]
+            return {
+                _JSON_TYPE_KEY: "ndarray",
+                "dtype": str(array.dtype),
+                "shape": list(array.shape),
+                "complex": True,
+                "data": data,
+            }
+        return {
+            _JSON_TYPE_KEY: "ndarray",
+            "dtype": str(array.dtype),
+            "shape": list(array.shape),
+            "complex": False,
+            "data": array.tolist(),
+        }
+    if isinstance(value, (np.bool_,)):
+        return bool(value)
+    if isinstance(value, (np.integer,)):
+        return int(value)
+    if isinstance(value, (np.floating,)):
+        return float(value)
+    if isinstance(value, complex):
+        return {_JSON_TYPE_KEY: "complex", "real": float(value.real), "imag": float(value.imag)}
+    if isinstance(value, dict):
+        return {str(key): _json_safe(item) for key, item in value.items()}
+    if isinstance(value, (list, tuple)):
+        return [_json_safe(item) for item in value]
+    return value
+
+def _json_restore(value):
+    if isinstance(value, dict):
+        kind = value.get(_JSON_TYPE_KEY)
+        if kind == "ndarray":
+            shape = tuple(value.get("shape", ()))
+            dtype = value.get("dtype")
+            if value.get("complex"):
+                data = [complex(real, imag) for real, imag in value.get("data", [])]
+                return np.array(data, dtype=dtype or np.complex64).reshape(shape)
+            return np.array(value.get("data", []), dtype=dtype).reshape(shape)
+        if kind == "complex":
+            return complex(value.get("real", 0.0), value.get("imag", 0.0))
+        return {key: _json_restore(item) for key, item in value.items()}
+    if isinstance(value, list):
+        return [_json_restore(item) for item in value]
+    return value
+
+def unmap_arg(arg):
+    if arg.HasField('int64_value'):
+        return arg.int64_value
+    elif arg.HasField('float_value'):
+        return arg.float_value
+    elif arg.HasField('string_value'):
+        return arg.string_value
+    elif arg.HasField('bool_value'):
+        return arg.bool_value
+    elif arg.HasField('real_array'):
+        shape = tuple(arg.real_array.shape.dim)
+        return np.array(arg.real_array.data, dtype=np.float64).reshape(shape)
+    elif arg.HasField('complex_array'):
+        shape = tuple(arg.complex_array.shape.dim)
+        data = [complex(c.real, c.imag) for c in arg.complex_array.data]
+        return np.array(data, dtype=np.complex64).reshape(shape)
+    elif arg.HasField('json_value'):
+        return _json_restore(json.loads(arg.json_value))
+    else:
+        raise ValueError(f"Unknown argument type during unmapping: {arg}")
+    
+def map_arg(value):
+    arg = grpc_pb2.Argument()
+    
+    if isinstance(value, (bool, np.bool_)):
+        arg.bool_value = bool(value)
+    elif value is None or isinstance(value, dict):
+        arg.json_value = json.dumps(_json_safe(value), separators=(",", ":"))
+    elif isinstance(value, (int, np.integer)):
+        arg.int64_value = int(value)
+    elif isinstance(value, (float, np.floating)):
+        arg.float_value = float(value)
+    elif isinstance(value, str):
+        arg.string_value = value
+    elif isinstance(value, (list, tuple)):
+        try:
+            array = np.asarray(value)
+        except Exception:
+            arg.json_value = json.dumps(_json_safe(value), separators=(",", ":"))
+            return arg
+        if array.dtype == object:
+            try:
+                array = np.stack(value)
+            except Exception:
+                arg.json_value = json.dumps(_json_safe(value), separators=(",", ":"))
+                return arg
+        return map_arg(array)
+    elif isinstance(value, np.ndarray):
+        if value.dtype == object:
+            raise ValueError(f"Cannot map object-dtype array: {value!r}")
+        if np.iscomplexobj(value):
+            complex_array = arg.complex_array
+            complex_array.shape.dim.extend(value.shape)
+            for num in np.asarray(value, dtype=np.complex64).ravel():
+                complex_num = complex_array.data.add()
+                complex_num.real = float(num.real)
+                complex_num.imag = float(num.imag)
+        else:
+            float_array = arg.real_array
+            float_array.shape.dim.extend(value.shape)
+            float_array.data.extend(np.asarray(value, dtype=np.float32).ravel())
+    else:
+        raise ValueError(f"Unknown argument type during mapping: {value}")
+    return arg
+        
+def map_array_proto(np_array):
+    arg = grpc_pb2.Argument()
+    
+    # Check if the array is complex
+    if np.iscomplexobj(np_array):
+        complex_array = grpc_pb2.ComplexArray()
+        for num in np_array.flat:
+            complex_number = complex_array.data.add()
+            complex_number.real = num.real
+            complex_number.imag = num.imag
+        arg.complex_array.CopyFrom(complex_array)
+    else:
+        # Handle as a regular float array
+        float_array = grpc_pb2.FloatArray()
+        float_array.data.extend(np_array.flat)
+        arg.float_array.CopyFrom(float_array)
+
+    return arg
+
+def unmap_array_proto(arg):
+    # Check which type of array is available and convert appropriately
+    if arg.HasField('complex_array'):
+        # Convert ComplexArray to a numpy array of complex numbers
+        data = [complex(cn.real, cn.imag) for cn in arg.complex_array.data]
+        return np.array(data, dtype=np.complex64)
+    elif arg.HasField('float_array'):
+        # Convert FloatArray to a numpy array of floats
+        return np.array(arg.float_array.data, dtype=np.float32)
+    else:
+        raise ValueError("Argument does not contain a recognizable array.")