remoterf 0.0.7.21

A python API to remotely access signal centric hardware. Client-side only!

Remote RF

A python API to remotely access signal centric hardware.

Courtesy of Wireless Lab @ UCLA. - Ethan Ge

Prerequisites

• Python 3.10: This package works in Python 3.10+. If you don’t have Python installed, you can download it from the official Python website.

To check your current Python version, open a terminal and run:

python --version

• UCLA VPN: Please ensure that you are connected to the UCLA VPN. You can download and configure the VPN client from the following link: UCLA VPN Client Download. If you’re not connected to the VPN, you will not have access to the lab servers.

Installation

Use the package manager pip to install remoteRF. It is recommended that you install this package within a virtual environment.

python3 -m venv venv        # Create virtual environment
source venv/bin/activate    # Activate virtual environment

pip install remoteRF        # Install remoteRF

If pip install doesn't work, you can clone the source directly from github.

Reservation

Usage of the platform requires you to register a account and reserve a device in order to run scripts remotely.

1. Start UCLA VPN

• Start the CISCO Secure client, login and connect to any of the options.

2. Register a account:

remoterf-login  
# Run in the terminal 
# where the Python library is installed

# Typically, this will be the terminal where you’ve activated the virtual environment if you’re using one

• Input r to register a account, or l to login to a existing one.

Welcome to Remote RF Account System.
Please login or register to continue. (l/r):

• Once in, input help to see all avaliable commands.

3. Reserve Device:

getdev  # To view all avaliable devices

# Note the device ID. You will need this later to reserve said device

getres  # To view times not avaliable

# Optionally, you can also view all reservations, and determine a time slot you want a specific device reserved

perms   # To view your permissions

# Depending on your permission levels, you will be given different restrictions 

resdev # To reserve a device

# Input the number of days you want to view, and it will display available reservations in that time span.

Reservation successful. Thy Token -> example_token

# Take note of this token. You will need it to actually access the device.

Remote Access

With this token, you can now run scripts remotely. Please keep in mind that you MUST be connected to the UCLA VPN for this to work. Here is a explained sample script to get you going!

Python Script:

from remoteRF.drivers.adalm_pluto import *  # Imports device Pluto SDR remote drivers. Change depending on desired device.

sdr = adi.Pluto(    # Device initialization.
    token = 'example_token'     # Place the prior token here.
)

# You can now use this 'sdr' as you normally would with the default Pluto drivers.

If converting a existing non-remoteRF compatible script:

- import existing_device_drivers 

+ from remoteRF.drivers.device_drivers import *

- device = device(init)

+ device = device(token = 'sample_token')

Nothing else needs changing!

Closing

This is fundamentally a experimental platform, and there will be many unknown bugs and issues. Some devices do not have universal support for all its functions at the moment, I am working on that aspect.

So please submit feedback!