horiba-sdk 0.5.4__py3-none-any.whl → 0.7.0__py3-none-any.whl

horiba_sdk/sync/devices/single_devices/monochromator.py

@@ -1,413 +0,0 @@
-from enum import Enum
-from types import TracebackType
-from typing import Any, Optional, final
-
-from loguru import logger
-from overrides import override
-
-from horiba_sdk.communication import Response
-from horiba_sdk.icl_error import AbstractErrorDB
-from horiba_sdk.sync.communication.abstract_communicator import AbstractCommunicator
-from horiba_sdk.sync.devices.single_devices.abstract_device import AbstractDevice
-
-
-@final
-class Monochromator(AbstractDevice):
-    """Monochromator device
-
-    This class should not be instanced by the end user. Instead, the :class:`horiba_sdk.sync.devices.DeviceManager`
-    should be used to access the detected Monochromators on the system.
-    """
-
-    @final
-    class Shutter(Enum):
-        """Shutters installed in the monochromator."""
-
-        FIRST = 0
-        SECOND = 1
-
-    @final
-    class ShutterPosition(Enum):
-        """Position of the shutter."""
-
-        CLOSED = 0
-        OPENED = 1
-
-    @final
-    class Grating(Enum):
-        """Gratings installed in the monochromator"""
-
-        FIRST = 0
-        SECOND = 1
-        THIRD = 2
-
-    @final
-    class FilterWheel(Enum):
-        """Filter wheels installed in the monochromator.
-
-        .. note:: the filter wheel is an optional module
-
-        """
-
-        # TODO: clarify naming of filter wheel
-        FIRST = 0
-        SECOND = 1
-
-    @final
-    class FilterWheelPosition(Enum):
-        """Positions of the filter wheel installed in the monochromator.
-
-        .. note:: the filter wheel is an optional module
-
-        """
-
-        # TODO: clarify naming of filter wheel positions
-        RED = 0
-        GREEN = 1
-        BLUE = 2
-        YELLOW = 3
-
-    @final
-    class Mirror(Enum):
-        """Mirrors installed in the monochromator"""
-
-        ENTRANCE = 0
-        EXIT = 1
-
-    @final
-    class MirrorPosition(Enum):
-        """Possible positions of the mirrors"""
-
-        AXIAL = 0
-        LATERAL = 1
-
-    @final
-    class Slit(Enum):
-        """Slits available on the monochromator."""
-
-        # TODO: clarify how the slits are called
-        A = 0
-        B = 1
-        C = 2
-        D = 3
-
-    def __init__(self, device_id: int, communicator: AbstractCommunicator, error_db: AbstractErrorDB) -> None:
-        super().__init__(device_id, communicator, error_db)
-
-    def __enter__(self) -> 'Monochromator':
-        self.open()
-        return self
-
-    def __exit__(
-        self,
-        exc_type: Optional[type[BaseException]],
-        exc_value: Optional[BaseException],
-        traceback: Optional[TracebackType],
-    ) -> None:
-        if not self.is_open():
-            logger.debug('Monochromator is already closed')
-            return
-
-        self.close()
-
-    @override
-    def open(self) -> None:
-        """Opens the connection to the Monochromator
-
-        Raises:
-            Exception: When an error occured on the device side
-        """
-        super().open()
-        super()._execute_command('mono_open', {'index': self._id})
-
-    @override
-    def close(self) -> None:
-        """Closes the connection to the Monochromator
-
-        Raises:
-            Exception: When an error occured on the device side
-        """
-        super()._execute_command('mono_close', {'index': self._id})
-
-    def is_open(self) -> bool:
-        """Checks if the connection to the monochromator is open.
-
-        Raises:
-            Exception: When an error occured on the device side
-        """
-        response: Response = super()._execute_command('mono_isOpen', {'index': self._id})
-        return bool(response.results['open'])
-
-    def is_busy(self) -> bool:
-        """Checks if the monochromator is busy.
-
-        Raises:
-            Exception: When an error occured on the device side
-        """
-        response: Response = super()._execute_command('mono_isBusy', {'index': self._id})
-        return bool(response.results['busy'])
-
-    def initialize(self) -> None:
-        """Starts the monochromator initialization process called "homing".
-
-        Use :func:`Monochromator.is_busy()` to know if the operation is still taking place.
-
-        Raises:
-            Exception: When an error occured on the device side
-        """
-        super()._execute_command('mono_init', {'index': self._id})
-
-    def is_initialized(self) -> bool:
-        """This command returns true when the mono is initialized. Otherwise, it returns false.
-        Note: This command may also return false when the mono is busy with another command.
-
-        Returns:
-            bool: If the monochromator is initialized or not
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        response: Response = super()._execute_command('mono_isInitialized', {'index': self._id})
-        return bool(response.results['initialized'])
-
-    def configuration(self) -> dict[str, Any]:
-        """Returns the configuration of the monochromator.
-
-        Returns:
-            str: configuration of the monochromator
-        """
-        response: Response = super()._execute_command('mono_getConfig', {'index': self._id, 'compact': False})
-        return response.results['configuration']
-
-    def get_current_wavelength(self) -> float:
-        """Current wavelength of the monochromator's position in nm.
-
-        Returns:
-            float: The current wavelength in nm
-
-        Raises:
-            Exception: When an error occured on the device side
-        """
-        response = super()._execute_command('mono_getPosition', {'index': self._id})
-        return float(response.results['wavelength'])
-
-    def calibrate_wavelength(self, wavelength: float) -> None:
-        """This command sets the wavelength value of the current grating position of the monochromator.
-
-        .. warning:: This could potentially uncalibrate the monochromator and report an incorrect wavelength compared to
-                     the actual output wavelength.
-
-        Args:
-            wavelength (float): wavelength in nm
-
-        Raises:
-            Exception: When an error occured on the device side
-        """
-        super()._execute_command('mono_setPosition', {'index': self._id, 'wavelength': wavelength})
-
-    def move_to_target_wavelength(self, wavelength_nm: float) -> None:
-        """Orders the monochromator to move to the requested wavelength.
-
-        Use :func:`Monochromator.is_busy()` to know if the operation is still taking place.
-
-        Args:
-            wavelength_nm (float): wavelength in nm
-
-        Raises:
-            Exception: When an error occured on the device side
-        """
-        super()._execute_command('mono_moveToPosition', {'index': self._id, 'wavelength': wavelength_nm}, 180)
-
-    def get_turret_grating(self) -> Grating:
-        """Current grating of the turret.
-
-        .. note:: Prior to the initialization of the grating turret, this value may not reflect the actual position
-                  of the turret. To read the current position of the grating turret, please run
-                  :func:`Monochromator.home()` prior to running this command.
-
-        Returns:
-            Grating: current grating of turret. See :class:`Monochromator.Grating` for possible values.
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        response: Response = super()._execute_command('mono_getGratingPosition', {'index': self._id})
-        return self.Grating(response.results['position'])
-
-    def set_turret_grating(self, grating: Grating) -> None:
-        """Select turret grating
-
-        .. note:: Note: The turret sensor does not re-read the position each time it is moved, therefore the position
-                  may not be accurate prior to initialization. See note for get_turret_grating().
-
-        Args:
-            grating (Grating): new grating of the turret. See :class:`Monochromator.Grating` for possible values.
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        super()._execute_command('mono_moveGrating', {'index': self._id, 'position': grating.value})
-
-    def get_filter_wheel_position(self, filter_wheel: FilterWheel) -> FilterWheelPosition:
-        """Current position of the filter wheel.
-
-        Returns:
-            FilterWheelPosition: current position of the filter wheel. See :class:`Monochromator.FilterWheelPosition`
-            for possible values.
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        response: Response = super()._execute_command(
-            'mono_getFilterWheelPosition', {'index': self._id, 'type': filter_wheel.value}
-        )
-        return self.FilterWheelPosition(response.results['position'])
-
-    def set_filter_wheel_position(self, filter_wheel: FilterWheel, position: FilterWheelPosition) -> None:
-        """Sets the current position of the filter wheel.
-
-        Returns:
-            FilterWheelPosition: current position of the filter wheel. See :class:`Monochromator.FilterWheelPosition`,
-            for possible values.
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        super()._execute_command(
-            'mono_moveFilterWheel', {'index': self._id, 'locationId': filter_wheel.value, 'position': position.value}
-        )
-
-    def get_mirror_position(self, mirror: Mirror) -> MirrorPosition:
-        """Position of the selected mirror.
-
-        .. todo:: Get more information about possible values and explain elements contained in monochromator at top
-           of this class.
-
-        Args:
-            mirror (Mirror): desired mirror to get the position from.
-
-        Returns:
-            MirrorPosition: current mirror position. See :class:`Monochromator.MirrorPosition` for possible values
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        response: Response = super()._execute_command(
-            'mono_getMirrorPosition', {'index': self._id, 'locationId': mirror.value}
-        )
-        return self.MirrorPosition(response.results['position'])
-
-    def set_mirror_position(self, mirror: Mirror, position: MirrorPosition) -> None:
-        """Sets the position of the selected mirror.
-
-        .. todo:: Get more information about possible values and explain elements contained in monochromator at top
-           of this class.
-
-        Args:
-            mirror (Mirror): desired mirror to set the position.
-            position (MirrorPosition): position to set. See :class:`Monochromator.MirrorPosition` for possible values
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        super()._execute_command(
-            'mono_moveMirror', {'index': self._id, 'locationId': mirror.value, 'position': position.value}
-        )
-
-    def get_slit_position_in_mm(self, slit: Slit) -> float:
-        """Returns the position in millimeters [mm] of the selected slit.
-
-        Args:
-            slit (Slit): desired slit to get the position from. See :class:`Monochromator.Slit` for possible
-
-        Returns:
-            float: position in mm
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-
-        response: Response = super()._execute_command(
-            'mono_getSlitPositionInMM', {'index': self._id, 'locationId': slit.value}
-        )
-        return float(response.results['position'])
-
-    def set_slit_position(self, slit: Slit, position_in_mm: float) -> None:
-        """Sets the position of the selected slit.
-
-        Args:
-            slit (Slit): desired slit to set the position. See :class:`Monochromator.Slit` for possible values.
-            position_in_mm (float): position to set in millimeters [mm].
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        super()._execute_command(
-            'mono_moveSlitMM', {'index': self._id, 'locationId': slit.value, 'position': position_in_mm}
-        )
-
-    def get_slit_step_position(self, slit: Slit) -> int:
-        """Returns the position of the specified slit in steps.
-
-        Args:
-            slit (Slit): desired slit to get the position from. See :class:`Monochromator.Slit` for possible
-        Returns:
-            int: step position.
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-
-        response: Response = super()._execute_command(
-            'mono_getSlitStepPosition', {'index': self._id, 'locationId': slit.value}
-        )
-        return int(response.results['position'])
-
-    def set_slit_step_position(self, slit: Slit, step_position: int) -> None:
-        """Moves the specified slit to the position in steps.
-
-        Args:
-            slit (Slit): desired slit to set the step position. See :class:`Monochromator.Slit` for possible values.
-            step_position (int): the step position.
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        super()._execute_command(
-            'mono_moveSlit', {'index': self._id, 'locationId': slit.value, 'position': step_position}
-        )
-
-    def open_shutter(self) -> None:
-        """Opens the shutter.
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        super()._execute_command('mono_shutterOpen', {'index': self._id})
-
-    def close_shutter(self) -> None:
-        """Closes the shutter.
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        super()._execute_command('mono_shutterClose', {'index': self._id})
-
-    def get_shutter_position(self, shutter: Shutter) -> ShutterPosition:
-        """Returns the shutter position.
-
-        Returns:
-            ShutterPosition: OPEN or CLOSED
-
-        Raises:
-            Exception: When an error occurred on the device side
-        """
-        response: Response = super()._execute_command('mono_getShutterStatus', {'index': self._id})
-        # TODO: How many shutters are there?
-        if shutter == self.Shutter.FIRST:
-            return self.ShutterPosition(response.results['shutter 1'])
-        elif shutter == self.Shutter.SECOND:
-            return self.ShutterPosition(response.results['shutter 2'])
-        else:
-            logger.error(f'shutter {shutter} not implemented')
-            raise Exception('shutter not implemented')

horiba_sdk-0.5.4.dist-info/RECORD

@@ -1,53 +0,0 @@
-horiba_sdk/__init__.py,sha256=J8jCV90BJ2SCDFSpacDeAAsJa8PFqBUDpREOJeAgXug,679
-horiba_sdk/communication/__init__.py,sha256=nhS1rw1ZojM8zmRIx0VEFtYge0IH-B_L4zNBUNBJZYE,1564
-horiba_sdk/communication/abstract_communicator.py,sha256=E80dfOjrfuNay3W5jeSn4T2tUas6vygRcF46kSoP5j8,1498
-horiba_sdk/communication/communication_exception.py,sha256=d2ouOoVI6Q69_JL1bUEjjQOmjiO0CEm8K20WsaUuhB0,583
-horiba_sdk/communication/messages.py,sha256=Gxkw01JI0U5ShILANT0pezywcoSO2aHo06j1ixzZPEQ,2661
-horiba_sdk/communication/websocket_communicator.py,sha256=wQxGRtj3htQ8n_hMvcoBmZdD18iea0uiCEsTZYdR2Jg,8300
-horiba_sdk/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-horiba_sdk/core/acquisition_format.py,sha256=pHcHZck75BbJ4nn2FOZ9cUXq9juZUjoNxKdLUhIIINI,358
-horiba_sdk/core/clean_count_mode.py,sha256=7guLd3eUV3Y2Cnj3w0JJ7ry74I8a6MFQiqbK5pTb3oU,185
-horiba_sdk/core/resolution.py,sha256=VOQonjPBqZ2TbtiNVDBT3TI1Aymj1pPYWMoobFaXjG8,1029
-horiba_sdk/core/timer_resolution.py,sha256=V6pXEZMVvUUoqrJmLFFI45pFt_7po6-5r1DmC8jY6gs,300
-horiba_sdk/core/x_axis_conversion_type.py,sha256=SQrdbciTR8x5UWOqLDgxWPy12o0-yIVLrkm7N3gpWpg,449
-horiba_sdk/devices/__init__.py,sha256=YYsJL2CSJwc2vsAjFQEKXjA5_QAnKlxSwlx32EgzFME,336
-horiba_sdk/devices/abstract_device_discovery.py,sha256=04ZCEB5IZkUuJxSisS78eW6lAQNXG4uaDoPv-eBccBA,178
-horiba_sdk/devices/abstract_device_manager.py,sha256=RXj5_pzFHpiolJe3ZfFsofwpD1hlwUMwYD1DyWMmlI0,1717
-horiba_sdk/devices/ccd_discovery.py,sha256=nGuskZ07Y9myI__dU8LeLnrNiJEBpGPby21EEwgSVUk,2376
-horiba_sdk/devices/device_manager.py,sha256=ZmZjQjTLxJvs5NqWQLTfDcCNb3PFwBYbu1mg_qmMCVo,10847
-horiba_sdk/devices/fake_device_manager.py,sha256=Tr4Z067smYfy-ya29PO4PK4EWF6Sa1R2UQFZCWfPePE,5015
-horiba_sdk/devices/fake_icl_server.py,sha256=Yh9oh0YCbw-AXMnCHFWsZvJ7ZFjsnm1JG1y0ix1b-9Q,2348
-horiba_sdk/devices/fake_responses/ccd.json,sha256=sMg-UqU6W1I01n2kEbkFc5J0XF8E3JVdOjB-1MhufzM,17020
-horiba_sdk/devices/fake_responses/icl.json,sha256=ZPKhjx0BmwmqNGwbb7reXSStddgVZetCQQYVeNr9CSU,572
-horiba_sdk/devices/fake_responses/monochromator.json,sha256=I9yBMsJyXXVCLF1J8mNPsfgXasIg60IL-4ToECcoGhw,4308
-horiba_sdk/devices/monochromator_discovery.py,sha256=KoZ8vfPsI6QRuiD4BiE0YvzO42dQzFZqvoxygDSllE8,2365
-horiba_sdk/devices/single_devices/__init__.py,sha256=Ai6HLstvMqT1c6A0yKLAH6227TUdS4ZMsC6zFrsmJic,192
-horiba_sdk/devices/single_devices/abstract_device.py,sha256=CwCjHJWSp8WGrYsyq0ZhTQVnvYdoCG-kb4BU9SZXJm8,3994
-horiba_sdk/devices/single_devices/ccd.py,sha256=mnx0keMePP7JAxCs8ZgCm_05tyu89efjAcBn2FPv4FI,29995
-horiba_sdk/devices/single_devices/monochromator.py,sha256=r-9bI-ne_iGdfTWBvUnYSxxp1DQNlEt7wBN31cGfZ1E,14538
-horiba_sdk/icl_error/__init__.py,sha256=EtqHaUeoaLilpb7L7juuVamJgIZ3Anfnca0AO2o46rg,1053
-horiba_sdk/icl_error/abstract_error.py,sha256=5nQDI6MNfCi4xUx6taJcEWGwANOo8mPEb4kVxrO-DW8,1301
-horiba_sdk/icl_error/abstract_error_db.py,sha256=IJ3wGb6DWxnY35VIUwZX0X80IPi5k4QoQXnVjDy8lH8,589
-horiba_sdk/icl_error/error_list.json,sha256=wyDYZPeH2sYMRPoL-JBoDul4uaYvoqp7SJg0zypfl40,5977
-horiba_sdk/icl_error/icl_error.py,sha256=IElsKl5nvLjprIV_ub9MacJmdSS327iNwOXhSiJXTc0,755
-horiba_sdk/icl_error/icl_error_db.py,sha256=5Jbs_ZlMp8Bjr4u8reIxxfOSFYYkzWTfKIqOQ4oUSXQ,2603
-horiba_sdk/sync/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-horiba_sdk/sync/communication/__init__.py,sha256=iVHHW0cQ9w_J5dGRkwdBnw7vYgRLn5MVsdIFWGZvJoA,186
-horiba_sdk/sync/communication/abstract_communicator.py,sha256=CEkGj2qVNoWYkFD9HOlxV82kls3gsJ517gWPK-9rUBw,1185
-horiba_sdk/sync/communication/test_client.py,sha256=7N5sM2Y63GSuFDmOEFRXeTHeAY7Nq7yX5MvbdPXeDko,651
-horiba_sdk/sync/communication/websocket_communicator.py,sha256=rCa0RVwl9Evwtr8VJUhkhTiIX2yG6pVtblhV3BGwnxU,9234
-horiba_sdk/sync/devices/__init__.py,sha256=NDHi3zfDC52aTO1RpaPIBfyp7PEXfTqiYdvY_ThkyRE,469
-horiba_sdk/sync/devices/abstract_device_discovery.py,sha256=hKDWbI8-I3r5mrU3O1Y1ve6vV7sg6KpUa5d3EfcLIE8,447
-horiba_sdk/sync/devices/abstract_device_manager.py,sha256=hF9BGgVqi6EK0n6hdUDu7dnKI1SfZ5mCweGvm6vCJ5o,1709
-horiba_sdk/sync/devices/device_discovery.py,sha256=eLErCF3mFYK5Za0jRg2xBLQnWJTwce7LcWdm8OQcI0A,2723
-horiba_sdk/sync/devices/device_manager.py,sha256=yGoijQnxJn7xyI3TpkBf-DpN3JGPNrQDkDtvvSLKNQk,8429
-horiba_sdk/sync/devices/fake_device_manager.py,sha256=myj1GwxjcOmv9jZbaTk8QwC6qYluNaZfuP9xPXrw3do,2809
-horiba_sdk/sync/devices/fake_icl_server.py,sha256=DlQOC54p7UCYBTdZOZCD9TgDdK4MarnbaWFUXRo7NP4,3298
-horiba_sdk/sync/devices/single_devices/__init__.py,sha256=Ai6HLstvMqT1c6A0yKLAH6227TUdS4ZMsC6zFrsmJic,192
-horiba_sdk/sync/devices/single_devices/abstract_device.py,sha256=ABQpU6wU5trH0j8OVjDP6MeGTj41e1ey5K5sw7tCCdQ,2883
-horiba_sdk/sync/devices/single_devices/ccd.py,sha256=fHj3lU8pZJKCoo1W3xdLhucNd_7JM4XRRxbbHfAO5Os,28196
-horiba_sdk/sync/devices/single_devices/monochromator.py,sha256=ur0scHOnnX0f_xhxh4Wzz4CNyeltFPuGg49PmPKEFwg,14351
-horiba_sdk-0.5.4.dist-info/LICENSE,sha256=JD-7TpNZoT7emooLwaTU9bJZbFbeM1ba90b8gpCYxzM,1083
-horiba_sdk-0.5.4.dist-info/METADATA,sha256=MGbBOP5E9ZWO8D-gGsU8TInWUUWannU3v1K5D1t4CY0,14349
-horiba_sdk-0.5.4.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-horiba_sdk-0.5.4.dist-info/RECORD,,