Merge pull request #1092 from Daniel-Buckelew/Shutter-PR

Shutter Pull Request

Author: AdvancedImagingUTSW

src/navigate/config/configuration_database.py

@@ -152,13 +152,16 @@
 }
 
 shutter_device_types = {
+    "ASI Shutter": ("ASI", "asi"),
     "Analog/Digital Device": ("NI", "ni"),
     "Virtual Device": ("Synthetic", "synthetic"),
 }
 
 shutter_hardware_widgets = {
     "type": ["Device Type", "Combobox", "string", shutter_device_types, None],
     "channel": ["NI Channel", "Input", "string", None, "Example: PXI6259/port0/line0"],
+    "port": ["COM Port", "Input", "string", None, "Example: COM3"],
+    "axis": ["Shutter Axis", "Input", "string", None, "Example: 1"],
     "min": ["Minimum Voltage", "Spinbox", "float", None, "Example: 0"],
     "max": ["Maximum Voltage", "Spinbox", "float", None, "Example: 5"],
     "frame_config": {"ref": "hardware"},

src/navigate/model/devices/APIs/asi/asi_tiger_controller.py

@@ -938,3 +938,32 @@ def move_dichroic(self, dichroic_id, dichroic_position=0):
         """
         self.send_filter_wheel_command(f"MOVE {dichroic_id}={dichroic_position}")
         self.read_response()
+
+    def logic_card_on(self, axis : str):
+        """Turn on the logic card
+
+        Parameters
+        ----------
+        axis : str
+            The axis of the logic card
+        """
+
+        axis = int(axis) + 32
+        self.send_command(f'6 M E = {axis}\r')
+        self.read_response()
+        self.send_command(f'6 CCA Z=64\r')
+        self.read_response()
+
+    def logic_card_off(self, axis : str):
+        """Turn off the logic card
+
+        Parameters
+        ----------
+        axis : str
+            The axis of the logic card
+        """
+        axis = int(axis) + 32
+        self.send_command(f'6 M E = {axis}\r')
+        self.read_response()
+        self.send_command(f'6 CCA Z=0\r')
+        self.read_response()

src/navigate/model/devices/shutter/asi.py

@@ -0,0 +1,139 @@
+# Copyright (c) 2021-2024  The University of Texas Southwestern Medical Center.
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted for academic and research use only (subject to the
+# limitations in the disclaimer below) provided that the following conditions are met:
+
+#      * Redistributions of source code must retain the above copyright notice,
+#      this list of conditions and the following disclaimer.
+
+#      * Redistributions in binary form must reproduce the above copyright
+#      notice, this list of conditions and the following disclaimer in the
+#      documentation and/or other materials provided with the distribution.
+
+#      * Neither the name of the copyright holders nor the names of its
+#      contributors may be used to endorse or promote products derived from this
+#      software without specific prior written permission.
+
+# NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+# THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+# CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+
+# Standard Library Imports
+import logging
+import traceback
+from typing import Any, Dict
+
+# Local Imports
+from navigate.model.devices.shutter.base import ShutterBase
+from navigate.model.devices.device_types import SerialDevice
+from navigate.tools.decorators import log_initialization
+from navigate.model.devices.APIs.asi.asi_tiger_controller import TigerController
+
+# Logger Setup
+p = __name__.split(".")[1]
+logger = logging.getLogger(p)
+
+@log_initialization
+class ASIShutter(ShutterBase, SerialDevice):
+    """ShutterTTL Class
+
+    Triggering for shutters delivered from the TigerController.
+    Each output keeps their last digital state for as long the device is not
+    powered down.
+    """
+
+    def __init__(
+        self,
+        microscope_name: str,
+        device_connection: Any,
+        configuration: Dict[str, Any],
+        address=None,
+    ) -> None:
+        """Initialize the ASIShutter.
+
+        Parameters
+        ----------
+        microscope_name : str
+            Name of microscope in configuration
+        device_connection : Any
+            Hardware device to connect to
+        configuration : Dict[str, Any]
+            Global configuration of the microscope
+        """
+        super().__init__(microscope_name, device_connection, configuration)
+
+        self.address = address
+
+        self.shutter = device_connection
+
+        self.axis = configuration["configuration"]["microscopes"][microscope_name]["shutter"]["hardware"]["axis"]
+
+        self.port = configuration["configuration"]["microscopes"][microscope_name]["shutter"]["hardware"]["port"]
+
+    @classmethod
+    def connect(cls, port, baudrate=115200, timeout=0.25):
+        """Build ASILaser Serial Port connection
+
+        Parameters
+        ----------
+        port : str
+            Port for communicating with the shutter, e.g., COM1.
+        baudrate : int
+            Baud rate for communicating with the shutter, default is 115200.
+        timeout : float
+            Timeout for communicating with the shutter, default is 0.25.
+
+        Returns
+        -------
+        tiger_controller : TigerController
+            ASI Tiger Controller object.
+        """
+        # wait until ASI device is ready
+        tiger_controller = TigerController(port, baudrate)
+        tiger_controller.connect_to_serial()
+        if not tiger_controller.is_open():
+            logger.error("ASI shutter connection failed.")
+            raise Exception("ASI shutter connection failed.")
+        return tiger_controller
+
+    def __del__(self) -> None:
+        """Disconnect from the serial port."""
+        try:
+            if self.shutter:
+                self.shutter.disconnect_from_serial()
+                logger.debug("TigerController disconnected successfully.")
+        except Exception as e:
+            logger.exception(f"Error during cleanup: {traceback.format_exc()}")
+
+    def open_shutter(self) -> None:
+        """Opens the shutter."""
+        try:
+            self.shutter.logic_card_on(self.axis)
+            logger.debug("ASIShutter opened")
+        except Exception as e:
+            logger.exception(f"Shutter not open: {traceback.format_exc()}")
+
+    def close_shutter(self) -> None:
+        """Closes the shutter."""
+        try:
+            self.shutter.logic_card_off(self.axis)
+            logger.debug("ASIShutter closed")
+        except Exception as e:
+            logger.exception(f"Shutter did not close: {traceback.format_exc()}")
+
+    @property
+    def state(self) -> bool:
+        """Get the state of the shutter."""
+        return self.shutter.get_axis_position(self.axis)