Roofs (pyobs.modules.roof)

Modules for roofs. TODO: write doc

BaseDome

class BaseDome(**kwargs: Any)

Bases: IDome, BaseRoof

Base class for domes.

Initialize a new base dome.

async get_fits_header_before(namespaces: list[str] | None = None, **kwargs: Any) → dict[str, FitsHeaderEntry]

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.

BaseRoof

class BaseRoof(**kwargs: Any)

Bases: WeatherAwareMixin, MotionStatusMixin, IRoof, IFitsHeaderBefore, Module

Base class for roofs.

Initialize a new base roof.

async get_fits_header_before(namespaces: list[str] | None = None, **kwargs: Any) → dict[str, FitsHeaderEntry]

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.

DummyRoof

class DummyRoof(**kwargs: Any)

Bases: BaseRoof, IRoof

A dummy camera for testing.

Creates a new dummy root.

get_percent_open() → float

Get the percentage the roof is open.

async init(**kwargs: Any) → None

Open the roof.

Raises:

InitError – If the roof could not be initialized (e.g. another motion is in progress).

async open() → None

Open module.

async park(**kwargs: Any) → None

Close the roof.

Raises:

ParkError – If the roof could not be parked (e.g. another motion is in progress).

async stop_motion(device: str | None = None, **kwargs: Any) → None

Stop the motion.

Parameters:

device – Name of device to stop, or None for all.

Raises:

DeviceBusyError – If current motion could not be aborted.