load_settings#

load_settings(daq: ziDAQServer, device: str, filename: str) → None[source]#

Load a LabOne settings file to the specified device.

This function is synchronous; it will block until loading the settings has finished.

Parameters:

  • daq (ziDAQServer) – A ziPython API session.

  • device (str) – The device ID specifying where to load the settings,

  • e.g. –

  • 'dev123'. –

  • filename (str) – The filename of the xml settings file to load. The filename can

  • path. (include a relative or full) –

Raises:

RuntimeError – If loading the settings times out.

Return type:

None

Examples

>>> import zhinst.utils as utils
>>> daq = utils.autoConnect()
>>> dev = utils.autoDetect(daq)
>>> # Then, e.g., load settings from a file in the current directory:
>>> utils.load_settings(daq, dev, 'my_settings.xml')
>>> # Then, e.g., load settings from the default LabOne settings path:
>>> filename = 'default_ui.xml'
>>> path = utils.get_default_settings_path(daq)
>>> utils.load_settings(daq, dev, path + os.sep + filename)