zaber-motion 7.8.3__tar.gz → 7.9.0__tar.gz

{zaber_motion-7.8.3/zaber_motion.egg-info → zaber_motion-7.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zaber_motion
-Version: 7.8.3
+Version: 7.9.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.8.3 → zaber_motion-7.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zaber_motion"
-version = "7.8.3"
+version = "7.9.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.8.3 → zaber_motion-7.9.0}/zaber_motion/ascii/connection.py

@@ -114,9 +114,17 @@ class Connection:
         """
         self.__change_checksum_enabled(value)
 
+    @property
+    def is_open(self) -> bool:
+        """
+        Returns whether the connection is open.
+        Does not guarantee that subsequent requests will succeed.
+        """
+        return self.__retrieve_is_open()
+
     def __init__(self, interface_id: int):
         self._interface_id = interface_id
-        self.__setup_events()
+        self.__setup_events(0)
 
     @staticmethod
     def open_serial_port(
@@ -402,6 +410,40 @@ class Connection:
         )
         return AsyncConnectionOpener(request)
 
+    def reopen(
+            self
+    ) -> None:
+        """
+        Reopens the connection.
+        To continue using events on the connection, you must resubscribe to event observables.
+        Throws an exception if the connection is already open.
+        """
+        request = dto.InterfaceEmptyRequest(
+            interface_id=self.interface_id,
+        )
+        response = call(
+            "interface/reopen",
+            request,
+            dto.IntResponse.from_binary)
+        self.__setup_events(response.value)
+
+    async def reopen_async(
+            self
+    ) -> None:
+        """
+        Reopens the connection.
+        To continue using events on the connection, you must resubscribe to event observables.
+        Throws an exception if the connection is already open.
+        """
+        request = dto.InterfaceEmptyRequest(
+            interface_id=self.interface_id,
+        )
+        response = await call_async(
+            "interface/reopen",
+            request,
+            dto.IntResponse.from_binary)
+        self.__setup_events(response.value)
+
     def generic_command(
             self,
             command: str,
@@ -1007,6 +1049,24 @@ class Connection:
         )
         call_sync("interface/set_checksum_enabled", request)
 
+    def __retrieve_is_open(
+            self
+    ) -> bool:
+        """
+        Returns is open.
+
+        Returns:
+            Is open.
+        """
+        request = dto.InterfaceEmptyRequest(
+            interface_id=self.interface_id,
+        )
+        response = call_sync(
+            "interface/get_is_open",
+            request,
+            dto.BoolResponse.from_binary)
+        return response.value
+
     @staticmethod
     def __free(
             interface_id: int
@@ -1030,11 +1090,11 @@ class Connection:
         """ __exit__ """
         self.close()
 
-    def __setup_events(self) -> None:
+    def __setup_events(self, session_id: int) -> None:
         def filter_connection_event(
             data: TConnectionEvents,
         ) -> bool:
-            return data.interface_id == self._interface_id
+            return data.interface_id == self._interface_id and data.session_id == session_id
 
         self._disconnected = ReplaySubject[MotionLibException]()  # terminates all the events
 

{zaber_motion-7.8.3 → zaber_motion-7.9.0}/zaber_motion/binary/connection.py

@@ -66,6 +66,14 @@ class Connection:
         """
         return self._interface_id
 
+    @property
+    def is_open(self) -> bool:
+        """
+        Returns whether the connection is open.
+        Does not guarantee that the subsequent requests will succeed.
+        """
+        return self.__retrieve_is_open()
+
     def __init__(self, interface_id: int):
         self._interface_id = interface_id
         self.__setup_events()
@@ -497,6 +505,24 @@ class Connection:
 
         return Device(self, device_address)
 
+    def __retrieve_is_open(
+            self
+    ) -> bool:
+        """
+        Returns is open.
+
+        Returns:
+            Is open.
+        """
+        request = dto.InterfaceEmptyRequest(
+            interface_id=self.interface_id,
+        )
+        response = call_sync(
+            "interface/get_is_open",
+            request,
+            dto.BoolResponse.from_binary)
+        return response.value
+
     def __repr__(
             self
     ) -> str:

{zaber_motion-7.8.3 → zaber_motion-7.9.0}/zaber_motion/dto/requests/alert_event_wrapper.py

@@ -12,12 +12,18 @@ class AlertEventWrapper:
 
     interface_id: int = 0
 
+    session_id: int = 0
+    """
+    The id of the connection session.
+    """
+
     alert: AlertEvent = field(default_factory=AlertEvent.zero_values)
 
     @staticmethod
     def zero_values() -> 'AlertEventWrapper':
         return AlertEventWrapper(
             interface_id=0,
+            session_id=0,
             alert=AlertEvent.zero_values(),
         )
 
@@ -35,6 +41,7 @@ class AlertEventWrapper:
     def to_dict(self) -> Dict[str, Any]:
         return {
             'interfaceId': int(self.interface_id),
+            'sessionId': int(self.session_id),
             'alert': self.alert.to_dict(),
         }
 
@@ -42,6 +49,7 @@ class AlertEventWrapper:
     def from_dict(data: Dict[str, Any]) -> 'AlertEventWrapper':
         return AlertEventWrapper(
             interface_id=data.get('interfaceId'),  # type: ignore
+            session_id=data.get('sessionId'),  # type: ignore
             alert=AlertEvent.from_dict(data.get('alert')),  # type: ignore
         )
 
@@ -56,6 +64,15 @@ class AlertEventWrapper:
         if int(self.interface_id) != self.interface_id:
             raise ValueError(f'Property "InterfaceId" of "AlertEventWrapper" is not integer value.')
 
+        if self.session_id is None:
+            raise ValueError(f'Property "SessionId" of "AlertEventWrapper" is None.')
+
+        if not isinstance(self.session_id, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "SessionId" of "AlertEventWrapper" is not a number.')
+
+        if int(self.session_id) != self.session_id:
+            raise ValueError(f'Property "SessionId" of "AlertEventWrapper" is not integer value.')
+
         if self.alert is None:
             raise ValueError(f'Property "Alert" of "AlertEventWrapper" is None.')
 

{zaber_motion-7.8.3 → zaber_motion-7.9.0}/zaber_motion/dto/requests/binary_reply_only_event_wrapper.py

@@ -12,12 +12,18 @@ class BinaryReplyOnlyEventWrapper:
 
     interface_id: int = 0
 
+    session_id: int = 0
+    """
+    The id of the connection session.
+    """
+
     reply: ReplyOnlyEvent = field(default_factory=ReplyOnlyEvent.zero_values)
 
     @staticmethod
     def zero_values() -> 'BinaryReplyOnlyEventWrapper':
         return BinaryReplyOnlyEventWrapper(
             interface_id=0,
+            session_id=0,
             reply=ReplyOnlyEvent.zero_values(),
         )
 
@@ -35,6 +41,7 @@ class BinaryReplyOnlyEventWrapper:
     def to_dict(self) -> Dict[str, Any]:
         return {
             'interfaceId': int(self.interface_id),
+            'sessionId': int(self.session_id),
             'reply': self.reply.to_dict(),
         }
 
@@ -42,6 +49,7 @@ class BinaryReplyOnlyEventWrapper:
     def from_dict(data: Dict[str, Any]) -> 'BinaryReplyOnlyEventWrapper':
         return BinaryReplyOnlyEventWrapper(
             interface_id=data.get('interfaceId'),  # type: ignore
+            session_id=data.get('sessionId'),  # type: ignore
             reply=ReplyOnlyEvent.from_dict(data.get('reply')),  # type: ignore
         )
 
@@ -56,6 +64,15 @@ class BinaryReplyOnlyEventWrapper:
         if int(self.interface_id) != self.interface_id:
             raise ValueError(f'Property "InterfaceId" of "BinaryReplyOnlyEventWrapper" is not integer value.')
 
+        if self.session_id is None:
+            raise ValueError(f'Property "SessionId" of "BinaryReplyOnlyEventWrapper" is None.')
+
+        if not isinstance(self.session_id, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "SessionId" of "BinaryReplyOnlyEventWrapper" is not a number.')
+
+        if int(self.session_id) != self.session_id:
+            raise ValueError(f'Property "SessionId" of "BinaryReplyOnlyEventWrapper" is not integer value.')
+
         if self.reply is None:
             raise ValueError(f'Property "Reply" of "BinaryReplyOnlyEventWrapper" is None.')
 

{zaber_motion-7.8.3 → zaber_motion-7.9.0}/zaber_motion/dto/requests/disconnected_event.py

@@ -18,6 +18,11 @@ class DisconnectedEvent:
     The id of the interface that was disconnected.
     """
 
+    session_id: int = 0
+    """
+    The id of the connection session.
+    """
+
     error_type: Errors = next(first for first in Errors)
     """
     The type of error that caused the disconnection.
@@ -32,6 +37,7 @@ class DisconnectedEvent:
     def zero_values() -> 'DisconnectedEvent':
         return DisconnectedEvent(
             interface_id=0,
+            session_id=0,
             error_type=next(first for first in Errors),
             error_message="",
         )
@@ -50,6 +56,7 @@ class DisconnectedEvent:
     def to_dict(self) -> Dict[str, Any]:
         return {
             'interfaceId': int(self.interface_id),
+            'sessionId': int(self.session_id),
             'errorType': self.error_type.value,
             'errorMessage': str(self.error_message or ''),
         }
@@ -58,6 +65,7 @@ class DisconnectedEvent:
     def from_dict(data: Dict[str, Any]) -> 'DisconnectedEvent':
         return DisconnectedEvent(
             interface_id=data.get('interfaceId'),  # type: ignore
+            session_id=data.get('sessionId'),  # type: ignore
             error_type=Errors(data.get('errorType')),  # type: ignore
             error_message=data.get('errorMessage'),  # type: ignore
         )
@@ -73,6 +81,15 @@ class DisconnectedEvent:
         if int(self.interface_id) != self.interface_id:
             raise ValueError(f'Property "InterfaceId" of "DisconnectedEvent" is not integer value.')
 
+        if self.session_id is None:
+            raise ValueError(f'Property "SessionId" of "DisconnectedEvent" is None.')
+
+        if not isinstance(self.session_id, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "SessionId" of "DisconnectedEvent" is not a number.')
+
+        if int(self.session_id) != self.session_id:
+            raise ValueError(f'Property "SessionId" of "DisconnectedEvent" is not integer value.')
+
         if self.error_type is None:
             raise ValueError(f'Property "ErrorType" of "DisconnectedEvent" is None.')
 

{zaber_motion-7.8.3 → zaber_motion-7.9.0}/zaber_motion/dto/requests/unknown_binary_response_event_wrapper.py

@@ -12,12 +12,18 @@ class UnknownBinaryResponseEventWrapper:
 
     interface_id: int = 0
 
+    session_id: int = 0
+    """
+    The id of the connection session.
+    """
+
     unknown_response: UnknownResponseEvent = field(default_factory=UnknownResponseEvent.zero_values)
 
     @staticmethod
     def zero_values() -> 'UnknownBinaryResponseEventWrapper':
         return UnknownBinaryResponseEventWrapper(
             interface_id=0,
+            session_id=0,
             unknown_response=UnknownResponseEvent.zero_values(),
         )
 
@@ -35,6 +41,7 @@ class UnknownBinaryResponseEventWrapper:
     def to_dict(self) -> Dict[str, Any]:
         return {
             'interfaceId': int(self.interface_id),
+            'sessionId': int(self.session_id),
             'unknownResponse': self.unknown_response.to_dict(),
         }
 
@@ -42,6 +49,7 @@ class UnknownBinaryResponseEventWrapper:
     def from_dict(data: Dict[str, Any]) -> 'UnknownBinaryResponseEventWrapper':
         return UnknownBinaryResponseEventWrapper(
             interface_id=data.get('interfaceId'),  # type: ignore
+            session_id=data.get('sessionId'),  # type: ignore
             unknown_response=UnknownResponseEvent.from_dict(data.get('unknownResponse')),  # type: ignore
         )
 
@@ -56,6 +64,15 @@ class UnknownBinaryResponseEventWrapper:
         if int(self.interface_id) != self.interface_id:
             raise ValueError(f'Property "InterfaceId" of "UnknownBinaryResponseEventWrapper" is not integer value.')
 
+        if self.session_id is None:
+            raise ValueError(f'Property "SessionId" of "UnknownBinaryResponseEventWrapper" is None.')
+
+        if not isinstance(self.session_id, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "SessionId" of "UnknownBinaryResponseEventWrapper" is not a number.')
+
+        if int(self.session_id) != self.session_id:
+            raise ValueError(f'Property "SessionId" of "UnknownBinaryResponseEventWrapper" is not integer value.')
+
         if self.unknown_response is None:
             raise ValueError(f'Property "UnknownResponse" of "UnknownBinaryResponseEventWrapper" is None.')
 

{zaber_motion-7.8.3 → zaber_motion-7.9.0}/zaber_motion/dto/requests/unknown_response_event_wrapper.py

@@ -12,12 +12,18 @@ class UnknownResponseEventWrapper:
 
     interface_id: int = 0
 
+    session_id: int = 0
+    """
+    The id of the connection session.
+    """
+
     unknown_response: UnknownResponseEvent = field(default_factory=UnknownResponseEvent.zero_values)
 
     @staticmethod
     def zero_values() -> 'UnknownResponseEventWrapper':
         return UnknownResponseEventWrapper(
             interface_id=0,
+            session_id=0,
             unknown_response=UnknownResponseEvent.zero_values(),
         )
 
@@ -35,6 +41,7 @@ class UnknownResponseEventWrapper:
     def to_dict(self) -> Dict[str, Any]:
         return {
             'interfaceId': int(self.interface_id),
+            'sessionId': int(self.session_id),
             'unknownResponse': self.unknown_response.to_dict(),
         }
 
@@ -42,6 +49,7 @@ class UnknownResponseEventWrapper:
     def from_dict(data: Dict[str, Any]) -> 'UnknownResponseEventWrapper':
         return UnknownResponseEventWrapper(
             interface_id=data.get('interfaceId'),  # type: ignore
+            session_id=data.get('sessionId'),  # type: ignore
             unknown_response=UnknownResponseEvent.from_dict(data.get('unknownResponse')),  # type: ignore
         )
 
@@ -56,6 +64,15 @@ class UnknownResponseEventWrapper:
         if int(self.interface_id) != self.interface_id:
             raise ValueError(f'Property "InterfaceId" of "UnknownResponseEventWrapper" is not integer value.')
 
+        if self.session_id is None:
+            raise ValueError(f'Property "SessionId" of "UnknownResponseEventWrapper" is None.')
+
+        if not isinstance(self.session_id, (int, float, decimal.Decimal)):
+            raise ValueError(f'Property "SessionId" of "UnknownResponseEventWrapper" is not a number.')
+
+        if int(self.session_id) != self.session_id:
+            raise ValueError(f'Property "SessionId" of "UnknownResponseEventWrapper" is not integer value.')
+
         if self.unknown_response is None:
             raise ValueError(f'Property "UnknownResponse" of "UnknownResponseEventWrapper" is None.')
 

{zaber_motion-7.8.3 → zaber_motion-7.9.0}/zaber_motion/library.py

@@ -154,7 +154,7 @@ class Library:
         """
         request = dto.CheckVersionRequest(
             host="py",
-            version="7.8.3",
+            version="7.9.0",
         )
         call_sync("library/check_version", request)
 

zaber_motion-7.9.0/zaber_motion/version.py

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

{zaber_motion-7.8.3 → zaber_motion-7.9.0/zaber_motion.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zaber_motion
-Version: 7.8.3
+Version: 7.9.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.8.3/zaber_motion/version.py

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