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

zaber_motion/dto/ascii/simple_tuning.py

@@ -1,118 +1,118 @@
-# 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, Optional
-import decimal
-from collections.abc import Iterable
-import zaber_bson
-from .servo_tuning_param import ServoTuningParam
-
-
-@dataclass
-class SimpleTuning:
-    """
-    The masses and parameters last used by simple tuning.
-    """
-
-    is_used: bool
-    """
-    Whether the tuning returned is currently in use by this paramset,
-    or if it has been overwritten by a later change.
-    """
-
-    is_set: bool
-    """
-    If this paramset has been tuned using the simple tuning method, whether or not it's currently in use.
-    """
-
-    load_mass: float
-    """
-    The mass of the load in kg, excluding the mass of the carriage.
-    """
-
-    tuning_params: List[ServoTuningParam]
-    """
-    The parameters used by simple tuning.
-    """
-
-    carriage_mass: Optional[float] = None
-    """
-    The mass of the carriage in kg.
-    """
-
-    motor_inertia: Optional[float] = None
-    """
-    The inertia of the motor in kg⋅m².
-    """
-
-    @staticmethod
-    def zero_values() -> 'SimpleTuning':
-        return SimpleTuning(
-            is_used=False,
-            is_set=False,
-            carriage_mass=None,
-            motor_inertia=None,
-            load_mass=0,
-            tuning_params=[],
-        )
-
-    @staticmethod
-    def from_binary(data_bytes: bytes) -> 'SimpleTuning':
-        """" Deserialize a binary representation of this class. """
-        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
-        return SimpleTuning.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 {
-            'isUsed': bool(self.is_used),
-            'isSet': bool(self.is_set),
-            'carriageMass': float(self.carriage_mass) if self.carriage_mass is not None else None,
-            'motorInertia': float(self.motor_inertia) if self.motor_inertia is not None else None,
-            'loadMass': float(self.load_mass),
-            'tuningParams': [item.to_dict() for item in self.tuning_params] if self.tuning_params is not None else [],
-        }
-
-    @staticmethod
-    def from_dict(data: Dict[str, Any]) -> 'SimpleTuning':
-        return SimpleTuning(
-            is_used=data.get('isUsed'),  # type: ignore
-            is_set=data.get('isSet'),  # type: ignore
-            carriage_mass=data.get('carriageMass'),  # type: ignore
-            motor_inertia=data.get('motorInertia'),  # type: ignore
-            load_mass=data.get('loadMass'),  # type: ignore
-            tuning_params=[ServoTuningParam.from_dict(item) for item in data.get('tuningParams')],  # type: ignore
-        )
-
-    def validate(self) -> None:
-        """" Validates the properties of the instance. """
-        if self.carriage_mass is not None:
-            if not isinstance(self.carriage_mass, (int, float, decimal.Decimal)):
-                raise ValueError(f'Property "CarriageMass" of "SimpleTuning" is not a number.')
-
-        if self.motor_inertia is not None:
-            if not isinstance(self.motor_inertia, (int, float, decimal.Decimal)):
-                raise ValueError(f'Property "MotorInertia" of "SimpleTuning" is not a number.')
-
-        if self.load_mass is None:
-            raise ValueError(f'Property "LoadMass" of "SimpleTuning" is None.')
-
-        if not isinstance(self.load_mass, (int, float, decimal.Decimal)):
-            raise ValueError(f'Property "LoadMass" of "SimpleTuning" is not a number.')
-
-        if self.tuning_params is not None:
-            if not isinstance(self.tuning_params, Iterable):
-                raise ValueError('Property "TuningParams" of "SimpleTuning" is not iterable.')
-
-            for i, tuning_params_item in enumerate(self.tuning_params):
-                if tuning_params_item is None:
-                    raise ValueError(f'Item {i} in property "TuningParams" of "SimpleTuning" is None.')
-
-                if not isinstance(tuning_params_item, ServoTuningParam):
-                    raise ValueError(f'Item {i} in property "TuningParams" of "SimpleTuning" is not an instance of "ServoTuningParam".')
-
-                tuning_params_item.validate()
+# 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, Optional
+import decimal
+from collections.abc import Iterable
+import zaber_bson
+from .servo_tuning_param import ServoTuningParam
+
+
+@dataclass
+class SimpleTuning:
+    """
+    The masses and parameters last used by simple tuning.
+    """
+
+    is_used: bool
+    """
+    Whether the tuning returned is currently in use by this paramset,
+    or if it has been overwritten by a later change.
+    """
+
+    is_set: bool
+    """
+    If this paramset has been tuned using the simple tuning method, whether or not it's currently in use.
+    """
+
+    load_mass: float
+    """
+    The mass of the load in kg, excluding the mass of the carriage.
+    """
+
+    tuning_params: List[ServoTuningParam]
+    """
+    The parameters used by simple tuning.
+    """
+
+    carriage_mass: Optional[float] = None
+    """
+    The mass of the carriage in kg.
+    """
+
+    motor_inertia: Optional[float] = None
+    """
+    The inertia of the motor in kg⋅m².
+    """
+
+    @staticmethod
+    def zero_values() -> 'SimpleTuning':
+        return SimpleTuning(
+            is_used=False,
+            is_set=False,
+            carriage_mass=None,
+            motor_inertia=None,
+            load_mass=0,
+            tuning_params=[],
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'SimpleTuning':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return SimpleTuning.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 {
+            'isUsed': bool(self.is_used),
+            'isSet': bool(self.is_set),
+            'carriageMass': float(self.carriage_mass) if self.carriage_mass is not None else None,
+            'motorInertia': float(self.motor_inertia) if self.motor_inertia is not None else None,
+            'loadMass': float(self.load_mass),
+            'tuningParams': [item.to_dict() for item in self.tuning_params] if self.tuning_params is not None else [],
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'SimpleTuning':
+        return SimpleTuning(
+            is_used=data.get('isUsed'),  # type: ignore
+            is_set=data.get('isSet'),  # type: ignore
+            carriage_mass=data.get('carriageMass'),  # type: ignore
+            motor_inertia=data.get('motorInertia'),  # type: ignore
+            load_mass=data.get('loadMass'),  # type: ignore
+            tuning_params=[ServoTuningParam.from_dict(item) for item in data.get('tuningParams')],  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.carriage_mass is not None:
+            if not isinstance(self.carriage_mass, (int, float, decimal.Decimal)):
+                raise ValueError(f'Property "CarriageMass" of "SimpleTuning" is not a number.')
+
+        if self.motor_inertia is not None:
+            if not isinstance(self.motor_inertia, (int, float, decimal.Decimal)):
+                raise ValueError(f'Property "MotorInertia" of "SimpleTuning" is not a number.')
+
+        if self.load_mass is None:
+            raise ValueError(f'Property "LoadMass" of "SimpleTuning" is None.')
+
+        if not isinstance(self.load_mass, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "LoadMass" of "SimpleTuning" is not a number.')
+
+        if self.tuning_params is not None:
+            if not isinstance(self.tuning_params, Iterable):
+                raise ValueError('Property "TuningParams" of "SimpleTuning" is not iterable.')
+
+            for i, tuning_params_item in enumerate(self.tuning_params):
+                if tuning_params_item is None:
+                    raise ValueError(f'Item {i} in property "TuningParams" of "SimpleTuning" is None.')
+
+                if not isinstance(tuning_params_item, ServoTuningParam):
+                    raise ValueError(f'Item {i} in property "TuningParams" of "SimpleTuning" is not an instance of "ServoTuningParam".')
+
+                tuning_params_item.validate()

zaber_motion/dto/ascii/simple_tuning_param_definition.py

@@ -1,100 +1,100 @@
-# 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 SimpleTuningParamDefinition:
-    """
-    Information about a parameter used for the simple tuning method.
-    """
-
-    name: str
-    """
-    The name of the parameter.
-    """
-
-    min_label: str
-    """
-    The human readable description of the effect of a lower value on this setting.
-    """
-
-    max_label: str
-    """
-    The human readable description of the effect of a higher value on this setting.
-    """
-
-    data_type: str
-    """
-    How this parameter will be parsed by the tuner.
-    """
-
-    default_value: Optional[float] = None
-    """
-    The default value of this parameter.
-    """
-
-    @staticmethod
-    def zero_values() -> 'SimpleTuningParamDefinition':
-        return SimpleTuningParamDefinition(
-            name="",
-            min_label="",
-            max_label="",
-            data_type="",
-            default_value=None,
-        )
-
-    @staticmethod
-    def from_binary(data_bytes: bytes) -> 'SimpleTuningParamDefinition':
-        """" Deserialize a binary representation of this class. """
-        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
-        return SimpleTuningParamDefinition.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 {
-            'name': str(self.name or ''),
-            'minLabel': str(self.min_label or ''),
-            'maxLabel': str(self.max_label or ''),
-            'dataType': str(self.data_type or ''),
-            'defaultValue': float(self.default_value) if self.default_value is not None else None,
-        }
-
-    @staticmethod
-    def from_dict(data: Dict[str, Any]) -> 'SimpleTuningParamDefinition':
-        return SimpleTuningParamDefinition(
-            name=data.get('name'),  # type: ignore
-            min_label=data.get('minLabel'),  # type: ignore
-            max_label=data.get('maxLabel'),  # type: ignore
-            data_type=data.get('dataType'),  # type: ignore
-            default_value=data.get('defaultValue'),  # type: ignore
-        )
-
-    def validate(self) -> None:
-        """" Validates the properties of the instance. """
-        if self.name is not None:
-            if not isinstance(self.name, str):
-                raise ValueError(f'Property "Name" of "SimpleTuningParamDefinition" is not a string.')
-
-        if self.min_label is not None:
-            if not isinstance(self.min_label, str):
-                raise ValueError(f'Property "MinLabel" of "SimpleTuningParamDefinition" is not a string.')
-
-        if self.max_label is not None:
-            if not isinstance(self.max_label, str):
-                raise ValueError(f'Property "MaxLabel" of "SimpleTuningParamDefinition" is not a string.')
-
-        if self.data_type is not None:
-            if not isinstance(self.data_type, str):
-                raise ValueError(f'Property "DataType" of "SimpleTuningParamDefinition" is not a string.')
-
-        if self.default_value is not None:
-            if not isinstance(self.default_value, (int, float, decimal.Decimal)):
-                raise ValueError(f'Property "DefaultValue" of "SimpleTuningParamDefinition" is not a number.')
+# 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 SimpleTuningParamDefinition:
+    """
+    Information about a parameter used for the simple tuning method.
+    """
+
+    name: str
+    """
+    The name of the parameter.
+    """
+
+    min_label: str
+    """
+    The human readable description of the effect of a lower value on this setting.
+    """
+
+    max_label: str
+    """
+    The human readable description of the effect of a higher value on this setting.
+    """
+
+    data_type: str
+    """
+    How this parameter will be parsed by the tuner.
+    """
+
+    default_value: Optional[float] = None
+    """
+    The default value of this parameter.
+    """
+
+    @staticmethod
+    def zero_values() -> 'SimpleTuningParamDefinition':
+        return SimpleTuningParamDefinition(
+            name="",
+            min_label="",
+            max_label="",
+            data_type="",
+            default_value=None,
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'SimpleTuningParamDefinition':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return SimpleTuningParamDefinition.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 {
+            'name': str(self.name or ''),
+            'minLabel': str(self.min_label or ''),
+            'maxLabel': str(self.max_label or ''),
+            'dataType': str(self.data_type or ''),
+            'defaultValue': float(self.default_value) if self.default_value is not None else None,
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'SimpleTuningParamDefinition':
+        return SimpleTuningParamDefinition(
+            name=data.get('name'),  # type: ignore
+            min_label=data.get('minLabel'),  # type: ignore
+            max_label=data.get('maxLabel'),  # type: ignore
+            data_type=data.get('dataType'),  # type: ignore
+            default_value=data.get('defaultValue'),  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.name is not None:
+            if not isinstance(self.name, str):
+                raise ValueError(f'Property "Name" of "SimpleTuningParamDefinition" is not a string.')
+
+        if self.min_label is not None:
+            if not isinstance(self.min_label, str):
+                raise ValueError(f'Property "MinLabel" of "SimpleTuningParamDefinition" is not a string.')
+
+        if self.max_label is not None:
+            if not isinstance(self.max_label, str):
+                raise ValueError(f'Property "MaxLabel" of "SimpleTuningParamDefinition" is not a string.')
+
+        if self.data_type is not None:
+            if not isinstance(self.data_type, str):
+                raise ValueError(f'Property "DataType" of "SimpleTuningParamDefinition" is not a string.')
+
+        if self.default_value is not None:
+            if not isinstance(self.default_value, (int, float, decimal.Decimal)):
+                raise ValueError(f'Property "DefaultValue" of "SimpleTuningParamDefinition" is not a number.')

zaber_motion/dto/ascii/stream_axis_definition.py

@@ -1,70 +1,70 @@
-# 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
-from .stream_axis_type import StreamAxisType
-
-
-@dataclass
-class StreamAxisDefinition:
-    """
-    Defines an axis of the stream.
-    """
-
-    axis_number: int
-    """
-    Number of a physical axis or a lockstep group.
-    """
-
-    axis_type: Optional[StreamAxisType] = None
-    """
-    Defines the type of the axis.
-    """
-
-    @staticmethod
-    def zero_values() -> 'StreamAxisDefinition':
-        return StreamAxisDefinition(
-            axis_number=0,
-            axis_type=None,
-        )
-
-    @staticmethod
-    def from_binary(data_bytes: bytes) -> 'StreamAxisDefinition':
-        """" Deserialize a binary representation of this class. """
-        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
-        return StreamAxisDefinition.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 {
-            'axisNumber': int(self.axis_number),
-            'axisType': self.axis_type.value if self.axis_type is not None else None,
-        }
-
-    @staticmethod
-    def from_dict(data: Dict[str, Any]) -> 'StreamAxisDefinition':
-        return StreamAxisDefinition(
-            axis_number=data.get('axisNumber'),  # type: ignore
-            axis_type=StreamAxisType(data.get('axisType')) if data.get('axisType') is not None else None,  # type: ignore
-        )
-
-    def validate(self) -> None:
-        """" Validates the properties of the instance. """
-        if self.axis_number is None:
-            raise ValueError(f'Property "AxisNumber" of "StreamAxisDefinition" is None.')
-
-        if not isinstance(self.axis_number, (int, float, decimal.Decimal)):
-            raise ValueError(f'Property "AxisNumber" of "StreamAxisDefinition" is not a number.')
-
-        if int(self.axis_number) != self.axis_number:
-            raise ValueError(f'Property "AxisNumber" of "StreamAxisDefinition" is not integer value.')
-
-        if self.axis_type is not None:
-            if not isinstance(self.axis_type, StreamAxisType):
-                raise ValueError(f'Property "AxisType" of "StreamAxisDefinition" is not an instance of "StreamAxisType".')
+# 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
+from .stream_axis_type import StreamAxisType
+
+
+@dataclass
+class StreamAxisDefinition:
+    """
+    Defines an axis of the stream.
+    """
+
+    axis_number: int
+    """
+    Number of a physical axis or a lockstep group.
+    """
+
+    axis_type: Optional[StreamAxisType] = None
+    """
+    Defines the type of the axis.
+    """
+
+    @staticmethod
+    def zero_values() -> 'StreamAxisDefinition':
+        return StreamAxisDefinition(
+            axis_number=0,
+            axis_type=None,
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'StreamAxisDefinition':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return StreamAxisDefinition.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 {
+            'axisNumber': int(self.axis_number),
+            'axisType': self.axis_type.value if self.axis_type is not None else None,
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'StreamAxisDefinition':
+        return StreamAxisDefinition(
+            axis_number=data.get('axisNumber'),  # type: ignore
+            axis_type=StreamAxisType(data.get('axisType')) if data.get('axisType') is not None else None,  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.axis_number is None:
+            raise ValueError(f'Property "AxisNumber" of "StreamAxisDefinition" is None.')
+
+        if not isinstance(self.axis_number, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "AxisNumber" of "StreamAxisDefinition" is not a number.')
+
+        if int(self.axis_number) != self.axis_number:
+            raise ValueError(f'Property "AxisNumber" of "StreamAxisDefinition" is not integer value.')
+
+        if self.axis_type is not None:
+            if not isinstance(self.axis_type, StreamAxisType):
+                raise ValueError(f'Property "AxisType" of "StreamAxisDefinition" is not an instance of "StreamAxisType".')

zaber_motion/dto/ascii/stream_axis_type.py

@@ -1,11 +1,11 @@
-# This file is generated. Do not modify by hand.
-from enum import Enum
-
-
-class StreamAxisType(Enum):
-    """
-    Denotes type of the stream axis.
-    """
-
-    PHYSICAL = 0
-    LOCKSTEP = 1
+# This file is generated. Do not modify by hand.
+from enum import Enum
+
+
+class StreamAxisType(Enum):
+    """
+    Denotes type of the stream axis.
+    """
+
+    PHYSICAL = 0
+    LOCKSTEP = 1

zaber_motion/dto/ascii/stream_mode.py

@@ -1,13 +1,13 @@
-# This file is generated. Do not modify by hand.
-from enum import Enum
-
-
-class StreamMode(Enum):
-    """
-    Mode of a stream.
-    """
-
-    DISABLED = 0
-    STORE = 1
-    STORE_ARBITRARY_AXES = 2
-    LIVE = 3
+# This file is generated. Do not modify by hand.
+from enum import Enum
+
+
+class StreamMode(Enum):
+    """
+    Mode of a stream.
+    """
+
+    DISABLED = 0
+    STORE = 1
+    STORE_ARBITRARY_AXES = 2
+    LIVE = 3

zaber_motion/dto/ascii/trigger_action.py

@@ -1,12 +1,12 @@
-# This file is generated. Do not modify by hand.
-from enum import Enum
-
-
-class TriggerAction(Enum):
-    """
-    Trigger action identifier.
-    """
-
-    ALL = 0
-    A = 1
-    B = 2
+# This file is generated. Do not modify by hand.
+from enum import Enum
+
+
+class TriggerAction(Enum):
+    """
+    Trigger action identifier.
+    """
+
+    ALL = 0
+    A = 1
+    B = 2