ephys-link 1.3.0b2__tar.gz → 1.3.3__tar.gz

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ephys-link
-Version: 1.3.0b2
+Version: 1.3.3
 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
@@ -25,15 +25,14 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
-Requires-Python: <3.13,>=3.8
-Requires-Dist: aiohttp==3.9.4
-Requires-Dist: platformdirs==4.2.0
+Requires-Python: <3.13,>=3.10
+Requires-Dist: aiohttp==3.9.5
+Requires-Dist: platformdirs==4.2.2
 Requires-Dist: pyserial==3.5
-Requires-Dist: python-socketio==5.11.2
+Requires-Dist: python-socketio[asyncio-client]==5.11.2
 Requires-Dist: pythonnet==3.0.3
-Requires-Dist: requests==2.31.0
 Requires-Dist: sensapex==1.400.0
-Requires-Dist: vbl-aquarium==0.0.12
+Requires-Dist: vbl-aquarium==0.0.15
 Description-Content-Type: text/markdown
 
 # Electrophysiology Manipulator Link
@@ -124,16 +123,14 @@ Import the modules you need and launch the server.
 from ephys_link.server import Server
 
 server = Server()
-server.launch("sensapex", 8081)
+server.launch("sensapex", args.proxy_address, 8081)
 ```
 
 ## Install for Development
 
 1. Clone the repository.
 2. Install [Hatch](https://hatch.pypa.io/latest/install/)
-3. Install the latest Microsoft Visual C++ (MSVC v143+ x86/64) and the Windows SDK (10/11)
-   via [Visual Studio Build Tools Installer](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
-4. In a terminal, navigate to the repository's root directory and run
+3. In a terminal, navigate to the repository's root directory and run
 
    ```bash
    hatch shell
@@ -141,6 +138,10 @@ server.launch("sensapex", 8081)
 
 This will create a virtual environment, install Python 12 (if not found), and install the package in editable mode.
 
+If you encounter any dependency issues (particularly with `aiohttp`), try installing the latest Microsoft Visual C++
+(MSVC v143+ x86/64) and the Windows SDK (10/11)
+via [Visual Studio Build Tools Installer](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
+
 # Documentation and More Information
 
 Complete documentation including API usage and development installation can be

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/README.md

@@ -86,16 +86,14 @@ Import the modules you need and launch the server.
 from ephys_link.server import Server
 
 server = Server()
-server.launch("sensapex", 8081)
+server.launch("sensapex", args.proxy_address, 8081)
 ```
 
 ## Install for Development
 
 1. Clone the repository.
 2. Install [Hatch](https://hatch.pypa.io/latest/install/)
-3. Install the latest Microsoft Visual C++ (MSVC v143+ x86/64) and the Windows SDK (10/11)
-   via [Visual Studio Build Tools Installer](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
-4. In a terminal, navigate to the repository's root directory and run
+3. In a terminal, navigate to the repository's root directory and run
 
    ```bash
    hatch shell
@@ -103,6 +101,10 @@ server.launch("sensapex", 8081)
 
 This will create a virtual environment, install Python 12 (if not found), and install the package in editable mode.
 
+If you encounter any dependency issues (particularly with `aiohttp`), try installing the latest Microsoft Visual C++
+(MSVC v143+ x86/64) and the Windows SDK (10/11)
+via [Visual Studio Build Tools Installer](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
+
 # Documentation and More Information
 
 Complete documentation including API usage and development installation can be

ephys_link-1.3.3/ephys_link.spec

@@ -0,0 +1,70 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+from ephys_link.__about__ import __version__ as version
+
+from argparse import ArgumentParser
+
+parser = ArgumentParser()
+parser.add_argument("-d", "--dir", action="store_true", help="Outputs a directory")
+options = parser.parse_args()
+
+FILE_NAME = f"EphysLink-v{version}"
+
+a = Analysis(
+    ['src\\ephys_link\\__main__.py'],
+    pathex=[],
+    binaries=[('src\\ephys_link\\resources', 'ephys_link\\resources')],
+    datas=[],
+    hiddenimports=['engineio.async_drivers.aiohttp'],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=[],
+    noarchive=False,
+    optimize=1,
+)
+pyz = PYZ(a.pure)
+
+if options.dir:
+    exe = EXE(
+        pyz,
+        a.scripts,
+        [],
+        exlude_binaries=True,
+        name=FILE_NAME,
+        debug=False,
+        bootloader_ignore_signals=False,
+        strip=False,
+        upx=True,
+        upx_exclude=[],
+        console=True,
+        disable_windowed_traceback=False,
+        argv_emulation=False,
+        target_arch=None,
+        codesign_identity=None,
+        entitlements_file=None,
+        icon='assets\\icon.ico',
+    )
+    coll = COLLECT(exe, a.binaries, a.datas, strip=False, upx=True, upx_exclude=[], name=FILE_NAME)
+else:
+    exe = EXE(
+        pyz,
+        a.scripts,
+        a.binaries,
+        a.datas,
+        [],
+        name=FILE_NAME,
+        debug=False,
+        bootloader_ignore_signals=False,
+        strip=False,
+        upx=True,
+        upx_exclude=[],
+        runtime_tmpdir=None,
+        console=True,
+        disable_windowed_traceback=False,
+        argv_emulation=False,
+        target_arch=None,
+        codesign_identity=None,
+        entitlements_file=None,
+        icon='assets\\icon.ico',
+    )

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/pyproject.toml

@@ -7,7 +7,7 @@ name = "ephys-link"
 dynamic = ["version"]
 description = "A Python Socket.IO server that allows any Socket.IO-compliant application to communicate with manipulators used in electrophysiology experiments."
 readme = "README.md"
-requires-python = ">=3.8, <3.13"
+requires-python = ">=3.10, <3.13"
 license = "GPL-3.0-only"
 keywords = ["socket-io", "manipulator", "electrophysiology", "ephys", "sensapex", "neuroscience", "neurotech", "virtualbrainlab", "new-scale"]
 authors = [{ name = "Kenneth Yang", email = "kjy5@uw.edu" }]
@@ -30,14 +30,13 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Medical Science Apps.",
 ]
 dependencies = [
-    "aiohttp==3.9.4",
-    "platformdirs==4.2.0",
+    "aiohttp==3.9.5",
+    "platformdirs==4.2.2",
     "pyserial==3.5",
-    "python-socketio==5.11.2",
+    "python-socketio[asyncio_client]==5.11.2",
     "pythonnet==3.0.3",
-    "requests==2.31.0",
     "sensapex==1.400.0",
-    "vbl-aquarium==0.0.12"
+    "vbl-aquarium==0.0.15"
 ]
 
 [project.urls]
@@ -60,8 +59,8 @@ exclude = ["/.github", "/.idea"]
 python = "3.12"
 dependencies = [
     "coverage[toml]>=6.5",
+    "mypy>=1.0.0",
     "pytest",
-    "python-socketio[client]==5.11.2",
 ]
 [tool.hatch.envs.default.scripts]
 test = "pytest {args:tests}"
@@ -74,24 +73,19 @@ cov = [
     "test-cov",
     "cov-report",
 ]
+types = "mypy --strict --install-types --non-interactive {args:src/ephys_link tests}"
 
 #[[tool.hatch.envs.all.matrix]]
 #python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
-[tool.hatch.envs.types]
-dependencies = [
-    "mypy>=1.0.0",
-]
-[tool.hatch.envs.types.scripts]
-check = "mypy --install-types --non-interactive {args:src/ephys_link tests}"
-
 [tool.hatch.envs.exe]
 python = "3.12"
 dependencies = [
-    "pyinstaller==6.3.0",
+    "pyinstaller",
 ]
 [tool.hatch.envs.exe.scripts]
-build = "pyinstaller.exe ephys_link.spec -y"
+build = "pyinstaller.exe ephys_link.spec -y -- -d && pyinstaller.exe ephys_link.spec -y"
+build_onefile = "pyinstaller.exe ephys_link.spec -y"
 build_clean = "pyinstaller.exe ephys_link.spec -y --clean"
 
 [tool.coverage.run]

ephys_link-1.3.3/scripts/proxy_dev.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from asyncio import run
+
+from socketio import AsyncClient
+
+pinpoint_id = "4158ebf3"
+is_requester = True
+
+sio = AsyncClient()
+
+
+async def main():
+    await sio.connect("http://localhost:3000")
+    # await sio.emit("get_manipulators", lambda m: print(m))
+    await sio.wait()
+
+
+@sio.event
+async def get_pinpoint_id() -> tuple[str, bool]:
+    return pinpoint_id, is_requester
+
+
+run(main())

ephys_link-1.3.3/src/ephys_link/__about__.py

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

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/__main__.py

@@ -1,4 +1,5 @@
 from argparse import ArgumentParser
+from asyncio import run
 from sys import argv
 
 from ephys_link import common as com
@@ -26,13 +27,22 @@ parser.add_argument(
     help='Manipulator type (i.e. "sensapex", "new_scale", or "new_scale_pathfinder"). Default: "sensapex".',
 )
 parser.add_argument("-d", "--debug", dest="debug", action="store_true", help="Enable debug mode.")
+parser.add_argument("-x", "--use-proxy", dest="use_proxy", action="store_true", help="Enable proxy mode.")
+parser.add_argument(
+    "-a",
+    "--proxy-address",
+    type=str,
+    default="proxy2.virtualbrainlab.org",
+    dest="proxy_address",
+    help="Proxy IP address.",
+)
 parser.add_argument(
     "-p",
     "--port",
     type=int,
     default=8081,
     dest="port",
-    help="Port to serve on. Default: 8081 (avoids conflict with other HTTP servers).",
+    help="TCP/IP port to use. Default: 8081 (avoids conflict with other HTTP servers).",
 )
 parser.add_argument(
     "--pathfinder_port",
@@ -83,7 +93,12 @@ def main() -> None:
         e_stop.watch()
 
     # Launch with parsed arguments on main thread.
-    server.launch(args.type, args.port, args.pathfinder_port, args.ignore_updates)
+    if args.use_proxy:
+        run(
+            server.launch_for_proxy(args.proxy_address, args.port, args.type, args.pathfinder_port, args.ignore_updates)
+        )
+    else:
+        server.launch(args.type, args.port, args.pathfinder_port, args.ignore_updates)
 
 
 if __name__ == "__main__":

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/gui.py

@@ -1,3 +1,4 @@
+from asyncio import run
 from json import dumps, load
 from os import makedirs
 from os.path import exists
@@ -24,15 +25,27 @@ class GUI:
         self._root = Tk()
 
         # Create default settings dictionary
-        settings = {"type": "sensapex", "debug": False, "port": 8081, "pathfinder_port": 8080, "serial": "no-e-stop"}
+        settings = {
+            "ignore_updates": False,
+            "type": "sensapex",
+            "debug": False,
+            "proxy": False,
+            "proxy_address": "proxy2.virtualbrainlab.org",
+            "port": 8081,
+            "pathfinder_port": 8080,
+            "serial": "no-e-stop",
+        }
 
         # Read settings.
         if exists(f"{SETTINGS_DIR}\\{SETTINGS_FILENAME}"):
             with open(f"{SETTINGS_DIR}\\{SETTINGS_FILENAME}") as settings_file:
                 settings = load(settings_file)
 
+        self._ignore_updates = BooleanVar(value=settings["ignore_updates"])
         self._type = StringVar(value=settings["type"])
         self._debug = BooleanVar(value=settings["debug"])
+        self._proxy = BooleanVar(value=settings["proxy"])
+        self._proxy_address = StringVar(value=settings["proxy_address"])
         self._port = IntVar(value=settings["port"])
         self._pathfinder_port = IntVar(value=settings["pathfinder_port"])
         self._serial = StringVar(value=settings["serial"])
@@ -61,15 +74,41 @@ class GUI:
         server_serving_settings = ttk.LabelFrame(mainframe, text="Serving Settings", padding=3)
         server_serving_settings.grid(column=0, row=0, sticky="news")
 
-        # IP.
-        ttk.Label(server_serving_settings, text="IP:", anchor=E, justify=RIGHT).grid(column=0, row=0, sticky="we")
+        # Local IP.
+        ttk.Label(server_serving_settings, text="Local IP:", anchor=E, justify=RIGHT).grid(column=0, row=0, sticky="we")
         ttk.Label(server_serving_settings, text=gethostbyname(gethostname())).grid(column=1, row=0, sticky="we")
 
+        # Proxy.
+        ttk.Label(server_serving_settings, text="Use Proxy:", anchor=E, justify=RIGHT).grid(
+            column=0, row=1, sticky="we"
+        )
+        ttk.Checkbutton(
+            server_serving_settings,
+            variable=self._proxy,
+        ).grid(column=1, row=1, sticky="we")
+
+        # Proxy address.
+        ttk.Label(server_serving_settings, text="Proxy Address:", anchor=E, justify=RIGHT).grid(
+            column=0, row=2, sticky="we"
+        )
+        ttk.Entry(server_serving_settings, textvariable=self._proxy_address, justify=CENTER).grid(
+            column=1, row=2, sticky="we"
+        )
+
         # Port.
-        ttk.Label(server_serving_settings, text="Port:", anchor=E, justify=RIGHT).grid(column=0, row=1, sticky="we")
+        ttk.Label(server_serving_settings, text="Port:", anchor=E, justify=RIGHT).grid(column=0, row=3, sticky="we")
         ttk.Entry(server_serving_settings, textvariable=self._port, width=5, justify=CENTER).grid(
-            column=1, row=1, sticky="we"
+            column=1, row=3, sticky="we"
+        )
+
+        # Ignore updates.
+        ttk.Label(server_serving_settings, text="Ignore Updates:", anchor=E, justify=RIGHT).grid(
+            column=0, row=4, sticky="we"
         )
+        ttk.Checkbutton(
+            server_serving_settings,
+            variable=self._ignore_updates,
+        ).grid(column=1, row=4, sticky="we")
 
         # ---
 
@@ -141,8 +180,11 @@ class GUI:
 
         # Save settings.
         settings = {
+            "ignore_updates": self._ignore_updates.get(),
             "type": self._type.get(),
             "debug": self._debug.get(),
+            "proxy": self._proxy.get(),
+            "proxy_address": self._proxy_address.get(),
             "port": self._port.get(),
             "pathfinder_port": self._pathfinder_port.get(),
             "serial": self._serial.get(),
@@ -160,4 +202,16 @@ class GUI:
             e_stop = EmergencyStop(server, self._serial.get())
             e_stop.watch()
 
-        server.launch(self._type.get(), self._port.get(), self._pathfinder_port.get())
+        # Launch with parsed arguments on main thread.
+        if self._proxy.get():
+            run(
+                server.launch_for_proxy(
+                    self._proxy_address.get(),
+                    self._port.get(),
+                    self._type.get(),
+                    self._pathfinder_port.get(),
+                    self._ignore_updates.get(),
+                )
+            )
+        else:
+            server.launch(self._type.get(), self._port.get(), self._pathfinder_port.get(), self._ignore_updates.get())

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/platform_handler.py

@@ -34,7 +34,7 @@ from vbl_aquarium.models.unity import Vector4
 from ephys_link import common as com
 
 if TYPE_CHECKING:
-    import socketio
+    from socketio import AsyncClient, AsyncServer
 
 
 class PlatformHandler(ABC):
@@ -309,7 +309,7 @@ class PlatformHandler(ABC):
             print(f"{e}\n")
             return BooleanStateResponse(error="Error setting inside brain")
 
-    async def calibrate(self, manipulator_id: str, sio: socketio.AsyncServer) -> str:
+    async def calibrate(self, manipulator_id: str, sio: AsyncClient | AsyncServer) -> str:
         """Calibrate manipulator
 
         :param manipulator_id: ID of manipulator to calibrate
@@ -423,7 +423,7 @@ class PlatformHandler(ABC):
         raise NotImplementedError
 
     @abstractmethod
-    async def _calibrate(self, manipulator_id: str, sio: socketio.AsyncServer) -> str:
+    async def _calibrate(self, manipulator_id: str, sio: AsyncClient | AsyncServer) -> str:
         """Calibrate manipulator
 
         :param manipulator_id: ID of manipulator to calibrate

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/platform_manipulator.py

@@ -3,6 +3,7 @@
 Most functionality will be implemented on the platform handler side. This is mostly
 for enforcing implementation of the stop method and hold common properties.
 """
+
 from abc import ABC, abstractmethod
 
 # Constants

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/platforms/sensapex_handler.py

@@ -95,7 +95,7 @@ class SensapexHandler(PlatformHandler):
                 cur_pos = self.manipulators[manipulator_id].get_pos()["position"]
 
                 # Check difference between current and target position
-                for prev, cur in zip([10000, 10000, 10000, 10000], cur_pos):
+                for prev, cur in zip([10000, 10000, 10000, 10000], cur_pos, strict=False):
                     if abs(prev - cur) > 1:
                         still_working = True
                         break

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/platforms/sensapex_manipulator.py

@@ -59,7 +59,13 @@ class SensapexManipulator(PlatformManipulator):
             # com.dprint(f"[SUCCESS]\t Got position of manipulator {self._id}\n")
             return PositionalResponse(
                 position=Vector4(
-                    **dict(zip(Vector4.model_fields.keys(), [axis / MM_TO_UM for axis in self._device.get_pos(1)]))
+                    **dict(
+                        zip(
+                            Vector4.model_fields.keys(),
+                            [axis / MM_TO_UM for axis in self._device.get_pos(1)],
+                            strict=False,
+                        )
+                    )
                 )
             )
         except Exception as e:

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/platforms/ump3_handler.py

@@ -28,30 +28,30 @@ class UMP3Handler(SensapexHandler):
 
         self.manipulators[manipulator_id] = UMP3Manipulator(self.ump.get_device(int(manipulator_id)))
 
-    def _platform_space_to_unified_space(self, platform_position: list[float]) -> list[float]:
+    def _platform_space_to_unified_space(self, platform_position: Vector4) -> Vector4:
         # unified   <-  platform
         # +x        <-  +y
         # +y        <-  -x
         # +z        <-  -z
         # +d        <-  +d/x
 
-        return [
-            platform_position[1],
-            self.dimensions[0] - platform_position[0],
-            self.dimensions[2] - platform_position[2],
-            platform_position[3],
-        ]
+        return Vector4(
+            x=platform_position.y,
+            y=self.dimensions.x - platform_position.x,
+            z=self.dimensions.z - platform_position.z,
+            w=platform_position.w,
+        )
 
-    def _unified_space_to_platform_space(self, unified_position: list[float]) -> list[float]:
+    def _unified_space_to_platform_space(self, unified_position: Vector4) -> Vector4:
         # platform  <-  unified
         # +x        <-  -y
         # +y        <-  +x
         # +z        <-  -z
         # +d/x      <-  +d
 
-        return [
-            self.dimensions[1] - unified_position[1],
-            unified_position[0],
-            self.dimensions[2] - unified_position[2],
-            unified_position[3],
-        ]
+        return Vector4(
+            x=self.dimensions.y - unified_position.y,
+            y=unified_position.x,
+            z=self.dimensions.z - unified_position.z,
+            w=unified_position.w,
+        )

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/platforms/ump3_manipulator.py

@@ -55,7 +55,9 @@ class UMP3Manipulator(SensapexManipulator):
             position.append(position[0])
 
             # com.dprint(f"[SUCCESS]\t Got position of manipulator {self._id}\n")
-            return PositionalResponse(position=Vector4(**dict(zip(Vector4.model_fields.keys(), position))))
+            return PositionalResponse(
+                position=Vector4(**dict(zip(Vector4.model_fields.keys(), position, strict=False)))
+            )
         except Exception as e:
             print(f"[ERROR]\t\t Getting position of manipulator {self._id}")
             print(f"{e}\n")

{ephys_link-1.3.0b2 → ephys_link-1.3.3}/src/ephys_link/server.py

@@ -11,18 +11,20 @@ every event, the server does the following:
 
 from __future__ import annotations
 
+from asyncio import get_event_loop
 from json import loads
 from signal import SIGINT, SIGTERM, signal
-from sys import exit
 from typing import TYPE_CHECKING, Any
+from uuid import uuid4
 
-from aiohttp import web
+from aiohttp import ClientConnectionError, ClientSession
+from aiohttp.web import Application, run_app
 from aiohttp.web_runner import GracefulExit
-from packaging import version
+from packaging.version import parse
 from pydantic import ValidationError
-from requests import get
-from requests.exceptions import ConnectionError
-from socketio import AsyncServer
+
+# from socketio import AsyncServer
+from socketio import AsyncClient, AsyncServer
 from vbl_aquarium.models.ephys_link import (
     BooleanStateResponse,
     CanWriteRequest,
@@ -32,6 +34,7 @@ from vbl_aquarium.models.ephys_link import (
     InsideBrainRequest,
     PositionalResponse,
 )
+from vbl_aquarium.models.proxy import PinpointIdResponse
 
 from ephys_link.__about__ import __version__
 from ephys_link.common import (
@@ -48,46 +51,31 @@ if TYPE_CHECKING:
 
 
 class Server:
-    def __init__(self):
-        # Server and Socketio
-        self.sio = AsyncServer()
-        self.app = web.Application()
+    def __init__(self) -> None:
+        """Declare and setup server object. Launching is done is a separate function."""
+
+        # Server object.
+        self.sio: AsyncClient | AsyncServer | None = None
+
+        # Web application object.
+        self.app: Application | None = None
 
+        # Proxy server ID.
+        self.pinpoint_id: str = ""
+
+        # Manipulator platform handler.
+        self.platform: PlatformHandler | None = None
         # Is there a client connected?
         self.is_connected = False
 
         # Is the server running?
         self.is_running = False
 
-        # Current platform handler (defaults to Sensapex).
-        self.platform: PlatformHandler = SensapexHandler()
-
         # Register server exit handlers.
         signal(SIGTERM, self.close_server)
         signal(SIGINT, self.close_server)
 
-        # Attach server to the web app.
-        self.sio.attach(self.app)
-
-        # Declare events and assign handlers.
-        self.sio.on("connect", self.connect)
-        self.sio.on("disconnect", self.disconnect)
-        self.sio.on("get_version", self.get_version)
-        self.sio.on("get_manipulators", self.get_manipulators)
-        self.sio.on("register_manipulator", self.register_manipulator)
-        self.sio.on("unregister_manipulator", self.unregister_manipulator)
-        self.sio.on("get_pos", self.get_pos)
-        self.sio.on("get_angles", self.get_angles)
-        self.sio.on("get_shank_count", self.get_shank_count)
-        self.sio.on("goto_pos", self.goto_pos)
-        self.sio.on("drive_to_depth", self.drive_to_depth)
-        self.sio.on("set_inside_brain", self.set_inside_brain)
-        self.sio.on("calibrate", self.calibrate)
-        self.sio.on("bypass_calibration", self.bypass_calibration)
-        self.sio.on("set_can_write", self.set_can_write)
-        self.sio.on("stop", self.stop)
-        self.sio.on("*", self.catch_all)
-
+    # Server events.
     async def connect(self, sid, _, __) -> bool:
         """Acknowledge connection to the server.
 
@@ -122,7 +110,15 @@ class Server:
         self.platform.reset()
         self.is_connected = False
 
-    # Events
+    # Ephys Link Events
+
+    async def get_pinpoint_id(self) -> str:
+        """Get the pinpoint ID.
+
+        :return: Pinpoint ID and whether the client is a requester.
+        :rtype: tuple[str, bool]
+        """
+        return PinpointIdResponse(pinpoint_id=self.pinpoint_id, is_requester=False).to_string()
 
     @staticmethod
     async def get_version(_) -> str:
@@ -133,6 +129,8 @@ class Server:
         :return: Version number as defined in :mod:`ephys_link.__about__`.
         :rtype: str
         """
+        dprint("[EVENT]\t\t Get version")
+
         return __version__
 
     async def get_manipulators(self, _) -> str:
@@ -361,38 +359,21 @@ class Server:
         print(f"[UNKNOWN EVENT]:\t {data}")
         return "UNKNOWN_EVENT"
 
-    def launch(
-        self,
-        platform_type: str,
-        server_port: int,
-        pathfinder_port: int | None = None,
-        ignore_updates: bool = False,  # noqa: FBT002
-    ) -> None:
-        """Launch the server.
-
-        :param platform_type: Parsed argument for platform type.
-        :type platform_type: str
-        :param server_port: HTTP port to serve the server.
-        :type server_port: int
-        :param pathfinder_port: Port New Scale Pathfinder's server is on.
-        :type pathfinder_port: int
-        :param ignore_updates: Flag to ignore checking for updates.
-        :type ignore_updates: bool
-        :return: None
-        """
-
+    # Server functions
+    async def launch_setup(self, platform_type: str, pathfinder_port: int, ignore_updates) -> None:
         # Import correct manipulator handler
-        if platform_type == "sensapex":
-            # Already assigned (was the default)
-            pass
-        elif platform_type == "ump3":
-            self.platform = UMP3Handler()
-        elif platform_type == "new_scale":
-            self.platform = NewScaleHandler()
-        elif platform_type == "new_scale_pathfinder":
-            self.platform = NewScalePathfinderHandler(pathfinder_port)
-        else:
-            exit(f"[ERROR]\t\t Invalid manipulator type: {platform_type}")
+        match platform_type:
+            case "sensapex":
+                self.platform = SensapexHandler()
+            case "ump3":
+                self.platform = UMP3Handler()
+            case "new_scale":
+                self.platform = NewScaleHandler()
+            case "new_scale_pathfinder":
+                self.platform = NewScalePathfinderHandler(pathfinder_port)
+            case _:
+                error = f"[ERROR]\t\t Invalid manipulator type: {platform_type}"
+                raise ValueError(error)
 
         # Preamble.
         print(ASCII)
@@ -401,19 +382,24 @@ class Server:
         # Check for newer version.
         if not ignore_updates:
             try:
-                version_request = get("https://api.github.com/repos/VirtualBrainLab/ephys-link/tags", timeout=10)
-                latest_version = version_request.json()[0]["name"]
-                if version.parse(latest_version) > version.parse(__version__):
-                    print(f"New version available: {latest_version}")
-                    print("Download at: https://github.com/VirtualBrainLab/ephys-link/releases/latest")
-            except ConnectionError:
+                async with (
+                    ClientSession() as session,
+                    session.get("https://api.github.com/repos/VirtualBrainLab/ephys-link/tags") as response,
+                ):
+                    latest_version = (await response.json())[0]["name"]
+                    if parse(latest_version) > parse(__version__):
+                        print(f"New version available: {latest_version}")
+                        print("Download at: https://github.com/VirtualBrainLab/ephys-link/releases/latest")
+
+                await session.close()
+            except ClientConnectionError:
                 pass
 
         # Explain window.
         print()
         print("This is the Ephys Link server window.")
         print("You may safely leave it running in the background.")
-        print("To stop the it, close this window or press CTRL + Pause/Break.")
+        print("To stop it, close this window or press CTRL + Pause/Break.")
         print()
 
         # List available manipulators
@@ -421,9 +407,95 @@ class Server:
         print(self.platform.get_manipulators().manipulators)
         print()
 
+    async def launch_for_proxy(
+        self, proxy_address: str, port: int, platform_type: str, pathfinder_port: int | None, ignore_updates: bool
+    ) -> None:
+        """Launch the server in proxy mode.
+
+        :param proxy_address: Proxy IP address.
+        :type proxy_address: str
+        :param port: Port to serve the server.
+        :type port: int
+        :param platform_type: Parsed argument for platform type.
+        :type platform_type: str
+        :param pathfinder_port: Port New Scale Pathfinder's server is on.
+        :type pathfinder_port: int
+        :param ignore_updates: Flag to ignore checking for updates.
+        :type ignore_updates: bool
+        :return: None
+        """
+
+        # Launch setup
+        await self.launch_setup(platform_type, pathfinder_port, ignore_updates)
+
+        # Create AsyncClient.
+        self.sio = AsyncClient()
+        self.pinpoint_id = str(uuid4())[:8]
+
+        # Bind events.
+        self.bind_events()
+
+        # Connect and mark that server is running.
+        await self.sio.connect(f"http://{proxy_address}:{port}")
+        self.is_running = True
+        print(f"Pinpoint ID: {self.pinpoint_id}")
+        await self.sio.wait()
+
+    def launch(
+        self,
+        platform_type: str,
+        port: int,
+        pathfinder_port: int | None,
+        ignore_updates: bool,
+    ) -> None:
+        """Launch the server.
+
+        :param platform_type: Parsed argument for platform type.
+        :type platform_type: str
+        :param port: HTTP port to serve the server.
+        :type port: int
+        :param pathfinder_port: Port New Scale Pathfinder's server is on.
+        :type pathfinder_port: int
+        :param ignore_updates: Flag to ignore checking for updates.
+        :type ignore_updates: bool
+        :return: None
+        """
+
+        # Launch setup (synchronously)
+        get_event_loop().run_until_complete(self.launch_setup(platform_type, pathfinder_port, ignore_updates))
+
+        # Create AsyncServer
+        self.sio = AsyncServer()
+        self.app = Application()
+        self.sio.attach(self.app)
+
+        # Bind events
+        self.sio.on("connect", self.connect)
+        self.sio.on("disconnect", self.disconnect)
+        self.bind_events()
+
         # Mark that server is running
         self.is_running = True
-        web.run_app(self.app, port=server_port)
+        run_app(self.app, port=port)
+
+    def bind_events(self) -> None:
+        """Bind Ephys Link events to the server."""
+        self.sio.on("get_pinpoint_id", self.get_pinpoint_id)
+        self.sio.on("get_version", self.get_version)
+        self.sio.on("get_manipulators", self.get_manipulators)
+        self.sio.on("register_manipulator", self.register_manipulator)
+        self.sio.on("unregister_manipulator", self.unregister_manipulator)
+        self.sio.on("get_pos", self.get_pos)
+        self.sio.on("get_angles", self.get_angles)
+        self.sio.on("get_shank_count", self.get_shank_count)
+        self.sio.on("goto_pos", self.goto_pos)
+        self.sio.on("drive_to_depth", self.drive_to_depth)
+        self.sio.on("set_inside_brain", self.set_inside_brain)
+        self.sio.on("calibrate", self.calibrate)
+        self.sio.on("bypass_calibration", self.bypass_calibration)
+        self.sio.on("set_can_write", self.set_can_write)
+        self.sio.on("stop", self.stop)
+        self.sio.on("*", self.catch_all)
 
     def close_server(self, _, __) -> None:
         """Close the server."""

ephys_link-1.3.0b2/ephys_link.spec

@@ -1,39 +0,0 @@
-# -*- mode: python ; coding: utf-8 -*-
-
-from ephys_link.__about__ import __version__ as version
-
-a = Analysis(
-    ['src\\ephys_link\\__main__.py'],
-    pathex=[],
-    binaries=[('src\\ephys_link\\resources', 'ephys_link\\resources')],
-    datas=[],
-    hiddenimports=['engineio.async_drivers.aiohttp'],
-    hookspath=[],
-    hooksconfig={},
-    runtime_hooks=[],
-    excludes=[],
-    noarchive=False,
-)
-pyz = PYZ(a.pure)
-
-exe = EXE(
-    pyz,
-    a.scripts,
-    a.binaries,
-    a.datas,
-    [],
-    name=f"EphysLink-v{version}",
-    debug=False,
-    bootloader_ignore_signals=False,
-    strip=False,
-    upx=True,
-    upx_exclude=[],
-    runtime_tmpdir=None,
-    console=True,
-    disable_windowed_traceback=False,
-    argv_emulation=False,
-    target_arch=None,
-    codesign_identity=None,
-    entitlements_file=None,
-    icon='assets\\icon.ico',
-)

ephys_link-1.3.0b2/src/ephys_link/__about__.py

@@ -1 +0,0 @@
-__version__ = "1.3.0b2"