zaberstage: Change connection string format to "device <n>"

Author: chrisjbillington

ZaberStageController/blacs_tabs.py

@@ -12,7 +12,7 @@
 #####################################################################
 
 from blacs.device_base_class import DeviceTab
-from .utils import get_stage_number
+from .utils import get_device_number
 
 class ZaberStageControllerTab(DeviceTab):
     def initialise_GUI(self):
@@ -39,7 +39,7 @@ def initialise_GUI(self):
                 'decimals': self.base_decimals,
             }
         # Sort by stage number:
-        ao_prop = {c: ao_prop[c] for c in sorted(ao_prop, key=get_stage_number)}
+        ao_prop = {c: ao_prop[c] for c in sorted(ao_prop, key=get_device_number)}
         # Create the output objects
         self.create_analog_outputs(ao_prop)
         # Create widgets for output objects
@@ -48,8 +48,8 @@ def initialise_GUI(self):
         self.auto_place_widgets(("Zaber Stages", ao_widgets))
 
         # Set the capabilities of this device
-        self.supports_remote_value_check(False) # TODO: Implement this if supported by hardware
-        self.supports_smart_programming(False) #TODO: Implement smart programming
+        self.supports_remote_value_check(False) # TODO: Implement
+        self.supports_smart_programming(False) #TODO: Implement
 
     def initialise_workers(self):
         # Create and set the primary worker

ZaberStageController/blacs_workers.py

@@ -16,7 +16,7 @@
 from labscript_utils import dedent
 import labscript_utils.h5_lock, h5py
 
-from .utils import get_stage_number
+from .utils import get_device_number
 
 class MockZaberInterface(object):
     def __init__(self, port):
@@ -65,7 +65,7 @@ def init(self):
 
     def program_manual(self, values):
         for connection, value in values.items():
-            stage_number = get_stage_number(connection)
+            stage_number = get_device_number(connection)
             self.controller.move(stage_number, int(round(value)))
         #TODO: return actual position of the zaber stage. Are they readable? Check API
         return values

ZaberStageController/labscript_devices.py

@@ -13,7 +13,7 @@
 from labscript import StaticAnalogQuantity, IntermediateDevice, set_passed_properties
 import numpy as np
 
-from .utils import get_stage_number
+from .utils import get_device_number
 
 # Base class for stages:
 class ZaberStage(StaticAnalogQuantity):
@@ -58,13 +58,13 @@ def __init__(self, name, com_port="", mock=False):
 
     def add_device(self, device):
         # Error-check the connection string:
-        _ = get_stage_number(device.connection)
+        _ = get_device_number(device.connection)
         IntermediateDevice.add_device(self, device)
 
     def generate_code(self, hdf5_file):
         IntermediateDevice.generate_code(self, hdf5_file)
         stages = {stage.connection: stage for stage in self.child_devices}
-        connections = sorted(stages, key=get_stage_number)
+        connections = sorted(stages, key=get_device_number)
         dtypes = [(connection, int) for connection in connections]
         static_value_table = np.empty(1, dtype=dtypes)
         for connection, stage in stages.items():

ZaberStageController/utils.py

@@ -14,22 +14,16 @@
 from labscript_utils import dedent
 
 
-def get_stage_number(connection_str):
-    """Return the integer stage number from the connection string or raise ValueError if
-    the connection string is not in the format "stage <n>" with positive n."""
+def get_device_number(connection_str):
+    """Return the integer device number from the connection string or raise ValueError
+    if the connection string is not in the format "device <n>" with positive n."""
     try:
         prefix, num = connection_str.split(' ')
         num = int(num)
-        if prefix != 'stage' or num <= 0:
+        if prefix != 'device' or num <= 0:
             raise ValueError
     except (TypeError, ValueError):
-        msg = f"""Connection string '{connection_str}' not in required format 'stage
+        msg = f"""Connection string '{connection_str}' not in required format 'device
             <n>' with n > 0"""
         raise ValueError(dedent(msg)) from None
     return num
-
-
-if __name__ == '__main__':
-    assert get_stage_number('stage 1') == 1
-    # get_stage_number('stage   ')
-    get_stage_number(None)