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

zaber_motion/ascii/pvt.py

@@ -1,105 +1,105 @@
-# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
-# ============== DO NOT EDIT DIRECTLY ============== #
-from typing import TYPE_CHECKING, List
-
-from ..call import call, call_async
-from ..dto import requests as dto
-
-from .pvt_sequence import PvtSequence
-from .pvt_buffer import PvtBuffer
-
-if TYPE_CHECKING:
-    from .device import Device
-
-
-class Pvt:
-    """
-    Class providing access to device PVT (Position-Velocity-Time) features.
-    Requires at least Firmware 7.33.
-    """
-
-    @property
-    def device(self) -> 'Device':
-        """
-        Device that this PVT belongs to.
-        """
-        return self._device
-
-    def __init__(self, device: 'Device'):
-        self._device: 'Device' = device
-
-    def get_sequence(
-            self,
-            pvt_id: int
-    ) -> 'PvtSequence':
-        """
-        Gets a PvtSequence class instance which allows you to control a particular PVT sequence on the device.
-
-        Args:
-            pvt_id: The ID of the PVT sequence to control. The IDs start at 1.
-
-        Returns:
-            PvtSequence instance.
-        """
-        if pvt_id <= 0:
-            raise ValueError('Invalid value; PVT sequences are numbered from 1.')
-
-        return PvtSequence(self.device, pvt_id)
-
-    def get_buffer(
-            self,
-            pvt_buffer_id: int
-    ) -> 'PvtBuffer':
-        """
-        Gets a PvtBuffer class instance which is a handle for a PVT buffer on the device.
-
-        Args:
-            pvt_buffer_id: The ID of the PVT buffer to control. PVT buffer IDs start at one.
-
-        Returns:
-            PvtBuffer instance.
-        """
-        if pvt_buffer_id <= 0:
-            raise ValueError('Invalid value; PVT buffers are numbered from 1.')
-
-        return PvtBuffer(self.device, pvt_buffer_id)
-
-    def list_buffer_ids(
-            self
-    ) -> List[int]:
-        """
-        Get a list of buffer IDs that are currently in use.
-
-        Returns:
-            List of buffer IDs.
-        """
-        request = dto.StreamBufferList(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            pvt=True,
-        )
-        response = call(
-            "device/stream_buffer_list",
-            request,
-            dto.IntArrayResponse.from_binary)
-        return response.values
-
-    async def list_buffer_ids_async(
-            self
-    ) -> List[int]:
-        """
-        Get a list of buffer IDs that are currently in use.
-
-        Returns:
-            List of buffer IDs.
-        """
-        request = dto.StreamBufferList(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            pvt=True,
-        )
-        response = await call_async(
-            "device/stream_buffer_list",
-            request,
-            dto.IntArrayResponse.from_binary)
-        return response.values
+# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
+# ============== DO NOT EDIT DIRECTLY ============== #
+from typing import TYPE_CHECKING, List
+
+from ..call import call, call_async
+from ..dto import requests as dto
+
+from .pvt_sequence import PvtSequence
+from .pvt_buffer import PvtBuffer
+
+if TYPE_CHECKING:
+    from .device import Device
+
+
+class Pvt:
+    """
+    Class providing access to device PVT (Position-Velocity-Time) features.
+    Requires at least Firmware 7.33.
+    """
+
+    @property
+    def device(self) -> 'Device':
+        """
+        Device that this PVT belongs to.
+        """
+        return self._device
+
+    def __init__(self, device: 'Device'):
+        self._device: 'Device' = device
+
+    def get_sequence(
+            self,
+            pvt_id: int
+    ) -> 'PvtSequence':
+        """
+        Gets a PvtSequence class instance which allows you to control a particular PVT sequence on the device.
+
+        Args:
+            pvt_id: The ID of the PVT sequence to control. The IDs start at 1.
+
+        Returns:
+            PvtSequence instance.
+        """
+        if pvt_id <= 0:
+            raise ValueError('Invalid value; PVT sequences are numbered from 1.')
+
+        return PvtSequence(self.device, pvt_id)
+
+    def get_buffer(
+            self,
+            pvt_buffer_id: int
+    ) -> 'PvtBuffer':
+        """
+        Gets a PvtBuffer class instance which is a handle for a PVT buffer on the device.
+
+        Args:
+            pvt_buffer_id: The ID of the PVT buffer to control. PVT buffer IDs start at one.
+
+        Returns:
+            PvtBuffer instance.
+        """
+        if pvt_buffer_id <= 0:
+            raise ValueError('Invalid value; PVT buffers are numbered from 1.')
+
+        return PvtBuffer(self.device, pvt_buffer_id)
+
+    def list_buffer_ids(
+            self
+    ) -> List[int]:
+        """
+        Get a list of buffer IDs that are currently in use.
+
+        Returns:
+            List of buffer IDs.
+        """
+        request = dto.StreamBufferList(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            pvt=True,
+        )
+        response = call(
+            "device/stream_buffer_list",
+            request,
+            dto.IntArrayResponse.from_binary)
+        return response.values
+
+    async def list_buffer_ids_async(
+            self
+    ) -> List[int]:
+        """
+        Get a list of buffer IDs that are currently in use.
+
+        Returns:
+            List of buffer IDs.
+        """
+        request = dto.StreamBufferList(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            pvt=True,
+        )
+        response = await call_async(
+            "device/stream_buffer_list",
+            request,
+            dto.IntArrayResponse.from_binary)
+        return response.values

zaber_motion/ascii/pvt_buffer.py

@@ -1,146 +1,146 @@
-# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
-# ============== DO NOT EDIT DIRECTLY ============== #
-from typing import TYPE_CHECKING, List
-from ..dto.ascii.pvt_sequence_data import PvtSequenceData
-from ..dto import requests as dto
-from ..call import call, call_async
-
-if TYPE_CHECKING:
-    from .device import Device
-
-
-class PvtBuffer:
-    """
-    Represents a PVT buffer with this number on a device.
-    A PVT buffer is a place to store a queue of PVT actions.
-    """
-
-    @property
-    def device(self) -> 'Device':
-        """
-        The Device this buffer exists on.
-        """
-        return self._device
-
-    @property
-    def buffer_id(self) -> int:
-        """
-        The number identifying the buffer on the device.
-        """
-        return self._buffer_id
-
-    def __init__(self, device: 'Device', buffer_id: int):
-        self._device: 'Device' = device
-        self._buffer_id: int = buffer_id
-
-    def get_content(
-            self
-    ) -> List[str]:
-        """
-        Gets the buffer contents as an array of strings.
-
-        Returns:
-            A string array containing all the PVT commands stored in the buffer.
-        """
-        request = dto.StreamBufferGetContentRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            buffer_id=self.buffer_id,
-            pvt=True,
-        )
-        response = call(
-            "device/stream_buffer_get_content",
-            request,
-            dto.StreamBufferGetContentResponse.from_binary)
-        return response.buffer_lines
-
-    async def get_content_async(
-            self
-    ) -> List[str]:
-        """
-        Gets the buffer contents as an array of strings.
-
-        Returns:
-            A string array containing all the PVT commands stored in the buffer.
-        """
-        request = dto.StreamBufferGetContentRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            buffer_id=self.buffer_id,
-            pvt=True,
-        )
-        response = await call_async(
-            "device/stream_buffer_get_content",
-            request,
-            dto.StreamBufferGetContentResponse.from_binary)
-        return response.buffer_lines
-
-    def retrieve_sequence_data(
-            self
-    ) -> PvtSequenceData:
-        """
-        Gets the buffer contents as a PvtSequenceData object.
-
-        Returns:
-            The PVT data loaded from the buffer.
-        """
-        request = dto.PvtBufferGetSequenceDataRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            buffer_id=self.buffer_id,
-        )
-        response = call(
-            "device/pvt_buffer_get_data",
-            request,
-            PvtSequenceData.from_binary)
-        return response
-
-    async def retrieve_sequence_data_async(
-            self
-    ) -> PvtSequenceData:
-        """
-        Gets the buffer contents as a PvtSequenceData object.
-
-        Returns:
-            The PVT data loaded from the buffer.
-        """
-        request = dto.PvtBufferGetSequenceDataRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            buffer_id=self.buffer_id,
-        )
-        response = await call_async(
-            "device/pvt_buffer_get_data",
-            request,
-            PvtSequenceData.from_binary)
-        return response
-
-    def erase(
-            self
-    ) -> None:
-        """
-        Erases the contents of the buffer.
-        This method fails if there is a PVT sequence writing to the buffer.
-        """
-        request = dto.StreamBufferEraseRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            buffer_id=self.buffer_id,
-            pvt=True,
-        )
-        call("device/stream_buffer_erase", request)
-
-    async def erase_async(
-            self
-    ) -> None:
-        """
-        Erases the contents of the buffer.
-        This method fails if there is a PVT sequence writing to the buffer.
-        """
-        request = dto.StreamBufferEraseRequest(
-            interface_id=self.device.connection.interface_id,
-            device=self.device.device_address,
-            buffer_id=self.buffer_id,
-            pvt=True,
-        )
-        await call_async("device/stream_buffer_erase", request)
+# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
+# ============== DO NOT EDIT DIRECTLY ============== #
+from typing import TYPE_CHECKING, List
+from ..dto.ascii.pvt_sequence_data import PvtSequenceData
+from ..dto import requests as dto
+from ..call import call, call_async
+
+if TYPE_CHECKING:
+    from .device import Device
+
+
+class PvtBuffer:
+    """
+    Represents a PVT buffer with this number on a device.
+    A PVT buffer is a place to store a queue of PVT actions.
+    """
+
+    @property
+    def device(self) -> 'Device':
+        """
+        The Device this buffer exists on.
+        """
+        return self._device
+
+    @property
+    def buffer_id(self) -> int:
+        """
+        The number identifying the buffer on the device.
+        """
+        return self._buffer_id
+
+    def __init__(self, device: 'Device', buffer_id: int):
+        self._device: 'Device' = device
+        self._buffer_id: int = buffer_id
+
+    def get_content(
+            self
+    ) -> List[str]:
+        """
+        Gets the buffer contents as an array of strings.
+
+        Returns:
+            A string array containing all the PVT commands stored in the buffer.
+        """
+        request = dto.StreamBufferGetContentRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            buffer_id=self.buffer_id,
+            pvt=True,
+        )
+        response = call(
+            "device/stream_buffer_get_content",
+            request,
+            dto.StreamBufferGetContentResponse.from_binary)
+        return response.buffer_lines
+
+    async def get_content_async(
+            self
+    ) -> List[str]:
+        """
+        Gets the buffer contents as an array of strings.
+
+        Returns:
+            A string array containing all the PVT commands stored in the buffer.
+        """
+        request = dto.StreamBufferGetContentRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            buffer_id=self.buffer_id,
+            pvt=True,
+        )
+        response = await call_async(
+            "device/stream_buffer_get_content",
+            request,
+            dto.StreamBufferGetContentResponse.from_binary)
+        return response.buffer_lines
+
+    def retrieve_sequence_data(
+            self
+    ) -> PvtSequenceData:
+        """
+        Gets the buffer contents as a PvtSequenceData object.
+
+        Returns:
+            The PVT data loaded from the buffer.
+        """
+        request = dto.PvtBufferGetSequenceDataRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            buffer_id=self.buffer_id,
+        )
+        response = call(
+            "device/pvt_buffer_get_data",
+            request,
+            PvtSequenceData.from_binary)
+        return response
+
+    async def retrieve_sequence_data_async(
+            self
+    ) -> PvtSequenceData:
+        """
+        Gets the buffer contents as a PvtSequenceData object.
+
+        Returns:
+            The PVT data loaded from the buffer.
+        """
+        request = dto.PvtBufferGetSequenceDataRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            buffer_id=self.buffer_id,
+        )
+        response = await call_async(
+            "device/pvt_buffer_get_data",
+            request,
+            PvtSequenceData.from_binary)
+        return response
+
+    def erase(
+            self
+    ) -> None:
+        """
+        Erases the contents of the buffer.
+        This method fails if there is a PVT sequence writing to the buffer.
+        """
+        request = dto.StreamBufferEraseRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            buffer_id=self.buffer_id,
+            pvt=True,
+        )
+        call("device/stream_buffer_erase", request)
+
+    async def erase_async(
+            self
+    ) -> None:
+        """
+        Erases the contents of the buffer.
+        This method fails if there is a PVT sequence writing to the buffer.
+        """
+        request = dto.StreamBufferEraseRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+            buffer_id=self.buffer_id,
+            pvt=True,
+        )
+        await call_async("device/stream_buffer_erase", request)