import warnings
from typing import Any, Optional, Union
import numpy as np
import qcodes.validators as vals
from qcodes.instrument import VisaInstrument
from qcodes.parameters import create_on_off_val_mapping
[docs]class Agilent_E8527D(VisaInstrument):
"""
This is the QCoDeS driver for the Agilent_E8527D signal generator.
This driver will most likely work for multiple Agilent sources.
This driver does not contain all commands available for the E8527D but
only the ones most commonly used.
"""
def __init__(self, name: str, address: str,
step_attenuator: Optional[bool] = None,
terminator: str = '\n',
**kwargs: Any) -> None:
super().__init__(name, address, terminator=terminator, **kwargs)
if step_attenuator is not None:
warnings.warn("step_attenuator argument to E8527D is deprecated "
"and has no effect. It will be removed in the "
"future.")
# Query installed options
self._options = self.ask_raw('DIAG:CPU:INFO:OPT:DET?')
# Determine installed frequency option
frequency_option = None
for f_option in ['513', '520', '521', '532', '540', '550', '567']:
if f_option in self._options:
frequency_option = f_option
if frequency_option is None:
raise RuntimeError('Could not determine the frequency option')
# convert installed frequency option to frequency ranges, based on:
# https://www.keysight.com/us/en/assets/7018-01233/configuration-guides
# /5989-1325.pdf
# the frequency range here is the max range and not the specified
# (calibrated) one
f_options_dict = {
"513": (100e3, 13e9),
"520": (100e3, 20e9),
"521": (10e6, 20e9),
"532": (100e3, 31.8e9),
"540": (100e3, 40e9),
"550": (100e3, 50e9),
"567": (100e3, 70e9)
}
# assign min and max frequencies
self._min_freq: float
self._max_freq: float
self._min_freq, self._max_freq = f_options_dict[frequency_option]
# Based on installed frequency option and presence/absence of step
# attenuator (option '1E1') determine power range based on:
# https://www.keysight.com/us/en/assets/7018-01211/data-sheets
# /5989-0698.pdf
# assign min and max powers
self._min_power: float
self._max_power: float
if '1E1' in self._options:
if frequency_option in ['513', '520', '521', '532', '540']:
self._min_power = -135
self._max_power = 10
else:
self._min_power = -110
self._max_power = 5
else:
# default minimal power is -20 dBm
if frequency_option in ['513', '520', '521', '532', '540']:
self._min_power = -20
self._max_power = 10
else:
self._min_power = -20
self._max_power = 5
self.add_parameter(name='frequency',
label='Frequency',
unit='Hz',
get_cmd='FREQ:CW?',
set_cmd='FREQ:CW' + ' {:.4f}',
get_parser=float,
set_parser=float,
vals=vals.Numbers(self._min_freq, self._max_freq))
self.add_parameter(name='phase',
label='Phase',
unit='deg',
get_cmd='PHASE?',
set_cmd='PHASE' + ' {:.8f}',
get_parser=self.rad_to_deg,
set_parser=self.deg_to_rad,
vals=vals.Numbers(-180, 180))
self.add_parameter(name='power',
label='Power',
unit='dBm',
get_cmd='POW:AMPL?',
set_cmd='POW:AMPL' + ' {:.4f}',
get_parser=float,
set_parser=float,
vals=vals.Numbers(self._min_power, self._max_power))
self.add_parameter('status',
get_cmd=':OUTP?',
set_cmd='OUTP {}',
val_mapping=create_on_off_val_mapping(on_val='1',
off_val='0'))
self.connect_message()
# Note it would be useful to have functions like this in some module instead
# of repeated in every instrument driver.
[docs] @staticmethod
def rad_to_deg(angle_rad: Union[float, np.floating, np.integer]) -> float:
angle_deg = float(angle_rad) / (2 * np.pi) * 360
return angle_deg
[docs] @staticmethod
def deg_to_rad(angle_deg: Union[float, np.floating, np.integer]) -> float:
angle_rad = float(angle_deg) / 360 * 2 * np.pi
return angle_rad
[docs] def on(self) -> None:
self.set('status', 'on')
[docs] def off(self) -> None:
self.set('status', 'off')