Merge pull request #1099 from Daniel-Buckelew/rfvc_pr

ASI RFVC Changes to be merged in Navigate

Author: AdvancedImagingUTSW

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

@@ -112,6 +112,34 @@ Optotune Focus Tunable Lens
 
 ------------------
 
+ASI
+---
+
+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.
+
+There are two analog waveforms offered, triangle and ramp waves. The triangle waveform is 
+a periodic analog waveform, with no delay periods. The sawtooth waveform is a periodic 
+analog waveform with a delay period between each cycle. 
+
+.. collapse:: Configuration File
+
+    .. code-block:: yaml
+
+      microscopes: 
+        microscope_name:
+          remote_focus_device:
+            hardware: 
+              type: ASI
+              axis: A
+              min: 0
+              max: 5
+              port: COM2
+              baudrate: 9600
+|
+
+------------------
+
 Synthetic Remote Focus Device
 -----------------------------
 If no remote focus device is present, one must configure the software to use a synthetic

src/navigate/config/configuration_database.py

@@ -435,12 +435,14 @@
 remote_focus_device_types = {
     "Equipment Solutions": ("EquipmentSolutions", "equipment_solutions"),
     "Analog Device": ("NI", "ni"),
+    "ASI Device": ("ASI", "asi"),
     "Virtual Device": ("Synthetic", "synthetic"),
 }
 
 remote_focus_hardware_widgets = {
     "type": ["Device Type", "Combobox", "string", remote_focus_device_types, None],
     "channel": ["DAQ Channel", "Input", "string", None, "Example: PXI6259/ao3"],
+    "axis": ["Device Type", "Input", "string", None, "Example: A"],
     "min": [
         "Minimum Voltage",
         "Spinbox",

src/navigate/model/device_startup_functions.py

@@ -536,7 +536,7 @@ 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.lower().startswith("synthetic"):
         from navigate.model.devices.daq.synthetic import SyntheticDAQ
 

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

@@ -1010,3 +1010,69 @@ def logic_card_off(self, axis : str) -> None:
         self.read_response()
         self.send_command(f'6 CCA Z=0\r')
         self.read_response()
+        
+    def logic_cell_on(self, axis : str):
+        self.send_command(f'M E = {axis}\r')
+        self.read_response()
+        self.send_command(f'CCA Z=1\r')
+        self.read_response()
+
+    def logic_cell_off(self, axis :str):
+        self.send_command(f'M E = {axis}\r')
+        self.read_response()
+        self.send_command(f'CCA Z=0\r')
+        self.read_response()
+
+    def SA_waveform(self, axis:str, waveform=0, amplitude=1000, offset=500, frequency=1000):
+        """Programs the analog waveforms using SAA, SAO, and SAP
+        Default waveform is a sawtooth waveform with an amplitude of 1V with an offset of 0.5V
+
+        Parameters
+        ----------
+        axis: str
+            Tiger Controller axis
+        waveform: 
+            Type of waveform pattern according to https://asiimaging.com/docs/commands/sap
+        amplitude:
+            amplitude of the waveform in mV
+        offset:
+            sets the center position of the waveform in mV
+        frequency:
+            sets the period of the waveform in milliseconds       
+        """
+
+        "Verify if this is for synchronous or asynchronous"
+        print(f"Period (ms): {frequency}")
+        if (waveform % 128 == 3):
+            offset = .5*(offset+amplitude)
+        amplitude = amplitude*2            
+
+        self.send_command(f"3 SAP {axis}={waveform}")
+        self.read_response()
+        self.send_command(f"3 SAA {axis}={amplitude}")
+        self.read_response()
+        self.send_command(f"3 SAO {axis}={offset}")
+        self.read_response()
+        self.send_command(f"3 SAF {axis}={frequency}")
+        self.read_response()
+
+    def SAM(self, axis: str, mode: int):
+        """Sets the single-axis mode according to the integer code.
+
+        0: stops waveforms if they are running
+        1: starts generating the waveform pattern
+        2: waveform only runs for one cycle, then waits for another trigger
+        3: starts generating the waveform pattern, restarts the other waveform on the same card
+        4: starts generating the waveform, free running after the trigger
+
+        Parameters
+        ----------
+        axis: str
+            Laser axis
+        mode: 
+            Integer code     
+        """
+
+        self.send_command(f"3 SAM {axis}={mode}")
+        self.read_response()
+