def update_monitor():
if ((self.use_monitor is None and get_config_use_monitor())
or self.use_monitor):
# restart Monitor
Monitor(*self._monitor_parameters)
def load_instrument(self, identifier: str,
**kwargs) -> Instrument:
"""
Creates an instrument driver as described by the loaded config file.
Args:
identifier: the identfying string that is looked up in the yaml
configuration file, which identifies the instrument to be added
**kwargs: additional keyword arguments that get passed on to the
__init__-method of the instrument to be added.
"""
# load file
self.load_file(self.filename)
# load from config
if identifier not in self._instrument_config.keys():
raise RuntimeError('Instrument {} not found in config.'
.format(identifier))
instr_cfg = self._instrument_config[identifier]
# config is not parsed for errors. On errors qcodes should be able to
# to report them
# check if instrument is already defined and close connection
if instr_cfg.get('enable_forced_reconnect',
enable_forced_reconnect):
# save close instrument and remove from monitor list
with suppress(KeyError):
instr = Instrument.find_instrument(identifier)
# remove parameters related to this instrument from the monitor list
self.monitor_parameters = {k:v for k,v in self.monitor_parameters.items() if v.root_instrument is not instr}
instr.close()
# remove instrument from station snapshot
self.station.components.pop(instr.name)
# instantiate instrument
module = importlib.import_module(instr_cfg['driver'])
instr_class = getattr(module, instr_cfg['type'])
init_kwargs = instr_cfg.get('init',{})
# somebody might have a empty init section in the config
init_kwargs = {} if init_kwargs is None else init_kwargs
if 'address' in instr_cfg:
init_kwargs['address'] = instr_cfg['address']
if 'port' in instr_cfg:
init_kwargs['port'] = instr_cfg['port']
# make explicitly passed arguments overide the ones from the config file
# the intuitive line:
# We are mutating the dict below
# so make a copy to ensure that any changes
# does not leek into the station config object
# specifically we may be passing non pickleable
# instrument instances via kwargs
instr_kwargs = deepcopy(init_kwargs)
instr_kwargs.update(kwargs)
instr = instr_class(name=identifier, **instr_kwargs)
# setup
# local function to refactor common code from defining new parameter
# and setting existing one
def setup_parameter_from_dict(parameter, options_dict):
for attr, val in options_dict.items():
if attr in self.PARAMETER_ATTRIBUTES:
# set the attributes of the parameter, that map 1 to 1
setattr(parameter, attr, val)
# extra attributes that need parsing
elif attr == 'limits':
lower, upper = [float(x) for x in val.split(',')]
parameter.vals = validators.Numbers(lower, upper)
elif attr == 'monitor' and val is True:
self.monitor_parameters[id(parameter)] = parameter
elif attr == 'alias':
setattr(instr, val, parameter)
elif attr == 'initial_value':
# skip value attribute so that it gets set last
# when everything else has been set up
pass
else:
log.warning(f'Attribute {attr} no recognized when'
f' instatiating parameter \"{parameter.name}\"')
if 'initial_value' in options_dict:
parameter.set(options_dict['initial_value'])
# setup existing parameters
for name, options in instr_cfg.get('parameters', {}).items():
# get the parameter object from its name:
p = instr
for level in name.split('.'):
p = getattr(p, level)
setup_parameter_from_dict(p, options)
# setup new parameters
for name, options in instr_cfg.get('add_parameters', {}).items():
# allow only top level paremeters for now
# pop source only temporarily
source = options.pop('source', False)
if source:
source_p = instr
for level in source.split('.'):
source_p = getattr(source_p, level)
instr.add_parameter(name,
DelegateParameter,
source=source_p)
else:
instr.add_parameter(name, Parameter)
p = getattr(instr, name)
setup_parameter_from_dict(p, options)
# restore source
options['source'] = source
# add the instrument to the station
self.station.add_component(instr)
# restart Monitor
Monitor(*self.monitor_parameters.values())
return instr