zaber-motion 7.12.0__py3-none-win_amd64.whl → 7.14.0__py3-none-win_amd64.whl

zaber_motion/microscopy/camera_trigger.py

@@ -1,108 +1,108 @@
-# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
-# ============== DO NOT EDIT DIRECTLY ============== #
-# pylint: disable=W0622
-
-from ..call import call, call_async, call_sync
-from ..dto import requests as dto
-from ..ascii import Device
-from ..units import TimeUnits, Units
-
-
-class CameraTrigger:
-    """
-    An abstraction over a device and it's digital output channel.
-    """
-
-    @property
-    def device(self) -> Device:
-        """
-        The device whose digital output triggers the camera.
-        """
-        return self._device
-
-    @property
-    def channel(self) -> int:
-        """
-        The digital output channel that triggers the camera.
-        """
-        return self._channel
-
-    def __init__(self, device: Device, channel: int):
-        """
-        Creates instance of `CameraTrigger` based on the given device and digital output channel.
-        """
-        self._device: Device = device
-        self._channel: int = channel
-
-    def trigger(
-            self,
-            pulse_width: float,
-            unit: TimeUnits = Units.NATIVE,
-            wait: bool = True
-    ) -> None:
-        """
-        Triggers the camera.
-        Schedules trigger pulse on the digital output channel.
-        By default, the method waits until the trigger pulse is finished.
-
-        Args:
-            pulse_width: The time duration of the trigger pulse.
-                Depending on the camera setting, the argument can be use to specify exposure.
-            unit: Units of time.
-            wait: If false, the method does not wait until the trigger pulse is finished.
-        """
-        request = dto.MicroscopeTriggerCameraRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            channel_number=self.channel,
-            delay=pulse_width,
-            unit=unit,
-            wait=wait,
-        )
-        call("microscope/trigger_camera", request)
-
-    async def trigger_async(
-            self,
-            pulse_width: float,
-            unit: TimeUnits = Units.NATIVE,
-            wait: bool = True
-    ) -> None:
-        """
-        Triggers the camera.
-        Schedules trigger pulse on the digital output channel.
-        By default, the method waits until the trigger pulse is finished.
-
-        Args:
-            pulse_width: The time duration of the trigger pulse.
-                Depending on the camera setting, the argument can be use to specify exposure.
-            unit: Units of time.
-            wait: If false, the method does not wait until the trigger pulse is finished.
-        """
-        request = dto.MicroscopeTriggerCameraRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            channel_number=self.channel,
-            delay=pulse_width,
-            unit=unit,
-            wait=wait,
-        )
-        await call_async("microscope/trigger_camera", request)
-
-    def __repr__(
-            self
-    ) -> str:
-        """
-        Returns a string that represents the device.
-
-        Returns:
-            A string that represents the device.
-        """
-        request = dto.AxisToStringRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-        )
-        response = call_sync(
-            "device/device_to_string",
-            request,
-            dto.StringResponse.from_binary)
-        return response.value
+# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
+# ============== DO NOT EDIT DIRECTLY ============== #
+# pylint: disable=W0622
+
+from ..call import call, call_async, call_sync
+from ..dto import requests as dto
+from ..ascii import Device
+from ..units import TimeUnits, Units
+
+
+class CameraTrigger:
+    """
+    An abstraction over a device and it's digital output channel.
+    """
+
+    @property
+    def device(self) -> Device:
+        """
+        The device whose digital output triggers the camera.
+        """
+        return self._device
+
+    @property
+    def channel(self) -> int:
+        """
+        The digital output channel that triggers the camera.
+        """
+        return self._channel
+
+    def __init__(self, device: Device, channel: int):
+        """
+        Creates instance of `CameraTrigger` based on the given device and digital output channel.
+        """
+        self._device: Device = device
+        self._channel: int = channel
+
+    def trigger(
+            self,
+            pulse_width: float,
+            unit: TimeUnits = Units.NATIVE,
+            wait: bool = True
+    ) -> None:
+        """
+        Triggers the camera.
+        Schedules trigger pulse on the digital output channel.
+        By default, the method waits until the trigger pulse is finished.
+
+        Args:
+            pulse_width: The time duration of the trigger pulse.
+                Depending on the camera setting, the argument can be use to specify exposure.
+            unit: Units of time.
+            wait: If false, the method does not wait until the trigger pulse is finished.
+        """
+        request = dto.MicroscopeTriggerCameraRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            channel_number=self.channel,
+            delay=pulse_width,
+            unit=unit,
+            wait=wait,
+        )
+        call("microscope/trigger_camera", request)
+
+    async def trigger_async(
+            self,
+            pulse_width: float,
+            unit: TimeUnits = Units.NATIVE,
+            wait: bool = True
+    ) -> None:
+        """
+        Triggers the camera.
+        Schedules trigger pulse on the digital output channel.
+        By default, the method waits until the trigger pulse is finished.
+
+        Args:
+            pulse_width: The time duration of the trigger pulse.
+                Depending on the camera setting, the argument can be use to specify exposure.
+            unit: Units of time.
+            wait: If false, the method does not wait until the trigger pulse is finished.
+        """
+        request = dto.MicroscopeTriggerCameraRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            channel_number=self.channel,
+            delay=pulse_width,
+            unit=unit,
+            wait=wait,
+        )
+        await call_async("microscope/trigger_camera", request)
+
+    def __repr__(
+            self
+    ) -> str:
+        """
+        Returns a string that represents the device.
+
+        Returns:
+            A string that represents the device.
+        """
+        request = dto.AxisToStringRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+        )
+        response = call_sync(
+            "device/device_to_string",
+            request,
+            dto.StringResponse.from_binary)
+        return response.value

zaber_motion/microscopy/filter_changer.py

@@ -1,167 +1,167 @@
-# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
-# ============== DO NOT EDIT DIRECTLY ============== #
-# pylint: disable=W0622
-
-from ..call import call, call_async, call_sync
-from ..dto import requests as dto
-from ..ascii import Device
-
-
-class FilterChanger:
-    """
-    A generic turret device.
-    """
-
-    @property
-    def device(self) -> Device:
-        """
-        The base device of this turret.
-        """
-        return self._device
-
-    def __init__(self, device: Device):
-        """
-        Creates instance of `FilterChanger` based on the given device.
-        """
-        self._device: Device = device
-
-    def get_number_of_filters(
-            self
-    ) -> int:
-        """
-        Gets number of filters of the changer.
-
-        Returns:
-            Number of positions.
-        """
-        request = dto.AxisEmptyRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            axis=1,
-        )
-        response = call(
-            "device/get_index_count",
-            request,
-            dto.IntResponse.from_binary)
-        return response.value
-
-    async def get_number_of_filters_async(
-            self
-    ) -> int:
-        """
-        Gets number of filters of the changer.
-
-        Returns:
-            Number of positions.
-        """
-        request = dto.AxisEmptyRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            axis=1,
-        )
-        response = await call_async(
-            "device/get_index_count",
-            request,
-            dto.IntResponse.from_binary)
-        return response.value
-
-    def get_current_filter(
-            self
-    ) -> int:
-        """
-        Returns the current filter number starting from 1.
-        The value of 0 indicates that the position is either unknown or between two filters.
-
-        Returns:
-            Filter number starting from 1 or 0 if the position cannot be determined.
-        """
-        request = dto.AxisEmptyRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            axis=1,
-        )
-        response = call(
-            "device/get_index_position",
-            request,
-            dto.IntResponse.from_binary)
-        return response.value
-
-    async def get_current_filter_async(
-            self
-    ) -> int:
-        """
-        Returns the current filter number starting from 1.
-        The value of 0 indicates that the position is either unknown or between two filters.
-
-        Returns:
-            Filter number starting from 1 or 0 if the position cannot be determined.
-        """
-        request = dto.AxisEmptyRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            axis=1,
-        )
-        response = await call_async(
-            "device/get_index_position",
-            request,
-            dto.IntResponse.from_binary)
-        return response.value
-
-    def change(
-            self,
-            filter: int
-    ) -> None:
-        """
-        Changes to the specified filter.
-
-        Args:
-            filter: Filter number starting from 1.
-        """
-        request = dto.DeviceMoveRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            axis=1,
-            type=dto.AxisMoveType.INDEX,
-            wait_until_idle=True,
-            arg_int=filter,
-        )
-        call("device/move", request)
-
-    async def change_async(
-            self,
-            filter: int
-    ) -> None:
-        """
-        Changes to the specified filter.
-
-        Args:
-            filter: Filter number starting from 1.
-        """
-        request = dto.DeviceMoveRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            axis=1,
-            type=dto.AxisMoveType.INDEX,
-            wait_until_idle=True,
-            arg_int=filter,
-        )
-        await call_async("device/move", request)
-
-    def __repr__(
-            self
-    ) -> str:
-        """
-        Returns a string that represents the device.
-
-        Returns:
-            A string that represents the device.
-        """
-        request = dto.AxisToStringRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-        )
-        response = call_sync(
-            "device/device_to_string",
-            request,
-            dto.StringResponse.from_binary)
-        return response.value
+# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
+# ============== DO NOT EDIT DIRECTLY ============== #
+# pylint: disable=W0622
+
+from ..call import call, call_async, call_sync
+from ..dto import requests as dto
+from ..ascii import Device
+
+
+class FilterChanger:
+    """
+    A generic turret device.
+    """
+
+    @property
+    def device(self) -> Device:
+        """
+        The base device of this turret.
+        """
+        return self._device
+
+    def __init__(self, device: Device):
+        """
+        Creates instance of `FilterChanger` based on the given device.
+        """
+        self._device: Device = device
+
+    def get_number_of_filters(
+            self
+    ) -> int:
+        """
+        Gets number of filters of the changer.
+
+        Returns:
+            Number of positions.
+        """
+        request = dto.AxisEmptyRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            axis=1,
+        )
+        response = call(
+            "device/get_index_count",
+            request,
+            dto.IntResponse.from_binary)
+        return response.value
+
+    async def get_number_of_filters_async(
+            self
+    ) -> int:
+        """
+        Gets number of filters of the changer.
+
+        Returns:
+            Number of positions.
+        """
+        request = dto.AxisEmptyRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            axis=1,
+        )
+        response = await call_async(
+            "device/get_index_count",
+            request,
+            dto.IntResponse.from_binary)
+        return response.value
+
+    def get_current_filter(
+            self
+    ) -> int:
+        """
+        Returns the current filter number starting from 1.
+        The value of 0 indicates that the position is either unknown or between two filters.
+
+        Returns:
+            Filter number starting from 1 or 0 if the position cannot be determined.
+        """
+        request = dto.AxisEmptyRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            axis=1,
+        )
+        response = call(
+            "device/get_index_position",
+            request,
+            dto.IntResponse.from_binary)
+        return response.value
+
+    async def get_current_filter_async(
+            self
+    ) -> int:
+        """
+        Returns the current filter number starting from 1.
+        The value of 0 indicates that the position is either unknown or between two filters.
+
+        Returns:
+            Filter number starting from 1 or 0 if the position cannot be determined.
+        """
+        request = dto.AxisEmptyRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            axis=1,
+        )
+        response = await call_async(
+            "device/get_index_position",
+            request,
+            dto.IntResponse.from_binary)
+        return response.value
+
+    def change(
+            self,
+            filter: int
+    ) -> None:
+        """
+        Changes to the specified filter.
+
+        Args:
+            filter: Filter number starting from 1.
+        """
+        request = dto.DeviceMoveRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            axis=1,
+            type=dto.AxisMoveType.INDEX,
+            wait_until_idle=True,
+            arg_int=filter,
+        )
+        call("device/move", request)
+
+    async def change_async(
+            self,
+            filter: int
+    ) -> None:
+        """
+        Changes to the specified filter.
+
+        Args:
+            filter: Filter number starting from 1.
+        """
+        request = dto.DeviceMoveRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            axis=1,
+            type=dto.AxisMoveType.INDEX,
+            wait_until_idle=True,
+            arg_int=filter,
+        )
+        await call_async("device/move", request)
+
+    def __repr__(
+            self
+    ) -> str:
+        """
+        Returns a string that represents the device.
+
+        Returns:
+            A string that represents the device.
+        """
+        request = dto.AxisToStringRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+        )
+        response = call_sync(
+            "device/device_to_string",
+            request,
+            dto.StringResponse.from_binary)
+        return response.value