Merge pull request #1111 from TheDeanLab/full-functionality

Author: AdvancedImagingUTSW

docs/source/02_user_guide/01_supported_hardware/galvo.rst

@@ -38,6 +38,53 @@ Multiple types of galvanometers have been used, including Cambridge Technologies
 
 |
 
+------------
+
+ASI
+---
+
+Multiple types of galvanometers have been used, including Cambridge
+Technologies/Novanta, Thorlabs, and ScannerMAX. Each of these devices
+are externally controlled via analog signals delivered from the ASI 
+Tiger Controller.
+
+The ASI Tiger Controller has a few limitations for the analog signals. First, the 
+minimum voltage must be zero volts. Second, the period value needs to be a whole number.
+Third, there are three analog waveforms offered, sawtooth,  
+triangle, and sine waves.
+
+The sawtooth waveform is a periodic analog waveform. There are three duty cycle values 
+accepted, 0, 50, and 100. If the duty cycle is 0, the waveform is a falling sawtooth 
+waveform. If the duty cycle is 50, then it is a triangle wave. If the duty cycle is 100, 
+the waveform is a rising sawtooth waveform. 
+
+
+.. collapse:: Configuration File
+
+    .. code-block:: yaml
+
+        microscopes:
+          microscope_name:
+            galvo:
+               -
+                hardware:
+                  type: ASI
+                  axis: A
+                  min: 0
+                  max: 1.0
+                waveform: sine
+                phase: 0
+               -
+                hardware:
+                  type: ASI
+                  axis: B
+                  min: 0
+                  max: 1.0
+                waveform: sine
+                phase: 1.57079632679
+
+|
+
 -----------------
 
 Synthetic Galvo

src/navigate/config/configuration_database.py

@@ -108,6 +108,7 @@
 
 daq_device_types = {
     "National Instruments": "NI",
+    "Applied Scientific Instrumentation": "ASI",
     "Virtual Device": "Synthetic",
 }
 
@@ -468,7 +469,7 @@
     "frame_config": {"ref": "hardware"},
 }
 
-galvo_device_types = {"Analog Device": ("NI", "ni"), "Virtual Device": ("Synthetic", "synthetic")}
+galvo_device_types = {"Analog Device": ("NI", "ni"), "ASI Device": ("ASI", "asi"), "Virtual Device": ("Synthetic", "synthetic")}
 
 waveform_types = {
     "Sine": "sine",
@@ -485,6 +486,7 @@
         None,
         "*Analog Device only. Example: PXI6259/ao1",
     ],
+    "hardware/axis": ["Axis", "Input", "string", None, "Example: A"],
     "hardware/min": [
         "Minimum Voltage",
         "Spinbox",

src/navigate/model/device_startup_functions.py

@@ -513,7 +513,9 @@ def start_device(
     device_not_found(microscope_name, device_category, device_type, device_id)
 
 
-def start_daq(configuration: Dict[str, Any], device_type: str = "NI") -> DAQBase:
+def start_daq(
+    configuration: Dict[str, Any], device_type: str = "NI", name: str = "name"
+) -> DAQBase:
     """Initializes the data acquisition (DAQ) class on a dedicated thread.
 
     Load daq information from the configuration file. Proper daq types include NI and
@@ -536,7 +538,12 @@ def start_daq(configuration: Dict[str, Any], device_type: str = "NI") -> DAQBase
         from navigate.model.devices.daq.ni import NIDAQ
 
         return NIDAQ(configuration)
-    
+
+    elif device_type == "asi.ASI":
+        # from navigate.model.devices.daq.asi import ASIDaq
+        # name = "Microscope-0"
+        return start_device(name, configuration, "daq")
+
     elif device_type.lower().startswith("synthetic"):
         from navigate.model.devices.daq.synthetic import SyntheticDAQ
 
@@ -578,9 +585,9 @@ def device_not_found(*args: Any) -> None:
 def load_devices(
     microscope_name: str,
     configuration: Dict[str, Any],
-    is_synthetic=False,
-    devices_dict={},
-    plugin_devices=None,
+    is_synthetic: bool = False,
+    devices_dict: dict = {},
+    plugin_devices: Optional[dict] = None,
 ) -> dict:
     """Load devices from configuration.
 
@@ -592,6 +599,8 @@ def load_devices(
         Configuration dictionary
     is_synthetic : bool
         Run synthetic version of hardware?
+    devices_dict : dict
+        Dictionary of devices to load
     plugin_devices : dict
         Dictionary of plugin devices
 
@@ -615,6 +624,6 @@ def load_devices(
         ]["hardware"]["type"]
 
     if device_type not in devices_dict["daq"]:
-        devices_dict["daq"][device_type] = start_daq(configuration, device_type)
+        devices_dict["daq"][device_type] = start_daq(configuration, device_type, microscope_name)
 
     return devices_dict