Modules reference

satnogsconfig

SatNOGS Config module initialization

satnogsconfig.main()[source]

SatNOGS Setup utility

satnogsconfig.config

Configuration module

class satnogsconfig.config.Config(filename)[source]

Manage configuration file

Parameters

filename (str) – File path of configuration

_load_config()[source]

Load and parse YAML configuration

Returns

Configuration dictionary

Return type

dict or NoneType

clear_config()[source]

Clear configuration file

dump_config(to_file=False)[source]

Dump configuration in YAML format

Parameters

to_file (bool, optional) – Dump to file

Returns

YAML configuration

Return type

str

get_variable(variable)[source]

Get variable value from configuration

Parameters

variable (str) – Variable to get the value

Returns

Value of variable

Return type

str or bool or NoneType

set_variable(variable, value)[source]

Set variable value in configuration

Parameters
  • variable (str) – Variable to set the value

  • value (str or bool or NoneType) – Value of variable

satnogsconfig.helpers

Helpers module

class satnogsconfig.helpers.Ansible(ansible_dir)[source]

Call Ansible playbooks

pull(playbooks, url, branch=None, tags=None, extra_args=None)[source]

Pull and run Ansible playbook

Parameters
  • playbooks (list) – List of playbooks

  • url (str) – Git URL to pull playbooks

  • branch (str, optional) – Git branch to pull playbooks

  • tags (list, optional) – List of tags

  • extra_args (list, optional) – List of extra arguments to pass to Ansible

Returns

Whether Ansible execution succeeded

Return type

bool

run(playbooks, tags=None, extra_args=None)[source]

Run Ansible playbook

Parameters
  • playbooks (list) – List of playbooks

  • tags (list, optional) – List of tags

  • extra_args (list, optional) – List of extra arguments to pass to Ansible

Returns

Whether Ansible execution succeeded

Return type

bool

class satnogsconfig.helpers.GrSatnogs[source]

Get and set gr-satnogs configuration

property gr_satnogs_version

Get gr-satnogs version

probe_soapysdr()[source]

Probe SoapySDR hardware

class satnogsconfig.helpers.SatnogsSetup[source]

Interract with satnogs-setup

property gnuradio_version

Get installed gnuradio version

Returns

Version of gr-soapy

Return type

str

property gr_satnogs_version

Get installed gr-satnogs version

Returns

Version of gr-satnogs

Return type

str

property gr_soapy_version

Get installed gr-soapy version

Returns

Version of gr-soapy

Return type

str

property is_applied

Check whether configuration has been applied

Returns

Whether configuration has been applied

Return type

bool

static restart(boot=False)[source]

Restart satnogs-setup script

Parameters

boot (bool, optional) – Whether to bootstrap or not

property satnogs_client_ansible_version

Get installed SatNOGS Client Ansible version

Returns

Version of SatNOGS Client Ansible

Return type

str

property satnogs_client_version

Get installed SatNOGS Client version

Returns

Version of SatNOGS Client

Return type

str

property satnogs_flowgraphs_version

Get installed satnogs-flowgraphs version

Returns

Version of satnogs-flowgraphs

Return type

str

property tags

Get satnogs-setup tags

Returns

Set of tags

Return type

set

upgrade_system()[source]

Upgrade system packages

class satnogsconfig.helpers.Support(config, satnogs_setup, ansible)[source]

Create support information to be used for reporting bugs

dump(*args, **kwargs)[source]

Dump support information

Returns

JSON dump of support information

Return type

str

property info

Support information

Returns

Support information dictionary

Return type

dict

satnogsconfig.menu

Menu module

class satnogsconfig.menu.Menu(menu, config, backtitle=None)[source]

Show a menu structure based on dialog

Parameters
  • menu (dict) – Menu dictionary

  • config (dict) – Configuration dictionary

  • backtitle (str, optional) – Default dialog backtitle

_apply(menu)[source]

Request setup from configuration management tool

_configbox(menu)[source]

Show scrollbox for viewing configuration

Parameters

menu (dict) – Menu dictionary

_exit(menu)[source]

Exit the utility

Parameters

menu (dict) – Menu dictionary

_get_common_options(menu)[source]

Get dialog common options

Parameters

menu (dict) – Menu dictionary

Returns

Common option dictionary

Return type

dict

_msgbox(menu)[source]

Show msgbox

Parameters

menu (dict) – Menu dictionary

_reboot(menu)[source]

Reboot system

Parameters

menu (dict) – Menu dictionary

_resetyesno(menu)[source]

Reset configuration

Parameters

menu (dict) – Menu dictionary

_set_default_backtitle(backtitle=None)[source]

Set backtitle of menu

Parameters

backtitle (str) – Menu backtitle

_submenu(menu)[source]

Show submenu

Parameters

menu (dict) – Menu dictionary

_support(_)[source]

Show support information

_update(_)[source]

Request tool update

_update_stack(menu, response)[source]

Update stack based on dialog responses

Parameters
  • menu (dict) – Menu dictionary

  • response (str) – Dialog response

_variablebox(menu)[source]

Show inputbox for setting a variable

Parameters

menu (dict) – Menu dictionary

_variableyesno(menu)[source]

Show boolean selection for setting a variable

Parameters

menu (dict) – Menu dictionary

property backtitle

Get default backtitle

Returns

Background title

Return type

str

show()[source]

Show dialog menu structure

satnogsconfig.menu._clear_screen()[source]

Clear screen

satnogsconfig.menu._get_variables(menu, name=None, mandatory=False)[source]

Get all menu variable items

Parameters
  • menu (dict) – Menu dictionary

  • name (str, optional) – Name of menu item

  • mandatory (bool, optional) – Return only mandatory variables

Returns

Menu variables dictionary

Return type

dict

satnogsconfig.menu._load_menu(file)[source]

Load menu structure from YAML file

Parameters

file (file) – Menu file stream

Returns

Menu dictionary

Return type

dict

satnogsconfig.menu._reboot()[source]

Reboot system