zaber-motion 7.14.0__py3-none-win_amd64.whl → 8.0.0__py3-none-win_amd64.whl

zaber_motion/dto/requests/set_simple_tuning.py

@@ -21,17 +21,17 @@ class SetSimpleTuning:
 
     paramset: ServoTuningParamset = next(first for first in ServoTuningParamset)
 
-    load_mass: float = 0
+    load_inertia: float = 0
 
-    load_mass_units: UnitsAndLiterals = Units.NATIVE
+    load_inertia_units: UnitsAndLiterals = Units.NATIVE
 
-    carriage_mass_units: UnitsAndLiterals = Units.NATIVE
+    carriage_inertia_units: UnitsAndLiterals = Units.NATIVE
 
     motor_inertia_units: UnitsAndLiterals = Units.NATIVE
 
     tuning_params: List[ServoTuningParam] = field(default_factory=list)
 
-    carriage_mass: Optional[float] = None
+    carriage_inertia: Optional[float] = None
 
     motor_inertia: Optional[float] = None
 
@@ -42,10 +42,10 @@ class SetSimpleTuning:
             device=0,
             axis=0,
             paramset=next(first for first in ServoTuningParamset),
-            load_mass=0,
-            load_mass_units=Units.NATIVE,
-            carriage_mass=None,
-            carriage_mass_units=Units.NATIVE,
+            load_inertia=0,
+            load_inertia_units=Units.NATIVE,
+            carriage_inertia=None,
+            carriage_inertia_units=Units.NATIVE,
             motor_inertia=None,
             motor_inertia_units=Units.NATIVE,
             tuning_params=[],
@@ -68,10 +68,10 @@ class SetSimpleTuning:
             'device': int(self.device),
             'axis': int(self.axis),
             'paramset': self.paramset.value,
-            'loadMass': float(self.load_mass),
-            'loadMassUnits': units_from_literals(self.load_mass_units).value,
-            'carriageMass': float(self.carriage_mass) if self.carriage_mass is not None else None,
-            'carriageMassUnits': units_from_literals(self.carriage_mass_units).value,
+            'loadInertia': float(self.load_inertia),
+            'loadInertiaUnits': units_from_literals(self.load_inertia_units).value,
+            'carriageInertia': float(self.carriage_inertia) if self.carriage_inertia is not None else None,
+            'carriageInertiaUnits': units_from_literals(self.carriage_inertia_units).value,
             'motorInertia': float(self.motor_inertia) if self.motor_inertia is not None else None,
             'motorInertiaUnits': units_from_literals(self.motor_inertia_units).value,
             'tuningParams': [item.to_dict() for item in self.tuning_params] if self.tuning_params is not None else [],
@@ -84,10 +84,10 @@ class SetSimpleTuning:
             device=data.get('device'),  # type: ignore
             axis=data.get('axis'),  # type: ignore
             paramset=ServoTuningParamset(data.get('paramset')),  # type: ignore
-            load_mass=data.get('loadMass'),  # type: ignore
-            load_mass_units=Units(data.get('loadMassUnits')),  # type: ignore
-            carriage_mass=data.get('carriageMass'),  # type: ignore
-            carriage_mass_units=Units(data.get('carriageMassUnits')),  # type: ignore
+            load_inertia=data.get('loadInertia'),  # type: ignore
+            load_inertia_units=Units(data.get('loadInertiaUnits')),  # type: ignore
+            carriage_inertia=data.get('carriageInertia'),  # type: ignore
+            carriage_inertia_units=Units(data.get('carriageInertiaUnits')),  # type: ignore
             motor_inertia=data.get('motorInertia'),  # type: ignore
             motor_inertia_units=Units(data.get('motorInertiaUnits')),  # type: ignore
             tuning_params=[ServoTuningParam.from_dict(item) for item in data.get('tuningParams')],  # type: ignore
@@ -128,27 +128,27 @@ class SetSimpleTuning:
         if not isinstance(self.paramset, ServoTuningParamset):
             raise ValueError(f'Property "Paramset" of "SetSimpleTuning" is not an instance of "ServoTuningParamset".')
 
-        if self.load_mass is None:
-            raise ValueError(f'Property "LoadMass" of "SetSimpleTuning" is None.')
+        if self.load_inertia is None:
+            raise ValueError(f'Property "LoadInertia" of "SetSimpleTuning" is None.')
 
-        if not isinstance(self.load_mass, (int, float, decimal.Decimal)):
-            raise ValueError(f'Property "LoadMass" of "SetSimpleTuning" is not a number.')
+        if not isinstance(self.load_inertia, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "LoadInertia" of "SetSimpleTuning" is not a number.')
 
-        if self.load_mass_units is None:
-            raise ValueError(f'Property "LoadMassUnits" of "SetSimpleTuning" is None.')
+        if self.load_inertia_units is None:
+            raise ValueError(f'Property "LoadInertiaUnits" of "SetSimpleTuning" is None.')
 
-        if not isinstance(self.load_mass_units, (Units, str)):
-            raise ValueError(f'Property "LoadMassUnits" of "SetSimpleTuning" is not Units.')
+        if not isinstance(self.load_inertia_units, (Units, str)):
+            raise ValueError(f'Property "LoadInertiaUnits" of "SetSimpleTuning" is not Units.')
 
-        if self.carriage_mass is not None:
-            if not isinstance(self.carriage_mass, (int, float, decimal.Decimal)):
-                raise ValueError(f'Property "CarriageMass" of "SetSimpleTuning" is not a number.')
+        if self.carriage_inertia is not None:
+            if not isinstance(self.carriage_inertia, (int, float, decimal.Decimal)):
+                raise ValueError(f'Property "CarriageInertia" of "SetSimpleTuning" is not a number.')
 
-        if self.carriage_mass_units is None:
-            raise ValueError(f'Property "CarriageMassUnits" of "SetSimpleTuning" is None.')
+        if self.carriage_inertia_units is None:
+            raise ValueError(f'Property "CarriageInertiaUnits" of "SetSimpleTuning" is None.')
 
-        if not isinstance(self.carriage_mass_units, (Units, str)):
-            raise ValueError(f'Property "CarriageMassUnits" of "SetSimpleTuning" is not Units.')
+        if not isinstance(self.carriage_inertia_units, (Units, str)):
+            raise ValueError(f'Property "CarriageInertiaUnits" of "SetSimpleTuning" is not Units.')
 
         if self.motor_inertia is not None:
             if not isinstance(self.motor_inertia, (int, float, decimal.Decimal)):

zaber_motion/dto/requests/unit_convert_native_request.py

@@ -0,0 +1,91 @@
+# 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
+from ..unit_conversion_descriptor import UnitConversionDescriptor
+from ...units import Units, UnitsAndLiterals, units_from_literals
+
+
+@dataclass
+class UnitConvertNativeRequest:
+
+    value: float = 0
+
+    values: List[float] = field(default_factory=list)
+
+    unit: UnitsAndLiterals = Units.NATIVE
+
+    conversion: UnitConversionDescriptor = field(default_factory=UnitConversionDescriptor.zero_values)
+
+    @staticmethod
+    def zero_values() -> 'UnitConvertNativeRequest':
+        return UnitConvertNativeRequest(
+            value=0,
+            values=[],
+            unit=Units.NATIVE,
+            conversion=UnitConversionDescriptor.zero_values(),
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'UnitConvertNativeRequest':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return UnitConvertNativeRequest.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 {
+            'value': float(self.value),
+            'values': [float(item) for item in self.values] if self.values is not None else [],
+            'unit': units_from_literals(self.unit).value,
+            'conversion': self.conversion.to_dict(),
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'UnitConvertNativeRequest':
+        return UnitConvertNativeRequest(
+            value=data.get('value'),  # type: ignore
+            values=data.get('values'),  # type: ignore
+            unit=Units(data.get('unit')),  # type: ignore
+            conversion=UnitConversionDescriptor.from_dict(data.get('conversion')),  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.value is None:
+            raise ValueError(f'Property "Value" of "UnitConvertNativeRequest" is None.')
+
+        if not isinstance(self.value, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "Value" of "UnitConvertNativeRequest" is not a number.')
+
+        if self.values is not None:
+            if not isinstance(self.values, Iterable):
+                raise ValueError('Property "Values" of "UnitConvertNativeRequest" is not iterable.')
+
+            for i, values_item in enumerate(self.values):
+                if values_item is None:
+                    raise ValueError(f'Item {i} in property "Values" of "UnitConvertNativeRequest" is None.')
+
+                if not isinstance(values_item, (int, float, decimal.Decimal)):
+                    raise ValueError(f'Item {i} in property "Values" of "UnitConvertNativeRequest" is not a number.')
+
+        if self.unit is None:
+            raise ValueError(f'Property "Unit" of "UnitConvertNativeRequest" is None.')
+
+        if not isinstance(self.unit, (Units, str)):
+            raise ValueError(f'Property "Unit" of "UnitConvertNativeRequest" is not Units.')
+
+        if self.conversion is None:
+            raise ValueError(f'Property "Conversion" of "UnitConvertNativeRequest" is None.')
+
+        if not isinstance(self.conversion, UnitConversionDescriptor):
+            raise ValueError(f'Property "Conversion" of "UnitConvertNativeRequest" is not an instance of "UnitConversionDescriptor".')
+
+        self.conversion.validate()

zaber_motion/dto/unit_conversion_descriptor.py

@@ -0,0 +1,93 @@
+# 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 decimal
+import zaber_bson
+
+
+@dataclass
+class UnitConversionDescriptor:
+    """
+    Information about unit conversion.
+    """
+
+    dimension: str
+    """
+    Name of the dimension being converted.
+    """
+
+    conversion_function: str
+    """
+    Internal name of conversion function used.
+    """
+
+    scale: float
+    """
+    Scale factor used in conversion, if applicable.
+    """
+
+    resolution: Optional[int] = None
+    """
+    Microstep resolution used in conversion, if applicable.
+    """
+
+    @staticmethod
+    def zero_values() -> 'UnitConversionDescriptor':
+        return UnitConversionDescriptor(
+            dimension="",
+            conversion_function="",
+            scale=0,
+            resolution=None,
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'UnitConversionDescriptor':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return UnitConversionDescriptor.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 {
+            'dimension': str(self.dimension or ''),
+            'conversionFunction': str(self.conversion_function or ''),
+            'scale': float(self.scale),
+            'resolution': int(self.resolution) if self.resolution is not None else None,
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'UnitConversionDescriptor':
+        return UnitConversionDescriptor(
+            dimension=data.get('dimension'),  # type: ignore
+            conversion_function=data.get('conversionFunction'),  # type: ignore
+            scale=data.get('scale'),  # type: ignore
+            resolution=data.get('resolution'),  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.dimension is not None:
+            if not isinstance(self.dimension, str):
+                raise ValueError(f'Property "Dimension" of "UnitConversionDescriptor" is not a string.')
+
+        if self.conversion_function is not None:
+            if not isinstance(self.conversion_function, str):
+                raise ValueError(f'Property "ConversionFunction" of "UnitConversionDescriptor" is not a string.')
+
+        if self.scale is None:
+            raise ValueError(f'Property "Scale" of "UnitConversionDescriptor" is None.')
+
+        if not isinstance(self.scale, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "Scale" of "UnitConversionDescriptor" is not a number.')
+
+        if self.resolution is not None:
+            if not isinstance(self.resolution, (int, float, decimal.Decimal)):
+                raise ValueError(f'Property "Resolution" of "UnitConversionDescriptor" is not a number.')
+
+            if int(self.resolution) != self.resolution:
+                raise ValueError(f'Property "Resolution" of "UnitConversionDescriptor" is not integer value.')

zaber_motion/library.py

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

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/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/microscopy/objective_changer.py

@@ -5,7 +5,7 @@ from typing import Optional
 from ..call import call, call_async, call_sync
 from ..dto import requests as dto
 from ..dto.measurement import Measurement
-from ..ascii import Connection, Device, Axis
+from ..ascii import Device, Axis
 from ..units import Units, LengthUnits
 
 
@@ -39,74 +39,6 @@ class ObjectiveChanger:
         self._focus_axis: Axis = focus_axis
         self.__verify_is_changer()
 
-    @staticmethod
-    def find(
-            connection: Connection,
-            turret_address: int = 0,
-            focus_address: int = 0
-    ) -> 'ObjectiveChanger':
-        """
-        Deprecated: Use microscope's `Find` method instead or instantiate manually.
-
-        Finds an objective changer on a connection.
-        In case of conflict, specify the optional device addresses.
-        Devices on the connection must be identified.
-
-        Args:
-            connection: Connection on which to detect the objective changer.
-            turret_address: Optional device address of the turret device (X-MOR).
-            focus_address: Optional device address of the focus device (X-LDA).
-
-        Returns:
-            New instance of objective changer.
-        """
-        request = dto.ObjectiveChangerRequest(
-            interface_id=connection.interface_id,
-            turret_address=turret_address,
-            focus_address=focus_address,
-        )
-        response = call(
-            "objective_changer/detect",
-            request,
-            dto.ObjectiveChangerCreateResponse.from_binary)
-        return ObjectiveChanger(
-            Device(connection, response.turret),
-            Axis(Device(connection, response.focus_address), response.focus_axis))
-
-    @staticmethod
-    async def find_async(
-            connection: Connection,
-            turret_address: int = 0,
-            focus_address: int = 0
-    ) -> 'ObjectiveChanger':
-        """
-        Deprecated: Use microscope's `Find` method instead or instantiate manually.
-
-        Finds an objective changer on a connection.
-        In case of conflict, specify the optional device addresses.
-        Devices on the connection must be identified.
-
-        Args:
-            connection: Connection on which to detect the objective changer.
-            turret_address: Optional device address of the turret device (X-MOR).
-            focus_address: Optional device address of the focus device (X-LDA).
-
-        Returns:
-            New instance of objective changer.
-        """
-        request = dto.ObjectiveChangerRequest(
-            interface_id=connection.interface_id,
-            turret_address=turret_address,
-            focus_address=focus_address,
-        )
-        response = await call_async(
-            "objective_changer/detect",
-            request,
-            dto.ObjectiveChangerCreateResponse.from_binary)
-        return ObjectiveChanger(
-            Device(connection, response.turret),
-            Axis(Device(connection, response.focus_address), response.focus_axis))
-
     def change(
             self,
             objective: int,

zaber_motion/unit_table.py

@@ -1,8 +1,10 @@
 # ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
 # ============== DO NOT EDIT DIRECTLY ============== #
+from typing import List
 
 from .call import call_sync
 from .dto import requests as dto
+from .dto.unit_conversion_descriptor import UnitConversionDescriptor
 from .units import UnitsAndLiterals
 
 
@@ -84,3 +86,115 @@ class UnitTable:
             request,
             dto.DoubleResponse.from_binary)
         return response.value
+
+    @staticmethod
+    def convert_to_native_units(
+            conversion: UnitConversionDescriptor,
+            value: float,
+            to_unit: UnitsAndLiterals
+    ) -> float:
+        """
+        Converts a value from one unit to native units given unit conversion descriptor.
+
+        Args:
+            conversion: The unit conversion data retrieved from device or axis.
+            value: The value to be converted.
+            to_unit: The unit which the value is being converted to.
+
+        Returns:
+            The converted value. Throws ConversionFailedException if unit is incompatible.
+        """
+        request = dto.UnitConvertNativeRequest(
+            conversion=conversion,
+            value=value,
+            unit=to_unit,
+        )
+        response = call_sync(
+            "units/convert_to_native_unit",
+            request,
+            dto.DoubleResponse.from_binary)
+        return response.value
+
+    @staticmethod
+    def convert_from_native_units(
+            conversion: UnitConversionDescriptor,
+            value: float,
+            from_unit: UnitsAndLiterals
+    ) -> float:
+        """
+        Converts a value from one unit to native units given unit conversion descriptor.
+
+        Args:
+            conversion: The unit conversion data retrieved from device or axis.
+            value: The value to be converted.
+            from_unit: The unit which the value is being converted from.
+
+        Returns:
+            The converted value. Throws ConversionFailedException if unit is incompatible.
+        """
+        request = dto.UnitConvertNativeRequest(
+            conversion=conversion,
+            value=value,
+            unit=from_unit,
+        )
+        response = call_sync(
+            "units/convert_from_native_unit",
+            request,
+            dto.DoubleResponse.from_binary)
+        return response.value
+
+    @staticmethod
+    def convert_to_native_units_batch(
+            conversion: UnitConversionDescriptor,
+            values: List[float],
+            to_unit: UnitsAndLiterals
+    ) -> List[float]:
+        """
+        Converts values from one unit to native units given unit conversion descriptor.
+
+        Args:
+            conversion: The unit conversion data retrieved from device or axis.
+            values: The value to be converted.
+            to_unit: The unit which the value is being converted to.
+
+        Returns:
+            The converted values. Throws ConversionFailedException if unit is incompatible.
+        """
+        request = dto.UnitConvertNativeRequest(
+            conversion=conversion,
+            values=values,
+            unit=to_unit,
+        )
+        response = call_sync(
+            "units/convert_to_native_unit_batch",
+            request,
+            dto.DoubleArrayResponse.from_binary)
+        return response.values
+
+    @staticmethod
+    def convert_from_native_units_batch(
+            conversion: UnitConversionDescriptor,
+            values: List[float],
+            from_unit: UnitsAndLiterals
+    ) -> List[float]:
+        """
+        Converts values from one unit to native units given unit conversion descriptor.
+
+        Args:
+            conversion: The unit conversion data retrieved from device or axis.
+            values: The value to be converted.
+            from_unit: The unit which the value is being converted from.
+
+        Returns:
+            The converted values. Throws ConversionFailedException if unit is incompatible.
+        """
+        request = dto.UnitConvertNativeRequest(
+            conversion=conversion,
+            values=values,
+            unit=from_unit,
+        )
+        response = call_sync(
+            "units/convert_from_native_unit_batch",
+            request,
+            dto.DoubleArrayResponse.from_binary)
+        return response.values

zaber_motion/version.py

@@ -1 +1 @@
-__version__ = "7.14.0"
+__version__ = "8.0.0"

{zaber_motion-7.14.0.dist-info → zaber_motion-8.0.0.dist-info}/METADATA

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