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) – 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.SatnogsSetup[source]

Interract with satnogs-setup

request_bootstrap()[source]

Request bootstrapping from satnog-setup

request_setup()[source]

Request installation from satnogs-setup

property satnogs_client_ansible_version

Get installed SatNOGS Client Ansible version

property satnogs_client_version

Get installed SatNOGS Client version

upgrade_system()[source]

Upgrade system packages

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

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(_)[source]

Request setup from configuration management tool

_configbox(menu)[source]

Show scrollbox for viewing configuration

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

_resetyesno(menu)[source]

Reset configuration

Parameters

menu (dict) – Menu dictionary

_submenu(menu)[source]

Show submenu

Parameters

menu (dict) – Menu dictionary

_update(_)[source]

Request tool update

_upgrade(_)[source]

Run system upgrade

_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._load_menu(file)[source]

Load menu structure from YAML file

Parameters

file (file) – Menu file stream

Returns

Menu dictionary

Return type

dict