pyobs-gui

This is a pyobs (documentation) module providing a GUI for operating the whole system.

Example configuration

This is an example configuration for a GUI that defines one custom widget for the guiding module:

class: pyobs_gui.GUI

widgets:
  - module: guiding
    overwrite: True
    widget:
      class: mypackage.GuidingWidget

comm:
  jid: test@example.com
  password: ***

timezone: Europe/Berlin
location:
  longitude: 9.944333
  latitude: 51.560583
  elevation: 201.

vfs:
  class: pyobs.vfs.VirtualFileSystem
  roots:
    cache:
      class: pyobs.vfs.HttpFile
      download: http://localhost:37075/
    webcam:
      class: pyobs.vfs.HttpFile
      download: http://localhost:37077/

Available classes

There is one single class for the GUI.

GUI

class GUI(show_shell: bool = True, show_events: bool = True, show_status: bool = True, show_modules: List[str] | None = None, widgets: List[Dict[str, Any]] | None = None, sidebar: List[Dict[str, Any]] | None = None, *args: Any, **kwargs: Any)

Bases: Module, IFitsHeaderBefore

Inits a new GUI.

Parameters:

• show_shell – Whether to show the shell page.

• show_events – Whether to show the events page.

• show_modules – If not empty, show only listed modules.

• widgets – List of custom widgets.

• sidebar – List of custom sidebar widgets.

async get_fits_header_before(namespaces: List[str] | None = None, **kwargs: Any) → Dict[str, Tuple[Any, str]]

Returns FITS header for the current status of this module.

Parameters:

namespaces – If given, only return FITS headers for the given namespaces.

Returns:

Dictionary containing FITS headers.

async open() → None

Open module.