Merge pull request #8025 from qutech/enh/driver_improvements

Make several driver improvements

Author: jenshnielsen

docs/changes/newsfragments/8025.breaking

@@ -0,0 +1 @@
+Yokogawa GS200: The `step` and `delay` arguments of `ramp_voltage` and `ramp_current` have been deprecated in favor of the `ramp_step` and `ramp_rate` instrument parameters.

docs/changes/newsfragments/8025.improved_driver

@@ -0,0 +1,9 @@
+Keysight 344xxA: Add SCPI mnemonics (`'MIN'`, `'MAX'`, `'DEF'`) to allowed values where allowed
+Oxford Mercury IPS: Allow setting current ramp rate and target
+Oxford Triton: Also assume magnet is not available if there is a communication timeout
+Yokagawa GS200 Program: Validate program times on multiples of the internal clock rate of 0.1s
+Yokagawa GS200 Program: Only add trigger parameter if monitor option is installed
+Yokagawa GS200 Program: Add get parser to `count`; allow setting to SCPI mnemonics `'MIN'`, `'MAX'`.
+Yokagawa GS200 Program: Add `hold()`, `pause()`, `cont()` methods.
+Yokagawa GS200: Add parameters reading out device registers (`status_byte`, `standard_event_register`, `extended_event_register`, `condition_register`)
+Yokagawa GS200: Implement hardware ramps. `ramp_mode` parameter switches the mode of output sets between `"JUMP"`, `"SOFTWARE"`, and `"HARDWARE"`. The last uses a program to ramp, software corresponds to the previous ramp implementation. `ramp_step`, `ramp_rate`, `ramp_blocking` configure the way ramps behave.

src/qcodes/instrument_drivers/Keysight/private/Keysight_344xxA_submodules.py

@@ -2,7 +2,7 @@
 from bisect import bisect_left
 from contextlib import ExitStack
 from functools import partial
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Literal, TypeAlias, get_args
 
 import numpy as np
 import numpy.typing as npt
@@ -28,6 +28,8 @@
 
     from typing_extensions import Unpack
 
+NumericScpiMnemonic: TypeAlias = Literal["MIN", "MAX", "DEF"]
+
 
 class Keysight344xxATrigger(InstrumentChannel["Keysight344xxA"]):
     """Implements triggering parameters and methods of Keysight 344xxA."""
@@ -946,7 +948,9 @@ def __init__(
                 set_cmd=self._set_apt_time,
                 get_cmd=self._get_with_sense_function("APERture"),
                 get_parser=float,
-                vals=vals.Numbers(*apt_times[self.model]),
+                vals=vals.MultiType(
+                    vals.Numbers(*apt_times[self.model]), vals.Enum("MIN", "MAX", "DEF")
+                ),
                 docstring=textwrap.dedent(
                     """\
                 Specifies the integration time in seconds (called aperture
@@ -1240,8 +1244,11 @@ def func(value: str) -> None:
 
         return func
 
-    def _set_apt_time(self, value: float) -> None:
-        self._write_with_sense_function("APERture", f"{value:f}")
+    def _set_apt_time(self, value: float | NumericScpiMnemonic) -> None:
+        if isinstance(value, float):
+            self._write_with_sense_function("APERture", f"{value:f}")
+        else:
+            self._write_with_sense_function("APERture", f"{value!s}")
 
         # setting aperture time switches aperture mode ON
         self.aperture_mode.get()
@@ -1262,21 +1269,25 @@ def _set_range(self, value: float) -> None:
         # resolution settings change with range
         self.resolution.get()
 
-    def _set_resolution(self, value: float) -> None:
+    def _set_resolution(self, value: float | NumericScpiMnemonic) -> None:
         rang = self.range.get()
 
         # convert both value*range and the resolution factors
         # to strings with few digits, so we avoid floating point
         # rounding errors.
-        res_fac_strs = [f"{(v * rang):.1e}" for v in self._resolution_factors]
-        if f"{value:.1e}" not in res_fac_strs:
-            raise ValueError(
-                f"Resolution setting {value:.1e}"
-                f"({value} at range {rang}) does not exist. "
-                f"Possible values are {res_fac_strs}"
-            )
-
-        self.write(f"VOLT:DC:RES {value:.1e}")
+        if value in get_args(NumericScpiMnemonic):
+            str_value = str(value)  # already str, but mypy does not know this
+        else:
+            res_fac_strs = [f"{(v * rang):.1e}" for v in self._resolution_factors]
+            str_value = f"{value:.1e}"
+            if str_value not in res_fac_strs:
+                raise ValueError(
+                    f"Resolution setting {str_value}"
+                    f"({value} at range {rang}) does not exist. "
+                    f"Possible values are {res_fac_strs}"
+                )
+
+        self.write(f"VOLT:DC:RES {str_value}")
 
         # NPLC settings change with resolution
         self.NPLC.get()

src/qcodes/instrument_drivers/oxford/MercuryiPS_VISA.py

@@ -155,6 +155,7 @@ def __init__(
             "current_target",
             label="Target current",
             get_cmd=partial(self._param_getter, "SIG:CSET"),
+            set_cmd=partial(self._param_setter, "SIG:CSET"),
             unit="A",
             get_parser=partial(_signal_parser, 1),
         )
@@ -177,7 +178,9 @@ def __init__(
             label="Ramp rate (current)",
             unit="A/s",
             get_cmd=partial(self._param_getter, "SIG:RCST"),
+            set_cmd=partial(self._param_setter, "SIG:RCST"),
             get_parser=partial(_signal_parser, 1 / 60),
+            set_parser=lambda x: x * 60,
         )
         """Parameter current_ramp_rate"""
 

src/qcodes/instrument_drivers/oxford/triton.py

@@ -67,7 +67,10 @@ def __init__(
         self._control_channel = 5
         self.pump_label_dict = {"TURB1": "Turbo 1", "COMP": "Compressor"}
 
-        self.magnet_available: bool = self._get_control_B_param("ACTN") != "INVALID"
+        self.magnet_available: bool = self._get_control_B_param("ACTN") not in (
+            "INVALID",
+            "communication timeout",
+        )
         """Indicates if a magnet is equipped *and* controlled by the Triton."""
 
         self.time: Parameter = self.add_parameter(