spectrometer_base

frog.hardware.plugins.spectrometer.spectrometer_base

Provides a generic base class for spectrometers.

Attributes

Classes

SpectrometerBase()

Bases: Device

A generic base class for spectrometers.

Create a new SpectrometerBase.

Source code in frog/hardware/plugins/spectrometer/spectrometer_base.py

def __init__(self) -> None:
    """Create a new SpectrometerBase."""
    super().__init__()

    for command in (
        "connect",
        "start_measuring",
        "stop_measuring",
    ):
        self.subscribe(getattr(self, command), command)

Functions

connect() abstractmethod

Connect to the spectrometer.

Source code in frog/hardware/plugins/spectrometer/spectrometer_base.py

@abstractmethod
def connect(self) -> None:
    """Connect to the spectrometer."""

send_status_message(status)

Send a status update via pubsub.

Source code in frog/hardware/plugins/spectrometer/spectrometer_base.py

def send_status_message(self, status: SpectrometerStatus) -> None:
    """Send a status update via pubsub."""
    self.send_message(f"status.{status.name.lower()}", status=status)

start_measuring() abstractmethod

Start a new measurement.

Source code in frog/hardware/plugins/spectrometer/spectrometer_base.py

@abstractmethod
def start_measuring(self) -> None:
    """Start a new measurement."""

stop_measuring() abstractmethod

Stop the current measurement.

Source code in frog/hardware/plugins/spectrometer/spectrometer_base.py

@abstractmethod
def stop_measuring(self) -> None:
    """Stop the current measurement."""