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

zaber_motion/ascii/axis_group.py

@@ -1,391 +1,391 @@
-# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
-# ============== DO NOT EDIT DIRECTLY ============== #
-
-from typing import List
-from ..call import call, call_async, call_sync
-
-from ..dto import requests as dto
-from .axis import Axis
-from ..dto.measurement import Measurement
-from ..units import LengthUnits
-
-
-class AxisGroup:
-    """
-    Groups multiple axes across devices into a single group to allow for simultaneous movement.
-    Note that the movement is not coordinated and trajectory is inconsistent and not repeatable between calls.
-    Make sure that any possible trajectory is clear of potential obstacles.
-    The movement methods return after all the axes finish the movement successfully
-    or throw an error as soon as possible.
-    """
-
-    @property
-    def axes(self) -> List[Axis]:
-        """
-        Axes of the group.
-        """
-        return self._axes
-
-    def __init__(self, axes: List[Axis]):
-        """
-        Initializes the group with the axes to be controlled.
-        """
-        self._axes: List[Axis] = axes.copy()
-
-    def home(
-            self
-    ) -> None:
-        """
-        Homes the axes.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        call("axes/home", request)
-
-    async def home_async(
-            self
-    ) -> None:
-        """
-        Homes the axes.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        await call_async("axes/home", request)
-
-    def stop(
-            self
-    ) -> None:
-        """
-        Stops the axes.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        call("axes/stop", request)
-
-    async def stop_async(
-            self
-    ) -> None:
-        """
-        Stops the axes.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        await call_async("axes/stop", request)
-
-    def move_absolute(
-            self,
-            *position: Measurement
-    ) -> None:
-        """
-        Moves the axes to absolute position.
-
-        Args:
-            position: Position.
-        """
-        request = dto.AxesMoveRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-            position=list(position),
-        )
-        call("axes/move_absolute", request)
-
-    async def move_absolute_async(
-            self,
-            *position: Measurement
-    ) -> None:
-        """
-        Moves the axes to absolute position.
-
-        Args:
-            position: Position.
-        """
-        request = dto.AxesMoveRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-            position=list(position),
-        )
-        await call_async("axes/move_absolute", request)
-
-    def move_relative(
-            self,
-            *position: Measurement
-    ) -> None:
-        """
-        Move axes to position relative to the current position.
-
-        Args:
-            position: Position.
-        """
-        request = dto.AxesMoveRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-            position=list(position),
-        )
-        call("axes/move_relative", request)
-
-    async def move_relative_async(
-            self,
-            *position: Measurement
-    ) -> None:
-        """
-        Move axes to position relative to the current position.
-
-        Args:
-            position: Position.
-        """
-        request = dto.AxesMoveRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-            position=list(position),
-        )
-        await call_async("axes/move_relative", request)
-
-    def move_min(
-            self
-    ) -> None:
-        """
-        Moves axes to the minimum position as specified by limit.min.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        call("axes/move_min", request)
-
-    async def move_min_async(
-            self
-    ) -> None:
-        """
-        Moves axes to the minimum position as specified by limit.min.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        await call_async("axes/move_min", request)
-
-    def move_max(
-            self
-    ) -> None:
-        """
-        Moves axes to the maximum position as specified by limit.max.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        call("axes/move_max", request)
-
-    async def move_max_async(
-            self
-    ) -> None:
-        """
-        Moves axes to the maximum position as specified by limit.max.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        await call_async("axes/move_max", request)
-
-    def wait_until_idle(
-            self
-    ) -> None:
-        """
-        Waits until all the axes stop moving.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        call("axes/wait_until_idle", request)
-
-    async def wait_until_idle_async(
-            self
-    ) -> None:
-        """
-        Waits until all the axes stop moving.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        await call_async("axes/wait_until_idle", request)
-
-    def is_busy(
-            self
-    ) -> bool:
-        """
-        Returns bool indicating whether any of the axes is executing a motion command.
-
-        Returns:
-            True if any of the axes is currently executing a motion command. False otherwise.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        response = call(
-            "axes/is_busy",
-            request,
-            dto.BoolResponse.from_binary)
-        return response.value
-
-    async def is_busy_async(
-            self
-    ) -> bool:
-        """
-        Returns bool indicating whether any of the axes is executing a motion command.
-
-        Returns:
-            True if any of the axes is currently executing a motion command. False otherwise.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        response = await call_async(
-            "axes/is_busy",
-            request,
-            dto.BoolResponse.from_binary)
-        return response.value
-
-    def is_homed(
-            self
-    ) -> bool:
-        """
-        Returns bool indicating whether all the axes are homed.
-
-        Returns:
-            True if all the axes are homed. False otherwise.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        response = call(
-            "axes/is_homed",
-            request,
-            dto.BoolResponse.from_binary)
-        return response.value
-
-    async def is_homed_async(
-            self
-    ) -> bool:
-        """
-        Returns bool indicating whether all the axes are homed.
-
-        Returns:
-            True if all the axes are homed. False otherwise.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        response = await call_async(
-            "axes/is_homed",
-            request,
-            dto.BoolResponse.from_binary)
-        return response.value
-
-    def get_position(
-            self,
-            *unit: LengthUnits
-    ) -> List[float]:
-        """
-        Returns current axes position.
-        The positions are requested sequentially.
-        The result position may not be accurate if the axes are moving.
-
-        Args:
-            unit: Units of position. You can specify units once or for each axis separately.
-
-        Returns:
-            Axes position.
-        """
-        request = dto.AxesGetSettingRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-            setting="pos",
-            unit=list(unit),
-        )
-        response = call(
-            "axes/get_setting",
-            request,
-            dto.DoubleArrayResponse.from_binary)
-        return response.values
-
-    async def get_position_async(
-            self,
-            *unit: LengthUnits
-    ) -> List[float]:
-        """
-        Returns current axes position.
-        The positions are requested sequentially.
-        The result position may not be accurate if the axes are moving.
-
-        Args:
-            unit: Units of position. You can specify units once or for each axis separately.
-
-        Returns:
-            Axes position.
-        """
-        request = dto.AxesGetSettingRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-            setting="pos",
-            unit=list(unit),
-        )
-        response = await call_async(
-            "axes/get_setting",
-            request,
-            dto.DoubleArrayResponse.from_binary)
-        return response.values
-
-    def __repr__(
-            self
-    ) -> str:
-        """
-        Returns a string that represents the axes.
-
-        Returns:
-            A string that represents the axes.
-        """
-        request = dto.AxesEmptyRequest(
-            interfaces=[axis.device.connection.interface_id for axis in self._axes],
-            devices=[axis.device.device_address for axis in self._axes],
-            axes=[axis.axis_number for axis in self._axes],
-        )
-        response = call_sync(
-            "axes/to_string",
-            request,
-            dto.StringResponse.from_binary)
-        return response.value
+# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
+# ============== DO NOT EDIT DIRECTLY ============== #
+
+from typing import List
+from ..call import call, call_async, call_sync
+
+from ..dto import requests as dto
+from .axis import Axis
+from ..dto.measurement import Measurement
+from ..units import LengthUnits
+
+
+class AxisGroup:
+    """
+    Groups multiple axes across devices into a single group to allow for simultaneous movement.
+    Note that the movement is not coordinated and trajectory is inconsistent and not repeatable between calls.
+    Make sure that any possible trajectory is clear of potential obstacles.
+    The movement methods return after all the axes finish the movement successfully
+    or throw an error as soon as possible.
+    """
+
+    @property
+    def axes(self) -> List[Axis]:
+        """
+        Axes of the group.
+        """
+        return self._axes
+
+    def __init__(self, axes: List[Axis]):
+        """
+        Initializes the group with the axes to be controlled.
+        """
+        self._axes: List[Axis] = axes.copy()
+
+    def home(
+            self
+    ) -> None:
+        """
+        Homes the axes.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        call("axes/home", request)
+
+    async def home_async(
+            self
+    ) -> None:
+        """
+        Homes the axes.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        await call_async("axes/home", request)
+
+    def stop(
+            self
+    ) -> None:
+        """
+        Stops the axes.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        call("axes/stop", request)
+
+    async def stop_async(
+            self
+    ) -> None:
+        """
+        Stops the axes.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        await call_async("axes/stop", request)
+
+    def move_absolute(
+            self,
+            *position: Measurement
+    ) -> None:
+        """
+        Moves the axes to absolute position.
+
+        Args:
+            position: Position.
+        """
+        request = dto.AxesMoveRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+            position=list(position),
+        )
+        call("axes/move_absolute", request)
+
+    async def move_absolute_async(
+            self,
+            *position: Measurement
+    ) -> None:
+        """
+        Moves the axes to absolute position.
+
+        Args:
+            position: Position.
+        """
+        request = dto.AxesMoveRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+            position=list(position),
+        )
+        await call_async("axes/move_absolute", request)
+
+    def move_relative(
+            self,
+            *position: Measurement
+    ) -> None:
+        """
+        Move axes to position relative to the current position.
+
+        Args:
+            position: Position.
+        """
+        request = dto.AxesMoveRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+            position=list(position),
+        )
+        call("axes/move_relative", request)
+
+    async def move_relative_async(
+            self,
+            *position: Measurement
+    ) -> None:
+        """
+        Move axes to position relative to the current position.
+
+        Args:
+            position: Position.
+        """
+        request = dto.AxesMoveRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+            position=list(position),
+        )
+        await call_async("axes/move_relative", request)
+
+    def move_min(
+            self
+    ) -> None:
+        """
+        Moves axes to the minimum position as specified by limit.min.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        call("axes/move_min", request)
+
+    async def move_min_async(
+            self
+    ) -> None:
+        """
+        Moves axes to the minimum position as specified by limit.min.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        await call_async("axes/move_min", request)
+
+    def move_max(
+            self
+    ) -> None:
+        """
+        Moves axes to the maximum position as specified by limit.max.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        call("axes/move_max", request)
+
+    async def move_max_async(
+            self
+    ) -> None:
+        """
+        Moves axes to the maximum position as specified by limit.max.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        await call_async("axes/move_max", request)
+
+    def wait_until_idle(
+            self
+    ) -> None:
+        """
+        Waits until all the axes stop moving.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        call("axes/wait_until_idle", request)
+
+    async def wait_until_idle_async(
+            self
+    ) -> None:
+        """
+        Waits until all the axes stop moving.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        await call_async("axes/wait_until_idle", request)
+
+    def is_busy(
+            self
+    ) -> bool:
+        """
+        Returns bool indicating whether any of the axes is executing a motion command.
+
+        Returns:
+            True if any of the axes is currently executing a motion command. False otherwise.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        response = call(
+            "axes/is_busy",
+            request,
+            dto.BoolResponse.from_binary)
+        return response.value
+
+    async def is_busy_async(
+            self
+    ) -> bool:
+        """
+        Returns bool indicating whether any of the axes is executing a motion command.
+
+        Returns:
+            True if any of the axes is currently executing a motion command. False otherwise.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        response = await call_async(
+            "axes/is_busy",
+            request,
+            dto.BoolResponse.from_binary)
+        return response.value
+
+    def is_homed(
+            self
+    ) -> bool:
+        """
+        Returns bool indicating whether all the axes are homed.
+
+        Returns:
+            True if all the axes are homed. False otherwise.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        response = call(
+            "axes/is_homed",
+            request,
+            dto.BoolResponse.from_binary)
+        return response.value
+
+    async def is_homed_async(
+            self
+    ) -> bool:
+        """
+        Returns bool indicating whether all the axes are homed.
+
+        Returns:
+            True if all the axes are homed. False otherwise.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        response = await call_async(
+            "axes/is_homed",
+            request,
+            dto.BoolResponse.from_binary)
+        return response.value
+
+    def get_position(
+            self,
+            *unit: LengthUnits
+    ) -> List[float]:
+        """
+        Returns current axes position.
+        The positions are requested sequentially.
+        The result position may not be accurate if the axes are moving.
+
+        Args:
+            unit: Units of position. You can specify units once or for each axis separately.
+
+        Returns:
+            Axes position.
+        """
+        request = dto.AxesGetSettingRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+            setting="pos",
+            unit=list(unit),
+        )
+        response = call(
+            "axes/get_setting",
+            request,
+            dto.DoubleArrayResponse.from_binary)
+        return response.values
+
+    async def get_position_async(
+            self,
+            *unit: LengthUnits
+    ) -> List[float]:
+        """
+        Returns current axes position.
+        The positions are requested sequentially.
+        The result position may not be accurate if the axes are moving.
+
+        Args:
+            unit: Units of position. You can specify units once or for each axis separately.
+
+        Returns:
+            Axes position.
+        """
+        request = dto.AxesGetSettingRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+            setting="pos",
+            unit=list(unit),
+        )
+        response = await call_async(
+            "axes/get_setting",
+            request,
+            dto.DoubleArrayResponse.from_binary)
+        return response.values
+
+    def __repr__(
+            self
+    ) -> str:
+        """
+        Returns a string that represents the axes.
+
+        Returns:
+            A string that represents the axes.
+        """
+        request = dto.AxesEmptyRequest(
+            interfaces=[axis.device.connection.interface_id for axis in self._axes],
+            devices=[axis.device.device_address for axis in self._axes],
+            axes=[axis.axis_number for axis in self._axes],
+        )
+        response = call_sync(
+            "axes/to_string",
+            request,
+            dto.StringResponse.from_binary)
+        return response.value