RemoteRF 2.0.11__tar.gz → 2.0.13__tar.gz

{remoterf-2.0.11/src/remoterf.egg-info → remoterf-2.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: remoterf
-Version: 2.0.11
+Version: 2.0.13
 Summary: A python API to remotely access signal centric hardware. Client-side only! Courtesy of Wireless Lab @ UCLA & Prof. Ian Roberts.
 Author: Ethan Ge
 Author-email: ethoGalaxy@gmail.com

{remoterf-2.0.11 → remoterf-2.0.13}/setup.py

@@ -21,7 +21,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="remoterf",
-    version="2.0.11",
+    version="2.0.13",
     author="Ethan Ge",
     author_email="ethoGalaxy@gmail.com",
     description="A python API to remotely access signal centric hardware. Client-side only! Courtesy of Wireless Lab @ UCLA & Prof. Ian Roberts.",

{remoterf-2.0.11 → remoterf-2.0.13}/src/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 = 31
+PANEL_CONTENT_WIDTH = 35
 PANEL_INNER_WIDTH = PANEL_CONTENT_WIDTH + 2
 PANEL_WIDTH = PANEL_INNER_WIDTH + 2
 PANEL_GAP = 1
@@ -113,7 +113,7 @@ def _panel_lines(
     top = f"{top_left}{label}{horizontal * (PANEL_INNER_WIDTH - len(label))}{top_right}"
     content = (
         f"{marker} www.remoterf.net",
-        "Created by E. Ge and I. Roberts",
+        "Created by the Wireless Lab at UCLA",
         f"VERSION  {version}",
         f"SERVER   {server or 'NA'}",
     )

{remoterf-2.0.11 → remoterf-2.0.13}/src/remoteRF/drivers/dynamic_device.py

@@ -1070,6 +1070,8 @@ def _emit_client_object_bindings(client_objects: dict, *, class_name: str) -> li
 # Regular string (not f-string) — {_PREFIX}/{prop}/{e} are literal text
 # that become f-strings inside the *generated* file.
 _HELPERS = '''\
+import os
+
 from importlib import import_module as _import_module
 
 from ...common.utils import map_arg, unmap_arg
@@ -1230,7 +1232,9 @@ def _codegen(schema: dict) -> str:
         f'            self.token = make_virtual_token(token, device_type="{device_type}")',
         "            return",
         '        if token is None:',
-        '            raise ValueError("A reservation token is required unless virtual=True")',
+        '            token = os.getenv("REMOTERF_TOKEN")',
+        '        if not token:',
+        '            raise ValueError("A reservation token is required; pass token= or set REMOTERF_TOKEN")',
         "        self.token = token",
         "        from ..dynamic_device import install_driver_if_stale",
         "        install_driver_if_stale(token=token, current_hash=_SCHEMA_HASH)",

{remoterf-2.0.11 → remoterf-2.0.13}/src/remoteRF/drivers/hackrf/hackrf_remote.py

@@ -14,21 +14,35 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 # Auto-generated from IDL schema — do not edit by hand.
-# device_type: hackrf  driver_version: 0.1.1  schema_hash: sha256:1d6e935e2e33959e753b89d943a1a5696d814ec28aac52a7c39142b3fce89693
+# device_type: hackrf  driver_version: 0.1.1  schema_hash: sha256:6fb625ce99aaf7e190de013ad3e66276265020a5464d9d55d4c0e076dae28f3c
 
 _PREFIX = "Hackrf"
-_SCHEMA_HASH = "sha256:1d6e935e2e33959e753b89d943a1a5696d814ec28aac52a7c39142b3fce89693"
+_SCHEMA_HASH = "sha256:6fb625ce99aaf7e190de013ad3e66276265020a5464d9d55d4c0e076dae28f3c"
 _CLIENT_MODULES = {}
 _CLIENT_OBJECTS = {}
 
+import os
+
 from importlib import import_module as _import_module
 
-from ...core.grpc_client import rpc_client
 from ...common.utils import map_arg, unmap_arg
+from .._virtual import (
+    is_virtual_token,
+    make_virtual_token,
+    virtual_call,
+    virtual_get,
+    virtual_set,
+)
 
 _NO_ARG = object()
 
 
+def _rpc_client(*, function_name, args):
+    from ...core.grpc_client import rpc_client
+
+    return rpc_client(function_name=function_name, args=args)
+
+
 for _alias, _module_path in _CLIENT_MODULES.items():
     globals()[_alias] = _import_module(_module_path)
 
@@ -71,27 +85,34 @@ def _wrap_client_return(spec, self_obj, result):
 
 
 def _try_get(prop, token):
-    return unmap_arg(rpc_client(
+    if is_virtual_token(token):
+        return virtual_get(token, prop)
+    return unmap_arg(_rpc_client(
         function_name=f"{_PREFIX}:{prop}:GET",
         args={'a': map_arg(token)},
     ).results[prop])
 
 
 def _try_set(prop, value, token):
-    rpc_client(
+    if is_virtual_token(token):
+        virtual_set(token, prop, value)
+        return None
+    _rpc_client(
         function_name=f"{_PREFIX}:{prop}:SET",
         args={prop: map_arg(value), 'a': map_arg(token)},
     )
 
 
 def _try_call(prop, token, arg=_NO_ARG):
+    if is_virtual_token(token):
+        return virtual_call(token, prop, arg, has_arg=arg is not _NO_ARG)
     if arg is _NO_ARG:
-        resp = rpc_client(
+        resp = _rpc_client(
             function_name=f"{_PREFIX}:{prop}:CALL0",
             args={'a': map_arg(token)},
         )
     else:
-        resp = rpc_client(
+        resp = _rpc_client(
             function_name=f"{_PREFIX}:{prop}:CALL1",
             args={'a': map_arg(token), 'arg1': map_arg(arg)},
         )
@@ -100,12 +121,15 @@ def _try_call(prop, token, arg=_NO_ARG):
 
 
 def _try_calln(prop, token, kwargs):
+    if is_virtual_token(token):
+        filtered = {key: value for key, value in dict(kwargs).items() if value is not _NO_ARG}
+        return virtual_call(token, prop, filtered, has_arg=True)
     payload = {'a': map_arg(token)}
     for key, value in dict(kwargs).items():
         if value is _NO_ARG:
             continue
         payload[str(key)] = map_arg(value)
-    resp = rpc_client(
+    resp = _rpc_client(
         function_name=f"{_PREFIX}:{prop}:CALLN",
         args=payload,
     )
@@ -114,7 +138,15 @@ def _try_calln(prop, token, kwargs):
 
 class HackRF:
 
-    def __init__(self, token: str):
+    def __init__(self, token: str = None, *, virtual: bool = False):
+        self.virtual = bool(virtual)
+        if self.virtual:
+            self.token = make_virtual_token(token, device_type="hackrf")
+            return
+        if token is None:
+            token = os.getenv("REMOTERF_TOKEN")
+        if not token:
+            raise ValueError("A reservation token is required; pass token= or set REMOTERF_TOKEN")
         self.token = token
         from ..dynamic_device import install_driver_if_stale
         install_driver_if_stale(token=token, current_hash=_SCHEMA_HASH)
@@ -204,6 +236,10 @@ class HackRF:
         'Clear any captured or queued IQ bytes while the radio is idle.'
         return _try_call("clear_buffer", self.token)
 
+    def close(self):
+        'Safely end this remote TX use without closing the server-owned radio.'
+        return _try_call("close", self.token)
+
     def enumerate(self):
         'Return attached serials as a JSON array for broad client compatibility.'
         return _try_call("enumerate", self.token)
@@ -213,7 +249,7 @@ class HackRF:
         return _try_call("get_serial_no", self.token)
 
     def load_tx_iq(self, samples):
-        'Convert normalized IQ samples and load the native transmit buffer.'
+        'Load normalized complex or native interleaved signed-int8 TX IQ.'
         return _try_call("load_tx_iq", self.token, samples)
 
     def read_samples(self, num_samples=_NO_ARG):
@@ -222,6 +258,18 @@ class HackRF:
             "num_samples": num_samples,
         })
 
+    def set_freq(self, value):
+        'Compatibility alias for setting the center frequency in Hz.'
+        return _try_call("set_freq", self.token, value)
+
+    def set_sample_rate(self, value):
+        'Compatibility alias for setting the complex sample rate in Hz.'
+        return _try_call("set_sample_rate", self.token, value)
+
+    def setup(self):
+        'Confirm the already-managed remote HackRF is ready for use.'
+        return _try_call("setup", self.token)
+
     def start_tx(self):
         'Start transmitting the IQ bytes previously loaded with load_tx_iq().'
         return _try_call("start_tx", self.token)

{remoterf-2.0.11 → remoterf-2.0.13/src/remoterf.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: remoterf
-Version: 2.0.11
+Version: 2.0.13
 Summary: A python API to remotely access signal centric hardware. Client-side only! Courtesy of Wireless Lab @ UCLA & Prof. Ian Roberts.
 Author: Ethan Ge
 Author-email: ethoGalaxy@gmail.com

{remoterf-2.0.11 → remoterf-2.0.13}/tests/test_banner.py

@@ -47,11 +47,11 @@ class BannerTests(unittest.TestCase):
             index for index, line in enumerate(lines) if "╭─ REMOTERF CLIENT" in line
         )
         self.assertIn("◆ www.remoterf.net", lines[panel_top + 1])
-        self.assertIn("Created by E. Ge and I. Roberts", lines[panel_top + 2])
+        self.assertIn("Created by the Wireless Lab at UCLA", lines[panel_top + 2])
         self.assertIn("VERSION  2.0.9 (latest)", lines[panel_top + 3])
         self.assertIn("SERVER   192.0.2.10:61005", lines[panel_top + 4])
         self.assertNotIn("STATUS", text)
-        self.assertNotIn("UCLA", text)
+        self.assertIn("UCLA", text)
         self.assertNotIn("TIME", text)
         self.assertTrue(all(len(line) < SIDE_BY_SIDE_MIN_COLUMNS for line in lines))
 
@@ -81,7 +81,7 @@ class BannerTests(unittest.TestCase):
         self.assertIn(ASCII_COMPAT_BANNER.splitlines()[0], text)
         self.assertNotIn("█", text)
         self.assertIn("* www.remoterf.net", text)
-        self.assertIn("Created by E. Ge and I. Roberts", text)
+        self.assertIn("Created by the Wireless Lab at UCLA", text)
         self.assertIn("SERVER   rrf.example:61005", text)
         self.assertNotIn("TIME", text)
 

{remoterf-2.0.11 → remoterf-2.0.13}/tests/test_dynamic_device_codegen.py

@@ -13,6 +13,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
+import os
 import unittest
 import sys
 import tempfile
@@ -413,6 +414,15 @@ class DynamicDeviceCodegenTests(unittest.TestCase):
             exec(code, module.__dict__)
 
             device = module.FakeDevice("token")
+            old_token = os.environ.get("REMOTERF_TOKEN")
+            os.environ["REMOTERF_TOKEN"] = "token-from-env"
+            try:
+                self.assertEqual(module.FakeDevice().token, "token-from-env")
+            finally:
+                if old_token is None:
+                    os.environ.pop("REMOTERF_TOKEN", None)
+                else:
+                    os.environ["REMOTERF_TOKEN"] = old_token
             self.assertEqual(device.status, {"raw": True})
             self.assertEqual(device.echo({"payload": 3}), {"payload": 3})
             self.assertEqual(device.configure(1.0), {"configured": True})
@@ -423,6 +433,7 @@ class DynamicDeviceCodegenTests(unittest.TestCase):
         self.assertEqual(
             [item[0] for item in seen],
             [
+                "Fake_device:ip:CALL0",
                 "Fake_device:ip:CALL0",
                 "Fake_device:status:GET",
                 "Fake_device:echo:CALL1",