ephys-link 2.0.1__tar.gz → 2.0.2__tar.gz

{ephys_link-2.0.1 → ephys_link-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ephys-link
-Version: 2.0.1
+Version: 2.0.2
 Summary: A Python Socket.IO server that allows any Socket.IO-compliant application to communicate with manipulators used in electrophysiology experiments.
 Project-URL: Documentation, https://virtualbrainlab.org/ephys_link/installation_and_use.html
 Project-URL: Issues, https://github.com/VirtualBrainLab/ephys-link/issues

ephys_link-2.0.2/src/ephys_link/__about__.py

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

{ephys_link-2.0.1 → ephys_link-2.0.2}/src/ephys_link/bindings/fake_binding.py

@@ -57,8 +57,9 @@ class FakeBinding(BaseBinding):
     async def get_shank_count(self, manipulator_id: str) -> int:
         return 1
 
+    @staticmethod
     @override
-    def get_movement_tolerance(self) -> float:
+    def get_movement_tolerance() -> float:
         return 0.001
 
     @override

{ephys_link-2.0.1 → ephys_link-2.0.2}/src/ephys_link/bindings/mpm_binding.py

@@ -62,12 +62,11 @@ class MPMBinding(BaseBinding):
         "AN",
     )
 
-    # Server cache lifetime (60 FPS).
-    CACHE_LIFETIME = 1 / 60
+    # Server data update rate (30 FPS).
+    SERVER_DATA_UPDATE_RATE = 1 / 30
 
     # Movement polling preferences.
     UNCHANGED_COUNTER_LIMIT = 10
-    POLL_INTERVAL = 0.1
 
     # Speed preferences (mm/s to use coarse mode).
     COARSE_SPEED_THRESHOLD = 0.1
@@ -113,7 +112,8 @@ class MPMBinding(BaseBinding):
         manipulator_data: dict[str, float] = await self._manipulator_data(manipulator_id)
         stage_z: float = manipulator_data["Stage_Z"]
 
-        await sleep(self.POLL_INTERVAL)  # Wait for the stage to stabilize.
+        # Wait for the stage to stabilize.
+        await sleep(self.SERVER_DATA_UPDATE_RATE)
 
         return Vector4(
             x=manipulator_data["Stage_X"],
@@ -139,8 +139,9 @@ class MPMBinding(BaseBinding):
     async def get_shank_count(self, manipulator_id: str) -> int:
         return int((await self._manipulator_data(manipulator_id))["ShankCount"])  # pyright: ignore [reportAny]
 
+    @staticmethod
     @override
-    def get_movement_tolerance(self) -> float:
+    def get_movement_tolerance() -> float:
         return 0.01
 
     @override
@@ -180,7 +181,7 @@ class MPMBinding(BaseBinding):
             and unchanged_counter < self.UNCHANGED_COUNTER_LIMIT
         ):
             # Wait for a short time before checking again.
-            await sleep(self.POLL_INTERVAL)
+            await sleep(self.SERVER_DATA_UPDATE_RATE)
 
             # Update current position.
             current_position = await self.get_position(manipulator_id)
@@ -219,9 +220,13 @@ class MPMBinding(BaseBinding):
         )
 
         # Wait for the manipulator to reach the target depth or be stopped or get stuck.
-        while not self._movement_stopped and not abs(current_depth - depth) <= self.get_movement_tolerance():
+        while (
+            not self._movement_stopped
+            and not abs(current_depth - depth) <= self.get_movement_tolerance()
+            and unchanged_counter < self.UNCHANGED_COUNTER_LIMIT
+        ):
             # Wait for a short time before checking again.
-            await sleep(self.POLL_INTERVAL)
+            await sleep(self.SERVER_DATA_UPDATE_RATE)
 
             # Get the current depth.
             current_depth = (await self.get_position(manipulator_id)).w
@@ -281,10 +286,11 @@ class MPMBinding(BaseBinding):
         )
 
     # Helper functions.
+
     async def _query_data(self) -> dict[str, Any]:  # pyright: ignore [reportExplicitAny]
         try:
             # Update cache if it's expired.
-            if get_running_loop().time() - self.cache_time > self.CACHE_LIFETIME:
+            if get_running_loop().time() - self.cache_time > self.SERVER_DATA_UPDATE_RATE:
                 # noinspection PyTypeChecker
                 self.cache = (await get_running_loop().run_in_executor(None, get, self._url)).json()
                 self.cache_time = get_running_loop().time()

{ephys_link-2.0.1 → ephys_link-2.0.2}/src/ephys_link/bindings/ump_4_binding.py

@@ -77,8 +77,9 @@ class Ump4Binding(BaseBinding):
         error_message = "UMP-4 does not support getting shank count"
         raise AttributeError(error_message)
 
+    @staticmethod
     @override
-    def get_movement_tolerance(self) -> float:
+    def get_movement_tolerance() -> float:
         return 0.001
 
     @override

{ephys_link-2.0.1 → ephys_link-2.0.2}/src/ephys_link/utils/base_binding.py

@@ -99,8 +99,9 @@ class BaseBinding(ABC):
             Number of shanks on the manipulator.
         """
 
+    @staticmethod
     @abstractmethod
-    def get_movement_tolerance(self) -> float:
+    def get_movement_tolerance() -> float:
         """Get the tolerance for how close the final position must be to the target position in a movement (mm).
 
         Returns:

ephys_link-2.0.1/src/ephys_link/__about__.py

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