ZIDeviceSettingsModule#

class ZIDeviceSettingsModule(*args: Any, **kwargs: Any)[source]#

Bases: ZIBaseModule

Implements the device settings module for storing and loading settings.

The Device Settings Module provides functionality for saving and loading device settings to and from file. The file is saved in XML format.

For simple save and load two helper functions exist save_to_file and load_from_file.

Note: It is not recommend to use this function to read the

device settings. Instead one can use the zhinst-toolkit functionality to read all settings from a device/subtree from the device directly by calling it.

For a complete documentation see the LabOne user manual https://docs.zhinst.com/labone_programming_manual/device_settings_module.html

Parameters:

  • tk_object – Underlying zhinst-toolkit object.

  • session – Session to the Data Server.

  • name – Name of the module in QCoDeS.

  • args (Any)

  • kwargs (Any)

Return type:

Any

Methods

load_from_file(filename, device[, timeout])

Load a LabOne settings file to a device.

read()

Read device settings.

save_to_file(filename, device[, timeout])

Save the device settings to a LabOne settings file.

Attributes