zaber-motion 7.9.1__py3-none-win_amd64.whl → 7.11.0__py3-none-win_amd64.whl

zaber_motion/__init__.py

@@ -9,6 +9,7 @@ from .tools import Tools as Tools
 from .unit_table import UnitTable as UnitTable
 from .dto.axis_address import AxisAddress as AxisAddress
 from .dto.channel_address import ChannelAddress as ChannelAddress
+from .dto.device_db_source import DeviceDbSource as DeviceDbSource
 from .dto.device_db_source_type import DeviceDbSourceType as DeviceDbSourceType
 from .dto.firmware_version import FirmwareVersion as FirmwareVersion
 from .dto.log_output_mode import LogOutputMode as LogOutputMode
@@ -83,6 +84,7 @@ from .dto.exceptions.command_failed_exception_data import CommandFailedException
 from .dto.exceptions.command_too_long_exception_data import CommandTooLongExceptionData as CommandTooLongExceptionData
 from .dto.exceptions.device_address_conflict_exception_data import DeviceAddressConflictExceptionData as DeviceAddressConflictExceptionData
 from .dto.exceptions.device_db_failed_exception_data import DeviceDbFailedExceptionData as DeviceDbFailedExceptionData
+from .dto.exceptions.device_db_inner_error import DeviceDbInnerError as DeviceDbInnerError
 from .dto.exceptions.g_code_execution_exception_data import GCodeExecutionExceptionData as GCodeExecutionExceptionData
 from .dto.exceptions.g_code_syntax_exception_data import GCodeSyntaxExceptionData as GCodeSyntaxExceptionData
 from .dto.exceptions.invalid_packet_exception_data import InvalidPacketExceptionData as InvalidPacketExceptionData

zaber_motion/ascii/all_axes.py

@@ -23,7 +23,7 @@ class AllAxes:
         return self._device
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def home(
             self,

zaber_motion/ascii/axis.py

@@ -112,11 +112,11 @@ class Axis:
         return self.__retrieve_label()
 
     def __init__(self, device: 'Device', axis_number: int):
-        self._device = device
-        self._axis_number = axis_number
-        self._settings = AxisSettings(self)
-        self._storage = AxisStorage(self)
-        self._warnings = Warnings(device, axis_number)
+        self._device: 'Device' = device
+        self._axis_number: int = axis_number
+        self._settings: AxisSettings = AxisSettings(self)
+        self._storage: AxisStorage = AxisStorage(self)
+        self._warnings: Warnings = Warnings(device, axis_number)
 
     def home(
             self,

zaber_motion/ascii/axis_group.py

@@ -30,7 +30,7 @@ class AxisGroup:
         """
         Initializes the group with the axes to be controlled.
         """
-        self._axes = axes.copy()
+        self._axes: List[Axis] = axes.copy()
 
     def home(
             self

zaber_motion/ascii/axis_settings.py

@@ -20,7 +20,7 @@ class AxisSettings:
     """
 
     def __init__(self, axis: 'Axis'):
-        self._axis = axis
+        self._axis: 'Axis' = axis
 
     def get(
             self,

zaber_motion/ascii/connection.py

@@ -123,7 +123,7 @@ class Connection:
         return self.__retrieve_is_open()
 
     def __init__(self, interface_id: int):
-        self._interface_id = interface_id
+        self._interface_id: int = interface_id
         self.__setup_events(0)
 
     @staticmethod

zaber_motion/ascii/device.py

@@ -180,17 +180,17 @@ class Device:
         return self._pvt
 
     def __init__(self, connection: 'Connection', device_address: int):
-        self._connection = connection
-        self._device_address = device_address
-        self._settings = DeviceSettings(self)
-        self._storage = DeviceStorage(self)
-        self._io = DeviceIO(self)
-        self._all_axes = AllAxes(self)
-        self._warnings = Warnings(self, 0)
-        self._oscilloscope = Oscilloscope(self)
-        self._triggers = Triggers(self)
-        self._streams = Streams(self)
-        self._pvt = Pvt(self)
+        self._connection: 'Connection' = connection
+        self._device_address: int = device_address
+        self._settings: DeviceSettings = DeviceSettings(self)
+        self._storage: DeviceStorage = DeviceStorage(self)
+        self._io: DeviceIO = DeviceIO(self)
+        self._all_axes: AllAxes = AllAxes(self)
+        self._warnings: Warnings = Warnings(self, 0)
+        self._oscilloscope: Oscilloscope = Oscilloscope(self)
+        self._triggers: Triggers = Triggers(self)
+        self._streams: Streams = Streams(self)
+        self._pvt: Pvt = Pvt(self)
 
     def identify(
             self,

zaber_motion/ascii/device_io.py

@@ -21,7 +21,7 @@ class DeviceIO:
     """
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def get_channels_info(
             self

zaber_motion/ascii/device_settings.py

@@ -20,7 +20,7 @@ class DeviceSettings:
     """
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def get(
             self,

zaber_motion/ascii/lockstep.py

@@ -32,8 +32,8 @@ class Lockstep:
         return self._lockstep_group_id
 
     def __init__(self, device: 'Device', lockstep_group_id: int):
-        self._device = device
-        self._lockstep_group_id = lockstep_group_id
+        self._device: 'Device' = device
+        self._lockstep_group_id: int = lockstep_group_id
 
     def enable(
             self,

zaber_motion/ascii/oscilloscope.py

@@ -26,7 +26,7 @@ class Oscilloscope:
         return self._device
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def add_channel(
             self,

zaber_motion/ascii/oscilloscope_data.py

@@ -57,7 +57,7 @@ class OscilloscopeData:
         return self.__retrieve_properties().io_channel
 
     def __init__(self, data_id: int):
-        self._data_id = data_id
+        self._data_id: int = data_id
 
     def get_timebase(
             self,

zaber_motion/ascii/pvt.py

@@ -26,7 +26,7 @@ class Pvt:
         return self._device
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def get_sequence(
             self,

zaber_motion/ascii/pvt_buffer.py

@@ -29,8 +29,8 @@ class PvtBuffer:
         return self._buffer_id
 
     def __init__(self, device: 'Device', buffer_id: int):
-        self._device = device
-        self._buffer_id = buffer_id
+        self._device: 'Device' = device
+        self._buffer_id: int = buffer_id
 
     def get_content(
             self

zaber_motion/ascii/pvt_io.py

@@ -18,8 +18,8 @@ class PvtIo:
     """
 
     def __init__(self, device: 'Device', stream_id: int):
-        self._device = device
-        self._stream_id = stream_id
+        self._device: 'Device' = device
+        self._stream_id: int = stream_id
 
     def set_digital_output(
             self,

zaber_motion/ascii/pvt_sequence.py

@@ -66,9 +66,9 @@ class PvtSequence:
         return self._io
 
     def __init__(self, device: 'Device', pvt_id: int):
-        self._device = device
-        self._pvt_id = pvt_id
-        self._io = PvtIo(device, pvt_id)
+        self._device: 'Device' = device
+        self._pvt_id: int = pvt_id
+        self._io: PvtIo = PvtIo(device, pvt_id)
 
     def setup_live_composite(
             self,
@@ -1144,11 +1144,12 @@ class PvtSequence:
 
         Units must be wrapped in parens or square braces: ie. (µm/s), [µm/s].
         Additionally, native units are the default if no units are specified.
+        Time values default to milliseconds if no units are provided.
         If no header is included, then column order is assumed to be "T,P1,V1,P2,V2,...".
         In this case the number of columns must be odd.
 
         Args:
-            path: The path from which the csv file will be loaded.
+            path: The path to the csv file to load.
 
         Returns:
             The PVT csv data loaded from the file.
@@ -1183,11 +1184,12 @@ class PvtSequence:
 
         Units must be wrapped in parens or square braces: ie. (µm/s), [µm/s].
         Additionally, native units are the default if no units are specified.
+        Time values default to milliseconds if no units are provided.
         If no header is included, then column order is assumed to be "T,P1,V1,P2,V2,...".
         In this case the number of columns must be odd.
 
         Args:
-            path: The path from which the csv file will be loaded.
+            path: The path to the csv file to load.
 
         Returns:
             The PVT csv data loaded from the file.

zaber_motion/ascii/servo_tuner.py

@@ -32,7 +32,7 @@ class ServoTuner:
         """
         Creates instance of ServoTuner for the given axis.
         """
-        self._axis = axis
+        self._axis: Axis = axis
 
     def get_startup_paramset(
             self

zaber_motion/ascii/storage.py

@@ -18,7 +18,7 @@ class AxisStorage:
     """
 
     def __init__(self, axis: 'Axis'):
-        self._axis = axis
+        self._axis: 'Axis' = axis
 
     def set_string(
             self,
@@ -474,7 +474,7 @@ class DeviceStorage:
     """
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def set_string(
             self,

zaber_motion/ascii/stream.py

@@ -61,9 +61,9 @@ class Stream:
         return self._io
 
     def __init__(self, device: 'Device', stream_id: int):
-        self._device = device
-        self._stream_id = stream_id
-        self._io = StreamIo(device, stream_id)
+        self._device: 'Device' = device
+        self._stream_id: int = stream_id
+        self._io: StreamIo = StreamIo(device, stream_id)
 
     def setup_live_composite(
             self,

zaber_motion/ascii/stream_buffer.py

@@ -29,8 +29,8 @@ class StreamBuffer:
         return self._buffer_id
 
     def __init__(self, device: 'Device', buffer_id: int):
-        self._device = device
-        self._buffer_id = buffer_id
+        self._device: 'Device' = device
+        self._buffer_id: int = buffer_id
 
     def get_content(
             self

zaber_motion/ascii/stream_io.py

@@ -18,8 +18,8 @@ class StreamIo:
     """
 
     def __init__(self, device: 'Device', stream_id: int):
-        self._device = device
-        self._stream_id = stream_id
+        self._device: 'Device' = device
+        self._stream_id: int = stream_id
 
     def set_digital_output(
             self,

zaber_motion/ascii/streams.py

@@ -26,7 +26,7 @@ class Streams:
         return self._device
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def get_stream(
             self,

zaber_motion/ascii/transport.py

@@ -22,7 +22,7 @@ class Transport:
         return self._transport_id
 
     def __init__(self, transport_id: int):
-        self._transport_id = transport_id
+        self._transport_id: int = transport_id
 
     @staticmethod
     def open() -> 'Transport':

zaber_motion/ascii/trigger.py

@@ -38,8 +38,8 @@ class Trigger:
         return self._trigger_number
 
     def __init__(self, device: 'Device', trigger_number: int):
-        self._device = device
-        self._trigger_number = trigger_number
+        self._device: 'Device' = device
+        self._trigger_number: int = trigger_number
 
     def enable(
             self,

zaber_motion/ascii/triggers.py

@@ -26,7 +26,7 @@ class Triggers:
         return self._device
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def get_number_of_triggers(
             self

zaber_motion/ascii/warnings.py

@@ -16,8 +16,8 @@ class Warnings:
     """
 
     def __init__(self, device: 'Device', axis_number: int):
-        self._device = device
-        self._axis_number = axis_number
+        self._device: 'Device' = device
+        self._axis_number: int = axis_number
 
     def get_flags(
             self

zaber_motion/binary/connection.py

@@ -75,7 +75,7 @@ class Connection:
         return self.__retrieve_is_open()
 
     def __init__(self, interface_id: int):
-        self._interface_id = interface_id
+        self._interface_id: int = interface_id
         self.__setup_events()
 
     @staticmethod

zaber_motion/binary/device.py

@@ -124,9 +124,9 @@ class Device:
         return self.identity.device_type
 
     def __init__(self, connection: 'Connection', device_address: int):
-        self._connection = connection
-        self._settings = DeviceSettings(self)
-        self._device_address = device_address
+        self._connection: 'Connection' = connection
+        self._settings: DeviceSettings = DeviceSettings(self)
+        self._device_address: int = device_address
 
     def generic_command(
             self,

zaber_motion/binary/device_settings.py

@@ -18,7 +18,7 @@ class DeviceSettings:
     """
 
     def __init__(self, device: 'Device'):
-        self._device = device
+        self._device: 'Device' = device
 
     def get(
             self,

zaber_motion/dto/__init__.py

@@ -2,6 +2,7 @@
 # pylint: disable=line-too-long
 from .axis_address import AxisAddress as AxisAddress
 from .channel_address import ChannelAddress as ChannelAddress
+from .device_db_source import DeviceDbSource as DeviceDbSource
 from .device_db_source_type import DeviceDbSourceType as DeviceDbSourceType
 from .firmware_version import FirmwareVersion as FirmwareVersion
 from .log_output_mode import LogOutputMode as LogOutputMode

zaber_motion/dto/device_db_source.py

@@ -0,0 +1,66 @@
+# This file is generated. Do not modify by hand.
+# pylint: disable=line-too-long, unused-argument, f-string-without-interpolation, too-many-branches, too-many-statements, unnecessary-pass
+from dataclasses import dataclass
+from typing import Any, Dict, Optional
+import zaber_bson
+from .device_db_source_type import DeviceDbSourceType
+
+
+@dataclass
+class DeviceDbSource:
+    """
+    A source that device information can be retrieved from.
+    """
+
+    source_type: DeviceDbSourceType
+    """
+    Whether the source is a web service or a local DB file.
+    """
+
+    url_or_file_path: Optional[str] = None
+    """
+    The URL of the web service or path to the local DB file.
+    """
+
+    @staticmethod
+    def zero_values() -> 'DeviceDbSource':
+        return DeviceDbSource(
+            source_type=next(first for first in DeviceDbSourceType),
+            url_or_file_path=None,
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'DeviceDbSource':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return DeviceDbSource.from_dict(data)
+
+    def to_binary(self) -> bytes:
+        """" Serialize this class to a binary representation. """
+        self.validate()
+        return zaber_bson.dumps(self.to_dict())  # type: ignore
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            'sourceType': self.source_type.value,
+            'urlOrFilePath': str(self.url_or_file_path) if self.url_or_file_path is not None else None,
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'DeviceDbSource':
+        return DeviceDbSource(
+            source_type=DeviceDbSourceType(data.get('sourceType')),  # type: ignore
+            url_or_file_path=data.get('urlOrFilePath'),  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.source_type is None:
+            raise ValueError(f'Property "SourceType" of "DeviceDbSource" is None.')
+
+        if not isinstance(self.source_type, DeviceDbSourceType):
+            raise ValueError(f'Property "SourceType" of "DeviceDbSource" is not an instance of "DeviceDbSourceType".')
+
+        if self.url_or_file_path is not None:
+            if not isinstance(self.url_or_file_path, str):
+                raise ValueError(f'Property "UrlOrFilePath" of "DeviceDbSource" is not a string.')

zaber_motion/dto/exceptions/__init__.py

@@ -5,6 +5,7 @@ from .command_failed_exception_data import CommandFailedExceptionData as Command
 from .command_too_long_exception_data import CommandTooLongExceptionData as CommandTooLongExceptionData
 from .device_address_conflict_exception_data import DeviceAddressConflictExceptionData as DeviceAddressConflictExceptionData
 from .device_db_failed_exception_data import DeviceDbFailedExceptionData as DeviceDbFailedExceptionData
+from .device_db_inner_error import DeviceDbInnerError as DeviceDbInnerError
 from .g_code_execution_exception_data import GCodeExecutionExceptionData as GCodeExecutionExceptionData
 from .g_code_syntax_exception_data import GCodeSyntaxExceptionData as GCodeSyntaxExceptionData
 from .invalid_packet_exception_data import InvalidPacketExceptionData as InvalidPacketExceptionData

zaber_motion/dto/exceptions/device_db_failed_exception_data.py

@@ -1,8 +1,10 @@
 # This file is generated. Do not modify by hand.
 # pylint: disable=line-too-long, unused-argument, f-string-without-interpolation, too-many-branches, too-many-statements, unnecessary-pass
 from dataclasses import dataclass
-from typing import Any, Dict
+from typing import Any, Dict, List
+from collections.abc import Iterable
 import zaber_bson
+from .device_db_inner_error import DeviceDbInnerError
 
 
 @dataclass
@@ -16,10 +18,16 @@ class DeviceDbFailedExceptionData:
     Code describing type of the error.
     """
 
+    inner_errors: List[DeviceDbInnerError]
+    """
+    A list of errors that occurred while trying to access information from the device database.
+    """
+
     @staticmethod
     def zero_values() -> 'DeviceDbFailedExceptionData':
         return DeviceDbFailedExceptionData(
             code="",
+            inner_errors=[],
         )
 
     @staticmethod
@@ -36,12 +44,14 @@ class DeviceDbFailedExceptionData:
     def to_dict(self) -> Dict[str, Any]:
         return {
             'code': str(self.code or ''),
+            'innerErrors': [item.to_dict() for item in self.inner_errors] if self.inner_errors is not None else [],
         }
 
     @staticmethod
     def from_dict(data: Dict[str, Any]) -> 'DeviceDbFailedExceptionData':
         return DeviceDbFailedExceptionData(
             code=data.get('code'),  # type: ignore
+            inner_errors=[DeviceDbInnerError.from_dict(item) for item in data.get('innerErrors')],  # type: ignore
         )
 
     def validate(self) -> None:
@@ -49,3 +59,16 @@ class DeviceDbFailedExceptionData:
         if self.code is not None:
             if not isinstance(self.code, str):
                 raise ValueError(f'Property "Code" of "DeviceDbFailedExceptionData" is not a string.')
+
+        if self.inner_errors is not None:
+            if not isinstance(self.inner_errors, Iterable):
+                raise ValueError('Property "InnerErrors" of "DeviceDbFailedExceptionData" is not iterable.')
+
+            for i, inner_errors_item in enumerate(self.inner_errors):
+                if inner_errors_item is None:
+                    raise ValueError(f'Item {i} in property "InnerErrors" of "DeviceDbFailedExceptionData" is None.')
+
+                if not isinstance(inner_errors_item, DeviceDbInnerError):
+                    raise ValueError(f'Item {i} in property "InnerErrors" of "DeviceDbFailedExceptionData" is not an instance of "DeviceDbInnerError".')
+
+                inner_errors_item.validate()

zaber_motion/dto/exceptions/device_db_inner_error.py

@@ -0,0 +1,85 @@
+# This file is generated. Do not modify by hand.
+# pylint: disable=line-too-long, unused-argument, f-string-without-interpolation, too-many-branches, too-many-statements, unnecessary-pass
+from dataclasses import dataclass
+from typing import Any, Dict, List
+from collections.abc import Iterable
+import zaber_bson
+
+
+@dataclass
+class DeviceDbInnerError:
+    """
+    One of the errors that occurred while trying to access information from the device database.
+    """
+
+    code: str
+    """
+    Code describing type of the error.
+    """
+
+    message: str
+    """
+    Description of the error.
+    """
+
+    inner_errors: List['DeviceDbInnerError']
+    """
+    A list of errors that occurred while trying to access information from the device database.
+    """
+
+    @staticmethod
+    def zero_values() -> 'DeviceDbInnerError':
+        return DeviceDbInnerError(
+            code="",
+            message="",
+            inner_errors=[],
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'DeviceDbInnerError':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return DeviceDbInnerError.from_dict(data)
+
+    def to_binary(self) -> bytes:
+        """" Serialize this class to a binary representation. """
+        self.validate()
+        return zaber_bson.dumps(self.to_dict())  # type: ignore
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            'code': str(self.code or ''),
+            'message': str(self.message or ''),
+            'innerErrors': [item.to_dict() for item in self.inner_errors] if self.inner_errors is not None else [],
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'DeviceDbInnerError':
+        return DeviceDbInnerError(
+            code=data.get('code'),  # type: ignore
+            message=data.get('message'),  # type: ignore
+            inner_errors=[DeviceDbInnerError.from_dict(item) for item in data.get('innerErrors')],  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.code is not None:
+            if not isinstance(self.code, str):
+                raise ValueError(f'Property "Code" of "DeviceDbInnerError" is not a string.')
+
+        if self.message is not None:
+            if not isinstance(self.message, str):
+                raise ValueError(f'Property "Message" of "DeviceDbInnerError" is not a string.')
+
+        if self.inner_errors is not None:
+            if not isinstance(self.inner_errors, Iterable):
+                raise ValueError('Property "InnerErrors" of "DeviceDbInnerError" is not iterable.')
+
+            for i, inner_errors_item in enumerate(self.inner_errors):
+                if inner_errors_item is None:
+                    raise ValueError(f'Item {i} in property "InnerErrors" of "DeviceDbInnerError" is None.')
+
+                if not isinstance(inner_errors_item, DeviceDbInnerError):
+                    raise ValueError(f'Item {i} in property "InnerErrors" of "DeviceDbInnerError" is not an instance of "DeviceDbInnerError".')
+
+                inner_errors_item.validate()

zaber_motion/dto/requests/__init__.py

@@ -151,6 +151,7 @@ from .renumber_request import RenumberRequest as RenumberRequest
 from .response_type import ResponseType as ResponseType
 from .servo_tuning_paramset_response import ServoTuningParamsetResponse as ServoTuningParamsetResponse
 from .servo_tuning_request import ServoTuningRequest as ServoTuningRequest
+from .set_device_db_layered_sources_request import SetDeviceDbLayeredSourcesRequest as SetDeviceDbLayeredSourcesRequest
 from .set_device_db_source_request import SetDeviceDbSourceRequest as SetDeviceDbSourceRequest
 from .set_interface_checksum_enabled_request import SetInterfaceChecksumEnabledRequest as SetInterfaceChecksumEnabledRequest
 from .set_interface_timeout_request import SetInterfaceTimeoutRequest as SetInterfaceTimeoutRequest