Add types to generic instrument parameteres by jenshnielsen · Pull Request #8658 · microsoft/Qcodes

Jens Hedegaard Nielsen (jenshnielsen) · 2026-10-23T06:17:49Z

No description provided.

get_parser=bool turned the "0" response into True, and setting it sent True/False rather than 1/0. Also forward kwargs in ScopeArray so the driver can be instantiated without a deprecation warning.

Also fix the simulated trigger source setter, which had a stray '?'.

vals was silently overridden by val_mapping, so loop 2 accepted the 25 W range that only loop 1 supports.

The pulse width was returned as a string and labelled in ns, while the instrument and the validator use seconds.

The DG1000Z programming guide documents all of these replies in scientific notation. Also give the waveform parameter its own str getter instead of reusing the numeric waveform parameter helper.

The channel state, direct output and DC output are now booleans that accept True/False, 1/0 and "on"/"off". Also parse the sequence position as int.

Also annotate the range, voltage level and current level setters as taking floats rather than strings.

Only occupied slots get a module, so values are never None. Empty slots report model "0" for SYST:CTYP? and were already skipped.

The IF bandwidth is set in 1-1.5-2-3-5-7 steps, so e.g. 1.5 Hz is valid but could not be parsed as int. Add a minimal ZNB20 simulator to test it.

Passing the default parameter_class=Parameter explicitly prevented the value type from being inferred, so annotate the affected parameters with their value types.

Icomp and Pcomp are optional in the WV command, so allow None for the B1517A sweep compliances. Use an on/off value mapping for the B1520A LMN data monitor so it reads back as bool.

codecov · 2026-10-23T06:23:50Z

Codecov Report

❌ Patch coverage is 70.29289% with 284 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.50%. Comparing base (edd879c) to head (cc46d80).
⚠️ Report is 14 commits behind head on main.

Files with missing lines	Patch %	Lines
...odes/instrument_drivers/stanford_research/SR830.py	3.84%	25 Missing ⚠️
src/qcodes/instrument_drivers/Keysight/N52xx.py	4.76%	20 Missing ⚠️
...odes/instrument_drivers/stanford_research/SG384.py	4.76%	20 Missing ⚠️
...rc/qcodes/instrument_drivers/AlazarTech/ATS9373.py	6.25%	15 Missing ⚠️
...rc/qcodes/instrument_drivers/AlazarTech/ATS9440.py	6.66%	14 Missing ⚠️
...rc/qcodes/instrument_drivers/AlazarTech/ATS9870.py	6.66%	14 Missing ⚠️
...codes/instrument_drivers/Keithley/Keithley_2000.py	12.50%	14 Missing ⚠️
...ent_drivers/QuantumDesign/DynaCoolPPMS/DynaCool.py	6.66%	14 Missing ⚠️
src/qcodes/instrument_drivers/Galil/dmc_41x3.py	7.14%	13 Missing ⚠️
...codes/instrument_drivers/Keithley/Keithley_2400.py	7.69%	12 Missing ⚠️
... and 25 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8658      +/-   ##
==========================================
+ Coverage   72.59%   74.50%   +1.91%     
==========================================
  Files         307      307              
  Lines       32431    32430       -1     
==========================================
+ Hits        23543    24162     +619     
+ Misses       8888     8268     -620

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

🟡 Changes recommended

The compliance-clearing failure must be fixed before approval; the API-change newsfragment is also missing.

2 open issues

What changed in this PR

Adds explicit value and instrument-owner types to QCoDeS driver parameters, with runtime corrections and regression coverage to align parameter behavior with those types.

Changes:

Adds generic parameter annotations across instrument drivers.
Corrects numeric parsing, boolean mappings, selected SCPI commands, units, and validation.
Expands simulator definitions and driver regression tests.

Review findings:

Moderate — src/qcodes/instrument_drivers/Keysight/keysightb1500/KeysightB1517A.py:458: Clearing power compliance still raises ValueError when current compliance is unset, leaving the previous power limit stored. Apply the prerequisite check only for non-None power limits, and test clearing current compliance before power compliance, plus clearing power compliance on a fresh sweeper.
Nit — src/qcodes/instrument_drivers/agilent/Agilent_E8267C.py:60: Add a reStructuredText newsfragment under docs/changes/newsfragments/ documenting the observable getter, unit, and validation changes, including the public pulse_width return-type and unit changes.

Validation included source inspection and an isolated check confirming the compliance-clearing failure. Project tests and type checking were not run.

File	Description
`tests/drivers/test_tektronix_tps2012.py`	Tests numeric trigger-level reads and writes.
`tests/drivers/test_tektronix_dpo7200xx.py`	Tests boolean measurement state and legacy inputs.
`tests/drivers/test_tektronix_awg5014c.py`	Tests sequence positions and boolean outputs.
`tests/drivers/test_stanford_research_sr86x.py`	Tests integer capture progress.
`tests/drivers/test_rto_1000.py`	Tests trigger configuration and numeric impedance.
`tests/drivers/test_rs_sgs100a.py`	Tests output helpers and legacy status inputs.
`tests/drivers/test_rohde_schwarz_znb.py`	Tests fractional bandwidth and derived setpoints.
`tests/drivers/test_rigol_ds4000.py`	Tests boolean autoscale behavior.
`tests/drivers/test_rigol_ds1074z.py`	Tests numeric trigger levels.
`tests/drivers/test_rigol_dg1062.py`	Tests waveform and burst parameter types.
`tests/drivers/test_lakeshore_325.py`	Tests loop-specific heater output ranges.
`tests/drivers/test_keysight_e4980a.py`	Tests numeric impedance ranges.
`tests/drivers/test_keysight_34980a.py`	Tests occupied slots and generic module fallback.
`tests/drivers/test_keithley_7510.py`	Tests delay, averaging, and digitization parameters.
`tests/drivers/test_keithley_6500.py`	Tests display-digit configuration.
`tests/drivers/test_keithley_2450.py`	Tests numeric sensing and source parameters.
`tests/drivers/test_coppermountain_m5065.py`	Tests averaging triggers and legacy inputs.
`tests/drivers/test_agilent_e8267c.py`	Tests numeric pulse widths in seconds.
`tests/drivers/keysight_b1500/test_messagebuilder.py`	Tests PCH commands and queries.
`tests/drivers/keysight_b1500/b1500_driver_tests/test_b1520a_cmu.py`	Tests monitor state and legacy inputs.
`tests/drivers/keysight_b1500/b1500_driver_tests/test_b1517a_smu.py`	Tests clearing sweep compliance limits.
`src/qcodes/instrument/sims/Tektronix_TPS2012.yaml`	Adds TPS2012 simulation support.
`src/qcodes/instrument/sims/SR860.yaml`	Adds capture-progress simulation.
`src/qcodes/instrument/sims/RTO_1000.yaml`	Models trigger mode and impedance; fixes source writes.
`src/qcodes/instrument/sims/Rohde_Schwarz_ZNB20.yaml`	Adds single-channel bandwidth simulation.
`src/qcodes/instrument/sims/Rigol_DS4000.yaml`	Models boolean autoscale state.
`src/qcodes/instrument/sims/Rigol_DS1074Z.yaml`	Models scientific-notation trigger levels.
`src/qcodes/instrument/sims/Rigol_DG1062.yaml`	Models waveform, burst, and duty-cycle responses.
`src/qcodes/instrument/sims/lakeshore_model325.yaml`	Models loop-specific output ranges.
`src/qcodes/instrument/sims/Keysight_E4980A.yaml`	Models impedance range and autorange.
`src/qcodes/instrument/sims/keithley_7510.yaml`	Models averaging, delay, and digitization settings.
`src/qcodes/instrument/sims/Keithley_6500.yaml`	Adds display-digit simulation.
`src/qcodes/instrument/sims/Keithley_2450.yaml`	Models numeric sensing and source settings.
`src/qcodes/instrument/sims/Agilent_E8267C.yaml`	Adds pulse-width simulation.
`src/qcodes/instrument_drivers/yokogawa/Yokogawa_GS200.py`	Types monitoring, program, and source parameters.
`src/qcodes/instrument_drivers/tektronix/TPS2012.py`	Types parameters and parses trigger levels numerically.
`src/qcodes/instrument_drivers/tektronix/AWG70000A.py`	Types waveform, clock, and output parameters.
`src/qcodes/instrument_drivers/stanford_research/SR560.py`	Types the inversion parameter.
`src/qcodes/instrument_drivers/stanford_research/SG384.py`	Types synthesis and modulation parameters.
`src/qcodes/instrument_drivers/stahl/stahl.py`	Types electrical, lock, and temperature readings.
`src/qcodes/instrument_drivers/signal_hound/SignalHound_USB_SA124B.py`	Types acquisition settings and readings.
`src/qcodes/instrument_drivers/rigol/Rigol_DS4000.py`	Types parameters and fixes autoscale mapping and keyword forwarding.
`src/qcodes/instrument_drivers/rigol/Rigol_DS1074Z.py`	Types parameters and converts trigger levels to floats.
`src/qcodes/instrument_drivers/rigol/Rigol_DG4000.py`	Types counter and system parameters.
`src/qcodes/instrument_drivers/rigol/Rigol_DG1062.py`	Types parameters and fixes numeric parsing and polarity validation.
`src/qcodes/instrument_drivers/rigol/private/DP8xx.py`	Types supply-channel parameters.
`src/qcodes/instrument_drivers/QuantumDesign/DynaCoolPPMS/DynaCool.py`	Types temperature, field, and chamber parameters.
`src/qcodes/instrument_drivers/QDev/QDac_channels.py`	Types current, calibration, and verbosity parameters.
`src/qcodes/instrument_drivers/oxford/triton.py`	Types system status and PID-control parameters.
`src/qcodes/instrument_drivers/oxford/MercuryiPS_VISA.py`	Types magnet-channel and temperature parameters.
`src/qcodes/instrument_drivers/Minicircuits/Base_SPDT.py`	Types the base switch parameter.
`src/qcodes/instrument_drivers/Minicircuits/_minicircuits_rudat_13g_90.py`	Types identification and attenuation parameters.
`src/qcodes/instrument_drivers/Minicircuits/_minicircuits_rc_spdt.py`	Types SPDT switch selection.
`src/qcodes/instrument_drivers/Minicircuits/_minicircuits_rc_sp4t.py`	Types SP4T switch selection.
`src/qcodes/instrument_drivers/Lakeshore/Lakeshore_model_336.py`	Types calibration-curve selection.
`src/qcodes/instrument_drivers/Lakeshore/Lakeshore_model_325.py`	Types parameters and fixes loop-specific range validation.
`src/qcodes/instrument_drivers/Lakeshore/lakeshore_base.py`	Types shared heater and sensor parameters.
`src/qcodes/instrument_drivers/Keysight/private/Keysight_344xxA_submodules.py`	Types trigger, display, and measurement parameters.
`src/qcodes/instrument_drivers/Keysight/N52xx.py`	Types network-analyzer parameters.
`src/qcodes/instrument_drivers/Keysight/N51x1.py`	Types signal-generation and output parameters.
`src/qcodes/instrument_drivers/Keysight/KtMAwg.py`	Types channel configuration and gain parameters.
`src/qcodes/instrument_drivers/Keysight/KtM960x.py`	Types output and measurement configuration.
`src/qcodes/instrument_drivers/Keysight/keysightb1500/message_builder.py`	Corrects the PCH query command.
`src/qcodes/instrument_drivers/Keysight/keysightb1500/KeysightB1520A.py`	Types CMU parameters and normalizes monitor state.
`src/qcodes/instrument_drivers/Keysight/keysightb1500/KeysightB1517A.py`	Types sweep parameters and permits unset compliance values.
`src/qcodes/instrument_drivers/Keysight/keysightb1500/KeysightB1500_base.py`	Types autozero state.
`src/qcodes/instrument_drivers/Keysight/Keysight_N9030B.py`	Types analyzer settings and operating modes.
`src/qcodes/instrument_drivers/Keysight/Keysight_N6705B.py`	Types power-supply channel parameters.
`src/qcodes/instrument_drivers/Keysight/keysight_e4980a.py`	Types parameters and parses impedance ranges numerically.
`src/qcodes/instrument_drivers/Keysight/keysight_b220x.py`	Types routing, status, and connection parameters.
`src/qcodes/instrument_drivers/Keysight/keysight_34980a.py`	Types module storage and consolidates module registration.
`src/qcodes/instrument_drivers/Keysight/keysight_34934a.py`	Types relay-protection mode.
`src/qcodes/instrument_drivers/Keithley/Keithley_6500.py`	Types parameters and fixes the display-digit setter.
`src/qcodes/instrument_drivers/Keithley/Keithley_3706A.py`	Types connection and communication parameters.
`src/qcodes/instrument_drivers/Keithley/Keithley_2400.py`	Types source, sensing, and output parameters.
`src/qcodes/instrument_drivers/Keithley/Keithley_2000.py`	Types parameters and makes response parsing generic.
`src/qcodes/instrument_drivers/Keithley/_Keithley_2600.py`	Types channel and display parameters.
`src/qcodes/instrument_drivers/ithaco/Ithaco_1211.py`	Types the inversion parameter.
`src/qcodes/instrument_drivers/HP/HP_8753D.py`	Types sweep and display parameters.
`src/qcodes/instrument_drivers/HP/HP_83650A.py`	Types frequency, power, and modulation parameters.
`src/qcodes/instrument_drivers/HP/HP_8133A.py`	Types pulse-generator parameters.
`src/qcodes/instrument_drivers/Galil/dmc_41x3.py`	Types motion and controller parameters.
`src/qcodes/instrument_drivers/cryomagnetics/_TM620.py`	Types temperature readings.
`src/qcodes/instrument_drivers/cryomagnetics/_cryomagnetics4g.py`	Types magnet settings and readings.
`src/qcodes/instrument_drivers/CopperMountain/_M5xxx.py`	Types VNA parameters and uses boolean trigger control.
`src/qcodes/instrument_drivers/basel/BaselSP983a.py`	Types overload status.
`src/qcodes/instrument_drivers/american_magnetics/AMI430_visa.py`	Types heater, magnet, and ramp-control parameters.
`src/qcodes/instrument_drivers/AlazarTech/ATS9870.py`	Types acquisition settings.
`src/qcodes/instrument_drivers/AlazarTech/ATS9440.py`	Types acquisition settings.
`src/qcodes/instrument_drivers/AlazarTech/ATS9373.py`	Types acquisition settings and trigger holdoff.
`src/qcodes/instrument_drivers/AlazarTech/ATS9360.py`	Types acquisition settings and trigger holdoff.
`src/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py`	Types the acquisition result parameter.
`src/qcodes/instrument_drivers/AimTTi/_AimTTi_PL_P.py`	Types supply-channel parameters.
`src/qcodes/instrument_drivers/agilent/Agilent_E8267C.py`	Types parameters and corrects pulse-width parsing and units.
`src/qcodes/instrument_drivers/agilent/Agilent_E8257D.py`	Types parameters and uses boolean output helpers.
`src/qcodes/instrument_drivers/agilent/Agilent_34411A.py`	Types display-text parameters.
`src/qcodes/instrument_drivers/agilent/Agilent_34410A.py`	Types display-text parameters.
`src/qcodes/instrument_drivers/agilent/Agilent_34401A.py`	Types display text.
`src/qcodes/instrument_drivers/agilent/_Agilent_344xxA.py`	Types shared multimeter parameters.

_{Review effort: Balanced}

+            # None omits Pcomp from the WV command, i.e. no power compliance
+            vals=vals.MultiType(vals.Numbers(0.001, 80), vals.Enum(None)),


+            unit="s",
            set_cmd="PULM:INT:PWID {}",
            get_cmd="PULM:INT:PWID?",
+            get_parser=float,


Copilot · 2026-10-23T07:25:08Z

One or more custom setup steps configured for this repository failed during this Copilot code review run:

Fetch main branch

Setup steps run before each review. If the review above is missing context, or no review was posted at all, the failing step above may be the cause. See the workflow run for failure details, fix your setup steps configuration, and re-request a review.

Note

You can configure setup steps for Copilot code review separately from Copilot cloud agent with a copilot-code-review.yml file. Read the docs for details.

Copilot

🟡 Changes recommended

The slot-rescan regression, compliance-clearing failure, and missing release-note documentation remain unresolved.

3 open issues

_{Review effort: Balanced}

        for slot in self.system_slots_info:
            model_string = self.system_slots_info[slot]["model"]


Jens Hedegaard Nielsen (jenshnielsen) added 30 commits October 22, 2026 20:19

Add value types to Keysight driver parameters

045f130

Add value types to Keithley, HP and Agilent driver parameters

48a2f7b

Add value types to Tektronix and Rigol driver parameters

089956f

Add value types to R&S and SRS driver parameters

19e3b06

Add value types to Alazar, AMI, Oxford and Yokogawa parameters

d9cca43

Add value types to remaining driver parameters

49bccda

Parse Keithley 2450 count and line frequency as int

398605a

Parse SR86x captured kilobytes as int

0d512d8

Fix Rigol DS4000 enable_auto_scale

048d3e4

get_parser=bool turned the "0" response into True, and setting it sent True/False rather than 1/0. Also forward kwargs in ScopeArray so the driver can be instantiated without a deprecation warning.

Use seconds as unit of Keithley 7510 digitize aperture

6b68ce1

Fix RTO1000 trigger_mode querying the trigger source

bccd712

Also fix the simulated trigger source setter, which had a stray '?'.

Remove stray '?' from Keithley 6500 digits set command

74bca0c

Fix B1500 pch_query missing the '?'

7afa14d

Only allow Lakeshore 325 high output range on loop 1

a2bc12f

vals was silently overridden by val_mapping, so loop 2 accepted the 25 W range that only loop 1 supports.

Remove unused vals from Rigol DG1062 polarity

2dfbbfb

Parse Keithley 2450 nplc and source delay as float

3de7948

Parse Keithley 7510 delay, counts and sample rate as numbers

eb1e7f7

Fix Agilent E8267C pulse width type and unit

839c718

The pulse width was returned as a string and labelled in ns, while the instrument and the validator use seconds.

Parse Rigol DG1062 burst settings and duty cycle as numbers

4923921

The DG1000Z programming guide documents all of these replies in scientific notation. Also give the waveform parameter its own str getter instead of reusing the numeric waveform parameter helper.

Parse Rigol DS1074Z trigger level as float

1679752

Parse Tektronix TPS2012 trigger level as float

85d2e3d

Make Keithley 2000 _get_mode_param generic

3d172ac

Use on/off mapping for Tektronix AWG5014 states

72e1448

The channel state, direct output and DC output are now booleans that accept True/False, 1/0 and "on"/"off". Also parse the sequence position as int.

Parse R&S RTO1000 channel impedance as float

97cef05

Parse Keysight E4980A impedance range as float

895b860

Also annotate the range, voltage level and current level setters as taking floats rather than strings.

Type Keysight 34980A modules by slot

dff7ebe

Only occupied slots get a module, so values are never None. Empty slots report model "0" for SYST:CTYP? and were already skipped.

Pass bool to R&S SGS100A status

95290e3

Pass bool to Agilent E8257D output_enabled

aa2bdeb

Pass bool to CopperMountain averages trigger

0a0bbe8

Pass bool to Tektronix DPO measurement state

de55b22

Jens Hedegaard Nielsen (jenshnielsen) added 3 commits October 23, 2026 07:26

Fix R&S ZNB non-integer bandwidth

a41de9b

The IF bandwidth is set in 1-1.5-2-3-5-7 steps, so e.g. 1.5 Hz is valid but could not be parsed as int. Add a minimal ZNB20 simulator to test it.

Drop redundant parameter_class in mock instruments

f5693ca

Passing the default parameter_class=Parameter explicitly prevented the value type from being inferred, so annotate the affected parameters with their value types.

Fix B1500 compliance and volt monitor validators

cc46d80

Icomp and Pcomp are optional in the WV command, so allow None for the B1517A sweep compliances. Use an on/off value mapping for the B1520A LMN data monitor so it reads back as bool.

Jens Hedegaard Nielsen (jenshnielsen) requested a balanced review from Copilot October 23, 2026 07:15

Copilot started reviewing on behalf of Jens Hedegaard Nielsen (jenshnielsen) October 23, 2026 07:16

View session

Copilot AI reviewed Oct 23, 2026

View reviewed changes

Jens Hedegaard Nielsen (jenshnielsen) requested a balanced review from Copilot October 23, 2026 09:00

Copilot started reviewing on behalf of Jens Hedegaard Nielsen (jenshnielsen) October 23, 2026 09:01

View session

Copilot AI reviewed Oct 23, 2026

View reviewed changes

Comment thread src/qcodes/instrument_drivers/Keysight/keysight_34980a.py

Comment on lines 126 to 127

for slot in self.system_slots_info:

model_string = self.system_slots_info[slot]["model"]

Navigation Menu

Repository navigation

Add types to generic instrument parameteres - #8658

Add types to generic instrument parameteres#8658
Jens Hedegaard Nielsen (jenshnielsen) wants to merge 33 commits into
microsoft:mainfrom
jenshnielsen:add_parameter_annotations

Jens Hedegaard Nielsen (jenshnielsen) commented Oct 23, 2026

Uh oh!

codecov Bot commented Oct 23, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI commented Oct 23, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		# None omits Pcomp from the WV command, i.e. no power compliance
		vals=vals.MultiType(vals.Numbers(0.001, 80), vals.Enum(None)),

		for slot in self.system_slots_info:
		model_string = self.system_slots_info[slot]["model"]

Conversation

Jens Hedegaard Nielsen (jenshnielsen) commented Oct 23, 2026

Uh oh!

codecov Bot commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Copilot AI commented Oct 23, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented Oct 23, 2026 •

edited

Loading