ephys-link 2.1.0b0__py3-none-any.whl → 2.1.1__py3-none-any.whl

ephys_link/__about__.py

@@ -1 +1 @@
-__version__ = "2.1.0b0"
+__version__ = "2.1.1"

ephys_link/__main__.py

@@ -16,9 +16,9 @@ from keyboard import add_hotkey
 from ephys_link.back_end.platform_handler import PlatformHandler
 from ephys_link.back_end.server import Server
 from ephys_link.front_end.cli import CLI
+from ephys_link.front_end.console import Console
 from ephys_link.front_end.gui import GUI
-from ephys_link.utils.console import Console
-from ephys_link.utils.startup import check_for_updates, preamble
+from ephys_link.utils.startup import check_for_updates, get_binding_instance, preamble
 
 
 def main() -> None:
@@ -37,13 +37,16 @@ def main() -> None:
     if not options.ignore_updates:
         check_for_updates(console)
 
-    # 4. Instantiate the Platform Handler with the appropriate platform bindings.
-    platform_handler = PlatformHandler(options, console)
+    # 4. Instantiate the requested platform binding.
+    binding = get_binding_instance(options, console)
 
-    # 5. Add hotkeys for emergency stop.
+    # 5. Instantiate the Platform Handler with the appropriate platform bindings.
+    platform_handler = PlatformHandler(binding, console)
+
+    # 6. Add hotkeys for emergency stop.
     _ = add_hotkey("ctrl+alt+shift+q", lambda: run(platform_handler.emergency_stop()))
 
-    # 6. Start the server.
+    # 7. Start the server.
     Server(options, platform_handler, console).launch()
 
 

ephys_link/back_end/platform_handler.py

@@ -8,12 +8,10 @@ Usage:
 """
 
 from typing import final
-from uuid import uuid4
 
 from vbl_aquarium.models.ephys_link import (
     AngularResponse,
     BooleanStateResponse,
-    EphysLinkOptions,
     GetManipulatorsResponse,
     PlatformInfo,
     PositionalResponse,
@@ -23,81 +21,38 @@ from vbl_aquarium.models.ephys_link import (
     SetPositionRequest,
     ShankCountResponse,
 )
-from vbl_aquarium.models.unity import Vector4
 
-from ephys_link.bindings.mpm_binding import MPMBinding
+from ephys_link.front_end.console import Console
 from ephys_link.utils.base_binding import BaseBinding
-from ephys_link.utils.console import Console
+from ephys_link.utils.constants import (
+    EMERGENCY_STOP_MESSAGE,
+    NO_SET_POSITION_WHILE_INSIDE_BRAIN_ERROR,
+    did_not_reach_target_depth_error,
+    did_not_reach_target_position_error,
+)
 from ephys_link.utils.converters import vector4_to_array
-from ephys_link.utils.startup import get_bindings
 
 
 @final
 class PlatformHandler:
     """Handler for platform commands."""
 
-    def __init__(self, options: EphysLinkOptions, console: Console) -> None:
+    def __init__(self, binding: BaseBinding, console: Console) -> None:
         """Initialize platform handler.
 
         Args:
-            options: CLI options.
+            binding: Binding instance for the platform.
             console: Console instance.
         """
-        # Store the CLI options.
-        self._options = options
-
         # Store the console.
         self._console = console
 
         # Define bindings based on platform type.
-        self._bindings = self._get_binding_instance(options)
+        self._bindings = binding
 
         # Record which IDs are inside the brain.
         self._inside_brain: set[str] = set()
 
-        # Generate a Pinpoint ID for proxy usage.
-        self._pinpoint_id = str(uuid4())[:8]
-
-    def _get_binding_instance(self, options: EphysLinkOptions) -> BaseBinding:
-        """Match the platform type to the appropriate bindings.
-
-        Args:
-            options: CLI options.
-
-        Raises:
-            ValueError: If the platform type is not recognized.
-
-        Returns:
-            Bindings for the specified platform type.
-        """
-
-        # What the user supplied.
-        selected_type = options.type
-
-        for binding_type in get_bindings():
-            binding_cli_name = binding_type.get_cli_name()
-
-            # Notify deprecation of "ump-4" and "ump-3" CLI options and fix.
-            if selected_type in ("ump-4", "ump-3"):
-                self._console.error_print(
-                    "DEPRECATION",
-                    f"CLI option '{selected_type}' is deprecated and will be removed in v3.0.0. Use 'ump' instead.",
-                )
-                selected_type = "ump"
-
-            if binding_cli_name == selected_type:
-                # Pass in HTTP port for Pathfinder MPM.
-                if binding_cli_name == "pathfinder-mpm":
-                    return MPMBinding(options.mpm_port)
-
-                # Otherwise just return the binding.
-                return binding_type()
-
-        # Raise an error if the platform type is not recognized.
-        error_message = f'Platform type "{options.type}" not recognized.'
-        self._console.critical_print(error_message)
-        raise ValueError(error_message)
-
     # Platform metadata.
 
     def get_display_name(self) -> str:
@@ -152,7 +107,7 @@ class PlatformHandler:
             )
         except Exception as e:  # noqa: BLE001
             self._console.exception_error_print("Get Position", e)
-            return PositionalResponse(error=str(e))
+            return PositionalResponse(error=self._console.pretty_exception(e))
         else:
             return PositionalResponse(position=unified_position)
 
@@ -202,9 +157,8 @@ class PlatformHandler:
         try:
             # Disallow setting manipulator position while inside the brain.
             if request.manipulator_id in self._inside_brain:
-                error_message = 'Can not move manipulator while inside the brain. Set the depth ("set_depth") instead.'
-                self._console.error_print("Set Position", error_message)
-                return PositionalResponse(error=error_message)
+                self._console.error_print("Set Position", NO_SET_POSITION_WHILE_INSIDE_BRAIN_ERROR)
+                return PositionalResponse(error=NO_SET_POSITION_WHILE_INSIDE_BRAIN_ERROR)
 
             # Move to the new position.
             final_platform_position = await self._bindings.set_position(
@@ -222,11 +176,7 @@ class PlatformHandler:
 
                 # Check if the axis is within the movement tolerance.
                 if abs(axis) > self._bindings.get_movement_tolerance():
-                    error_message = (
-                        f"Manipulator {request.manipulator_id} did not reach target"
-                        f" position on axis {list(Vector4.model_fields.keys())[index]}."
-                        f" Requested: {request.position}, got: {final_unified_position}."
-                    )
+                    error_message = did_not_reach_target_position_error(request, index, final_unified_position)
                     self._console.error_print("Set Position", error_message)
                     return PositionalResponse(error=error_message)
         except Exception as e:  # noqa: BLE001
@@ -246,26 +196,22 @@ class PlatformHandler:
         """
         try:
             # Move to the new depth.
-            final_platform_depth = await self._bindings.set_depth(
+            final_depth = await self._bindings.set_depth(
                 manipulator_id=request.manipulator_id,
-                depth=self._bindings.unified_space_to_platform_space(Vector4(w=request.depth)).w,
+                depth=request.depth,
                 speed=request.speed,
             )
-            final_unified_depth = self._bindings.platform_space_to_unified_space(Vector4(w=final_platform_depth)).w
 
             # Return error if movement did not reach target within tolerance.
-            if abs(final_unified_depth - request.depth) > self._bindings.get_movement_tolerance():
-                error_message = (
-                    f"Manipulator {request.manipulator_id} did not reach target depth."
-                    f" Requested: {request.depth}, got: {final_unified_depth}."
-                )
+            if abs(final_depth - request.depth) > self._bindings.get_movement_tolerance():
+                error_message = did_not_reach_target_depth_error(request, final_depth)
                 self._console.error_print("Set Depth", error_message)
                 return SetDepthResponse(error=error_message)
         except Exception as e:  # noqa: BLE001
             self._console.exception_error_print("Set Depth", e)
             return SetDepthResponse(error=self._console.pretty_exception(e))
         else:
-            return SetDepthResponse(depth=final_unified_depth)
+            return SetDepthResponse(depth=final_depth)
 
     async def set_inside_brain(self, request: SetInsideBrainRequest) -> BooleanStateResponse:
         """Mark a manipulator as inside the brain or not.
@@ -278,16 +224,11 @@ class PlatformHandler:
         Returns:
             Inside brain state of the manipulator and an error message if any.
         """
-        try:
-            if request.inside:
-                self._inside_brain.add(request.manipulator_id)
-            else:
-                self._inside_brain.discard(request.manipulator_id)
-        except Exception as e:  # noqa: BLE001
-            self._console.exception_error_print("Set Inside Brain", e)
-            return BooleanStateResponse(error=self._console.pretty_exception(e))
+        if request.inside:
+            self._inside_brain.add(request.manipulator_id)
         else:
-            return BooleanStateResponse(state=request.inside)
+            self._inside_brain.discard(request.manipulator_id)
+        return BooleanStateResponse(state=request.inside)
 
     async def stop(self, manipulator_id: str) -> str:
         """Stop a manipulator.
@@ -316,12 +257,12 @@ class PlatformHandler:
             for manipulator_id in await self._bindings.get_manipulators():
                 await self._bindings.stop(manipulator_id)
         except Exception as e:  # noqa: BLE001
-            self._console.exception_error_print("Stop", e)
+            self._console.exception_error_print("Stop All", e)
             return self._console.pretty_exception(e)
         else:
             return ""
 
     async def emergency_stop(self) -> None:
         """Stops all manipulators with a message."""
-        self._console.critical_print("Emergency Stopping All Manipulators...")
+        self._console.critical_print(EMERGENCY_STOP_MESSAGE)
         _ = await self.stop_all()

ephys_link/back_end/server.py

@@ -32,8 +32,16 @@ from vbl_aquarium.utils.vbl_base_model import VBLBaseModel
 
 from ephys_link.__about__ import __version__
 from ephys_link.back_end.platform_handler import PlatformHandler
-from ephys_link.utils.console import Console
-from ephys_link.utils.constants import PORT
+from ephys_link.front_end.console import Console
+from ephys_link.utils.constants import (
+    MALFORMED_REQUEST_ERROR,
+    PORT,
+    PROXY_CLIENT_NOT_INITIALIZED_ERROR,
+    SERVER_NOT_INITIALIZED_ERROR,
+    UNKNOWN_EVENT_ERROR,
+    cannot_connect_as_client_is_already_connected_error,
+    client_disconnected_without_being_connected_error,
+)
 
 # Server message generic types.
 INPUT_TYPE = TypeVar("INPUT_TYPE", bound=VBLBaseModel)
@@ -61,9 +69,8 @@ class Server:
         if not self._options.use_proxy:
             # Exit if _sio is not a Server.
             if not isinstance(self._sio, AsyncServer):
-                error = "Server not initialized."
-                self._console.critical_print(error)
-                raise TypeError(error)
+                self._console.critical_print(SERVER_NOT_INITIALIZED_ERROR)
+                raise TypeError(SERVER_NOT_INITIALIZED_ERROR)
 
             self._app = Application()
             self._sio.attach(self._app)  # pyright: ignore [reportUnknownMemberType]
@@ -101,9 +108,8 @@ class Server:
             async def connect_proxy() -> None:
                 # Exit if _sio is not a proxy client.
                 if not isinstance(self._sio, AsyncClient):
-                    error = "Proxy client not initialized."
-                    self._console.critical_print(error)
-                    raise TypeError(error)
+                    self._console.critical_print(PROXY_CLIENT_NOT_INITIALIZED_ERROR)
+                    raise TypeError(PROXY_CLIENT_NOT_INITIALIZED_ERROR)
 
                 # noinspection HttpUrlsUsage
                 await self._sio.connect(f"http://{self._options.proxy_address}:{PORT}")  # pyright: ignore [reportUnknownMemberType]
@@ -125,13 +131,13 @@ class Server:
             Response for a malformed request.
         """
         self._console.error_print("MALFORMED REQUEST", f"{request}: {data}")
-        return dumps({"error": "Malformed request."})
+        return dumps(MALFORMED_REQUEST_ERROR)
 
     async def _run_if_data_available(
         self,
         function: Callable[[str], Coroutine[Any, Any, VBLBaseModel]],  # pyright: ignore [reportExplicitAny]
         event: str,
-        data: tuple[tuple[Any], ...],  # pyright: ignore [reportExplicitAny]
+        data: Any,  # pyright: ignore [reportAny, reportExplicitAny]
     ) -> str:
         """Run a function if data is available.
 
@@ -143,17 +149,16 @@ class Server:
         Returns:
             Response data from function.
         """
-        request_data = data[1]
-        if request_data:
-            return str((await function(str(request_data))).to_json_string())
-        return self._malformed_request_response(event, request_data)
+        if data:
+            return str((await function(str(data))).to_json_string())  # pyright: ignore[reportAny]
+        return self._malformed_request_response(event, data)  # pyright: ignore[reportAny]
 
     async def _run_if_data_parses(
         self,
         function: Callable[[INPUT_TYPE], Coroutine[Any, Any, OUTPUT_TYPE]],  # pyright: ignore [reportExplicitAny]
         data_type: type[INPUT_TYPE],
         event: str,
-        data: tuple[tuple[Any], ...],  # pyright: ignore [reportExplicitAny]
+        data: Any,  # pyright: ignore [reportAny, reportExplicitAny]
     ) -> str:
         """Run a function if data parses.
 
@@ -166,18 +171,17 @@ class Server:
         Returns:
             Response data from function.
         """
-        request_data = data[1]
-        if request_data:
+        if data:
             try:
-                parsed_data = data_type(**loads(str(request_data)))
+                parsed_data = data_type(**loads(str(data)))  # pyright: ignore[reportAny]
             except JSONDecodeError:
-                return self._malformed_request_response(event, request_data)
+                return self._malformed_request_response(event, data)  # pyright: ignore[reportAny]
             except ValidationError as e:
                 self._console.exception_error_print(event, e)
-                return self._malformed_request_response(event, request_data)
+                return self._malformed_request_response(event, data)  # pyright: ignore[reportAny]
             else:
                 return str((await function(parsed_data)).to_json_string())
-        return self._malformed_request_response(event, request_data)
+        return self._malformed_request_response(event, data)  # pyright: ignore[reportAny]
 
     # Event Handlers.
 
@@ -199,7 +203,7 @@ class Server:
             return True
 
         self._console.error_print(
-            "CONNECTION REFUSED", f"Cannot connect {sid} as {self._client_sid} is already connected."
+            "CONNECTION REFUSED", cannot_connect_as_client_is_already_connected_error(sid, self._client_sid)
         )
         return False
 
@@ -209,22 +213,24 @@ class Server:
         Args:
             sid: Socket session ID.
         """
-        self._console.info_print("DISCONNECTED", sid)
+        self._console.info_print("DISCONNECTION REQUEST", sid)
 
         # Reset client SID if it matches.
         if self._client_sid == sid:
             self._client_sid = ""
+            self._console.info_print("DISCONNECTED", sid)
         else:
-            self._console.error_print("DISCONNECTION", f"Client {sid} disconnected without being connected.")
+            self._console.error_print("DISCONNECTION", client_disconnected_without_being_connected_error(sid))
 
-    async def platform_event_handler(self, event: str, *args: tuple[Any]) -> str:  # pyright: ignore [reportExplicitAny]
+    async def platform_event_handler(self, event: str, _: str, data: Any) -> str:  # pyright: ignore [reportAny, reportExplicitAny]
         """Handle events from the server.
 
         Matches incoming events based on the Socket.IO API.
 
         Args:
             event: Event name.
-            args: Event arguments.
+            _: Socket session ID (unused).
+            data: Event data.
 
         Returns:
             Response data.
@@ -247,28 +253,27 @@ class Server:
             case "get_manipulators":
                 return str((await self._platform_handler.get_manipulators()).to_json_string())
             case "get_position":
-                return await self._run_if_data_available(self._platform_handler.get_position, event, args)
+                return await self._run_if_data_available(self._platform_handler.get_position, event, data)
             case "get_angles":
-                return await self._run_if_data_available(self._platform_handler.get_angles, event, args)
+                return await self._run_if_data_available(self._platform_handler.get_angles, event, data)
             case "get_shank_count":
-                return await self._run_if_data_available(self._platform_handler.get_shank_count, event, args)
+                return await self._run_if_data_available(self._platform_handler.get_shank_count, event, data)
             case "set_position":
                 return await self._run_if_data_parses(
-                    self._platform_handler.set_position, SetPositionRequest, event, args
+                    self._platform_handler.set_position, SetPositionRequest, event, data
                 )
             case "set_depth":
-                return await self._run_if_data_parses(self._platform_handler.set_depth, SetDepthRequest, event, args)
+                return await self._run_if_data_parses(self._platform_handler.set_depth, SetDepthRequest, event, data)
             case "set_inside_brain":
                 return await self._run_if_data_parses(
-                    self._platform_handler.set_inside_brain, SetInsideBrainRequest, event, args
+                    self._platform_handler.set_inside_brain, SetInsideBrainRequest, event, data
                 )
             case "stop":
-                request_data = args[1]
-                if request_data:
-                    return await self._platform_handler.stop(str(request_data))
-                return self._malformed_request_response(event, request_data)
+                if data:
+                    return await self._platform_handler.stop(str(data))  # pyright: ignore[reportAny]
+                return self._malformed_request_response(event, data)  # pyright: ignore[reportAny]
             case "stop_all":
                 return await self._platform_handler.stop_all()
             case _:
                 self._console.error_print("EVENT", f"Unknown event: {event}.")
-                return dumps({"error": "Unknown event."})
+                return dumps(UNKNOWN_EVENT_ERROR)

ephys_link/bindings/ump_binding.py

@@ -10,7 +10,6 @@ from sensapex import UMP, SensapexDevice  # pyright: ignore [reportMissingTypeSt
 from vbl_aquarium.models.unity import Vector4
 
 from ephys_link.utils.base_binding import BaseBinding
-from ephys_link.utils.constants import RESOURCES_DIRECTORY
 from ephys_link.utils.converters import (
     list_to_vector4,
     scalar_mm_to_um,
@@ -31,23 +30,11 @@ class UmpBinding(BaseBinding):
         """Initialize uMp bindings."""
 
         # Establish connection to Sensapex API (exit if connection fails).
-        UMP.set_library_path(RESOURCES_DIRECTORY)
         self._ump: UMP = UMP.get_ump()  # pyright: ignore [reportUnknownMemberType]
 
-        # Exit if no manipulators are connected.
-        device_ids: list[str] = list(map(str, self._ump.list_devices()))
-        if len(device_ids) == 0:
-            msg = "No manipulators connected."
-            raise RuntimeError(msg)
-
-        # Currently only supports using uMp-4 XOR uMp-3. Exit if both are connected.
-
-        # Use the first device as the reference for the number of axes.
-        self.num_axes: int = self._get_device(device_ids[0]).n_axes()
-
-        if any(self._get_device(device_id).n_axes() != self.num_axes for device_id in device_ids):  # pyright: ignore [reportUnknownArgumentType, reportUnknownMemberType]
-            msg = "uMp-4 and uMp-3 cannot be used at the same time."
-            raise RuntimeError(msg)
+        # Compute axis count, assumed as the first device. 0 if no devices are connected.
+        device_ids = list(map(str, self._ump.list_devices()))
+        self.axis_count: int = 0 if len(device_ids) == 0 else self._get_device(device_ids[0]).n_axes()
 
     @staticmethod
     @override
@@ -61,11 +48,18 @@ class UmpBinding(BaseBinding):
 
     @override
     async def get_manipulators(self) -> list[str]:
-        return list(map(str, self._ump.list_devices()))
+        device_ids = list(map(str, self._ump.list_devices()))
+
+        # Currently only supports using uMp-4 XOR uMp-3. Throw error if both are connected.
+        if any(self._get_device(device_id).n_axes() != self.axis_count for device_id in device_ids):  # pyright: ignore [reportUnknownArgumentType]
+            msg = "uMp-4 and uMp-3 cannot be used at the same time."
+            raise RuntimeError(msg)
+
+        return device_ids
 
     @override
     async def get_axes_count(self) -> int:
-        return self.num_axes
+        return self.axis_count
 
     @override
     def get_dimensions(self) -> Vector4:
@@ -236,4 +230,4 @@ class UmpBinding(BaseBinding):
         Returns:
             True if the device is uMp-3, False otherwise.
         """
-        return self.num_axes == self.UMP_3_NUM_AXES
+        return self.axis_count == self.UMP_3_NUM_AXES

ephys_link/front_end/cli.py

@@ -46,8 +46,8 @@ class CLI:
             "--type",
             type=str,
             dest="type",
-            default="ump-4",
-            help='Manipulator type (i.e. "ump-4", "pathfinder-mpm", "fake"). Default: "ump-4".',
+            default="ump",
+            help='Manipulator type (i.e. "ump", "pathfinder-mpm", "fake"). Default: "ump".',
         )
         _ = self._parser.add_argument(
             "-d",

ephys_link/{utils → front_end}/console.py

@@ -15,7 +15,7 @@ from rich.traceback import install
 
 @final
 class Console:
-    def __init__(self, *, enable_debug: bool) -> None:
+    def __init__(self, *, enable_debug: bool = False) -> None:
         """Initialize console properties.
 
         Args:

ephys_link/front_end/gui.py

@@ -20,7 +20,7 @@ from platformdirs import user_config_dir
 from vbl_aquarium.models.ephys_link import EphysLinkOptions
 
 from ephys_link.__about__ import __version__ as version
-from ephys_link.utils.startup import get_binding_display_to_cli_name
+from ephys_link.utils.startup import get_bindings
 
 # Define options path.
 OPTIONS_DIR = join(user_config_dir(), "VBL", "Ephys Link")
@@ -156,7 +156,7 @@ class GUI:
         platform_type_settings = ttk.LabelFrame(mainframe, text="Platform Type", padding=3)
         platform_type_settings.grid(column=0, row=1, sticky="news")
 
-        for index, (display_name, cli_name) in enumerate(get_binding_display_to_cli_name().items()):
+        for index, (display_name, cli_name) in enumerate(self._get_binding_display_to_cli_name().items()):
             ttk.Radiobutton(
                 platform_type_settings,
                 text=display_name,
@@ -202,3 +202,11 @@ class GUI:
         """
         self._submit = True
         self._root.destroy()
+
+    def _get_binding_display_to_cli_name(self) -> dict[str, str]:
+        """Get mapping of display to CLI option names of the available platform bindings.
+
+        Returns:
+            Dictionary of platform binding display name to CLI option name.
+        """
+        return {binding_type.get_display_name(): binding_type.get_cli_name() for binding_type in get_bindings()}

ephys_link/utils/constants.py

@@ -2,6 +2,9 @@
 
 from os.path import abspath, dirname, join
 
+from vbl_aquarium.models.ephys_link import SetDepthRequest, SetPositionRequest
+from vbl_aquarium.models.unity import Vector4
+
 # Ephys Link ASCII.
 ASCII = r"""
  ______       _                 _      _       _
@@ -16,8 +19,87 @@ ASCII = r"""
 
 # Absolute path to the resource folder.
 PACKAGE_DIRECTORY = dirname(dirname(abspath(__file__)))
-RESOURCES_DIRECTORY = join(PACKAGE_DIRECTORY, "resources")
 BINDINGS_DIRECTORY = join(PACKAGE_DIRECTORY, "bindings")
 
 # Ephys Link Port
 PORT = 3000
+
+# Error messages
+
+NO_SET_POSITION_WHILE_INSIDE_BRAIN_ERROR = (
+    'Cannot move manipulator while inside the brain. Set the depth ("set_depth") instead.'
+)
+
+
+def did_not_reach_target_position_error(
+    request: SetPositionRequest, axis_index: int, final_unified_position: Vector4
+) -> str:
+    """Generate an error message for when the manipulator did not reach the target position.
+    Args:
+        request: The object containing the requested position.
+        axis_index: The index of the axis that did not reach the target position.
+        final_unified_position: The final position of the manipulator.
+    Returns:
+        str: The error message.
+    """
+    return f"Manipulator {request.manipulator_id} did not reach target position on axis {list(Vector4.model_fields.keys())[axis_index]}. Requested: {request.position}, got: {final_unified_position}"
+
+
+def did_not_reach_target_depth_error(request: SetDepthRequest, final_unified_depth: float) -> str:
+    """Generate an error message for when the manipulator did not reach the target position.
+    Args:
+        request: The object containing the requested depth.
+        final_unified_depth: The final depth of the manipulator.
+    Returns:
+        str: The error message.
+    """
+    return f"Manipulator {request.manipulator_id} did not reach target depth. Requested: {request.depth}, got: {final_unified_depth}"
+
+
+EMERGENCY_STOP_MESSAGE = "Emergency Stopping All Manipulators..."
+
+SERVER_NOT_INITIALIZED_ERROR = "Server not initialized."
+PROXY_CLIENT_NOT_INITIALIZED_ERROR = "Proxy client not initialized."
+
+
+def cannot_connect_as_client_is_already_connected_error(new_client_sid: str, current_client_sid: str) -> str:
+    """Generate an error message for when the client is already connected.
+    Args:
+        new_client_sid: The SID of the new client.
+        current_client_sid: The SID of the current client.
+    Returns:
+        str: The error message.
+    """
+    return f"Cannot connect {new_client_sid} as {current_client_sid} is already connected."
+
+
+def client_disconnected_without_being_connected_error(client_sid: str) -> str:
+    """Generate an error message for when the client is disconnected without being connected.
+    Args:
+        client_sid: The SID of the client.
+    Returns:
+        str: The error message.
+    """
+    return f"Client {client_sid} disconnected without being connected."
+
+
+MALFORMED_REQUEST_ERROR = {"error": "Malformed request."}
+UNKNOWN_EVENT_ERROR = {"error": "Unknown event."}
+
+UNABLE_TO_CHECK_FOR_UPDATES_ERROR = (
+    "Unable to check for updates. Ignore updates or use the -i flag to disable checks.\n"
+)
+
+
+def ump_4_3_deprecation_error(cli_name: str):
+    return f"CLI option '{cli_name}' is deprecated and will be removed in v3.0.0. Use 'ump' instead."
+
+
+def unrecognized_platform_type_error(cli_name: str) -> str:
+    """Generate an error message for when the platform type is not recognized.
+    Args:
+        cli_name: The platform type that is not recognized.
+    Returns:
+        str: The error message.
+    """
+    return f'Platform type "{cli_name}" not recognized.'

ephys_link/utils/startup.py

@@ -6,11 +6,19 @@ from pkgutil import iter_modules
 
 from packaging.version import parse
 from requests import ConnectionError, ConnectTimeout, get
+from vbl_aquarium.models.ephys_link import EphysLinkOptions
 
 from ephys_link.__about__ import __version__
+from ephys_link.bindings.mpm_binding import MPMBinding
+from ephys_link.front_end.console import Console
 from ephys_link.utils.base_binding import BaseBinding
-from ephys_link.utils.console import Console
-from ephys_link.utils.constants import ASCII, BINDINGS_DIRECTORY
+from ephys_link.utils.constants import (
+    ASCII,
+    BINDINGS_DIRECTORY,
+    UNABLE_TO_CHECK_FOR_UPDATES_ERROR,
+    ump_4_3_deprecation_error,
+    unrecognized_platform_type_error,
+)
 
 
 def preamble() -> None:
@@ -37,9 +45,7 @@ def check_for_updates(console: Console) -> None:
             console.critical_print(f"Update available: {latest_version} (current: {__version__})")
             console.critical_print("Download at: https://github.com/VirtualBrainLab/ephys-link/releases/latest")
     except (ConnectionError, ConnectTimeout):
-        console.error_print(
-            "UPDATE", "Unable to check for updates. Ignore updates or use the the -i flag to disable checks.\n"
-        )
+        console.error_print("UPDATE", UNABLE_TO_CHECK_FOR_UPDATES_ERROR)
 
 
 def get_bindings() -> list[type[BaseBinding]]:
@@ -56,10 +62,41 @@ def get_bindings() -> list[type[BaseBinding]]:
     ]
 
 
-def get_binding_display_to_cli_name() -> dict[str, str]:
-    """Get mapping of display to CLI option names of the available platform bindings.
+def get_binding_instance(options: EphysLinkOptions, console: Console) -> BaseBinding:
+    """Get an instance of the requested binding class.
+
+    Args:
+        options: Ephys Link options.
+        console: Console instance for printing messages.
+
+    Raises:
+        ValueError: If the platform type is not recognized.
 
     Returns:
-        Dictionary of platform binding display name to CLI option name.
+        Instance of a platform binding class.
     """
-    return {binding_type.get_display_name(): binding_type.get_cli_name() for binding_type in get_bindings()}
+    selected_type = options.type
+
+    for binding_type in get_bindings():
+        binding_cli_name = binding_type.get_cli_name()
+
+        # Notify deprecation of "ump-4" and "ump-3" CLI options and fix.
+        if selected_type in ("ump-4", "ump-3"):
+            console.error_print(
+                "DEPRECATION",
+                ump_4_3_deprecation_error(selected_type),
+            )
+            selected_type = "ump"
+
+        if binding_cli_name == selected_type:
+            # Pass in HTTP port for Pathfinder MPM.
+            if binding_cli_name == "pathfinder-mpm":
+                return MPMBinding(options.mpm_port)
+
+            # Otherwise just return the binding.
+            return binding_type()
+
+    # Raise an error if the platform type is not recognized.
+    error_message = unrecognized_platform_type_error(selected_type)
+    console.critical_print(error_message)
+    raise ValueError(error_message)

{ephys_link-2.1.0b0.dist-info → ephys_link-2.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ephys-link
-Version: 2.1.0b0
+Version: 2.1.1
 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
@@ -22,16 +22,16 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
 Requires-Python: >=3.13
-Requires-Dist: aiohttp==3.11.16
+Requires-Dist: aiohttp==3.12.15
 Requires-Dist: colorama==0.4.6
 Requires-Dist: keyboard==0.13.5
-Requires-Dist: packaging==24.2
-Requires-Dist: platformdirs==4.3.7
+Requires-Dist: packaging==25.0
+Requires-Dist: platformdirs==4.4.0
 Requires-Dist: pyserial==3.5
 Requires-Dist: python-socketio[asyncio-client]==5.13.0
-Requires-Dist: requests==2.32.3
-Requires-Dist: rich==14.0.0
-Requires-Dist: sensapex==1.400.3
+Requires-Dist: requests==2.32.5
+Requires-Dist: rich==14.1.0
+Requires-Dist: sensapex==1.400.4
 Requires-Dist: vbl-aquarium==1.0.0
 Description-Content-Type: text/markdown
 
@@ -43,6 +43,7 @@ Description-Content-Type: text/markdown
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev)
 [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+[![Test](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/test.yml/badge.svg)](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/test.yml)
 
 <!-- [![Build](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/build.yml/badge.svg)](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/build.yml) -->
 

ephys_link-2.1.1.dist-info/RECORD

@@ -0,0 +1,24 @@
+ephys_link/__about__.py,sha256=zPJIgPGcoSNiD0qme18OnYJYE3A9VVytlhO-V5DaAW0,22
+ephys_link/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ephys_link/__main__.py,sha256=54zxQ-fyxC2-LGsTUdtlvib36ZZQwNyOa6IuffYLhhs,1582
+ephys_link/back_end/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ephys_link/back_end/platform_handler.py,sha256=6Lt_jaIcO9jTmWYOoWYkuhwSlCTT1Qfd53ru31X0fmc,10130
+ephys_link/back_end/server.py,sha256=uZOK9UQq4gp7yx6_4dZrfRTjsio2WXT8TwjO4E5kECA,10712
+ephys_link/bindings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ephys_link/bindings/fake_binding.py,sha256=PI7zYv-SjWsGFEs_FVu5Z5l9gykIqG3C7pQISdbwdoY,2357
+ephys_link/bindings/mpm_binding.py,sha256=vn7IKqdiZ6_MX91zomqDXX08ONHwVVgWncRuJTxJpOM,10872
+ephys_link/bindings/ump_binding.py,sha256=wbJe6Ro4E-TPejBBDkNsKUluF2Gr0rZBuyp3LJ2TipM,7865
+ephys_link/front_end/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ephys_link/front_end/cli.py,sha256=jWUEWhIHvWF8ZN6xPIbfoQblDWxMLsjwhtFB_jfOO_s,3093
+ephys_link/front_end/console.py,sha256=zq67dn7T4xKMg3jjbNra_1s0N9ItvsTRXVIhClWbjP8,3912
+ephys_link/front_end/gui.py,sha256=x5mNekxe1yhPKcCFNnDL3AarhNmUoBJooykFS_6pWt4,7227
+ephys_link/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ephys_link/utils/base_binding.py,sha256=rq0FtvkjAN287nX8rZwR-j6YPzV3Pkp8PqJfZlhIzqo,5413
+ephys_link/utils/constants.py,sha256=afD-FFrfCD3cZc500jzWw4I-dGibLPluxteX8BxlgK4,3883
+ephys_link/utils/converters.py,sha256=ZdVmIX-LHCwM__F0SpjN_mfNGGetr1U97xvHd0hf8T0,2038
+ephys_link/utils/startup.py,sha256=Yx9LSedaLmTpzkb1E0NOqxaDMhRXLShkI2PJj80_95U,3620
+ephys_link-2.1.1.dist-info/METADATA,sha256=soPPtLMp-oQw7xCKX1hwMo7Slu5qmBxv4Ryk7gfcs7Y,4775
+ephys_link-2.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ephys_link-2.1.1.dist-info/entry_points.txt,sha256=o8wV3AdnJ9o47vg9ymKxPNVq9pMdPq8UZHE_iyAJx-k,124
+ephys_link-2.1.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ephys_link-2.1.1.dist-info/RECORD,,

ephys_link-2.1.0b0.dist-info/RECORD

@@ -1,25 +0,0 @@
-ephys_link/__about__.py,sha256=72sTjjXH8lKUBOrH9ADJVFplt-JL7YxNRjHxZ7aL25E,24
-ephys_link/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ephys_link/__main__.py,sha256=sbFdC6KJjTfXDgRraU_fmGRPcF4I1Ur9PRDiD86dkRI,1449
-ephys_link/back_end/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ephys_link/back_end/platform_handler.py,sha256=gdiO6d0L-DWWLEJOL6eP6685tOC6otffmhfIBtPjhq0,12604
-ephys_link/back_end/server.py,sha256=mb3K3pXSO-gHaSj1CGJ0v3CSOW5YCi-p0EOKoySRzKQ,10322
-ephys_link/bindings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ephys_link/bindings/fake_binding.py,sha256=PI7zYv-SjWsGFEs_FVu5Z5l9gykIqG3C7pQISdbwdoY,2357
-ephys_link/bindings/mpm_binding.py,sha256=vn7IKqdiZ6_MX91zomqDXX08ONHwVVgWncRuJTxJpOM,10872
-ephys_link/bindings/ump_binding.py,sha256=-RwzUggGYsznhV6yiXb96y6WD-e3E7-tcDk6NfesiWU,8080
-ephys_link/front_end/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ephys_link/front_end/cli.py,sha256=isIJs_sZbz7VbNvLgi-HyDlE-TyKD12auDhMTxAkWQU,3099
-ephys_link/front_end/gui.py,sha256=MDcrTS_Xz9bopAgamh4HknqRC10W8E6eOS3Kss_2ZKQ,6864
-ephys_link/resources/libum.dll,sha256=YaD4dwiSNohx-XxHjx2eQWPOBEVvUIXARvx37e_yqNw,316316
-ephys_link/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ephys_link/utils/base_binding.py,sha256=rq0FtvkjAN287nX8rZwR-j6YPzV3Pkp8PqJfZlhIzqo,5413
-ephys_link/utils/console.py,sha256=52SYvXv_7Fx8QDL3RMFQoggQ1n5W93Yu5aU7uuJQgfg,3904
-ephys_link/utils/constants.py,sha256=1aML7zBNTM5onVSf6NDrYIR33VJy-dIHd1lFORVBGbM,725
-ephys_link/utils/converters.py,sha256=ZdVmIX-LHCwM__F0SpjN_mfNGGetr1U97xvHd0hf8T0,2038
-ephys_link/utils/startup.py,sha256=jZVed78tuWjUuZqWVgii_zumDr87T-ikEtOFa6KTE_E,2500
-ephys_link-2.1.0b0.dist-info/METADATA,sha256=i3-gX7xuUweGrkbvtoQQ01nNf2jsrd-hYtvLL_zF4tE,4609
-ephys_link-2.1.0b0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ephys_link-2.1.0b0.dist-info/entry_points.txt,sha256=o8wV3AdnJ9o47vg9ymKxPNVq9pMdPq8UZHE_iyAJx-k,124
-ephys_link-2.1.0b0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ephys_link-2.1.0b0.dist-info/RECORD,,