remoterf-host-testing 0.0.0__tar.gz

remoterf_host_testing-0.0.0/MANIFEST.in

@@ -0,0 +1 @@
+include hostrf.yml

remoterf_host_testing-0.0.0/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: remoterf-host-testing
+Version: 0.0.0
+Summary: RemoteRF host-side control package
+Author: Ethan Ge
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio
+Requires-Dist: protobuf
+Requires-Dist: numpy
+Requires-Dist: prompt_toolkit
+Requires-Dist: python-dotenv
+Requires-Dist: grpcio-tools
+Requires-Dist: pyyaml
+
+# RemoteRF Host (hostrf) — Linux Setup
+
+## HostRF Installation
+
+The guide is done/verified for Ubuntu Server/Desktop 24.04 LTS.
+
+### 0) If Raspberry Pi
+
+Raspberry Pi Imager → Install Ubuntu Server 24.04 LTS → Boot Raspberry Pi from SD card.
+
+### 1) System Prerequisites (APT)
+
+```bash
+sudo apt update
+sudo apt install -y curl ca-certificates bzip2 git build-essential
+sudo apt install -y libusb-1.0-0 udev
+```
+
+Optional: confirm architecture:
+
+```bash
+uname -m
+```
+
+* `x86_64` → Intel/AMD
+* `aarch64` → ARM64 (Raspberry Pi 64-bit, some servers)
+
+---
+
+### 2) Install Miniconda
+
+### 2.1 Download the installer
+
+#### x86_64
+
+```bash
+cd /tmp
+curl -fsSLO https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
+```
+
+#### ARM64 (aarch64)
+
+```bash
+cd /tmp
+curl -fsSLO https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh
+```
+
+### 2.2 Install (non-interactive, recommended)
+
+#### x86_64
+
+```bash
+bash Miniconda3-latest-Linux-x86_64.sh -b -p "$HOME/miniconda3"
+```
+
+#### ARM64 (aarch64)
+
+```bash
+bash Miniconda3-latest-Linux-aarch64.sh -b -p "$HOME/miniconda3"
+```
+
+### 2.3 Enable conda in your current shell
+
+```bash
+source "$HOME/miniconda3/etc/profile.d/conda.sh"
+conda --version
+```
+
+> If you want conda available automatically in new terminals:
+>
+> ```bash
+> "$HOME/miniconda3/bin/conda" init bash
+> source ~/.bashrc
+> ```
+
+### 2.4 Install **mamba** (default solver)
+
+```bash
+conda install -n base -c conda-forge -y mamba
+mamba --version
+```
+
+Might have to accept anaconda TOS.
+```bash
+conda tos accept --override-channels --channel https://repo.anaconda.com/pkgs/main
+
+conda tos accept --override-channels --channel https://repo.anaconda.com/pkgs/r
+```
+
+### 3) Create the Environment (with mamba (faster))
+
+```bash
+mamba create -n hostrf -y -c conda-forge -c defaults  python=3.10 pip setuptools wheel grpcio protobuf python-dotenv numpy scipy libiio pylibiio libusb
+
+conda activate hostrf
+python -m pip install -U pip
+python -m pip install pyadi-iio remoterf-host
+```
+
+```bash
+sudo reboot now
+```
+
+## HostRF Config
+
+Run the below for a comprehensive overview:
+```bash
+hostrf --help
+```
+
+To get hostrf up and running:
+
+### 1) Point to a RemoteRF server
+
+HostRF requires a RemoteRF Server already setup. See RemoteRF-Server for additional details.
+
+`hostrf` stores its config under: `~/.config/remoterf-host/`
+
+```bash
+hostrf --config --addr <host:port>
+# example:
+hostrf -c -a 164.97.201.67:5000
+hostrf -c -a --show
+```
+
+### 2) Set host parameters
+
+On the remoterf server, run the below:
+
+Example uses 'lab-host-01' as the host name.
+It will return a valid command you can just copy and paste into the host CLI.
+
+```bash
+serverrf --host --token-create lab-host-01 --length 8
+```
+
+Given the parameters/tokens returned, run the below:
+
+```bash
+hostrf --config --host <hostname> \"TOKEN\"
+#example:
+hostrf -c -h lab-host-01 "UTzhag"
+```
+
+<!-- 164.67.195.207:61005 -->
+
+### 3) Connect devices (Adalm Pluto)
+
+To connect plutos to the server:
+
+```bash
+iio_info -s
+```
+
+If the pluto doesn't show up, yet the below works:
+
+```bash
+sudo iio_info -s
+```
+
+Run the below and reboot after: 
+
+```bash
+sudo groupadd -f plugdev
+sudo usermod -aG plugdev "$USER"
+
+sudo tee /etc/udev/rules.d/53-adi-usb.rules >/dev/null <<'EOF'
+# Type the below in
+SUBSYSTEM=="usb", ATTR{idVendor}=="0456", MODE="0660", GROUP="plugdev"
+EOF
+
+sudo udevadm control --reload-rules
+sudo udevadm trigger
+sudo reboot now
+```
+
+
+Look for a 'hw_serial: 104473'. Keep note of said serial per device.
+
+Add pluto to device list. Understand that the device_id (int) needs to be GLOBALLY unique!
+
+```bash
+hostrf --device --add --pluto <id>:<device_name>:<hw_serial>
+
+#Example
+hostrf -d -a --pluto 10:"hostrf pluto 0":104473
+```
+
+Remove device:
+
+```bash
+hostrf -d -remove <id>
+```
+
+Show devices:
+```bash
+hostrf -d --show
+```
+
+Clear all device config:
+```bash
+hostrf -d --wipe
+```
+
+Run to start the host. You should be able to see host on the server if setup properly.
+```bash
+hostrf -s
+```

remoterf_host_testing-0.0.0/README.md

@@ -0,0 +1,208 @@
+# RemoteRF Host (hostrf) — Linux Setup
+
+## HostRF Installation
+
+The guide is done/verified for Ubuntu Server/Desktop 24.04 LTS.
+
+### 0) If Raspberry Pi
+
+Raspberry Pi Imager → Install Ubuntu Server 24.04 LTS → Boot Raspberry Pi from SD card.
+
+### 1) System Prerequisites (APT)
+
+```bash
+sudo apt update
+sudo apt install -y curl ca-certificates bzip2 git build-essential
+sudo apt install -y libusb-1.0-0 udev
+```
+
+Optional: confirm architecture:
+
+```bash
+uname -m
+```
+
+* `x86_64` → Intel/AMD
+* `aarch64` → ARM64 (Raspberry Pi 64-bit, some servers)
+
+---
+
+### 2) Install Miniconda
+
+### 2.1 Download the installer
+
+#### x86_64
+
+```bash
+cd /tmp
+curl -fsSLO https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
+```
+
+#### ARM64 (aarch64)
+
+```bash
+cd /tmp
+curl -fsSLO https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh
+```
+
+### 2.2 Install (non-interactive, recommended)
+
+#### x86_64
+
+```bash
+bash Miniconda3-latest-Linux-x86_64.sh -b -p "$HOME/miniconda3"
+```
+
+#### ARM64 (aarch64)
+
+```bash
+bash Miniconda3-latest-Linux-aarch64.sh -b -p "$HOME/miniconda3"
+```
+
+### 2.3 Enable conda in your current shell
+
+```bash
+source "$HOME/miniconda3/etc/profile.d/conda.sh"
+conda --version
+```
+
+> If you want conda available automatically in new terminals:
+>
+> ```bash
+> "$HOME/miniconda3/bin/conda" init bash
+> source ~/.bashrc
+> ```
+
+### 2.4 Install **mamba** (default solver)
+
+```bash
+conda install -n base -c conda-forge -y mamba
+mamba --version
+```
+
+Might have to accept anaconda TOS.
+```bash
+conda tos accept --override-channels --channel https://repo.anaconda.com/pkgs/main
+
+conda tos accept --override-channels --channel https://repo.anaconda.com/pkgs/r
+```
+
+### 3) Create the Environment (with mamba (faster))
+
+```bash
+mamba create -n hostrf -y -c conda-forge -c defaults  python=3.10 pip setuptools wheel grpcio protobuf python-dotenv numpy scipy libiio pylibiio libusb
+
+conda activate hostrf
+python -m pip install -U pip
+python -m pip install pyadi-iio remoterf-host
+```
+
+```bash
+sudo reboot now
+```
+
+## HostRF Config
+
+Run the below for a comprehensive overview:
+```bash
+hostrf --help
+```
+
+To get hostrf up and running:
+
+### 1) Point to a RemoteRF server
+
+HostRF requires a RemoteRF Server already setup. See RemoteRF-Server for additional details.
+
+`hostrf` stores its config under: `~/.config/remoterf-host/`
+
+```bash
+hostrf --config --addr <host:port>
+# example:
+hostrf -c -a 164.97.201.67:5000
+hostrf -c -a --show
+```
+
+### 2) Set host parameters
+
+On the remoterf server, run the below:
+
+Example uses 'lab-host-01' as the host name.
+It will return a valid command you can just copy and paste into the host CLI.
+
+```bash
+serverrf --host --token-create lab-host-01 --length 8
+```
+
+Given the parameters/tokens returned, run the below:
+
+```bash
+hostrf --config --host <hostname> \"TOKEN\"
+#example:
+hostrf -c -h lab-host-01 "UTzhag"
+```
+
+<!-- 164.67.195.207:61005 -->
+
+### 3) Connect devices (Adalm Pluto)
+
+To connect plutos to the server:
+
+```bash
+iio_info -s
+```
+
+If the pluto doesn't show up, yet the below works:
+
+```bash
+sudo iio_info -s
+```
+
+Run the below and reboot after: 
+
+```bash
+sudo groupadd -f plugdev
+sudo usermod -aG plugdev "$USER"
+
+sudo tee /etc/udev/rules.d/53-adi-usb.rules >/dev/null <<'EOF'
+# Type the below in
+SUBSYSTEM=="usb", ATTR{idVendor}=="0456", MODE="0660", GROUP="plugdev"
+EOF
+
+sudo udevadm control --reload-rules
+sudo udevadm trigger
+sudo reboot now
+```
+
+
+Look for a 'hw_serial: 104473'. Keep note of said serial per device.
+
+Add pluto to device list. Understand that the device_id (int) needs to be GLOBALLY unique!
+
+```bash
+hostrf --device --add --pluto <id>:<device_name>:<hw_serial>
+
+#Example
+hostrf -d -a --pluto 10:"hostrf pluto 0":104473
+```
+
+Remove device:
+
+```bash
+hostrf -d -remove <id>
+```
+
+Show devices:
+```bash
+hostrf -d --show
+```
+
+Clear all device config:
+```bash
+hostrf -d --wipe
+```
+
+Run to start the host. You should be able to see host on the server if setup properly.
+```bash
+hostrf -s
+```

remoterf_host_testing-0.0.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "remoterf-host-testing" 
+version = "0.0.0" 
+description = "RemoteRF host-side control package"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [{ name = "Ethan Ge" }]
+dependencies = [
+  "grpcio",
+  "protobuf",
+  "numpy",
+  "prompt_toolkit",
+  "python-dotenv",
+  "grpcio-tools",
+  "pyyaml",
+]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.scripts]
+hostrf = "remoteRF_host.hostrf_cli:main"
+
+[tool.setuptools.package-data]
+remoteRF_host = ["*.yml"]

remoterf_host_testing-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

remoterf_host_testing-0.0.0/src/remoteRF_host/common/grpc/__init__.py

@@ -0,0 +1,6 @@
+__all__ = [
+    "grpc_pb2",
+    "grpc_pb2_grpc",
+    "grpc_host_pb2",
+    "grpc_host_pb2_grpc",
+]

remoterf_host_testing-0.0.0/src/remoteRF_host/common/grpc/grpc_host_pb2.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: grpc_host.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,
+    '',
+    'grpc_host.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from . import grpc_pb2 as grpc__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0fgrpc_host.proto\x12\x08remoterf\x1a\ngrpc.proto\"A\n\tHostHello\x12\x0f\n\x07host_id\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\t\x12\x12\n\nhost_token\x18\x03 \x01(\t\"^\n\nDeviceInfo\x12\x10\n\x08local_id\x18\x01 \x01(\r\x12\r\n\x05label\x18\x02 \x01(\t\x12\x11\n\tdevice_id\x18\x03 \x01(\t\x12\x0e\n\x06serial\x18\x04 \x01(\t\x12\x0c\n\x04kind\x18\x05 \x01(\t\"_\n\x0e\x44\x65viceAnnounce\x12%\n\x07\x64\x65vices\x18\x01 \x03(\x0b\x32\x14.remoterf.DeviceInfo\x12\x0f\n\x07unix_ms\x18\x02 \x01(\x04\x12\x15\n\rfull_snapshot\x18\x03 \x01(\x08\"\xab\x01\n\nRpcRequest\x12\x0e\n\x06req_id\x18\x01 \x01(\t\x12\x18\n\x10global_device_id\x18\x02 \x01(\r\x12\x17\n\x0flocal_device_id\x18\x03 \x01(\r\x12\x11\n\tdevice_id\x18\x04 \x01(\t\x12-\n\x07request\x18\x05 \x01(\x0b\x32\x1c.remote_rf.GenericRPCRequest\x12\x18\n\x10\x64\x65\x61\x64line_unix_ms\x18\x06 \x01(\x04\"i\n\x0bRpcResponse\x12\x0e\n\x06req_id\x18\x01 \x01(\t\x12\n\n\x02ok\x18\x02 \x01(\x08\x12/\n\x08response\x18\x03 \x01(\x0b\x32\x1d.remote_rf.GenericRPCResponse\x12\r\n\x05\x65rror\x18\x04 \x01(\t\"\x1c\n\tHeartbeat\x12\x0f\n\x07unix_ms\x18\x01 \x01(\x04\"\x18\n\x06\x43\x61ncel\x12\x0e\n\x06req_id\x18\x01 \x01(\t\"e\n\x0bMetaRequest\x12\x0e\n\x06req_id\x18\x01 \x01(\t\x12\x18\n\x10include_platform\x18\x02 \x01(\x08\x12\x13\n\x0binclude_env\x18\x03 \x01(\x08\x12\x17\n\x0finclude_devices\x18\x04 \x01(\x08\"\xb7\x01\n\x08HostMeta\x12\x0f\n\x07host_id\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\t\x12\x0f\n\x07unix_ms\x18\x03 \x01(\x04\x12&\n\x02kv\x18\x04 \x03(\x0b\x32\x1a.remoterf.HostMeta.KvEntry\x12%\n\x07\x64\x65vices\x18\x05 \x03(\x0b\x32\x14.remoterf.DeviceInfo\x1a)\n\x07KvEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"[\n\x0cMetaResponse\x12\x0e\n\x06req_id\x18\x01 \x01(\t\x12\n\n\x02ok\x18\x02 \x01(\x08\x12\r\n\x05\x65rror\x18\x03 \x01(\t\x12 \n\x04meta\x18\x04 \x01(\x0b\x32\x12.remoterf.HostMeta\"\xf7\x02\n\tHostFrame\x12$\n\x05hello\x18\x01 \x01(\x0b\x32\x13.remoterf.HostHelloH\x00\x12\x33\n\x0f\x64\x65vice_announce\x18\x02 \x01(\x0b\x32\x18.remoterf.DeviceAnnounceH\x00\x12+\n\x0brpc_request\x18\x03 \x01(\x0b\x32\x14.remoterf.RpcRequestH\x00\x12-\n\x0crpc_response\x18\x04 \x01(\x0b\x32\x15.remoterf.RpcResponseH\x00\x12(\n\theartbeat\x18\x05 \x01(\x0b\x32\x13.remoterf.HeartbeatH\x00\x12\"\n\x06\x63\x61ncel\x18\x06 \x01(\x0b\x32\x10.remoterf.CancelH\x00\x12-\n\x0cmeta_request\x18\x07 \x01(\x0b\x32\x15.remoterf.MetaRequestH\x00\x12/\n\rmeta_response\x18\x08 \x01(\x0b\x32\x16.remoterf.MetaResponseH\x00\x42\x05\n\x03msg2E\n\nHostTunnel\x12\x37\n\x07\x43onnect\x12\x13.remoterf.HostFrame\x1a\x13.remoterf.HostFrame(\x01\x30\x01\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'grpc_host_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_HOSTMETA_KVENTRY']._loaded_options = None
+  _globals['_HOSTMETA_KVENTRY']._serialized_options = b'8\001'
+  _globals['_HOSTHELLO']._serialized_start=41
+  _globals['_HOSTHELLO']._serialized_end=106
+  _globals['_DEVICEINFO']._serialized_start=108
+  _globals['_DEVICEINFO']._serialized_end=202
+  _globals['_DEVICEANNOUNCE']._serialized_start=204
+  _globals['_DEVICEANNOUNCE']._serialized_end=299
+  _globals['_RPCREQUEST']._serialized_start=302
+  _globals['_RPCREQUEST']._serialized_end=473
+  _globals['_RPCRESPONSE']._serialized_start=475
+  _globals['_RPCRESPONSE']._serialized_end=580
+  _globals['_HEARTBEAT']._serialized_start=582
+  _globals['_HEARTBEAT']._serialized_end=610
+  _globals['_CANCEL']._serialized_start=612
+  _globals['_CANCEL']._serialized_end=636
+  _globals['_METAREQUEST']._serialized_start=638
+  _globals['_METAREQUEST']._serialized_end=739
+  _globals['_HOSTMETA']._serialized_start=742
+  _globals['_HOSTMETA']._serialized_end=925
+  _globals['_HOSTMETA_KVENTRY']._serialized_start=884
+  _globals['_HOSTMETA_KVENTRY']._serialized_end=925
+  _globals['_METARESPONSE']._serialized_start=927
+  _globals['_METARESPONSE']._serialized_end=1018
+  _globals['_HOSTFRAME']._serialized_start=1021
+  _globals['_HOSTFRAME']._serialized_end=1396
+  _globals['_HOSTTUNNEL']._serialized_start=1398
+  _globals['_HOSTTUNNEL']._serialized_end=1467
+# @@protoc_insertion_point(module_scope)

remoterf_host_testing-0.0.0/src/remoteRF_host/common/grpc/grpc_host_pb2_grpc.py

@@ -0,0 +1,97 @@
+# 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 grpc_host_pb2 as grpc__host__pb2
+
+GRPC_GENERATED_VERSION = '1.78.1'
+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},'
+        + ' but the generated code in grpc_host_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 HostTunnelStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Connect = channel.stream_stream(
+                '/remoterf.HostTunnel/Connect',
+                request_serializer=grpc__host__pb2.HostFrame.SerializeToString,
+                response_deserializer=grpc__host__pb2.HostFrame.FromString,
+                _registered_method=True)
+
+
+class HostTunnelServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def Connect(self, request_iterator, 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_HostTunnelServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Connect': grpc.stream_stream_rpc_method_handler(
+                    servicer.Connect,
+                    request_deserializer=grpc__host__pb2.HostFrame.FromString,
+                    response_serializer=grpc__host__pb2.HostFrame.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'remoterf.HostTunnel', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('remoterf.HostTunnel', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class HostTunnel(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def Connect(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(
+            request_iterator,
+            target,
+            '/remoterf.HostTunnel/Connect',
+            grpc__host__pb2.HostFrame.SerializeToString,
+            grpc__host__pb2.HostFrame.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)