ephys-link 1.3.3__py3-none-any.whl → 2.0.0__py3-none-any.whl

ephys_link/common.py

@@ -1,49 +0,0 @@
-"""Commonly used functions and dictionaries
-
-Contains globally used helper functions and typed dictionaries (to be used as
-callback parameters)
-"""
-
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from vbl_aquarium.models.unity import Vector4
-
-# Debugging flag
-DEBUG = False
-
-# Ephys Link ASCII
-ASCII = r"""
-  ______       _                 _      _       _
- |  ____|     | |               | |    (_)     | |
- | |__   _ __ | |__  _   _ ___  | |     _ _ __ | | __
- |  __| | '_ \| '_ \| | | / __| | |    | | '_ \| |/ /
- | |____| |_) | | | | |_| \__ \ | |____| | | | |   <
- |______| .__/|_| |_|\__, |___/ |______|_|_| |_|_|\_\
-        | |           __/ |
-        |_|          |___/
-"""
-
-
-def dprint(message: str) -> None:
-    """Print message if debug is enabled.
-
-    :param message: Message to print.
-    :type message: str
-    :return: None
-    """
-    if DEBUG:
-        print(message)
-
-
-def vector4_to_array(vector4: Vector4) -> list[float]:
-    """Convert a Vector4 to a list of floats.
-
-    :param vector4: Vector4 to convert.
-    :type vector4: :class:`vbl_aquarium.models.unity.Vector4`
-    :return: List of floats.
-    :rtype: list[float]
-    """
-    return [vector4.x, vector4.y, vector4.z, vector4.w]

ephys_link/emergency_stop.py

@@ -1,67 +0,0 @@
-from signal import SIGINT, SIGTERM, signal
-from threading import Event, Thread
-from time import sleep
-
-from serial import Serial
-from serial.tools import list_ports
-
-from ephys_link.common import dprint
-from ephys_link.server import Server
-
-
-class EmergencyStop:
-    """Serial system for emergency stop"""
-
-    def __init__(self, server: Server, serial_port: str) -> None:
-        """Setup serial port for emergency stop
-
-        :param server: The Ephys Link server instance
-        :type server: Server
-        :param serial_port: The serial port to poll
-        :type serial_port: str
-        :return: None
-        """
-        self._server = server
-        self._serial_port = serial_port
-        self._poll_rate = 0.05
-        self._kill_serial_event = Event()
-        self._poll_serial_thread = Thread(target=self._poll_serial, daemon=True)
-
-        # Register signals
-        signal(SIGTERM, self._close_serial)
-        signal(SIGINT, self._close_serial)
-
-    def watch(self) -> None:
-        """Start polling serial port for emergency stop"""
-        self._poll_serial_thread.start()
-
-    def _poll_serial(self) -> None:
-        """Continuously poll serial port for data
-
-        Close port on kill event
-        """
-        target_port = self._serial_port
-        if self._serial_port is None:
-            # Search for serial ports
-            for port, desc, _ in list_ports.comports():
-                if "Arduino" in desc or "USB Serial Device" in desc:
-                    target_port = port
-                    break
-
-        serial = Serial(target_port, 9600, timeout=self._poll_rate)
-        while not self._kill_serial_event.is_set():
-            if serial.in_waiting > 0:
-                serial.readline()
-                # Cause a break
-                dprint("[EMERGENCY STOP]\t\t Stopping all manipulators")
-                self._server.platform.stop()
-                serial.reset_input_buffer()
-            sleep(self._poll_rate)
-        print("Close poll")
-        serial.close()
-
-    def _close_serial(self, _, __) -> None:
-        """Close the serial connection"""
-        print("[INFO]\t\t Closing serial")
-        self._kill_serial_event.set()
-        self._poll_serial_thread.join()

ephys_link/gui.py

@@ -1,217 +0,0 @@
-from asyncio import run
-from json import dumps, load
-from os import makedirs
-from os.path import exists
-from socket import gethostbyname, gethostname
-from tkinter import CENTER, RIGHT, BooleanVar, E, IntVar, StringVar, Tk, ttk
-
-from platformdirs import user_config_dir
-
-import ephys_link.common as com
-from ephys_link.__about__ import __version__ as version
-from ephys_link.emergency_stop import EmergencyStop
-from ephys_link.server import Server
-
-SETTINGS_DIR = f"{user_config_dir()}\\VBL\\Ephys Link"
-SETTINGS_FILENAME = "settings.json"
-
-
-class GUI:
-    """GUI definition for Ephys Link"""
-
-    def __init__(self) -> None:
-        """Setup and construction of the Tk GUI"""
-
-        self._root = Tk()
-
-        # Create default settings dictionary
-        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"])
-
-    def launch(self) -> None:
-        """Build and launch GUI"""
-
-        # Build and run GUI.
-        self._build_gui()
-        self._root.mainloop()
-
-    def _build_gui(self):
-        """Build GUI"""
-
-        self._root.title(f"Ephys Link v{version}")
-
-        mainframe = ttk.Frame(self._root, padding=3)
-        mainframe.grid(column=0, row=0, sticky="news")
-        self._root.columnconfigure(0, weight=1)
-        self._root.rowconfigure(0, weight=1)
-        mainframe.columnconfigure(0, weight=1)
-        mainframe.rowconfigure(0, weight=1)
-
-        # Server serving settings.
-
-        server_serving_settings = ttk.LabelFrame(mainframe, text="Serving Settings", padding=3)
-        server_serving_settings.grid(column=0, row=0, sticky="news")
-
-        # 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=3, sticky="we")
-        ttk.Entry(server_serving_settings, textvariable=self._port, width=5, justify=CENTER).grid(
-            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")
-
-        # ---
-
-        # Platform type.
-        platform_type_settings = ttk.LabelFrame(mainframe, text="Platform Type", padding=3)
-        platform_type_settings.grid(column=0, row=1, sticky="news")
-
-        ttk.Radiobutton(
-            platform_type_settings,
-            text="Sensapex uMp-4",
-            variable=self._type,
-            value="sensapex",
-        ).grid(column=0, row=0, sticky="we")
-        ttk.Radiobutton(
-            platform_type_settings,
-            text="Sensapex uMp-3",
-            variable=self._type,
-            value="ump3",
-        ).grid(column=0, row=1, sticky="we")
-        ttk.Radiobutton(
-            platform_type_settings,
-            text="Pathfinder MPM Control v2.8.8+",
-            variable=self._type,
-            value="new_scale_pathfinder",
-        ).grid(column=0, row=2, sticky="we")
-        ttk.Radiobutton(
-            platform_type_settings,
-            text="New Scale M3-USB-3:1-EP",
-            variable=self._type,
-            value="new_scale",
-        ).grid(column=0, row=3, sticky="we")
-
-        # ---
-
-        # New Scale Settings.
-        new_scale_settings = ttk.LabelFrame(mainframe, text="Pathfinder Settings", padding=3)
-        new_scale_settings.grid(column=0, row=2, sticky="news")
-
-        # Port
-        ttk.Label(new_scale_settings, text="HTTP Server Port:", anchor=E, justify=RIGHT).grid(
-            column=0, row=1, sticky="we"
-        )
-        ttk.Entry(new_scale_settings, textvariable=self._pathfinder_port, width=5, justify=CENTER).grid(
-            column=1, row=1, sticky="we"
-        )
-
-        # ---
-
-        # Emergency Stop serial port.
-        e_stop_settings = ttk.LabelFrame(mainframe, text="Emergency Stop Settings", padding=3)
-        e_stop_settings.grid(column=0, row=3, sticky="news")
-
-        # Serial Port
-        ttk.Label(e_stop_settings, text="Serial Port:", anchor=E, justify=RIGHT).grid(column=0, row=1, sticky="we")
-        ttk.Entry(e_stop_settings, textvariable=self._serial, justify=CENTER).grid(column=1, row=1, sticky="we")
-
-        # Server launch button.
-        ttk.Button(
-            mainframe,
-            text="Launch Server",
-            command=self._launch_server,
-        ).grid(column=0, row=4, columnspan=2, sticky="we")
-
-    def _launch_server(self) -> None:
-        """Launch server based on GUI settings"""
-
-        # Close GUI.
-        self._root.destroy()
-
-        # 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(),
-        }
-        makedirs(SETTINGS_DIR, exist_ok=True)
-        with open(f"{SETTINGS_DIR}\\{SETTINGS_FILENAME}", "w+") as f:
-            f.write(dumps(settings))
-
-        # Launch server.
-        server = Server()
-
-        com.DEBUG = self._debug.get()
-
-        if self._serial.get() != "no-e-stop":
-            e_stop = EmergencyStop(server, self._serial.get())
-            e_stop.watch()
-
-        # 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())