zaber-motion 7.13.0__py3-none-win32.whl → 7.15.0__py3-none-win32.whl

zaber_motion/ascii/warning_flags.py

@@ -1,178 +1,178 @@
-# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
-# ============== DO NOT EDIT DIRECTLY ============== #
-
-
-class WarningFlags:
-
-    """
-    Critical System Error.
-    """
-    CRITICAL_SYSTEM_ERROR = "FF"
-
-    """
-    Peripheral Not Supported.
-    """
-    PERIPHERAL_NOT_SUPPORTED = "FN"
-
-    """
-    Peripheral Inactive.
-    """
-    PERIPHERAL_INACTIVE = "FZ"
-
-    """
-    Hardware Emergency Stop Driver Disabled.
-    """
-    HARDWARE_EMERGENCY_STOP = "FH"
-
-    """
-    Overvoltage or Undervoltage Driver Disabled.
-    """
-    OVERVOLTAGE_OR_UNDERVOLTAGE = "FV"
-
-    """
-    Driver Disabled on Startup or by Command.
-    Devices with Firmware 7.11 and above.
-    """
-    DRIVER_DISABLED_NO_FAULT = "FO"
-
-    """
-    Current Inrush Error.
-    """
-    CURRENT_INRUSH_ERROR = "FC"
-
-    """
-    Motor Temperature Error.
-    """
-    MOTOR_TEMPERATURE_ERROR = "FM"
-
-    """
-    Driver Disabled.
-    Devices with Firmware 7.10 and lower.
-    """
-    DRIVER_DISABLED = "FD"
-
-    """
-    Encoder Error.
-    """
-    ENCODER_ERROR = "FQ"
-
-    """
-    Index Error.
-    """
-    INDEX_ERROR = "FI"
-
-    """
-    Analog Encoder Sync Error.
-    """
-    ANALOG_ENCODER_SYNC_ERROR = "FA"
-
-    """
-    Overdrive Limit Exceeded.
-    """
-    OVERDRIVE_LIMIT_EXCEEDED = "FR"
-
-    """
-    Stalled and Stopped.
-    """
-    STALLED_AND_STOPPED = "FS"
-
-    """
-    Stream Bounds Error.
-    """
-    STREAM_BOUNDS_ERROR = "FB"
-
-    """
-    Interpolated Path Deviation.
-    """
-    INTERPOLATED_PATH_DEVIATION = "FP"
-
-    """
-    Limit Error.
-    """
-    LIMIT_ERROR = "FE"
-
-    """
-    Excessive Twist.
-    """
-    EXCESSIVE_TWIST = "FT"
-
-    """
-    Unexpected Limit Trigger.
-    """
-    UNEXPECTED_LIMIT_TRIGGER = "WL"
-
-    """
-    Voltage Out of Range.
-    """
-    VOLTAGE_OUT_OF_RANGE = "WV"
-
-    """
-    Controller Temperature High.
-    """
-    CONTROLLER_TEMPERATURE_HIGH = "WT"
-
-    """
-    Stalled with Recovery.
-    """
-    STALLED_WITH_RECOVERY = "WS"
-
-    """
-    Displaced When Stationary.
-    """
-    DISPLACED_WHEN_STATIONARY = "WM"
-
-    """
-    Invalid Calibration Type.
-    """
-    INVALID_CALIBRATION_TYPE = "WP"
-
-    """
-    No Reference Position.
-    """
-    NO_REFERENCE_POSITION = "WR"
-
-    """
-    Device Not Homed.
-    """
-    DEVICE_NOT_HOMED = "WH"
-
-    """
-    Manual Control.
-    """
-    MANUAL_CONTROL = "NC"
-
-    """
-    Movement Interrupted.
-    """
-    MOVEMENT_INTERRUPTED = "NI"
-
-    """
-    Stream Discontinuity.
-    """
-    STREAM_DISCONTINUITY = "ND"
-
-    """
-    Value Rounded.
-    """
-    VALUE_ROUNDED = "NR"
-
-    """
-    Value Truncated.
-    """
-    VALUE_TRUNCATED = "NT"
-
-    """
-    Setting Update Pending.
-    """
-    SETTING_UPDATE_PENDING = "NU"
-
-    """
-    Joystick Calibrating.
-    """
-    JOYSTICK_CALIBRATING = "NJ"
-
-    """
-    Device in Firmware Update Mode.
-    Firmware 6.xx only.
-    """
-    FIRMWARE_UPDATE_MODE = "NB"
+# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
+# ============== DO NOT EDIT DIRECTLY ============== #
+
+
+class WarningFlags:
+
+    """
+    Critical System Error.
+    """
+    CRITICAL_SYSTEM_ERROR = "FF"
+
+    """
+    Peripheral Not Supported.
+    """
+    PERIPHERAL_NOT_SUPPORTED = "FN"
+
+    """
+    Peripheral Inactive.
+    """
+    PERIPHERAL_INACTIVE = "FZ"
+
+    """
+    Hardware Emergency Stop Driver Disabled.
+    """
+    HARDWARE_EMERGENCY_STOP = "FH"
+
+    """
+    Overvoltage or Undervoltage Driver Disabled.
+    """
+    OVERVOLTAGE_OR_UNDERVOLTAGE = "FV"
+
+    """
+    Driver Disabled on Startup or by Command.
+    Devices with Firmware 7.11 and above.
+    """
+    DRIVER_DISABLED_NO_FAULT = "FO"
+
+    """
+    Current Inrush Error.
+    """
+    CURRENT_INRUSH_ERROR = "FC"
+
+    """
+    Motor Temperature Error.
+    """
+    MOTOR_TEMPERATURE_ERROR = "FM"
+
+    """
+    Driver Disabled.
+    Devices with Firmware 7.10 and lower.
+    """
+    DRIVER_DISABLED = "FD"
+
+    """
+    Encoder Error.
+    """
+    ENCODER_ERROR = "FQ"
+
+    """
+    Index Error.
+    """
+    INDEX_ERROR = "FI"
+
+    """
+    Analog Encoder Sync Error.
+    """
+    ANALOG_ENCODER_SYNC_ERROR = "FA"
+
+    """
+    Overdrive Limit Exceeded.
+    """
+    OVERDRIVE_LIMIT_EXCEEDED = "FR"
+
+    """
+    Stalled and Stopped.
+    """
+    STALLED_AND_STOPPED = "FS"
+
+    """
+    Stream Bounds Error.
+    """
+    STREAM_BOUNDS_ERROR = "FB"
+
+    """
+    Interpolated Path Deviation.
+    """
+    INTERPOLATED_PATH_DEVIATION = "FP"
+
+    """
+    Limit Error.
+    """
+    LIMIT_ERROR = "FE"
+
+    """
+    Excessive Twist.
+    """
+    EXCESSIVE_TWIST = "FT"
+
+    """
+    Unexpected Limit Trigger.
+    """
+    UNEXPECTED_LIMIT_TRIGGER = "WL"
+
+    """
+    Voltage Out of Range.
+    """
+    VOLTAGE_OUT_OF_RANGE = "WV"
+
+    """
+    Controller Temperature High.
+    """
+    CONTROLLER_TEMPERATURE_HIGH = "WT"
+
+    """
+    Stalled with Recovery.
+    """
+    STALLED_WITH_RECOVERY = "WS"
+
+    """
+    Displaced When Stationary.
+    """
+    DISPLACED_WHEN_STATIONARY = "WM"
+
+    """
+    Invalid Calibration Type.
+    """
+    INVALID_CALIBRATION_TYPE = "WP"
+
+    """
+    No Reference Position.
+    """
+    NO_REFERENCE_POSITION = "WR"
+
+    """
+    Device Not Homed.
+    """
+    DEVICE_NOT_HOMED = "WH"
+
+    """
+    Manual Control.
+    """
+    MANUAL_CONTROL = "NC"
+
+    """
+    Movement Interrupted.
+    """
+    MOVEMENT_INTERRUPTED = "NI"
+
+    """
+    Stream Discontinuity.
+    """
+    STREAM_DISCONTINUITY = "ND"
+
+    """
+    Value Rounded.
+    """
+    VALUE_ROUNDED = "NR"
+
+    """
+    Value Truncated.
+    """
+    VALUE_TRUNCATED = "NT"
+
+    """
+    Setting Update Pending.
+    """
+    SETTING_UPDATE_PENDING = "NU"
+
+    """
+    Joystick Calibrating.
+    """
+    JOYSTICK_CALIBRATING = "NJ"
+
+    """
+    Device in Firmware Update Mode.
+    Firmware 6.xx only.
+    """
+    FIRMWARE_UPDATE_MODE = "NB"

zaber_motion/ascii/warnings.py

@@ -1,152 +1,152 @@
-# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
-# ============== DO NOT EDIT DIRECTLY ============== #
-
-from typing import TYPE_CHECKING, Set
-from ..call import call, call_async
-
-from ..dto import requests as dto
-
-if TYPE_CHECKING:
-    from .device import Device
-
-
-class Warnings:
-    """
-    Class used to check and reset warnings and faults on device or axis.
-    """
-
-    def __init__(self, device: 'Device', axis_number: int):
-        self._device: 'Device' = device
-        self._axis_number: int = axis_number
-
-    def get_flags(
-            self
-    ) -> Set[str]:
-        """
-        Returns current warnings and faults on axis or device.
-
-        Returns:
-            Retrieved warnings and faults. Refer to WarningFlags to check a particular flag.
-        """
-        request = dto.DeviceGetWarningsRequest(
-            interface_id=self._device.connection.interface_id,
-            device=self._device.device_address,
-            axis=self._axis_number,
-            clear=False,
-        )
-        response = call(
-            "device/get_warnings",
-            request,
-            dto.DeviceGetWarningsResponse.from_binary)
-        return set(response.flags)
-
-    async def get_flags_async(
-            self
-    ) -> Set[str]:
-        """
-        Returns current warnings and faults on axis or device.
-
-        Returns:
-            Retrieved warnings and faults. Refer to WarningFlags to check a particular flag.
-        """
-        request = dto.DeviceGetWarningsRequest(
-            interface_id=self._device.connection.interface_id,
-            device=self._device.device_address,
-            axis=self._axis_number,
-            clear=False,
-        )
-        response = await call_async(
-            "device/get_warnings",
-            request,
-            dto.DeviceGetWarningsResponse.from_binary)
-        return set(response.flags)
-
-    def clear_flags(
-            self
-    ) -> Set[str]:
-        """
-        Clears (acknowledges) current warnings and faults on axis or device and returns them.
-
-        Returns:
-            Warnings and faults before clearing. Refer to WarningFlags to check a particular flag.
-        """
-        request = dto.DeviceGetWarningsRequest(
-            interface_id=self._device.connection.interface_id,
-            device=self._device.device_address,
-            axis=self._axis_number,
-            clear=True,
-        )
-        response = call(
-            "device/get_warnings",
-            request,
-            dto.DeviceGetWarningsResponse.from_binary)
-        return set(response.flags)
-
-    async def clear_flags_async(
-            self
-    ) -> Set[str]:
-        """
-        Clears (acknowledges) current warnings and faults on axis or device and returns them.
-
-        Returns:
-            Warnings and faults before clearing. Refer to WarningFlags to check a particular flag.
-        """
-        request = dto.DeviceGetWarningsRequest(
-            interface_id=self._device.connection.interface_id,
-            device=self._device.device_address,
-            axis=self._axis_number,
-            clear=True,
-        )
-        response = await call_async(
-            "device/get_warnings",
-            request,
-            dto.DeviceGetWarningsResponse.from_binary)
-        return set(response.flags)
-
-    def wait_to_clear(
-            self,
-            timeout: float,
-            *warning_flags: str
-    ) -> None:
-        """
-        Waits for the specified flags to clear.
-        Use for warnings flags that clear on their own.
-        Does not clear clearable warnings flags.
-        Throws TimeoutException if the flags don't clear in the specified time.
-
-        Args:
-            timeout: For how long to wait in milliseconds for the flags to clear.
-            warning_flags: The specific warning flags for which to wait to clear.
-        """
-        request = dto.WaitToClearWarningsRequest(
-            interface_id=self._device.connection.interface_id,
-            device=self._device.device_address,
-            axis=self._axis_number,
-            timeout=timeout,
-            warning_flags=list(warning_flags),
-        )
-        call("device/wait_to_clear_warnings", request)
-
-    async def wait_to_clear_async(
-            self,
-            timeout: float,
-            *warning_flags: str
-    ) -> None:
-        """
-        Waits for the specified flags to clear.
-        Use for warnings flags that clear on their own.
-        Does not clear clearable warnings flags.
-        Throws TimeoutException if the flags don't clear in the specified time.
-
-        Args:
-            timeout: For how long to wait in milliseconds for the flags to clear.
-            warning_flags: The specific warning flags for which to wait to clear.
-        """
-        request = dto.WaitToClearWarningsRequest(
-            interface_id=self._device.connection.interface_id,
-            device=self._device.device_address,
-            axis=self._axis_number,
-            timeout=timeout,
-            warning_flags=list(warning_flags),
-        )
-        await call_async("device/wait_to_clear_warnings", request)
+# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
+# ============== DO NOT EDIT DIRECTLY ============== #
+
+from typing import TYPE_CHECKING, Set
+from ..call import call, call_async
+
+from ..dto import requests as dto
+
+if TYPE_CHECKING:
+    from .device import Device
+
+
+class Warnings:
+    """
+    Class used to check and reset warnings and faults on device or axis.
+    """
+
+    def __init__(self, device: 'Device', axis_number: int):
+        self._device: 'Device' = device
+        self._axis_number: int = axis_number
+
+    def get_flags(
+            self
+    ) -> Set[str]:
+        """
+        Returns current warnings and faults on axis or device.
+
+        Returns:
+            Retrieved warnings and faults. Refer to WarningFlags to check a particular flag.
+        """
+        request = dto.DeviceGetWarningsRequest(
+            interface_id=self._device.connection.interface_id,
+            device=self._device.device_address,
+            axis=self._axis_number,
+            clear=False,
+        )
+        response = call(
+            "device/get_warnings",
+            request,
+            dto.DeviceGetWarningsResponse.from_binary)
+        return set(response.flags)
+
+    async def get_flags_async(
+            self
+    ) -> Set[str]:
+        """
+        Returns current warnings and faults on axis or device.
+
+        Returns:
+            Retrieved warnings and faults. Refer to WarningFlags to check a particular flag.
+        """
+        request = dto.DeviceGetWarningsRequest(
+            interface_id=self._device.connection.interface_id,
+            device=self._device.device_address,
+            axis=self._axis_number,
+            clear=False,
+        )
+        response = await call_async(
+            "device/get_warnings",
+            request,
+            dto.DeviceGetWarningsResponse.from_binary)
+        return set(response.flags)
+
+    def clear_flags(
+            self
+    ) -> Set[str]:
+        """
+        Clears (acknowledges) current warnings and faults on axis or device and returns them.
+
+        Returns:
+            Warnings and faults before clearing. Refer to WarningFlags to check a particular flag.
+        """
+        request = dto.DeviceGetWarningsRequest(
+            interface_id=self._device.connection.interface_id,
+            device=self._device.device_address,
+            axis=self._axis_number,
+            clear=True,
+        )
+        response = call(
+            "device/get_warnings",
+            request,
+            dto.DeviceGetWarningsResponse.from_binary)
+        return set(response.flags)
+
+    async def clear_flags_async(
+            self
+    ) -> Set[str]:
+        """
+        Clears (acknowledges) current warnings and faults on axis or device and returns them.
+
+        Returns:
+            Warnings and faults before clearing. Refer to WarningFlags to check a particular flag.
+        """
+        request = dto.DeviceGetWarningsRequest(
+            interface_id=self._device.connection.interface_id,
+            device=self._device.device_address,
+            axis=self._axis_number,
+            clear=True,
+        )
+        response = await call_async(
+            "device/get_warnings",
+            request,
+            dto.DeviceGetWarningsResponse.from_binary)
+        return set(response.flags)
+
+    def wait_to_clear(
+            self,
+            timeout: float,
+            *warning_flags: str
+    ) -> None:
+        """
+        Waits for the specified flags to clear.
+        Use for warnings flags that clear on their own.
+        Does not clear clearable warnings flags.
+        Throws TimeoutException if the flags don't clear in the specified time.
+
+        Args:
+            timeout: For how long to wait in milliseconds for the flags to clear.
+            warning_flags: The specific warning flags for which to wait to clear.
+        """
+        request = dto.WaitToClearWarningsRequest(
+            interface_id=self._device.connection.interface_id,
+            device=self._device.device_address,
+            axis=self._axis_number,
+            timeout=timeout,
+            warning_flags=list(warning_flags),
+        )
+        call("device/wait_to_clear_warnings", request)
+
+    async def wait_to_clear_async(
+            self,
+            timeout: float,
+            *warning_flags: str
+    ) -> None:
+        """
+        Waits for the specified flags to clear.
+        Use for warnings flags that clear on their own.
+        Does not clear clearable warnings flags.
+        Throws TimeoutException if the flags don't clear in the specified time.
+
+        Args:
+            timeout: For how long to wait in milliseconds for the flags to clear.
+            warning_flags: The specific warning flags for which to wait to clear.
+        """
+        request = dto.WaitToClearWarningsRequest(
+            interface_id=self._device.connection.interface_id,
+            device=self._device.device_address,
+            axis=self._axis_number,
+            timeout=timeout,
+            warning_flags=list(warning_flags),
+        )
+        await call_async("device/wait_to_clear_warnings", request)