Modules reference

satnogsclient

SatNOGS Client module initialization

satnogsclient.main()

Main function

satnogsclient.locator.locator

class satnogsclient.locator.locator.Locator

static show_location(gpsd)

update_location()

satnogsclient.observer.commsocket

satnogsclient.observer.observer

class satnogsclient.observer.observer.Observer

observe()

Starts threads for rotcrl and rigctl.

plot_waterfall(waterfall)

poll_gnu_proc_status(flowgraph)

remove_waterfall_file()

rename_data_file()

rename_ogg_file()

run_rig()

run_rot()

setup(observation_id, tle, observation_end, frequency, mode, baud)

Sets up required internal variables. * returns True if setup is ok * returns False if issue is encountered

satnogsclient.observer.observer.post_artifacts(artifacts_file, observation_id)

satnogsclient.observer.orbital

satnogsclient.observer.orbital.pinpoint(observer_dict, satellite_dict, timestamp=None)

Provides azimuth and altitude of tracked object.

args:

observer_dict: dictionary with details of observation point. satellite_dict: dictionary with details of satellite. time: timestamp we want to use for pinpointing the observed object.

returns:

Dictionary containing azimuth, altitude and “ok” for error detection.

satnogsclient.artifacts

class satnogsclient.artifacts.Artifacts(waterfall, observation_id)

create()

satnogsclient.waterfall

exception satnogsclient.waterfall.EmptyArrayError

Empty data array exception

class satnogsclient.waterfall.Waterfall(datafile_path)

Parse waterfall data file

Parameters

datafile_path (str_array) – Path to data file

plot(figure_path, vmin=None, vmax=None)

Plot waterfall into a figure

Parameters

• figure_path (str) – Path of figure file to save

• value_range (tuple) – Minimum and maximum value range

satnogsclient.waterfall._compress_waterfall(waterfall)

Compress spectra of waterfall

Parameters

waterfall (dict) – Watefall data

Returns

Compressed spectra

Return type

dict

satnogsclient.waterfall._get_waterfall(datafile_path)

Get waterfall data

Parameters

datafile_path (str_array) – Path to data file

Returns

Waterfall data including compressed data

Return type

dict

satnogsclient.waterfall._read_waterfall(datafile_path)

Read waterfall data file

Parameters

datafile_path (str) – Path to data file

Returns

Waterfall data

Return type

dict

satnogsclient.observer.worker

class satnogsclient.observer.worker.Worker(time_to_stop=None, sleep_time=None)

Class to facilitate as a worker for rotctl/rigctl.

_communicate_tracking_info()

_observation_end = None

_sleep_time = 0.1

_stay_alive = False

property is_alive

Returns if tracking loop is alive or not.

observer_dict = {}

satellite_dict = {}

send_to_socket(pin, sock)

trackobject(observer_dict, satellite_dict)

Sets tracking object. Can also be called while tracking to manipulate observation.

Parameters

• observer_dict – Location of the Observer, example: {‘lon’: 0.0, ‘lat’: 0.0, ‘elev’:0.0}

• satellite_dict – TLE of the satellite, example: {‘tle0’: ‘’, ‘tle1’: ‘’, ‘tle2’: ‘’}

trackstart()

Starts the thread that communicates tracking info to remote socket. Stops by calling trackstop()

trackstop()

Sets object flag to false and stops the tracking thread.

class satnogsclient.observer.worker.WorkerFreq(ip, port, **kwargs)

_communicate_tracking_info()

Runs as a daemon thread, communicating tracking info to remote socket. Uses observer and satellite objects set by trackobject(). Will exit when observation_end timestamp is reached.

_frequency = None

send_to_socket(pin, sock)

trackobject(frequency, observer_dict, satellite_dict)

Parameters

• frequency – Frequency of original signal in Hz

• observer_dict – Location of the Observer example: {‘lon’: 0.0, ‘lat’: 0.0, ‘elev:0.0}

• satellite_dict – TLE of the satellite example: {‘tle0’: ‘’, ‘tle1’: ‘’, ‘tle2’: ‘’}

class satnogsclient.observer.worker.WorkerTrack(port, **kwargs)

_altitude = None

_azimuth = None

_communicate_tracking_info()

Runs as a daemon thread, communicating tracking info to remote socket. Uses observer and satellite objects set by trackobject(). Will exit when observation_end timestamp is reached.

_flip = False

_midpoint = None

static find_midpoint(observer_dict, satellite_dict, start)

static flip_coordinates(azi, alt, timestamp, midpoint)

static normalize_angle(num, lower=0, upper=360)

send_to_socket(pin, sock)

trackobject(*args)

Parameters

*args –

Positional Arguments of parent class Worker

satnogsclient.rig

class satnogsclient.rig.Rig(model=Hamlib.RIG_MODEL_DUMMY, path='', debug=Hamlib.RIG_DEBUG_WARN)

Communicate and interface with rigs

Parameters

• model – Model of Hamlib rig

• path (str, optional) – Path or address to Hamlib rig device

• debug (int, optional) – Hamlib rig debug level

close()

Close Hamlib rig device

property frequency

Get rig frequency

Returns

Rig frequency

Return type

float

open()

Open Hamlib rig device

property vfo

Get active VFO

Returns

Active VFO

Return type

int

satnogsclient.rotator

class satnogsclient.rotator.Rotator(model, baud, port)

Communicate and interface with rotators

Parameters

• model (str) – Model of rotator e.g. “ROT_MODEL_EASYCOMM3” or “ROT_MODEL_DUMMY”

• baud (int) – The baud rate of serial communication, e.g. 19200

• port (str) – The port of the rotator, e.g. “/dev/ttyUSB0”

close()

End the communication with rotator

get_conf(cmd)

Return the configuration of a register

Parameters

pos (int) – Number of the register

Returns

Value of register

Return type

str

get_info()

Return information about the rotator

move(direction, speed)

Move the rotator with speed (mdeg/s) to specific direction

Parameters

• direction (str) – The direction of movent, e.g. ROT_MOVE_UP, ROT_MOVE_DOWN, ROT_MOVE_LEFT, ROT_MOVE_RIGHT

• speed (int) – The velocity set point in mdeg/s

open()

Start the communication with rotator

park()

Move the rotator to park position and return the current position

property position

Return the position in degrees of azimuth and elevation

Returns

Position in degrees

Return type

tuple(float, float)

reset()

Move the rotator to home position and return the current position

stop()

Stop the rotator and return the current position

satnogsclient.scheduler.tasks

satnogsclient.scheduler.tasks.get_jobs()

Query SatNOGS Network API to GET jobs.

satnogsclient.scheduler.tasks.keep_or_remove_file(filename)

satnogsclient.scheduler.tasks.post_data()

PUT observation data back to Network API.

satnogsclient.scheduler.tasks.spawn_observer(**kwargs)

satnogsclient.scheduler.tasks.status_listener()

satnogsclient.settings

SatNOGS Client settings file

satnogsclient.settings._cast_or_none(func, value)

satnogsclient.settings.validate(logger)

Validate the provided settings: - Check for the existance of all required variables - Validate format of the provided value for some required variables

Since this module has to be loaded before the logger has been initialized, this method requires a configured logger to be passed.

Arguments: logger – the output logger

satnogsclient.radio.flowgraphs

class satnogsclient.radio.flowgraphs.Flowgraph(device, sampling_rate, frequency, mode, baud, output_data)

Execute SatNOGS Flowgraphs

Parameters

• device (str) – SoapySDR device

• sampling_rate (int) – Sampling rate

• frequency (int) – RX frequency

• mode (str) – Mode of operation

• baud (int) – Baud rate or WPM

• output_data (dict) – Dictionary of output data

property enabled

Get flowgraph running status

Returns

Flowgraph running status

Return type

bool

property info

Get information and parameters of flowgraph and radio

Returns

Information about flowgraph and radio

Return type

dict