from typing import Any
import qcodes.validators as vals
from qcodes.instrument import VisaInstrument
from qcodes.parameters import create_on_off_val_mapping
[docs]
class RohdeSchwarzSGS100A(VisaInstrument):
"""
This is the QCoDeS driver for the Rohde & Schwarz SGS100A signal generator.
Status: beta-version.
.. todo::
- Add all parameters that are in the manual
- Add test suite
- See if there can be a common driver for RS mw sources from which
different models inherit
This driver will most likely work for multiple Rohde & Schwarz sources.
it would be a good idea to group all similar RS drivers together in one
module.
Tested working with
- RS_SGS100A
This driver does not contain all commands available for the RS_SGS100A but
only the ones most commonly used.
"""
def __init__(self, name: str, address: str, **kwargs: Any) -> None:
super().__init__(name, address, terminator="\n", **kwargs)
self.add_parameter(
name="frequency",
label="Frequency",
unit="Hz",
get_cmd="SOUR:FREQ?",
set_cmd="SOUR:FREQ {:.2f}",
get_parser=float,
vals=vals.Numbers(1e6, 20e9),
)
self.add_parameter(
name="phase",
label="Phase",
unit="deg",
get_cmd="SOUR:PHAS?",
set_cmd="SOUR:PHAS {:.2f}",
get_parser=float,
vals=vals.Numbers(0, 360),
)
self.add_parameter(
name="power",
label="Power",
unit="dBm",
get_cmd="SOUR:POW?",
set_cmd="SOUR:POW {:.2f}",
get_parser=float,
vals=vals.Numbers(-120, 25),
)
self.add_parameter(
"status",
label="RF Output",
get_cmd=":OUTP:STAT?",
set_cmd=":OUTP:STAT {}",
val_mapping=create_on_off_val_mapping(on_val="1", off_val="0"),
)
self.add_parameter(
"IQ_state",
label="IQ Modulation",
get_cmd=":IQ:STAT?",
set_cmd=":IQ:STAT {}",
val_mapping=create_on_off_val_mapping(on_val="1", off_val="0"),
)
self.add_parameter(
"pulsemod_state",
label="Pulse Modulation",
get_cmd=":SOUR:PULM:STAT?",
set_cmd=":SOUR:PULM:STAT {}",
val_mapping=create_on_off_val_mapping(on_val="1", off_val="0"),
)
self.add_parameter(
"pulsemod_source",
label="Pulse Modulation Source",
get_cmd="SOUR:PULM:SOUR?",
set_cmd="SOUR:PULM:SOUR {}",
vals=vals.Enum("INT", "EXT", "int", "ext"),
)
self.add_parameter(
"ref_osc_source",
label="Reference Oscillator Source",
get_cmd="SOUR:ROSC:SOUR?",
set_cmd="SOUR:ROSC:SOUR {}",
vals=vals.Enum("INT", "EXT", "int", "ext"),
)
# Define LO source INT/EXT (Only with K-90 option)
self.add_parameter(
"LO_source",
label="Local Oscillator Source",
get_cmd="SOUR:LOSC:SOUR?",
set_cmd="SOUR:LOSC:SOUR {}",
vals=vals.Enum("INT", "EXT", "int", "ext"),
)
# Define output at REF/LO Output (Only with K-90 option)
self.add_parameter(
"ref_LO_out",
label="REF/LO Output",
get_cmd="CONN:REFL:OUTP?",
set_cmd="CONN:REFL:OUTP {}",
vals=vals.Enum("REF", "LO", "OFF", "ref", "lo", "off", "Off"),
)
# Frequency mw_source outputs when used as a reference
self.add_parameter(
"ref_osc_output_freq",
label="Reference Oscillator Output Frequency",
get_cmd="SOUR:ROSC:OUTP:FREQ?",
set_cmd="SOUR:ROSC:OUTP:FREQ {}",
vals=vals.Enum("10MHz", "100MHz", "1000MHz"),
)
# Frequency of the external reference mw_source uses
self.add_parameter(
"ref_osc_external_freq",
label="Reference Oscillator External Frequency",
get_cmd="SOUR:ROSC:EXT:FREQ?",
set_cmd="SOUR:ROSC:EXT:FREQ {}",
vals=vals.Enum("10MHz", "100MHz", "1000MHz"),
)
# IQ impairments
self.add_parameter(
"IQ_impairments",
label="IQ Impairments",
get_cmd=":SOUR:IQ:IMP:STAT?",
set_cmd=":SOUR:IQ:IMP:STAT {}",
val_mapping=create_on_off_val_mapping(on_val="1", off_val="0"),
)
self.add_parameter(
"I_offset",
label="I Offset",
get_cmd="SOUR:IQ:IMP:LEAK:I?",
set_cmd="SOUR:IQ:IMP:LEAK:I {:.2f}",
get_parser=float,
vals=vals.Numbers(-10, 10),
)
self.add_parameter(
"Q_offset",
label="Q Offset",
get_cmd="SOUR:IQ:IMP:LEAK:Q?",
set_cmd="SOUR:IQ:IMP:LEAK:Q {:.2f}",
get_parser=float,
vals=vals.Numbers(-10, 10),
)
self.add_parameter(
"IQ_gain_imbalance",
label="IQ Gain Imbalance",
get_cmd="SOUR:IQ:IMP:IQR?",
set_cmd="SOUR:IQ:IMP:IQR {:.2f}",
get_parser=float,
vals=vals.Numbers(-1, 1),
)
self.add_parameter(
"IQ_angle",
label="IQ Angle Offset",
get_cmd="SOUR:IQ:IMP:QUAD?",
set_cmd="SOUR:IQ:IMP:QUAD {:.2f}",
get_parser=float,
vals=vals.Numbers(-8, 8),
)
# Determines the signal at the input/output of the multi purpose [TRIG] connector.
self.add_parameter(
"trigger_connector_mode",
label="Trigger Connector Mode",
get_cmd="CONN:TRIG:OMOD?",
set_cmd="CONN:TRIG:OMOD {}",
vals=vals.Enum(
"SVAL", # SVALid - Signal valid
"SNVAL", # SNValid - Signal not valid
"PVO", # PVOut - Pulse video out (K22 Only)
"PET", # PETrigger - Pulse mod ext trigger - PETrigger (K22 Only)
"PEMS", # PEMSource - Pulse mode ext source (K22 Only)
"sval", # same as SVAL
"snval", # same as SNVAL
"pvo", # same as PVO
"pet", # same as PET
"pems", # same as PEMS
),
)
# Pulse modulator
self.add_parameter(
"pulsemod_delay",
label="Pulse delay",
unit="s",
get_cmd="SOUR:PULM:DEL?",
set_cmd="SOUR:PULM:DEL {:g}",
get_parser=float,
vals=vals.Numbers(0, 100),
)
self.add_parameter(
"pulsemod_double_delay",
label="Pulse double delay",
unit="s",
get_cmd="SOUR:PULM:DOUB:DEL?",
set_cmd="SOUR:PULM:DOUB:DEL {:g}",
get_parser=float,
vals=vals.Numbers(40e-9, 100),
)
self.add_parameter(
"pulsemod_double_width",
label="Double pulse second width",
unit="s",
get_cmd="SOUR:PULM:DOUB:WIDT?",
set_cmd="SOUR:PULM:DOUB:WIDT {:g}",
get_parser=float,
vals=vals.Numbers(20e-9, 100),
)
self.add_parameter(
"pulsemod_mode",
label="Pulse modulation mode",
get_cmd="SOUR:PULM:MODE?",
set_cmd="SOUR:PULM:MODE {}",
vals=vals.Enum("SING", "DOUB", "sing", "doub", "single", "double"),
)
self.add_parameter(
"pulsemod_period",
label="Pulse mode period",
unit="s",
get_cmd="SOUR:PULM:PER?",
set_cmd="SOUR:PULM:PER {:g}",
get_parser=float,
vals=vals.Numbers(100e-9, 100),
)
self.add_parameter(
"pulsemod_polarity",
label="Pulse modulator signal polarity",
get_cmd="SOUR:PULM:POL?",
set_cmd="SOUR:PULM:POL {}",
vals=vals.Enum("NORM", "INV", "norm", "inv", "normal", "inverted"),
)
self.add_parameter(
"pulsemod_trig_ext_gate_polarity",
label="Polarity of the Gate signal",
get_cmd="SOUR:PULM:TRIG:EXT:GATE:POL?",
set_cmd="SOUR:PULM:TRIG:EXT:GATE:POL {}",
vals=vals.Enum("NORM", "INV", "norm", "inv", "normal", "inverted"),
)
self.add_parameter(
"pulsemod_trig_ext_impedance",
label="Impedance of the external pulse trigger",
get_cmd="SOUR:PULM:TRIG:EXT:IMP?",
set_cmd="SOUR:PULM:TRIG:EXT:IMP {}",
vals=vals.Enum("G50", "G10K"),
)
# Sets the polarity of the active slope of an externally applied trigger signal.
self.add_parameter(
"pulsemod_trig_ext_slope",
label="external pulse trigger active slope",
get_cmd="SOUR:PULM:TRIG:EXT:SLOP?",
set_cmd="SOUR:PULM:TRIG:EXT:SLOP {}",
vals=vals.Enum("NEG", "POS", "neg", "pos", "negative", "positive"),
)
self.add_parameter(
"pulsemod_trig_mode",
label="external pulse trigger active slope",
get_cmd="SOUR:PULM:TRIG:MODE?",
set_cmd="SOUR:PULM:TRIG:MODE {}",
vals=vals.Enum(
"AUTO", "EXT", "EGAT", "auto", "ext", "egat", "external", "egate"
),
)
self.add_parameter(
"pulsemod_width",
label="Pulse width",
unit="s",
get_cmd="SOUR:PULM:WIDT?",
set_cmd="SOUR:PULM:WIDT {:g}",
get_parser=float,
vals=vals.Numbers(20e-9, 100),
)
self.add_function("reset", call_cmd="*RST")
self.add_function("run_self_tests", call_cmd="*TST?")
self.connect_message()
[docs]
def on(self) -> None:
self.status("on")
[docs]
def off(self) -> None:
self.status("off")
class RohdeSchwarz_SGS100A(RohdeSchwarzSGS100A):
pass