from typing import TYPE_CHECKING
from qcodes import validators as vals
from qcodes.instrument import (
ChannelList,
InstrumentBaseKWArgs,
InstrumentChannel,
VisaInstrument,
VisaInstrumentKWArgs,
)
if TYPE_CHECKING:
from collections.abc import Sequence
from typing_extensions import Unpack
from qcodes.parameters import Parameter
class RigolDP8xxChannel(InstrumentChannel):
def __init__(
self,
parent: "RigolDP8xxBase",
name: str,
channel: int,
ch_range: tuple[float, float],
ovp_range: tuple[float, float],
ocp_range: tuple[float, float],
**kwargs: "Unpack[InstrumentBaseKWArgs]",
):
super().__init__(parent, name, **kwargs)
self.vmax = ch_range[0]
self.imax = ch_range[1]
self.ovp_range = ovp_range
self.ocp_range = ocp_range
select_cmd = f":INSTrument:NSELect {channel};"
def strstrip(s: str) -> str:
return str(s).strip()
self.set_voltage: Parameter = self.add_parameter(
"set_voltage",
label="Target voltage output",
set_cmd="{} :SOURce:VOLTage:LEVel:IMMediate:AMPLitude {}".format(
select_cmd, "{}"
),
get_cmd=f"{select_cmd} :SOURce:VOLTage:LEVel:IMMediate:AMPLitude?",
get_parser=float,
unit="V",
vals=vals.Numbers(min(0, self.vmax), max(0, self.vmax)),
)
"""Parameter set_voltage"""
self.set_current: Parameter = self.add_parameter(
"set_current",
label="Target current output",
set_cmd="{} :SOURce:CURRent:LEVel:IMMediate:AMPLitude {}".format(
select_cmd, "{}"
),
get_cmd=f"{select_cmd} :SOURce:CURRent:LEVel:IMMediate:AMPLitude?",
get_parser=float,
unit="A",
vals=vals.Numbers(0, self.imax),
)
"""Parameter set_current"""
self.state: Parameter = self.add_parameter(
"state",
label="Output enabled",
set_cmd="{} :OUTPut:STATe {}".format(select_cmd, "{}"),
get_cmd=f"{select_cmd} :OUTPut:STATe?",
get_parser=strstrip,
vals=vals.OnOff(),
)
"""Parameter state"""
self.mode: Parameter = self.add_parameter(
"mode",
label="Get the output mode",
get_cmd=f"{select_cmd} :OUTPut:MODE?",
get_parser=strstrip,
val_mapping={
"ConstantVoltage": "CV",
"ConstantCurrent": "CC",
"Unregulated": "UR",
},
)
"""Parameter mode"""
self.voltage: Parameter = self.add_parameter(
"voltage",
label="Measured voltage",
get_cmd=f"{select_cmd} :MEASure:VOLTage:DC?",
get_parser=float,
unit="V",
)
"""Parameter voltage"""
self.current: Parameter = self.add_parameter(
"current",
label="Measured current",
get_cmd=f"{select_cmd} :MEASure:CURRent:DC?",
get_parser=float,
unit="A",
)
"""Parameter current"""
self.power: Parameter = self.add_parameter(
"power",
label="Measured power",
get_cmd=f"{select_cmd} :MEASure:POWer?",
get_parser=float,
unit="W",
)
"""Parameter power"""
self.ovp_value: Parameter = self.add_parameter(
"ovp_value",
label="Over Voltage Protection value",
set_cmd="{} :VOLTage:PROTection:LEVel {}".format(select_cmd, "{}"),
get_cmd=f"{select_cmd} :VOLTage:PROTection:LEVel?",
get_parser=float,
unit="V",
vals=vals.Numbers(self.ovp_range[0], self.ovp_range[1]),
)
"""Parameter ovp_value"""
self.ovp_state: Parameter = self.add_parameter(
"ovp_state",
label="Over Voltage Protection status",
set_cmd="{} :VOLTage:PROTection:STATe {}".format(select_cmd, "{}"),
get_cmd=f"{select_cmd} :VOLTage:PROTection:STATe?",
get_parser=strstrip,
vals=vals.OnOff(),
)
"""Parameter ovp_state"""
self.ocp_value: Parameter = self.add_parameter(
"ocp_value",
label="Over Current Protection value",
set_cmd="{} :CURRent:PROTection:LEVel {}".format(select_cmd, "{}"),
get_cmd=f"{select_cmd} :CURRent:PROTection:LEVel?",
get_parser=float,
unit="A",
vals=vals.Numbers(self.ocp_range[0], self.ocp_range[1]),
)
"""Parameter ocp_value"""
self.ocp_state: Parameter = self.add_parameter(
"ocp_state",
label="Over Current Protection status",
set_cmd="{} :CURRent:PROTection:STATe {}".format(select_cmd, "{}"),
get_cmd=f"{select_cmd} :CURRent:PROTection:STATe?",
get_parser=strstrip,
vals=vals.OnOff(),
)
"""Parameter ocp_state"""
[docs]
class RigolDP8xxBase(VisaInstrument):
"""
This is the general DP8xx Power Supply driver class that implements shared parameters and functionality
among all similar power supply from Rigol.
This driver was written to be inherited from by a specific driver (e.g. RigolDP832). This baseClass should not
be instantiated directly.
"""
def __init__(
self,
name: str,
address: str,
channels_ranges: "Sequence[tuple[float, float]]",
ovp_ranges: tuple[
"Sequence[tuple[float, float]]", "Sequence[tuple[float, float]]"
],
ocp_ranges: tuple[
"Sequence[tuple[float, float]]", "Sequence[tuple[float, float]]"
],
**kwargs: "Unpack[VisaInstrumentKWArgs]",
):
super().__init__(name, address, **kwargs)
# Check if precision extension has been installed
opt = self.installed_options()
if "DP8-ACCURACY" in opt:
ovp_ranges_selected = ovp_ranges[1]
ocp_ranges_selected = ocp_ranges[1]
else:
ovp_ranges_selected = ovp_ranges[0]
ocp_ranges_selected = ocp_ranges[0]
# channel-specific parameters
channels = ChannelList(
self, "SupplyChannel", RigolDP8xxChannel, snapshotable=False
)
for ch_num, channel_range in enumerate(channels_ranges):
ch_name = f"ch{ch_num + 1}"
channel = RigolDP8xxChannel(
self,
ch_name,
ch_num + 1,
channel_range,
ovp_ranges_selected[ch_num],
ocp_ranges_selected[ch_num],
)
channels.append(channel)
self.add_submodule(ch_name, channel)
self.add_submodule("channels", channels.to_channel_tuple())
self.connect_message()
[docs]
def installed_options(self) -> list[str]:
"""Return the installed options"""
opt = self.ask("*OPT?")
optl = opt.strip().split(",")
optl_clean = [x for x in optl if x != "0"]
return optl_clean