specpipe

This Python package is automatically generated by the Swagger Codegen project:

• API version: 0.2.1
• Package version: 0.2.1
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/ml4wireless/specpipe-sdk-py.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ml4wireless/specpipe-sdk-py.git)

Then import the package:

import specpipe 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import specpipe

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import specpipe
from specpipe.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = specpipe.DeviceApi(specpipe.ApiClient(configuration))
devicename = 'devicename_example' # str | device name

try:
    # Read FM device configuration
    api_response = api_instance.fm_devices_devicename_get(devicename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->fm_devices_devicename_get: %s\n" % e)

# create an instance of the API class
api_instance = specpipe.DeviceApi(specpipe.ApiClient(configuration))
body = specpipe.UpdateFmDeviceRequest() # UpdateFmDeviceRequest | 
devicename = 'devicename_example' # str | device name

try:
    # Update FM device
    api_response = api_instance.fm_devices_devicename_put(body, devicename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->fm_devices_devicename_put: %s\n" % e)

# create an instance of the API class
api_instance = specpipe.DeviceApi(specpipe.ApiClient(configuration))

try:
    # List FM devices
    api_response = api_instance.fm_devices_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->fm_devices_get: %s\n" % e)

# create an instance of the API class
api_instance = specpipe.DeviceApi(specpipe.ApiClient(configuration))
devicename = 'devicename_example' # str | device name

try:
    # Read IQ device configuration
    api_response = api_instance.iq_devices_devicename_get(devicename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->iq_devices_devicename_get: %s\n" % e)

# create an instance of the API class
api_instance = specpipe.DeviceApi(specpipe.ApiClient(configuration))
body = specpipe.UpdateIqDeviceRequest() # UpdateIqDeviceRequest | 
devicename = 'devicename_example' # str | device name

try:
    # Update IQ device
    api_response = api_instance.iq_devices_devicename_put(body, devicename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->iq_devices_devicename_put: %s\n" % e)

# create an instance of the API class
api_instance = specpipe.DeviceApi(specpipe.ApiClient(configuration))

try:
    # List IQ devices
    api_response = api_instance.iq_devices_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->iq_devices_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /v0

Class	Method	HTTP request	Description
DeviceApi	fm_devices_devicename_get	GET /fm/devices/{devicename}	Read FM device configuration
DeviceApi	fm_devices_devicename_put	PUT /fm/devices/{devicename}	Update FM device
DeviceApi	fm_devices_get	GET /fm/devices	List FM devices
DeviceApi	iq_devices_devicename_get	GET /iq/devices/{devicename}	Read IQ device configuration
DeviceApi	iq_devices_devicename_put	PUT /iq/devices/{devicename}	Update IQ device
DeviceApi	iq_devices_get	GET /iq/devices	List IQ devices

Documentation For Models

• ErrorResponse
• FmDevice
• FmDeviceResponse
• FmDevicesResponse
• IqDevice
• IqDeviceResponse
• IqDevicesResponse
• UpdateFmDeviceRequest
• UpdateIqDeviceRequest