sdrangel/scriptsapi/qo100_datv.py

#!/usr/bin/env python3
"""
Quick control of configuration for receiving QO-100 DATV
"""

import requests, traceback, sys, json, time
from optparse import OptionParser
import sdrangel

base_url_pattern = "http://{0}/sdrangel"
base_url = None

# ======================================================================
def getInputOptions():
    """ Parse options """
# ----------------------------------------------------------------------
    parser = OptionParser(usage="usage: %%prog [-t]\n")
    parser.add_option("-a", "--address", dest="address", help="Address and port. Default: 127.0.0.1:8091", metavar="ADDRESS", type="string")
    parser.add_option("-d", "--device", dest="device_index", help="Index of device set. Default 0", metavar="INT", type="int")
    parser.add_option("-c", "--channel", dest="channel_index", help="Index of DATV demod channel. Default 0", metavar="INT", type="int")
    parser.add_option("-f", "--frequency", dest="frequency", help="Device center frequency (kHz). Mandatory", metavar="INT", type="int")
    parser.add_option("-s", "--symbol-rate", dest="symbol_rate", help="Symbol rate (kS/s). Mandatory", metavar="INT", type="int")
    parser.add_option("-n", "--no-decim", dest="no_decim", help="Do not change decimation", action="store_true")

    (options, args) = parser.parse_args()

    if options.address is None:
        options.address = "127.0.0.1:8091"
    if options.device_index is None:
        options.device_index = 0
    if options.channel_index is None:
        options.channel_index = 0
    if options.frequency is None:
        raise RuntimeError("Frequency (-f or --frequency) is mandatory")
    if options.symbol_rate is None:
        raise RuntimeError("Symbol rate (-s or --symbol-rate) is mandatory")

    return options

# ======================================================================
def change_center_frequency(content, new_frequency):
    """ Change center frequency searching recursively """
# ----------------------------------------------------------------------
    for k in content:
        if isinstance(content[k], dict):
            change_center_frequency(content[k], new_frequency)
        elif k == "centerFrequency":
            content[k] = new_frequency

# ======================================================================
def change_decim(content, new_decim):
    """ Change log2 decimation searching recursively """
# ----------------------------------------------------------------------
    for k in content:
        if isinstance(content[k], dict):
            change_decim(content[k], new_decim)
        elif k == "log2Decim":
            content[k] = new_decim

# ======================================================================
def change_rfbw(content, new_rfbw):
    """ Change RF bandwidth searching recursively """
# ----------------------------------------------------------------------
    for k in content:
        if isinstance(content[k], dict):
            change_rfbw(content[k], new_rfbw)
        elif k == "rfBandwidth":
            content[k] = new_rfbw

# ======================================================================
def change_symbol_rate(content, new_symbol_rate):
    """ Change symbol rate searching recursively """
# ----------------------------------------------------------------------
    for k in content:
        if isinstance(content[k], dict):
            change_symbol_rate(content[k], new_symbol_rate)
        elif k == "symbolRate":
            content[k] = new_symbol_rate

# ======================================================================
def get_device_sr_and_decim(hwtype, settings):
    """ Return device sample rate and decimation """
# ----------------------------------------------------------------------
    if hwtype == "Airspy" or hwtype == "AirspyHF":
        sr_index = settings.get("devSampleRateIndex", 0)
        if sr_index == 1:
            sr = 3000000
        else:
            sr = 6000000
        log2_decim = settings.get("log2Decim", 0)
    else:
        sr = settings.get("devSampleRate", 0)
        log2_decim = settings.get("log2Decim", 0)
    return sr, 1<<log2_decim

# ======================================================================
def calc_decim(device_sr, symbol_rate):
    """ Calculate ideal decimation and return as log2 """
# ----------------------------------------------------------------------
    quot = device_sr // (2*symbol_rate*1000)
    for i in range(6):
        if quot < 1<<i:
            break
    return 0 if i < 1 else i - 1

# ======================================================================
def set_device(options):
    """ Set the device """
# ----------------------------------------------------------------------
    device_settings_url = f"{base_url}/deviceset/{options.device_index}/device/settings"
    r = requests.get(url=device_settings_url)
    if r.status_code // 100 == 2: # OK
        rj = r.json()
        hwtype = rj.get("deviceHwType", None)
        device_settings = rj.get(sdrangel.DEVICE_TYPES[hwtype]["settings"], None)
        device_sr, device_decim = get_device_sr_and_decim(hwtype, device_settings)
        new_decim = calc_decim(device_sr, options.symbol_rate)
        print(f"sr: {device_sr} S/s decim: {device_decim} new decim: {1<<new_decim}")
        if not options.no_decim:
            change_decim(rj, new_decim)
        change_center_frequency(rj, options.frequency*1000)
        r = requests.patch(url=device_settings_url, json=rj)
        if r.status_code / 100 == 2:
            print(f'set_device: changed #{options.device_index}: frequency: {options.frequency} kHz log2Decim: {new_decim} No decim: {options.no_decim}')
        else:
            raise RuntimeError(f'set_device: failed to change device {options.device_index} with error {r.status_code}')
    else:
        raise RuntimeError(f"Cannot get device info for device set index {options.device_index} HTTP return code {r.status_code}")

# ======================================================================
def set_channel(options):
    """ Set the channel - assume DATV demod """
# ----------------------------------------------------------------------
    channel_settings_url = f"{base_url}/deviceset/{options.device_index}/channel/{options.channel_index}/settings"
    r = requests.get(url=channel_settings_url)
    if r.status_code // 100 == 2: # OK
        rj = r.json()
        rfbw = round(1.5*options.symbol_rate)*1000
        change_center_frequency(rj, 0)
        change_rfbw(rj, rfbw)
        change_symbol_rate(rj, options.symbol_rate*1000)
        r = requests.patch(url=channel_settings_url, json=rj)
        if r.status_code / 100 == 2:
            print(f'set_channel: changed {options.device_index}:{options.channel_index}: rfbw: {rfbw} Hz symbol rate: {options.symbol_rate} kS/s')
        else:
            raise RuntimeError(f'set_device: failed to change channel {options.device_index}:{options.channel_index} with error {r.status_code}')
    else:
        raise RuntimeError(f"Cannot get channel info for channel {options.device_index}:{options.channel_index} HTTP return code {r.status_code}")


# ======================================================================
def main():
    """ Main program """
# ----------------------------------------------------------------------
    try:
        options = getInputOptions()

        global base_url
        base_url =  base_url_pattern.format(options.address)
        print(f"Frequency: 10{options.frequency/1000} MHz Symbol rate: {options.symbol_rate} kS/s")
        set_device(options)
        set_channel(options)

    except Exception as ex:
        tb = traceback.format_exc()
        print(tb, file=sys.stderr)

# ======================================================================
if __name__ == "__main__":
    main()