Device Settings Module

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

In general, users are recommended to use the utility functions provided by the APIs instead of using the Device Settings module directly. The Matlab API provides ziSaveSettings() and ziLoadSettings() and the Python API provides zhinst.utils.save_settings() and zhinst.utils.load_settings. These are convenient wrappers to the Device Settings module for loading settings synchronously, i.e., these functions block until loading or saving has completed, the desired behavior in most cases. Advanced users can use the Device Settings module directly if they need to implement loading or saving asynchronously (non-blocking).

Device Settings Module Node Tree

The following section contains reference documentation for the settings and measurement data available on the device settings module.

Since these settings and data streams may be written and read using the LabOne APIs (Application Programming Interfaces) this section is of particular interest to users who would like to perform measurements programmatically via LabVIEW, Python, MATLAB, .NET or C.

command

/command

Properties:

Read, Write

Type:

String

Unit:

None

The command to execute: 'save' = Read device settings and save to file; 'load' = Load settings from file an write to device; 'read' = Read device settings only (no save).

device

/device

Properties:

Read, Write

Type:

String

Unit:

None

Comma separated list of devices that should be used for loading/saving device settings, e.g. 'dev99,dev100'.

errortext

/errortext

Properties:

Read

Type:

String

Unit:

None

The error text used in error messages.

filename

/filename

Properties:

Read, Write

Type:

String

Unit:

None

Name of settings file to use.

finished

/finished

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The status of the command.

path

/path

Properties:

Read, Write

Type:

String

Unit:

None

Directory where settings files should be located. If not set, the default settings location of the LabOne software is used.

throwonerror

/throwonerror

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Throw an exception is there was error executing the command.