Thorlabs kinesis drivers

pyproject.toml

@@ -65,7 +65,8 @@ show_error_codes = true
 
 [[tool.mypy.overrides]]
 module = [
-    "qcodes_contrib_drivers.drivers.Spectrum.pyspcm"
+    "qcodes_contrib_drivers.drivers.Spectrum.pyspcm",
+    "qcodes_contrib_drivers.drivers.Thorlabs.Thorlabs_PM100D.tlpm",
     ]
 ignore_errors = true
 
@@ -84,7 +85,8 @@ module = [
     "spirack",
     "zhinst.*",
     "ruamel.*",
-    "msl.loadlib"
+    "msl.loadlib",
+    "TLPM"
 ]
 ignore_missing_imports = true
 

src/qcodes_contrib_drivers/drivers/Horiba/Horiba_FHR.py

@@ -32,10 +32,11 @@
                     7: 'errAbort',
                     0xFFFFFFFF: 'errForce32bit'}
 
+    config: Mapping[str, str]
+
     def __init__(self, cli, handle):
         self.cli = cli
         self.handle = handle
-        self.config: dict[str, str]
 
     def error_check(self, code: int):
         if code != 0:

src/qcodes_contrib_drivers/drivers/Thorlabs/Thorlabs_K10CR1/__init__.py

@@ -0,0 +1,8 @@
+"""Drivers for Thorlabs K10CR1.
+
+There are two driver versions:
+ - Kinesis
+ - APT
+
+The APT platform has been deprecated by Thorlabs.
+"""

src/qcodes_contrib_drivers/drivers/Thorlabs/K10CR1.py → src/qcodes_contrib_drivers/drivers/Thorlabs/Thorlabs_K10CR1/apt.py

@@ -1,10 +1,14 @@
+from __future__ import annotations
+
 import enum
-from typing import Tuple, Optional
+import warnings
+from typing import Tuple
 
 import qcodes.utils.validators as vals
 from qcodes import Instrument
-
-from .private.APT import Thorlabs_APT, ThorlabsHWType
+from qcodes_contrib_drivers.drivers.Thorlabs.private.APT import (
+    ThorlabsHWType, Thorlabs_APT
+)
 
 
 class RotationDirection(enum.Enum):
@@ -19,7 +23,7 @@
     FORWARD = "fwd"
 
 
-class Thorlabs_K10CR1(Instrument):
+class ThorlabsK10CR1(Instrument):
     """
     Instrument driver for the Thorlabs K10CR1 rotator.
 
@@ -169,7 +173,8 @@
         return self.apt.mot_get_velocity_parameters(self.serial_number)
 
     def _set_velocity_parameters(self,
-                                 min_vel: Optional[float] = None, accn: Optional[float] = None, max_vel: Optional[float] = None):
+                                 min_vel: float | None = None, accn: float | None = None,
+                                 max_vel: float | None = None):
         if min_vel is None or accn is None or max_vel is None:
             old_min_vel, old_accn, old_max_vel = self._get_velocity_parameters()
             if min_vel is None:
@@ -204,8 +209,8 @@
     def _get_home_parameters(self) -> Tuple[int, int, float, float]:
         return self.apt.mot_get_home_parameters(self.serial_number)
 
-    def _set_home_parameters(self, direction: Optional[int] = None, lim_switch: Optional[int] = None,
-                             velocity: Optional[float] = None, zero_offset: Optional[float] = None):
+    def _set_home_parameters(self, direction: int | None = None, lim_switch: int | None = None,
+                             velocity: float | None = None, zero_offset: float | None = None):
         if direction is None or lim_switch is None or velocity is None or zero_offset is None:
             old_direction, old_lim_switch, old_velocity, old_zero_offset = self._get_home_parameters()
             if direction is None:
@@ -265,3 +270,10 @@
 
     def _move_home_async(self):
         self.apt.mot_move_home(self.serial_number, False)
+
+
+class K10CR1(ThorlabsK10CR1):
+    def __init__(self, name: str, device_id: int, apt: Thorlabs_APT, **kwargs):
+        warnings.warn('This class name is deprecated. Please use the ThorlabsK10CR1 class instead',
+                      DeprecationWarning)
+        super().__init__(name, device_id, apt, **kwargs)

src/qcodes_contrib_drivers/drivers/Thorlabs/Thorlabs_K10CR1/kinesis.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from qcodes_contrib_drivers.drivers.Thorlabs.private.kinesis import enums, isc
+
+
+class ThorlabsK10CR1(isc.KinesisISCInstrument, prefix='ISC',
+                     hardware_type=enums.KinesisHWType.CageRotator):
+    """Kinesis driver for Thorlabs K10CR1 cage rotator."""

src/qcodes_contrib_drivers/drivers/Thorlabs/Thorlabs_MFF10x/__init__.py

@@ -0,0 +1,8 @@
+"""Drivers for Thorlabs MFF10x.
+
+There are two driver versions:
+ - Kinesis
+ - APT
+
+The APT platform has been deprecated by Thorlabs.
+"""

src/qcodes_contrib_drivers/drivers/Thorlabs/MFF10x.py → src/qcodes_contrib_drivers/drivers/Thorlabs/Thorlabs_MFF10x/apt.py

@@ -1,8 +1,30 @@
+import warnings
+
 from qcodes import Instrument
-from .private.APT import Thorlabs_APT, ThorlabsHWType
+from qcodes_contrib_drivers.drivers.Thorlabs.private.APT import (
+    ThorlabsHWType, Thorlabs_APT
+)
+
+
+def _position_get_parser(val) -> str:
+    val = int(val)
+    if val == 0:
+        return 'open'
+    elif val == 1:
+        return 'close'
+    raise ValueError('Invalid return code', val)
+
 
+def _position_set_parser(val) -> int:
+    if val == 'open':
+        return 0
+    elif val == 'close':
+        return 1
+    else:
+        return int(val)
 
-class Thorlabs_MFF10x(Instrument):
+
+class ThorlabsMFF10x(Instrument):
     """
     Instrument driver for the Thorlabs MFF10x mirror flipper.
 
@@ -34,7 +56,8 @@
         self.add_parameter('position',
                            get_cmd=self._get_position,
                            set_cmd=self._set_position,
-                           get_parser=int,
+                           get_parser=_position_get_parser,
+                           set_parser=_position_set_parser,
                            label='Position')
 
         # print connect message
@@ -52,3 +75,10 @@
     # set methods
     def _set_position(self, position):
         self.apt.mot_move_jog(self.serial_number, position+1, False)
+
+
+class MFF10x(ThorlabsMFF10x):
+    def __init__(self, name: str, device_id: int, apt: Thorlabs_APT, **kwargs):
+        warnings.warn('This class name is deprecated. Please use the ThorlabsMFF10x class instead',
+                      DeprecationWarning)
+        super().__init__(name, device_id, apt, **kwargs)

src/qcodes_contrib_drivers/drivers/Thorlabs/Thorlabs_MFF10x/kinesis.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+import pathlib
+from typing import Any, Literal, Mapping
+
+from qcodes.parameters import Parameter
+from qcodes.validators import validators as vals
+from qcodes_contrib_drivers.drivers.Thorlabs.private.kinesis import enums
+from qcodes_contrib_drivers.drivers.Thorlabs.private.kinesis.core import (
+    KinesisInstrument
+)
+
+
+class ThorlabsMFF10x(KinesisInstrument, prefix='FF',
+                     hardware_type=enums.KinesisHWType.FilterFlipper):
+    """Kinesis driver for Thorlabs MFF10x filter flipper.
+
+    Args:
+        name:
+            An identifier for this instrument.
+        dll_dir (optional):
+            The directory where the kinesis dlls reside.
+        serial (optional):
+            The serial number of the device to connect to. If omitted,
+            the first available device found will be used. For a list
+            of all available devices, use
+            :meth:`list_available_devices` on an existing instance or
+            :func:`~qcodes_contrib_drivers.drivers.Thorlabs.private.kinesis.core.list_available_devices`.
+        simulation (optional):
+            Enable the Kinesis simulator mode. Note that the serial
+            number assigned to the simulated device should be given
+            since otherwise the first available device will be
+            connected (which might not be a simulated but a real one).
+        position_mapping (optional):
+            A val mapping for a more human-readable position mapping
+            than the internally used 1 and 2. Defaults to
+            ``{'open': 1, 'close': 2}``.
+        metadata (optional):
+            Additional static metadata.
+        label (optional):
+            Nicely formatted name of the instrument.
+
+    """
+
+    def __init__(self, name: str, dll_dir: str | pathlib.Path | None = '',
+                 serial: int | None = None, simulation: bool = False,
+                 polling: int = 200, home: bool = False,
+                 position_mapping: Mapping[str, Literal[1, 2]] | None = None,
+                 metadata: Mapping[Any, Any] | None = None,
+                 label: str | None = None):
+        super().__init__(name, dll_dir, serial, simulation, polling, home,
+                         metadata, label)
+
+        self.position = Parameter(
+            'position',
+            get_cmd=self._kinesis.get_position,
+            set_cmd=self._kinesis.move_to_position,
+            val_mapping=position_mapping or {'open': 1, 'close': 2},
+            label='Position',
+            instrument=self
+        )
+        """The position of the flipper."""
+        self.transit_time = Parameter(
+            'transit_time',
+            get_cmd=self._kinesis.get_transit_time,
+            set_cmd=self._kinesis.set_transit_time,
+            vals=vals.Ints(300, 2800),
+            set_parser=int,
+            unit='ms',
+            label='Transit time',
+            instrument=self
+        )
+        """The transit time between two positions."""
+
+    def toggle_position(self):
+        """Toggle the position of the flipper."""
+        # val_mapping is dynamic, so use inverse_val_mapping together
+        # with the hardware values
+        if self.position() == self.position.inverse_val_mapping[1]:
+            self.position(self.position.inverse_val_mapping[2])
+        else:
+            self.position(self.position.inverse_val_mapping[1])

src/qcodes_contrib_drivers/drivers/Thorlabs/Thorlabs_PM100D/__init__.py

@@ -0,0 +1,10 @@
+"""Drivers for Thorlabs PM100D.
+
+There are two driver versions:
+ - TLPM (libusb)
+ - VISA
+
+Newer versions of the Thorlabs Power Meter software use the TLPM driver
+and include a utility to switch the device between the two driver
+versions.
+"""