cgse 2024.7.0__py3-none-any.whl → 2025.0.1__py3-none-any.whl

egse/powermeter/thorlabs/pm100a.py

@@ -1,380 +0,0 @@
-import logging
-
-from egse.decorators import dynamic_interface
-from egse.device import DeviceInterface
-from egse.powermeter.thorlabs.pm100a_devif import ThorlabsError
-from egse.powermeter.thorlabs.pm100a_devif import ThorlabsPM100USBInterface
-from egse.proxy import Proxy
-from egse.randomwalk import RandomWalk
-from egse.settings import Settings
-from egse.zmq_ser import connect_address
-
-logger = logging.getLogger(__name__)
-
-CTRL_SETTINGS = Settings.load("Thorlabs PM100 Control Server")
-DEVICE_SETTINGS = Settings.load(filename="pm100a.yaml")
-
-
-class ThorlabsPM100Interface(DeviceInterface):
-    """
-    The Thorlabs PM100 base class.
-    """
-
-    @dynamic_interface
-    def info(self) -> str:
-        """
-        Retrieve basic information about the Thorlabs controller.
-
-        Returns:
-            a multiline string with information about the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def get_value(self, *args, **kwargs):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def get_id(self, *args, **kwargs):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def get_wavelength(self, *args, **kwargs):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def get_range(self, *args, **kwargs):
-        return NotImplemented
-
-    @dynamic_interface
-    def get_config(self, *args, **kwargs):
-        return NotImplemented
-
-    @dynamic_interface
-    def get_average(self, *args, **kwargs):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def get_diameter(self, *args, **kwargs):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def get_autozero(self, *args, **kwargs):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def set_average(self, average):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def set_wavelength(self, wave):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def set_range(self, range, auto=False):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def set_diameter(self, diameter):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-    @dynamic_interface
-    def set_zero(self, autozero):
-        """
-        Send a command string to the device and wait for a response.
-
-        Returns:
-            a response from the device.
-        """
-        return NotImplemented
-
-
-class ThorlabsPM100Simulator(ThorlabsPM100Interface):
-    """
-    The Thorlabs PM100 Simulator class.
-    """
-
-    def __init__(self):
-        self._is_connected = True
-        self._value = 0.0
-        self._randomwalk = RandomWalk(start=20, boundary=(0.0, 100), scale=0.1, count=0)
-        self._wavelength = 535
-        self._range = {"range": 2, "auto": 0}
-        self._average = 1
-        self._diameter = 0.01
-        self._autozero = {"set": False, "magnitude (W)": 0.002}
-
-    def is_connected(self):
-        return self._is_connected
-
-    def is_simulator(self):
-        return True
-
-    def connect(self):
-        self._is_connected = True
-
-    def disconnect(self):
-        self._is_connected = False
-
-    def reconnect(self):
-        self.connect()
-
-    def info(self) -> str:
-        return "PM100a - The Thorlabs PM100A Simulator"
-
-    def get_value(self):
-        return next(self._randomwalk)
-
-    def get_average(self):
-        return self._average
-
-    def get_id(self) -> str:
-        return self.info()
-
-    def get_wavelength(self):
-        "returns default values"
-        return self._wavelength
-
-    def get_range(self):
-        "returns dummy range"
-        return self._range
-
-    def get_diameter(self):
-        return self._diameter
-
-    def get_autozero(self):
-        return self._autozero
-
-    def get_config(self):
-        """Returns a dummy configuration."""
-        measurement = {"Value": self._value, "Average number": self._average}
-        return {
-            "Measurement": measurement,
-            "Correction Wavelength (nm)": self._wavelength,
-            "Beam diameter (mm)": self._diameter,
-            "Autozero correction": self._autozero,
-            "Power Range": self._range,
-        }
-
-    def set_wavelength(self, wave):
-        "returns default values"
-        self._wavelength = wave
-        return "wavelength set to: {self._wavelength}"
-
-    def set_range(self, range_action, auto=False):
-        # FIXME: the range_action parameter is not used in this method.
-        self._range["auto"] = auto
-        return self._range
-
-    def set_average(self, average):
-        self._average = average
-
-    def set_diameter(self, diameter):
-        self._diameter = diameter
-
-    def set_zero(self, autozero):
-        self._autozero["set"] = bool(autozero)
-
-
-class ThorlabsPM100Controller(ThorlabsPM100Interface):
-    def __init__(self):
-        """Initialize the ThorlabsPM100Controller interface."""
-
-        super().__init__()
-
-        logger.debug("Initializing ThorlabsPM100Controller")
-
-        try:
-            self.thorlabs = ThorlabsPM100USBInterface()
-            self.thorlabs.connect()
-
-        except ThorlabsError as exc:
-            logger.warning(f"ThorlabsError caught: Couldn't establish connection ({exc})")
-            raise ThorlabsError(
-                "Couldn't establish a connection with the Thorlabs PM100 USB controller."
-            ) from exc
-
-    def connect(self):
-        """Connects to the Thorlabs PM100 device."""
-        try:
-            self.thorlabs.connect()
-        except ThorlabsError as exc:
-             logger.warning(f"ThorlabsError caught: Couldn't establish connection ({exc})")
-             raise ConnectionError("Couldn't establish a connection with the Thorlabs PM100 USB controller.") from exc
-
-    def disconnect(self):
-         try:
-             self.thorlabs.disconnect()
-         except ThorlabsError as exc:
-             raise ConnectionError("Couldn't establish a connection with the Thorlabs PM100 USB controller.") from exc
-
-    def reconnect(self):
-        if self.is_connected():
-            self.disconnect()
-        self.connect()
-
-    def is_simulator(self):
-        return False
-
-    def is_connected(self):
-        """Check if the Thorlabs Controller is connected."""
-        return self.thorlabs.is_connected()
-
-    def info(self) -> str:
-        return self.thorlabs.info()
-
-    def get_value(self) -> float:
-        return self.thorlabs.get_value()
-
-    def get_id(self):
-        return self.thorlabs.get_id()
-
-    def get_response(self, cmd_string):
-        response = self.thorlabs.get_response(cmd_string)
-        return response
-
-    def get_wavelength(self) -> int:
-        return self.thorlabs.get_wavelength()
-
-    def get_range(self) -> dict:
-        return self.thorlabs.get_range()
-
-    def get_average(self):
-        return self.thorlabs.get_average()
-
-    def get_diameter(self) -> float:
-        return self.thorlabs.get_diameter()
-
-    def get_autozero(self) -> dict:
-        return self.thorlabs.get_autozero()
-
-    def get_config(self) -> dict:
-        measurement = {
-            "Value": self.thorlabs.get_value(),
-            "Average number": self.thorlabs.get_average(),
-        }
-        wavelength = self.thorlabs.get_wavelength()
-        beam = self.thorlabs.get_diameter()
-        range = self.thorlabs.get_range()
-        autozero = self.thorlabs.get_autozero()
-        return {
-            "Measurement": measurement,
-            "Correction Wavelength (nm)": wavelength,
-            "Beam diameter (mm)": beam,
-            "Autozero correction": autozero,
-            "Power Range": range,
-        }
-
-    def set_wavelength(self, wave):
-        self.thorlabs.set_wavelength(wave)
-
-    def set_average(self, average):
-        self.thorlabs.set_average(average)
-
-    def set_range(self, range_action, auto=False):
-        old_range = self.thorlabs.get_range()
-        if auto:
-            self.thorlabs.autorange(int(auto))
-        if not auto:
-            if range_action == "up":
-                self.thorlabs.range(round(old_range["range"] * 10, 4))
-            elif range_action == "down":
-                self.thorlabs.range(round(old_range["range"] * 0.1, 4))
-            elif range_action is None:
-                # Allows to switch from Auto to Manual range without changing the range
-                pass
-
-    def set_diameter(self, diameter):
-        self.thorlabs.set_diameter(diameter)
-
-    def set_zero(self, autozero):
-        self.thorlabs.set_zero(autozero)
-
-    @property
-    def power_meter(self):
-        return self.thorlabs.power_meter
-
-    @property
-    def instrument(self):
-        return self.thorlabs.instrument
-
-
-class ThorlabsPM100Proxy(Proxy, ThorlabsPM100Interface):
-    """The ThorlabsPM100Proxy class is used to connect to the control server and send commands to
-    the Thorlabs device remotely."""
-
-    def __init__(
-        self,
-        protocol=CTRL_SETTINGS.PROTOCOL,
-        hostname=CTRL_SETTINGS.HOSTNAME,
-        port=CTRL_SETTINGS.COMMANDING_PORT,
-    ):
-        """
-        Args:
-            protocol: the transport protocol [default is taken from settings file]
-            hostname: location of the control server (IP address)
-                [default is taken from settings file]
-            port: TCP port on which the control server is listening for commands
-                [default is taken from settings file]
-        """
-        super().__init__(connect_address(protocol, hostname, port))

egse/powermeter/thorlabs/pm100a.yaml

@@ -1,132 +0,0 @@
-BaseClass:
-    egse.powermeter.thorlabs.pm100a.ThorlabsPM100Interface
-
-ProxyClass:
-    egse.powermeter.thorlabs.pm100a.ThorlabsPM100Proxy
-
-ControlServerClass:
-    egse.powermeter.thorlabs.pm100a_cs.ThorlabsPM100ControlServer
-
-ControlServer:
-    egse.powermeter.thorlabs.pm100a_cs
-
-UserInterface:
-    egse.powermeter.thorlabs.pm100a_ui
-
-Commands:
-
-    # Each of these groups is parsed and used on both the server and the client side.
-    # The group name (e.g. is_simulator) will be monkey patched in the Proxy class for the device or service.
-    # The other field are:
-    #   description:   Used by the doc_string method to generate a help string
-    #   cmd:           Command string that will eventually be send to the hardware controller for the
-    #                  device after the arguments have been filled.
-    #   device_method: The name of the method to be called on the device class.
-    #                  These should all be defined by the base class for the device, i.e. LakeShoreBase.
-    #   response:      The name of the method to be called from the device protocol.
-    #                  This method should exist in the subclass of the CommandProtocol base class.
-
-    # Definition of the the DeviceInterface
-
-    is_connected:
-        description:    Check if the Thorlabs Hardware Controller is connected.
-
-    disconnect:
-        description:    Disconnect from the Thorlabs Powre Meter.
-
-                        This command will be send to the Thorlabs Control Server which will then
-                        disconnect from the hardware controller.
-
-                        This command doesn't affect the ZeroMQ connection of this Proxy to the
-                        control server. Use the service command ``disconnect()`` to disconnect
-                        from the control server.
-
-    connect:
-        description:    Connect to the Thorlabs Power Meter.
-
-    reconnect:
-        description:    Reconnect to the Thorlabs Power Meter.
-
-                        This command will force a disconnect and then try to re-connect to the controller.
-
-    is_simulator:
-        description:   Ask if the control server is a simulator instead of the real ThorlabsPM100Controller class.
-        returns:       bool | True if the far end is a simulator instead of the real hardware
-
-
-    # Definition of the device commands
-
-    info:
-        description:   Retrieve basic information about the Thorlabs and the Controller.
-
-    get_value:
-        description:   Retrieve the readout value from the Thorlabs power meter.
-        returns:       float | The current readout for the given device
-
-    get_average:
-        description:   Retrives the number of samples to average set in the Thorlabs power meter
-        returns:       int | the number of samples
-
-    get_id:
-        description:   Retrieve the rSCPI Identification for the Thorlabs power meter.
-        returns:       str | The IDN for the given device
-
-    get_wavelength:
-        description:   Retrieves the information of the configured wavelength in nm parameters for the Thorlabs power
-            meter
-        returns:       int | The value of the correction wavelength set in nm
-
-    get_range:
-        description:   Retrieves the upper power range of the Thorlabs Power meter
-        returns:       float | to be changed into string or something range goes from 2.41 W to 2.41E-5 W also if the
-            device is set to autorange
-
-    get_diameter:
-        description:   Retrieves the set beam parameter in mm of the Thorlabs Power meter
-        returns:       float | beam diameter in mm
-
-    get_autozero:
-        description:   Retrieves the autozero parameters of the Thorlabs Power meter
-        returns:       dict | set = bool, magnitude (W) = float
-
-    get_config:
-        description:   Retrieves the information of the parameters that have been set fot the Thorlabs power meter
-            (wavelength, and power range) together with a measured value
-        returns:       dict | returns a dictionary containing the parameters
-
-    set_wavelength:
-        description:   Sets the correction wavelength of the Thorlabs power meter
-        args:
-            wave:      int | set the wavelength in nm # possible values to be implemented are 532, 535, 635, 760, 830, 900, 1060
-        cmd:           "{wave}"
-        returns:       None
-
-    set_range:
-        description:   Sets the measurement range of the Thorlabs power meter
-        args:
-            range:     str | "up" to increase the power range, "down" to decrease it
-        kwargs:
-            auto:      bool | when True sets the Autorange ON
-        cmd:           "{range} {auto}"
-        returns:       None
-
-    set_average:
-        description:   Sets the number of samples to average of the Thorlabs power meter
-        args:
-            average:   int | number of samples (one sample takes 3ms)
-        cmd:           "{average}"
-        returns:       None
-
-    set_diameter:
-        description:   Sets the incident beam diameter parameter of the Thorlabs power meter
-        args:
-            diameter:  float | The beam diameter in mm. Values range from 0.1 to 9.4 mm
-        cmd:           "{diameter}"
-        returns:       None
-
-    set_zero:
-        description:   Measures dark for zero adjustment of the Thorlabs power meter. The sensor needs to be covered
-        args:
-            autozero:     bool | True = initiate autozero, False = abort autozero
-        cmd:           "{autozero}"
-        returns:       None

egse/powermeter/thorlabs/pm100a_cs.py

@@ -1,136 +0,0 @@
-import argparse
-import click
-import logging
-import sys
-
-import zmq
-
-from egse.control import ControlServer
-from egse.powermeter.thorlabs.pm100a import ThorlabsPM100Proxy
-from egse.powermeter.thorlabs.pm100a_protocol import ThorlabsPM100Protocol
-from egse.settings import Settings
-from prometheus_client import start_http_server
-
-logger = logging.getLogger(__name__)
-
-# Restrict the logging output for the following loggers.
-
-# Note that, in production, the logging level for the different loggers can be changed with a
-# service command `set_logging_level(logger_name, level)`.
-
-logger_levels = [
-    ("egse.protocol", logging.INFO),
-    ("egse.command", logging.INFO),
-    ("egse.settings", logging.INFO),
-]
-
-for name, level in logger_levels:
-    logger = logging.getLogger(name)
-    logger.setLevel(level)
-
-
-CTRL_SETTINGS = Settings.load("Thorlabs PM100 Control Server")
-
-class ThorlabsPM100ControlServer(ControlServer):
-    """
-    ThorlabsControlServer - Command and monitor the Thorlabs Power Meter Controllers.
-
-    This class works as a command and monitoring server to control the Thorlabs Controller remotely.
-
-    The sever binds to the following ZeroMQ sockets:
-
-    * a REQ-REP socket that can be used as a command server. Any client can connect and
-      send a command to the Thorlabs controller.
-
-    * a PUB-SUP socket that serves as a monitoring server. It will send out Thorlabs status
-      information to all the connected clients every DELAY seconds.
-
-    """
-
-    def __init__(self):
-        super().__init__()
-
-        self.device_protocol = ThorlabsPM100Protocol(self)
-
-        self.logger.debug(f"Binding ZeroMQ socket to {self.device_protocol.get_bind_address()}")
-
-        self.device_protocol.bind(self.dev_ctrl_cmd_sock)
-
-        self.poller.register(self.dev_ctrl_cmd_sock, zmq.POLLIN)
-
-    def get_communication_protocol(self):
-        return CTRL_SETTINGS.PROTOCOL
-
-    def get_commanding_port(self):
-        return CTRL_SETTINGS.COMMANDING_PORT
-
-    def get_service_port(self):
-        return CTRL_SETTINGS.SERVICE_PORT
-
-    def get_monitoring_port(self):
-        return CTRL_SETTINGS.MONITORING_PORT
-
-    def get_storage_mnemonic(self):
-        try:
-            return CTRL_SETTINGS.STORAGE_MNEMONIC
-        except AttributeError:
-            return "PM100A"
-
-    def before_serve(self):
-        start_http_server(CTRL_SETTINGS.METRICS_PORT)
-
-    def after_serve(self):
-        self.device_protocol.synoptics.disconnect_cs()
-
-@click.group()
-def cli():
-    pass
-
-
-@cli.command()
-@click.option("--simulator", "--sim", is_flag=True, help="Start the Thorlabs PM100 Powermeter Simulator as the backend.")
-def start(simulator):
-    """Start the Thorlabs PM100 Powermeter Control Server."""
-
-    if simulator:
-
-        Settings.set_simulation_mode(True)
-
-    try:
-
-        controller = ThorlabsPM100ControlServer()
-        controller.serve()
-
-    except KeyboardInterrupt:
-
-        print("Shutdown requested...exiting")
-
-    except SystemExit as exit_code:
-
-        print("System Exit with code {}.".format(exit_code))
-        sys.exit(exit_code)
-
-    except Exception:
-
-        logger.exception("Cannot start the Thorlabs PM100 Powermeter Control Server")
-
-        # The above line does exactly the same as the traceback, but on the logger
-        # import traceback
-        # traceback.print_exc(file=sys.stdout)
-
-    return 0
-
-
-@cli.command()
-def stop():
-    """Send a 'quit_server' command to the Thorlabs PM100 Powermeter Control Server."""
-
-    with ThorlabsPM100Proxy() as proxy:
-
-        sp = proxy.get_service_proxy()
-        sp.quit_server()
-
-
-if __name__ == "__main__":
-
-    sys.exit(cli())