zaber-motion 7.13.0__tar.gz → 7.15.0__tar.gz

{zaber_motion-7.13.0/zaber_motion.egg-info → zaber_motion-7.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zaber_motion
-Version: 7.13.0
+Version: 7.15.0
 Summary: An official library for communicating with Zaber devices.
 Author-email: "Zaber Technologies Inc." <contact@zaber.com>
 License: The MIT License (MIT)

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zaber_motion"
-version = "7.13.0"
+version = "7.15.0"
 description = "An official library for communicating with Zaber devices."
 authors = [{ name = "Zaber Technologies Inc.", email = "contact@zaber.com" }]
 license = { file = "LICENSE.txt" }

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/setup.py

@@ -19,13 +19,13 @@ def get_version():
 
 def download_bindings(version):
     url = f"https://api.zaber.io/downloads/software-downloads?product=zml_cpp_src&version={version}"
-    filename = f"ZaberMotionCppSource-{version}.zip"
-    bindings_prefix = "ZaberMotionCppSource/build/zaber-motion-lib"
+    archive_file = f"ZaberMotionCppSource-{version}.zip"
+    bindings_prefix = "ZaberMotionCppSource/build/zaber-motion-core"
 
-    with urllib.request.urlopen(url) as response, open(filename, 'wb') as out_file:
+    with urllib.request.urlopen(url) as response, open(archive_file, 'wb') as out_file:
         shutil.copyfileobj(response, out_file)
 
-    with zipfile.ZipFile(filename, 'r') as archive:
+    with zipfile.ZipFile(archive_file, 'r') as archive:
         files = archive.namelist()
         bindings = [f for f in files if f.startswith(bindings_prefix)]
         archive.extractall(".", bindings)
@@ -33,7 +33,7 @@ def download_bindings(version):
     shutil.rmtree(BINDINGS_DIR, ignore_errors=True)
     shutil.move("ZaberMotionCppSource/build", BINDINGS_DIR)
     shutil.rmtree("ZaberMotionCppSource", ignore_errors=True)
-    os.remove(filename)
+    os.remove(archive_file)
 
 
 def setup():

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/zaber_motion/dto/ascii/optional_measurement_sequence.py

@@ -16,7 +16,7 @@ class OptionalMeasurementSequence:
 
     values: List[Optional[float]]
     """
-    Sequence of values.
+    Sequence of optional values.
     """
 
     unit: Optional[UnitsAndLiterals] = None

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/zaber_motion/dto/requests/__init__.py

@@ -210,6 +210,7 @@ from .string_array_response import StringArrayResponse as StringArrayResponse
 from .string_response import StringResponse as StringResponse
 from .test_event import TestEvent as TestEvent
 from .test_request import TestRequest as TestRequest
+from .test_request_complex import TestRequestComplex as TestRequestComplex
 from .test_response import TestResponse as TestResponse
 from .test_response_long import TestResponseLong as TestResponseLong
 from .toggle_device_db_store_request import ToggleDeviceDbStoreRequest as ToggleDeviceDbStoreRequest
@@ -250,5 +251,6 @@ from .unknown_binary_response_event_wrapper import UnknownBinaryResponseEventWra
 from .unknown_response_event_wrapper import UnknownResponseEventWrapper as UnknownResponseEventWrapper
 from .wait_to_clear_warnings_request import WaitToClearWarningsRequest as WaitToClearWarningsRequest
 from .wait_to_respond_request import WaitToRespondRequest as WaitToRespondRequest
+from .wdi_generic_float_request import WdiGenericFloatRequest as WdiGenericFloatRequest
 from .wdi_generic_request import WdiGenericRequest as WdiGenericRequest
 from .wdi_get_status_response import WdiGetStatusResponse as WdiGetStatusResponse

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/zaber_motion/dto/requests/channel_on.py

@@ -1,9 +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, Optional
 import decimal
 import zaber_bson
+from ..measurement import Measurement
 
 
 @dataclass
@@ -17,6 +18,8 @@ class ChannelOn:
 
     on: bool = False
 
+    duration: Optional[Measurement] = None
+
     @staticmethod
     def zero_values() -> 'ChannelOn':
         return ChannelOn(
@@ -24,6 +27,7 @@ class ChannelOn:
             device=0,
             axis=0,
             on=False,
+            duration=None,
         )
 
     @staticmethod
@@ -43,6 +47,7 @@ class ChannelOn:
             'device': int(self.device),
             'axis': int(self.axis),
             'on': bool(self.on),
+            'duration': self.duration.to_dict() if self.duration is not None else None,
         }
 
     @staticmethod
@@ -52,6 +57,7 @@ class ChannelOn:
             device=data.get('device'),  # type: ignore
             axis=data.get('axis'),  # type: ignore
             on=data.get('on'),  # type: ignore
+            duration=Measurement.from_dict(data.get('duration')) if data.get('duration') is not None else None,  # type: ignore
         )
 
     def validate(self) -> None:
@@ -82,3 +88,9 @@ class ChannelOn:
 
         if int(self.axis) != self.axis:
             raise ValueError(f'Property "Axis" of "ChannelOn" is not integer value.')
+
+        if self.duration is not None:
+            if not isinstance(self.duration, Measurement):
+                raise ValueError(f'Property "Duration" of "ChannelOn" is not an instance of "Measurement".')
+
+            self.duration.validate()

zaber_motion-7.15.0/zaber_motion/dto/requests/test_request_complex.py

@@ -0,0 +1,57 @@
+# 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, field
+from typing import Any, Dict, List
+import decimal
+from collections.abc import Iterable
+import zaber_bson
+
+
+@dataclass
+class TestRequestComplex:
+
+    int_array: List[int] = field(default_factory=list)
+
+    @staticmethod
+    def zero_values() -> 'TestRequestComplex':
+        return TestRequestComplex(
+            int_array=[],
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'TestRequestComplex':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return TestRequestComplex.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 {
+            'intArray': [int(item) for item in self.int_array] if self.int_array is not None else [],
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'TestRequestComplex':
+        return TestRequestComplex(
+            int_array=data.get('intArray'),  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.int_array is not None:
+            if not isinstance(self.int_array, Iterable):
+                raise ValueError('Property "IntArray" of "TestRequestComplex" is not iterable.')
+
+            for i, int_array_item in enumerate(self.int_array):
+                if int_array_item is None:
+                    raise ValueError(f'Item {i} in property "IntArray" of "TestRequestComplex" is None.')
+
+                if not isinstance(int_array_item, (int, float, decimal.Decimal)):
+                    raise ValueError(f'Item {i} in property "IntArray" of "TestRequestComplex" is not a number.')
+
+                if int(int_array_item) != int_array_item:
+                    raise ValueError(f'Item {i} in property "IntArray" of "TestRequestComplex" is not integer value.')

zaber_motion-7.15.0/zaber_motion/dto/requests/wdi_generic_float_request.py

@@ -0,0 +1,119 @@
+# 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, field
+from typing import Any, Dict, List
+import decimal
+from collections.abc import Iterable
+import zaber_bson
+
+
+@dataclass
+class WdiGenericFloatRequest:
+
+    interface_id: int = 0
+
+    register_id: int = 0
+
+    count: int = 0
+
+    offset: int = 0
+
+    register_bank: str = ""
+
+    data: List[float] = field(default_factory=list)
+
+    @staticmethod
+    def zero_values() -> 'WdiGenericFloatRequest':
+        return WdiGenericFloatRequest(
+            interface_id=0,
+            register_id=0,
+            count=0,
+            offset=0,
+            register_bank="",
+            data=[],
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'WdiGenericFloatRequest':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return WdiGenericFloatRequest.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 {
+            'interfaceId': int(self.interface_id),
+            'registerId': int(self.register_id),
+            'count': int(self.count),
+            'offset': int(self.offset),
+            'registerBank': str(self.register_bank or ''),
+            'data': [float(item) for item in self.data] if self.data is not None else [],
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'WdiGenericFloatRequest':
+        return WdiGenericFloatRequest(
+            interface_id=data.get('interfaceId'),  # type: ignore
+            register_id=data.get('registerId'),  # type: ignore
+            count=data.get('count'),  # type: ignore
+            offset=data.get('offset'),  # type: ignore
+            register_bank=data.get('registerBank'),  # type: ignore
+            data=data.get('data'),  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.interface_id is None:
+            raise ValueError(f'Property "InterfaceId" of "WdiGenericFloatRequest" is None.')
+
+        if not isinstance(self.interface_id, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "InterfaceId" of "WdiGenericFloatRequest" is not a number.')
+
+        if int(self.interface_id) != self.interface_id:
+            raise ValueError(f'Property "InterfaceId" of "WdiGenericFloatRequest" is not integer value.')
+
+        if self.register_id is None:
+            raise ValueError(f'Property "RegisterId" of "WdiGenericFloatRequest" is None.')
+
+        if not isinstance(self.register_id, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "RegisterId" of "WdiGenericFloatRequest" is not a number.')
+
+        if int(self.register_id) != self.register_id:
+            raise ValueError(f'Property "RegisterId" of "WdiGenericFloatRequest" is not integer value.')
+
+        if self.count is None:
+            raise ValueError(f'Property "Count" of "WdiGenericFloatRequest" is None.')
+
+        if not isinstance(self.count, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "Count" of "WdiGenericFloatRequest" is not a number.')
+
+        if int(self.count) != self.count:
+            raise ValueError(f'Property "Count" of "WdiGenericFloatRequest" is not integer value.')
+
+        if self.offset is None:
+            raise ValueError(f'Property "Offset" of "WdiGenericFloatRequest" is None.')
+
+        if not isinstance(self.offset, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "Offset" of "WdiGenericFloatRequest" is not a number.')
+
+        if int(self.offset) != self.offset:
+            raise ValueError(f'Property "Offset" of "WdiGenericFloatRequest" is not integer value.')
+
+        if self.register_bank is not None:
+            if not isinstance(self.register_bank, str):
+                raise ValueError(f'Property "RegisterBank" of "WdiGenericFloatRequest" is not a string.')
+
+        if self.data is not None:
+            if not isinstance(self.data, Iterable):
+                raise ValueError('Property "Data" of "WdiGenericFloatRequest" is not iterable.')
+
+            for i, data_item in enumerate(self.data):
+                if data_item is None:
+                    raise ValueError(f'Item {i} in property "Data" of "WdiGenericFloatRequest" is None.')
+
+                if not isinstance(data_item, (int, float, decimal.Decimal)):
+                    raise ValueError(f'Item {i} in property "Data" of "WdiGenericFloatRequest" is not a number.')

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/zaber_motion/library.py

@@ -171,7 +171,7 @@ class Library:
         """
         request = dto.CheckVersionRequest(
             host="py",
-            version="7.13.0",
+            version="7.15.0",
         )
         call_sync("library/check_version", request)
 

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/zaber_motion/microscopy/illuminator.py

@@ -55,6 +55,30 @@ class Illuminator:
 
         return IlluminatorChannel(self, channel_number)
 
+    def turn_off(
+            self
+    ) -> None:
+        """
+        Turns all channels off.
+        """
+        request = dto.DeviceEmptyRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+        )
+        call("illuminator/all_off", request)
+
+    async def turn_off_async(
+            self
+    ) -> None:
+        """
+        Turns all channels off.
+        """
+        request = dto.DeviceEmptyRequest(
+            interface_id=self.device.connection.interface_id,
+            device=self.device.device_address,
+        )
+        await call_async("illuminator/all_off", request)
+
     def __verify_is_illuminator(
             self
     ) -> None:

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/zaber_motion/microscopy/illuminator_channel.py

@@ -8,6 +8,7 @@ from ..dto.ascii.response import Response
 from ..ascii import Axis, AxisSettings, AxisStorage, Warnings
 from ..dto.ascii.set_state_axis_response import SetStateAxisResponse
 from ..dto.firmware_version import FirmwareVersion
+from ..dto.measurement import Measurement
 
 if TYPE_CHECKING:
     from .illuminator import Illuminator
@@ -63,30 +64,42 @@ class IlluminatorChannel:
         self._warnings: Warnings = Warnings(illuminator.device, channel_number)
 
     def on(
-            self
+            self,
+            duration: Optional[Measurement] = None
     ) -> None:
         """
         Turns this channel on.
+
+        Args:
+            duration: Duration for which to turn the channel on.
+                If not specified, the channel remains on until turned off.
         """
         request = dto.ChannelOn(
             interface_id=self.illuminator.device.connection.interface_id,
             device=self.illuminator.device.device_address,
             axis=self.channel_number,
             on=True,
+            duration=duration,
         )
         call("illuminator/on", request)
 
     async def on_async(
-            self
+            self,
+            duration: Optional[Measurement] = None
     ) -> None:
         """
         Turns this channel on.
+
+        Args:
+            duration: Duration for which to turn the channel on.
+                If not specified, the channel remains on until turned off.
         """
         request = dto.ChannelOn(
             interface_id=self.illuminator.device.connection.interface_id,
             device=self.illuminator.device.device_address,
             axis=self.channel_number,
             on=True,
+            duration=duration,
         )
         await call_async("illuminator/on", request)
 

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/zaber_motion/microscopy/wdi_autofocus_provider.py

@@ -9,6 +9,7 @@ from ..exceptions.motion_lib_exception import MotionLibException
 
 from ..dto import requests as dto
 from ..dto.microscopy.wdi_autofocus_provider_status import WdiAutofocusProviderStatus
+from ..dto.firmware_version import FirmwareVersion
 
 
 class WdiAutofocusProvider:
@@ -28,6 +29,13 @@ class WdiAutofocusProvider:
         """
         return self._provider_id
 
+    @property
+    def firmware_version(self) -> FirmwareVersion:
+        """
+        The firmware version of the connected autofocus.
+        """
+        return self.__retrieve_firmware_version()
+
     def __init__(self, provider_id: int):
         self._provider_id: int = provider_id
 
@@ -116,6 +124,24 @@ class WdiAutofocusProvider:
         )
         call_sync("wdi/free", request)
 
+    def __retrieve_firmware_version(
+            self
+    ) -> FirmwareVersion:
+        """
+        Returns FW version.
+
+        Returns:
+            Firmware version.
+        """
+        request = dto.InterfaceEmptyRequest(
+            interface_id=self.provider_id,
+        )
+        response = call_sync(
+            "wdi/get_firmware_version",
+            request,
+            FirmwareVersion.from_binary)
+        return response
+
     def generic_read(
             self,
             register_id: int,
@@ -242,6 +268,120 @@ class WdiAutofocusProvider:
         )
         await call_async("wdi/write", request)
 
+    def generic_read_float(
+            self,
+            register_id: int,
+            count: int = 1,
+            offset: int = 0,
+            register_bank: str = "U"
+    ) -> List[float]:
+        """
+        Generic read operation.
+
+        Args:
+            register_id: Register address to read from.
+            count: Number of values to read (defaults to 1).
+            offset: Offset within the register (defaults to 0).
+            register_bank: Register bank letter (defaults to U for user bank).
+
+        Returns:
+            Array of floats read from the device.
+        """
+        request = dto.WdiGenericFloatRequest(
+            interface_id=self.provider_id,
+            register_id=register_id,
+            count=count,
+            offset=offset,
+            register_bank=register_bank,
+        )
+        response = call(
+            "wdi/read_float",
+            request,
+            dto.DoubleArrayResponse.from_binary)
+        return response.values
+
+    async def generic_read_float_async(
+            self,
+            register_id: int,
+            count: int = 1,
+            offset: int = 0,
+            register_bank: str = "U"
+    ) -> List[float]:
+        """
+        Generic read operation.
+
+        Args:
+            register_id: Register address to read from.
+            count: Number of values to read (defaults to 1).
+            offset: Offset within the register (defaults to 0).
+            register_bank: Register bank letter (defaults to U for user bank).
+
+        Returns:
+            Array of floats read from the device.
+        """
+        request = dto.WdiGenericFloatRequest(
+            interface_id=self.provider_id,
+            register_id=register_id,
+            count=count,
+            offset=offset,
+            register_bank=register_bank,
+        )
+        response = await call_async(
+            "wdi/read_float",
+            request,
+            dto.DoubleArrayResponse.from_binary)
+        return response.values
+
+    def generic_write_float(
+            self,
+            register_id: int,
+            data: List[float] = [],
+            offset: int = 0,
+            register_bank: str = "U"
+    ) -> None:
+        """
+        Generic write operation.
+
+        Args:
+            register_id: Register address to write to.
+            data: Array of values to write to the register. Empty array is allowed.
+            offset: Offset within the register (defaults to 0).
+            register_bank: Register bank letter (defaults to U for user bank).
+        """
+        request = dto.WdiGenericFloatRequest(
+            interface_id=self.provider_id,
+            register_id=register_id,
+            data=data,
+            offset=offset,
+            register_bank=register_bank,
+        )
+        call("wdi/write_float", request)
+
+    async def generic_write_float_async(
+            self,
+            register_id: int,
+            data: List[float] = [],
+            offset: int = 0,
+            register_bank: str = "U"
+    ) -> None:
+        """
+        Generic write operation.
+
+        Args:
+            register_id: Register address to write to.
+            data: Array of values to write to the register. Empty array is allowed.
+            offset: Offset within the register (defaults to 0).
+            register_bank: Register bank letter (defaults to U for user bank).
+        """
+        request = dto.WdiGenericFloatRequest(
+            interface_id=self.provider_id,
+            register_id=register_id,
+            data=data,
+            offset=offset,
+            register_bank=register_bank,
+        )
+        await call_async("wdi/write_float", request)
+
     def enable_laser(
             self
     ) -> None:

zaber_motion-7.15.0/zaber_motion/version.py

@@ -0,0 +1 @@
+__version__ = "7.15.0"

{zaber_motion-7.13.0 → zaber_motion-7.15.0/zaber_motion.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zaber_motion
-Version: 7.13.0
+Version: 7.15.0
 Summary: An official library for communicating with Zaber devices.
 Author-email: "Zaber Technologies Inc." <contact@zaber.com>
 License: The MIT License (MIT)

{zaber_motion-7.13.0 → zaber_motion-7.15.0}/zaber_motion.egg-info/SOURCES.txt

@@ -376,6 +376,7 @@ zaber_motion/dto/requests/string_array_response.py
 zaber_motion/dto/requests/string_response.py
 zaber_motion/dto/requests/test_event.py
 zaber_motion/dto/requests/test_request.py
+zaber_motion/dto/requests/test_request_complex.py
 zaber_motion/dto/requests/test_response.py
 zaber_motion/dto/requests/test_response_long.py
 zaber_motion/dto/requests/toggle_device_db_store_request.py
@@ -416,6 +417,7 @@ zaber_motion/dto/requests/unknown_binary_response_event_wrapper.py
 zaber_motion/dto/requests/unknown_response_event_wrapper.py
 zaber_motion/dto/requests/wait_to_clear_warnings_request.py
 zaber_motion/dto/requests/wait_to_respond_request.py
+zaber_motion/dto/requests/wdi_generic_float_request.py
 zaber_motion/dto/requests/wdi_generic_request.py
 zaber_motion/dto/requests/wdi_get_status_response.py
 zaber_motion/exceptions/__init__.py

zaber_motion-7.13.0/zaber_motion/version.py

@@ -1 +0,0 @@
-__version__ = "7.13.0"