Device Node Tree

This chapter contains reference documentation for the settings and measurement data available on MFLI Instruments. Whilst Functional Description LabOne User Interface describes many of these settings in terms of the features available in the LabOne User Interface, this chapter describes them on the device level and provides a hierarchically organized and comprehensive list of device functionality.

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

Please see:

  • Introduction for an introduction of how the instrument’s settings and measurement data are organized hierarchically in the Data Server’s so-called "Node Tree".

  • Reference Node Documentation for a reference list of the settings and measurement data available on MFLI Instruments, organized by branch in the Node Tree.

Introduction

This section provides an overview of how an instrument’s configuration and output is organized by the Data Server.

All communication with an instrument occurs via the Data Server program the instrument is connected to (see LabOne Software Architecture for an overview of LabOne’s software components). Although the instrument’s settings are stored locally on the device, it is the Data Server’s task to ensure it maintains the values of the current settings and makes these settings (and any subscribed data) available to all its current clients. A client may be the LabOne User Interface or a user’s own program implemented using one of the LabOne Application Programming Interfaces, e.g., Python.

The instrument’s settings and data are organized by the Data Server in a file-system-like hierarchical structure called the node tree. When an instrument is connected to a Data Server, it’s device ID becomes a top-level branch in the Data Server’s node tree. The features of the instrument are organized as branches underneath the top-level device branch and the individual instrument settings are leaves of these branches.

For example, the auxiliary outputs of the instrument with device ID "dev2006" are located in the tree in the branch:

/DEV2006/AUXOUTS/

In turn, each individual auxiliary output channel has it’s own branch underneath the "AUXOUTS" branch.

/DEV2006/AUXOUTS/0/
/DEV2006/AUXOUTS/1/
/DEV2006/AUXOUTS/2/
/DEV2006/AUXOUTS/3/

Whilst the auxiliary outputs and other channels are labelled on the instrument’s panels and the User Interface using 1-based indexing, the Data Server’s node tree uses 0-based indexing. Individual settings (and data) of an auxiliary output are available as leaves underneath the corresponding channel’s branch:

/DEV2006/AUXOUTS/0/DEMODSELECT
/DEV2006/AUXOUTS/0/LIMITLOWER
/DEV2006/AUXOUTS/0/LIMITUPPER
/DEV2006/AUXOUTS/0/OFFSET
/DEV2006/AUXOUTS/0/OUTPUTSELECT
/DEV2006/AUXOUTS/0/PREOFFSET
/DEV2006/AUXOUTS/0/SCALE
/DEV2006/AUXOUTS/0/VALUE

These are all individual node paths in the node tree; the lowest-level nodes which represent a single instrument setting or data stream. Whether the node is an instrument setting or data-stream and which type of data it contains or provides is well-defined and documented on a per-node basis in the Reference Node Documentation section in the relevant instrument-specific user manual. The different properties and types are explained in Node Properties and Data Types .

For instrument settings, a Data Server client modifies the node’s value by specifying the appropriate path and a value to the Data Server as a (path, value) pair. When an instrument’s setting is changed in the LabOne User Interface, the path and the value of the node that was changed are displayed in the Status Bar in the bottom of the Window. This is described in more detail in Node Properties and Data Types.

Module Parameters

LabOne Core Modules, such as the Sweeper, also use a similar tree-like structure to organize their parameters. Please note, however, that module nodes are not visible in the Data Server’s node tree; they are local to the instance of the module created in a LabOne client and are not synchronized between clients.

Node Properties and Data Types

A node may have one or more of the following properties:

Read

Data can be read from the node.

Write

Data can be written to the node.

Setting

A node with write attribute corresponding to an instrument configuration. The data in these nodes will be saved to and loaded from LabOne XML settings files.

Streaming

A node with the read attribute that provides instrument data, typically at a user-configured rate. The data is usually a more complex data type, for example demodulator data is returned as ZIDemodSample. A full list of streaming nodes is available in the Programming Manual in the Chapter Instrument Communication Their availability depends on the device class (e.g. MF) and the option set installed on the device.

A node may contain data of the following types:

Integer

Integer data.

Double

Double precision floating point data.

String

A string array.

Enumerated (integer)

As for Integer, but the node only allows certain values.

Composite data type

For example, ZIDemodSample. These custom data types are structures whose fields contain the instrument output, a timestamp and other relevant instrument settings such as the demodulator oscillator frequency. Documentation of custom data types is available in

Exploring the Node Tree

In the LabOne User Interface

A convenient method to learn which node is responsible for a specific instrument setting is to check the Command Log history in the bottom of the LabOne User Interface. The command in the Status Bar gets updated every time a configuration change is made. Figure 1 shows how the equivalent Matlab command is displayed after modifying the value of the auxiliary output 1’s offset. The format of the LabOne UI’s command history can be configured in the Config Tab (Matlab, Python and .NET are available). The entire history generated in the current UI session can be viewed by clicking the "Show Log" button.

NodeTreeDescription LabOneUILogStatusBar
Figure 1. When a device’s configuration is modified in the LabOne User Interface, the Status Bar displays the equivalent command to perform the same configuration via a LabOne programming interface. Here, the Matlab code to modify auxiliary output 1’s offset value is provided. When "Show Log" is clicked the entire configuration history is displayed in a new browser tab.
In a LabOne Programming Interface

A list of nodes (under a specific branch) can be requested from the Data Server in an API client using the listNodes command (Matlab, Python, .NET) or ziAPIListNodes() function (C API). Please see each API’s command reference for more help using the listNodes command. To obtain a list of all the nodes that provide data from an instrument at a high rate, so-called streaming nodes, the streamingonly flag can be provided to listNodes. More information on data streaming and streaming nodes is available in the LabOne Programming Manual).

The detailed descriptions of nodes that is provided in Reference Node Documentation is accessible directly in the LabOne Matlab or Python programming interfaces using the "help" command. The help command is daq.help(path) in Python and ziDAQ('help', path) in Matlab. The command returns a description of the instrument node including access properties, data type, units and available options. The "help" command also handles wildcards to return a detailed description of all nodes matching the path. An example is provided below.

daq = zhinst.ziPython.ziDAQServer('localhost', 8004, 6)
daq.help('/dev2006/auxouts/0/offset')
# Out:
# /DEV2006/AUXOUTS/0/OFFSET#
# Add the specified offset voltage to the signal after scaling. Auxiliary Output
# Value = (Signal+Preoffset)*Scale + Offset
# Properties: Read, Write, Setting
# Type: Double
# Unit: V

Data Server Nodes

The Data Server has nodes in the node tree available under the top-level /ZI/ branch. These nodes give information about the version and state of the Data Server the client is connected to. For example, the nodes:

  • /ZI/ABOUT/VERSION

  • /ZI/ABOUT/REVISION

are read-only nodes that contain information about the release version and revision of the Data Server. The nodes under the /ZI/DEVICES/ list which devices are connected, discoverable and visible to the Data Server.

The nodes:

  • /ZI/CONFIG/OPEN

  • /ZI/CONFIG/PORT

are settings nodes that can be used to configure which port the Data Server listens to for incoming client connections and whether it may accept connections from clients on hosts other than the localhost.

Nodes that are of particular use to programmers are:

  • /ZI/DEBUG/LOGPATH - the location of the Data Server’s log in the PC’s file system,

  • /ZI/DEBUG/LEVEL - the current log-level of the Data Server (configurable; has the Write attribute),

  • /ZI/DEBUG/LOG - the last Data Server log entries as a string array.

For documentation of all Data Server nodes see the /ZI/ section in the Reference Node Documentation section in the instrument-specific user manual.

Reference Node Documentation

This section describes all the nodes in the data server’s node tree organized by branch.See Node Properties and Data Types for an explanation of node properties and types.

AUXINS

/DEV…​./AUXINS/n/AVERAGING

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Defines the number of samples on the input to average as a power of two. Possible values are in the range [0, 16]. A value of 0 corresponds to the sampling rate of the auxiliary input’s ADC.

/DEV…​./AUXINS/n/SAMPLE

Properties:

Read, Stream

Type:

ZIAuxInSample

Unit:

V

Voltage measured at the Auxiliary Input after averaging. The data rate depends on the averaging value. Note, if the instrument has demodulator functionality, the auxiliary input values are available as fields in a demodulator sample and are aligned by timestamp with the demodulator output.

/DEV…​./AUXINS/n/VALUES/n

Properties:

Read

Type:

Double

Unit:

V

Voltage measured at the Auxiliary Input after averaging. The value of this node is updated at a low rate (50 Hz); the streaming node auxins/n/sample is updated at a high rate defined by the averaging.

AUXOUTS

/DEV…​./AUXOUTS/n/DEMODSELECT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Select the channel number of the selected signal source.

/DEV…​./AUXOUTS/n/LIMITLOWER

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Lower limit for the signal at the Auxiliary Output. A smaller value will be clipped.

/DEV…​./AUXOUTS/n/LIMITUPPER

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Upper limit for the signal at the Auxiliary Output. A larger value will be clipped.

/DEV…​./AUXOUTS/n/OFFSET

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Add the specified offset voltage to the signal after scaling. Auxiliary Output Value = (Signal+Preoffset)*Scale + Offset

/DEV…​./AUXOUTS/n/OUTPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal source to be represented on the Auxiliary Output.

-1

manual

Select Manual as the output option.

0

demod_x

Select Demod X as the output option.

1

demod_y

Select Demod Y as the output option.

2

demod_r

Select Demod R as the output option.

3

demod_theta

Select Demod Theta as the output option.

5

pid

Select PID Out as the output option.

9

pid_shift

Select PID Shift as the output option.

10

pid_error

Select PID Error as the output option.

11

tu_filtered

Select TU Filtered Value as the output option.

13

tu_output

Select TU Output Value as the output option.

/DEV…​./AUXOUTS/n/PREOFFSET

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Add a pre-offset to the signal before scaling is applied. Auxiliary Output Value = (Signal+Preoffset)*Scale + Offset

/DEV…​./AUXOUTS/n/SCALE

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Multiplication factor to scale the signal. Auxiliary Output Value = (Signal+Preoffset)*Scale + Offset

/DEV…​./AUXOUTS/n/VALUE

Properties:

Read

Type:

Double

Unit:

V

Voltage present on the Auxiliary Output. Auxiliary Output Value = (Signal+Preoffset)*Scale + Offset

CLOCKBASE

/DEV…​./CLOCKBASE

Properties:

Read

Type:

Double

Unit:

Hz

Returns the internal clock frequency of the device.

CURRINS

/DEV…​./CURRINS/n/AUTORANGE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Automatic adjustment of the Range to about two times the maximum current input amplitude measured over about 100 ms.

/DEV…​./CURRINS/n/FLOAT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Switches the input between floating (ON) and connected grounds (OFF). This setting applies both to the voltage and the current input. It is recommended to discharge the test device before connecting or to enable this setting only after the signal source has been connected to the Signal Input in grounded mode.

0

off

OFF: GND connected

1

on

ON: Floating

/DEV…​./CURRINS/n/MAX

Properties:

Read, Write

Type:

Double

Unit:

None

Gives the maximum measured input current (peak value) normalized to input range.

/DEV…​./CURRINS/n/MIN

Properties:

Read, Write

Type:

Double

Unit:

None

Gives the minimum measured input current (peak value) normalized to input range.

/DEV…​./CURRINS/n/ON

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the current input.

/DEV…​./CURRINS/n/RANGE

Properties:

Read, Write, Setting

Type:

Double

Unit:

A

Defines the gain of the current input amplifier. The range should exceed the incoming signal by roughly a factor of two including a potential DC offset. The instrument selects the next higher available range relative to a value inserted by the user. A suitable choice of this setting optimizes the accuracy and signal-to-noise ratio by ensuring that the full dynamic range of the input ADC is used.

/DEV…​./CURRINS/n/SCALING

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Applies the given scale factor to the current input.

/DEV…​./CURRINS/n/RANGESTEP/TRIGGER

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Switches to the next appropriate input range such that the range fits best with the measured input current.

DEMODS

/DEV…​./DEMODS/n/ADCSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the input signal for the demodulator.

0

sigin0, signal_input0

Sig In 1

1

currin0, current_input0

Curr In 1

2

trigin0, trigger_input0

Trigger Input 1

3

trigin1, trigger_input1

Trigger Input 2

4

auxout0, auxiliary_output0

Aux Out 1

5

auxout1, auxiliary_output1

Aux Out 2

6

auxout2, auxiliary_output2

Aux Out 3

7

auxout3, auxiliary_output3

Aux Out 4

8

auxin0, auxiliary_input0

Aux In 1

9

auxin1, auxiliary_input1

Aux In 2

174

demod_constant_input

Demodulate a constant input. This results in a sine wave of the frequency specified by the demodulator’s oscillator with an amplitude of 1 (at lower frequencies; higher frequencies will be attenuated). The maximum possible frequency is limited by the demodulator sampling rate and bandwidth; use demodulator order 1 for the least attenuation in demodulator output. This signal may be used with the auxiliary outputs, PID and Threshold Unit for advanced measurement and control tasks. When the demodulator output is written to an auxiliary output, the resulting signal can also be used as a second output channel (for low frequencies).

/DEV…​./DEMODS/n/BYPASS

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Allows to bypass the demodulator low-pass filter, thus increasing the bandwidth.

/DEV…​./DEMODS/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Enables the data acquisition for the corresponding demodulator. Note: increasing number of active demodulators increases load on the physical connection to the host computer.

0

off

OFF: demodulator inactive

1

on

ON: demodulator active

/DEV…​./DEMODS/n/FREQ

Properties:

Read

Type:

Double

Unit:

Hz

Indicates the frequency used for demodulation and for output generation. The demodulation frequency is calculated with oscillator frequency times the harmonic factor. When the MOD option is used linear combinations of oscillator frequencies including the harmonic factors define the demodulation frequencies.

/DEV…​./DEMODS/n/HARMONIC

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Multiplies the demodulator’s reference frequency by an integer factor. If the demodulator is used as a phase detector in external reference mode (PLL), the effect is that the internal oscillator locks to the external frequency divided by the integer factor.

/DEV…​./DEMODS/n/ORDER

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the filter roll off between 6 dB/oct and 48 dB/oct.

1

1st order filter 6 dB/oct

2

2nd order filter 12 dB/oct

3

3rd order filter 18 dB/oct

4

4th order filter 24 dB/oct

5

5th order filter 30 dB/oct

6

6th order filter 36 dB/oct

7

7th order filter 42 dB/oct

8

8th order filter 48 dB/oct

/DEV…​./DEMODS/n/OSCSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Connects the demodulator with the supplied oscillator. Number of available oscillators depends on the installed options.

0

Oscillator 1

1

Oscillator 2

2

Oscillator 3

3

Oscillator 4

/DEV…​./DEMODS/n/PHASEADJUST

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Adjust the demodulator phase automatically in order to read 0 degrees.

/DEV…​./DEMODS/n/PHASESHIFT

Properties:

Read, Write, Setting

Type:

Double

Unit:

deg

Phase shift applied to the reference input of the demodulator.

/DEV…​./DEMODS/n/RATE

Properties:

Read, Write, Setting

Type:

Double

Unit:

1/s

Defines the demodulator sampling rate, the number of samples that are sent to the host computer per second. A rate of about 7-10 higher as compared to the filter bandwidth usually provides sufficient aliasing suppression. This is also the rate of data received by LabOne Data Server and saved to the computer hard disk. This setting has no impact on the sample rate on the auxiliary outputs connectors. Note: the value inserted by the user may be approximated to the nearest value supported by the instrument.

/DEV…​./DEMODS/n/SAMPLE

Properties:

Read, Stream

Type:

ZIDemodSample

Unit:

Dependent

Contains streamed demodulator samples with sample interval defined by the demodulator data rate.

/DEV…​./DEMODS/n/SINC

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the sinc filter. When the filter bandwidth is comparable to or larger than the demodulation frequency, the demodulator output may contain frequency components at the frequency of demodulation and its higher harmonics. The sinc is an additional filter that attenuates these unwanted components in the demodulator output.

/DEV…​./DEMODS/n/TIMECONSTANT

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Sets the integration time constant or in other words, the cutoff frequency of the demodulator low pass filter.

/DEV…​./DEMODS/n/TRIGGER

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the acquisition mode (i.e. triggering) or the demodulator.

0

continuous

Continuous: demodulator data is continuously streamed to the host computer.

1

trigin0_rising, trigger_input0_rising

Trigger Input 1: rising edge triggered.

2

trigin0_falling, trigger_input0_falling

Trigger Input 1: falling edge triggered.

3

trigin0_both, trigger_input0_both

Trigger Input 1: triggering on both rising and falling edge.

4

trigin1_rising, trigger_input1_rising

Trigger Input 2: rising edge triggered.

5

trigin0or1_rising, trigger_input0or1_rising

Trigger Input 1 or 2: rising edge triggered on either input.

8

trigin1_falling, trigger_input1_falling

Trigger Input 2: falling edge triggered.

10

trigin0or1_falling, trigger_input0or1_falling

Trigger Input 1 or 2: falling edge triggered on either input.

12

trigin1_both, trigger_input1_both

Trigger Input 2: triggering on both rising and falling edge.

15

trigin0or1_both, trigger_input0or1_both

Trigger Input 1 or 2: triggering on both rising and falling edge or either trigger input.

16

trigin0_low, trigger_input0_low

Trigger Input 1: demodulator data is streamed to the host computer when the level is low (TTL).

32

trigin0_high, trigger_input0_high

Trigger Input 1 for MF: demodulator data is streamed to the host computer when the level is high (TTL).

64

trigin1_low, trigger_input1_low

Trigger Input 2: demodulator data is streamed to the host computer when the level is low (TTL).

80

trigin0or1_low, trigger_input0or1_low

Trigger Input 1 or 2: demodulator data is streamed to the host computer when either level is low (TTL).

128

trigin1_high, trigger_input1_high

Trigger Input 2: demodulator data is streamed to the host computer when the level is high (TTL).

160

trigin0or1_high, trigger_input0or1_high

Trigger Input 1 or 2: demodulator data is streamed to the host computer when either level is high (TTL).

DIOS (Digital I/O)

/DEV…​./DIOS/n/AUXDRIVE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Not used. Reserved for future use.

/DEV…​./DIOS/n/DECIMATION

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Sets the decimation factor for DIO data streamed to the host computer.

/DEV…​./DIOS/n/DRIVE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

When on (1), the corresponding 8-bit bus is in output mode. When off (0), it is in input mode. Bit 0 corresponds to the least significant byte. For example, the value 1 drives the least significant byte, the value 8 drives the most significant byte.

/DEV…​./DIOS/n/EXTCLK

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select DIO internal or external clocking.

0

internal

The DIO is internally clocked with a fixed frequency of 60 MHz.

1

external

The DIO is externally clocked with a clock signal connected to DIO Pin 68. The available range is from 1 Hz up to the internal clock frequency.

/DEV…​./DIOS/n/INPUT

Properties:

Read, Stream

Type:

ZIDIOSample

Unit:

None

Gives the value of the DIO input for those bytes where drive is disabled.

/DEV…​./DIOS/n/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select DIO mode

0

manual

Enables manual control of the DIO output bits.

3

threshold_unit

Enables setting of DIO output values by the threshold unit.

/DEV…​./DIOS/n/OUTPUT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Sets the value of the DIO output for those bytes where 'drive' is enabled.

EXTREFS

/DEV…​./EXTREFS/n/ADCSELECT

Properties:

Read

Type:

Integer (enumerated)

Unit:

None

Indicates the input signal selection for the selected demodulator.

0

sigin0, signal_input0

Signal Input 1 is connected to the corresponding demodulator.

1

currin0, current_input0

Current Input 1 is connected to the corresponding demodulator.

2

trigin0, trigger_input0

Trigger Input 1 is connected to the corresponding demodulator.

3

trigin1, trigger_input1

Trigger Input 2 is connected to the corresponding demodulator.

4

auxout0, auxiliary_output0

Auxiliary Output 1 is connected to the corresponding demodulator.

5

auxout1, auxiliary_output1

Auxiliary Output 2 is connected to the corresponding demodulator.

6

auxout2, auxiliary_output2

Auxiliary Output 3 is connected to the corresponding demodulator.

7

auxout3, auxiliary_output3

Auxiliary Output 4 is connected to the corresponding demodulator.

8

auxin0, auxiliary_input0

Auxiliary Input 1 is connected to the corresponding demodulator.

9

auxin1, auxiliary_input1

Auxiliary Input 2 is connected to the corresponding demodulator.

/DEV…​./EXTREFS/n/AUTOMODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

This defines the type of automatic adaptation of parameters in the PID used for Ext Ref.

0

off

No automatic adaption.

1

coefficients_only

The coefficients of the PID controller are automatically set.

2

low_bandwidth

The PID coefficients, the filter bandwidth and the output limits are automatically set using a low bandwidth.

3

high_bandwidth

The PID coefficients, the filter bandwidth and the output limits are automatically set using a high bandwidth.

4

all

All parameters of the PID including the center frequency are adapted.

/DEV…​./EXTREFS/n/DEMODSELECT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Indicates the demodulator connected to the extref channel.

/DEV…​./EXTREFS/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the external reference.

/DEV…​./EXTREFS/n/LOCKED

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates whether the external reference is locked.

/DEV…​./EXTREFS/n/OSCSELECT

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates which oscillator is being locked to the external reference.

FEATURES

/DEV…​./FEATURES/CODE

Properties:

Read, Write

Type:

String

Unit:

None

Node providing a mechanism to write feature codes.

/DEV…​./FEATURES/DEVTYPE

Properties:

Read

Type:

String

Unit:

None

Returns the device type.

/DEV…​./FEATURES/OPTIONS

Properties:

Read

Type:

String

Unit:

None

Returns enabled options.

/DEV…​./FEATURES/SERIAL

Properties:

Read

Type:

String

Unit:

None

Device serial number.

IMPS (Impedance)

/DEV…​./IMPS/n/AC

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Defines the input coupling for the Signal Inputs. AC coupling inserts a high-pass filter.

/DEV…​./IMPS/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable impedance calculation for demodulator data.

/DEV…​./IMPS/n/FREQ

Properties:

Read, Write, Setting

Type:

Double

Unit:

Hz

Frequency control for the oscillator used for impedance measurement.

/DEV…​./IMPS/n/INTERPOLATION

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the interpolation method of the compensation data. The interpolation method is particularly important if the derivative changes strongly e.g at cut-off frequencies.

0

linear

Linear: The linear interpolation is fastest but may create compensation errors in between the frequency points used for compensation.

1

pchip

Piecewise Cubic Hermite (PCHIP): The piecewise cubic Hermite interpolation will result in very accurate results but requires more calculation power.

/DEV…​./IMPS/n/MAXBANDWIDTH

Properties:

Read, Write, Setting

Type:

Double

Unit:

Hz

Limit of the maximum bandwidth used on the demodulator filter. Values above 1 kHz can heavily diminish measurement accuracy in the high-frequency region where the amplitude is no more constant over frequency.

/DEV…​./IMPS/n/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select impedance measurement mode.

0

4 Terminal

This method uses the current and the voltage drop across the DUT to calculate the DUT impedance. This method results in very accurate measurements as influences of series resistors on the output and current input are excluded.

1

2 Terminal

This method uses the driving voltage and the measured current to calculate the DUT impedance. The 2 Terminal method can be beneficial when measuring very high impedance where the parasitics of the voltage measurement are limiting the frequency range.

/DEV…​./IMPS/n/MODEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Representation of the complex impedance value Z by two real values accessible as Parameter 1 and Parameter 2 on all user interface displays.

0

r_c_parallel

Rp

Cp: Impedance value Z is represented by a resistive element Rp in parallel with a capacitive element Cp.

1

r_c_series

Rs + Cs: Impedance value Z is represented by a resistive element Rs in series with a capacitive element Cs.

2

r_l_series

Rs + Ls: Impedance value Z is represented by a resistive element Rs in series with an inductive element Ls.

3

g_b_parallel, admittance

G B: Impedance value Z is represented by conductance G = Real(Y) and Susceptance B = Imag(Y) of the admittance Y = 1/Z.

4

d_c_series

D Cs: Impedance value Z is represented by a dissipation factor D = -Real(Z)/Imag(Z) (loss tangent) and a series capacitive element.

5

q_c_series

Q Cs: Impedance value Z is represented by a quality factor Q = -Imag(Z)/Real(Z) and a series capacitive element.

6

d_l_series

D Ls: Impedance value Z is represented by a dissipation factor D = Real(Z)/Imag(Z) (loss tangent) and a series inductive element.

7

q_l_series

Q Ls: Impedance value Z is represented by a quality factor Q = Imag(Z)/Real(Z) and a series inductive element.

8

r_l_parallel

Rp

Lp: Impedance value Z is represented by a resistive element Rp in parallel with an inductive element Lp.

9

d_c_parallel

D Cp: Impedance value Z is represented by a dissipation factor D = Real(Z)/Imag(Z) (loss tangent) and a parallel capacitive element Cp.

/DEV…​./IMPS/n/OMEGASUPPRESSION

Properties:

Read, Write, Setting

Type:

Double

Unit:

dB

Suppression of the omega and 2-omega components. Small omega suppression can diminish measurements of very low or high impedance because the DC component can become dominant. Large omega suppression will have a significant impact on sweep time especially for low filter orders.

/DEV…​./IMPS/n/SAMPLE

Properties:

Read, Stream

Type:

ZIImpedanceSample

Unit:

None

Streaming node containing the impedance measurement sample data.

/DEV…​./IMPS/n/AUTO/BW

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable automatic bandwidth control. If enabled the optimum bandwidth is calculated based on the frequency and measurement data.

/DEV…​./IMPS/n/AUTO/INPUTRANGE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select input range control mode.

0

Manual

In manual mode the current and voltage input ranges are adjusted manually and separately. Use this mode with care as overload will result in inaccurate impedance results.

1

Auto

Dynamically adjust the input range according to the measured input signal strength. This optimizes the dynamic range and precision of impedance measurements.

2

Zone

This ranging option allows you to manually set the switching frequency limits for all eight current input ranges.

/DEV…​./IMPS/n/AUTO/OUTPUT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

If enabled, the drive voltage amplitude is controlled by the device. If disabled it can be set manually.

/DEV…​./IMPS/n/AUTO/SUPPRESS

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Indicates disabled periodic auto range control. A running sweeper module takes over the range control and thus disables the periodic range checks.

/DEV…​./IMPS/n/BIAS/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the DC bias voltage.

/DEV…​./IMPS/n/BIAS/VALUE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

DC bias voltage applied across the device under test. Both positive and negative bias voltages are supported. In a 4-terminal measurement, the bias voltage is limited by the maximum common voltage input range of the device. In a 2-terminal measurement, the bias voltage can be larger because the voltage inputs are not connected.

/DEV…​./IMPS/n/CURRENT/DEMODSELECT

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Demodulator used for current demodulation.

/DEV…​./IMPS/n/CURRENT/INPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the current input used for two- and four-terminal impedance measurements.

0

currin0, current_input0

Current Input 1

8

auxin0, auxiliary_input0

Aux In 1

9

auxin1, auxiliary_input1

Aux In 2

/DEV…​./IMPS/n/CURRENT/INVERT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

If enabled, the current input signal is inverted. This is useful to switch the polarity of an input signal which can be caused by additional current amplifiers.

/DEV…​./IMPS/n/CURRENT/RANGE

Properties:

Read, Write, Setting

Type:

Double

Unit:

A

Input current range used for the impedance measurement. Small current input ranges have a reduced bandwidth. In the Range Control modes 'Auto' and 'Impedance', the current range is switched automatically to a higher range if the frequency is too high.

/DEV…​./IMPS/n/CURRENT/SCALING

Properties:

Read, Write, Setting

Type:

Double

Unit:

A/V

The scaling factor will be applied to the current measurement done with an Aux In input.

/DEV…​./IMPS/n/DEMOD/HARMONIC

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Multiplies the demodulator’s reference frequency with the integer factor defined by this field.

/DEV…​./IMPS/n/DEMOD/ORDER

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the filter roll off between 6 dB/oct and 48 dB/oct of the current demodulator.

1

1st order filter 6 dB/oct

2

2nd order filter 12 dB/oct

3

3rd order filter 18 dB/oct

4

4th order filter 24 dB/oct

5

5th order filter 30 dB/oct

6

6th order filter 36 dB/oct

7

7th order filter 42 dB/oct

8

8th order filter 48 dB/oct

/DEV…​./IMPS/n/DEMOD/OSCSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Oscillator used to generate the frequency of the excitation voltage on the Hcur (+V) connector.

0

Oscillator 1

1

Oscillator 2

2

Oscillator 3

3

Oscillator 4

/DEV…​./IMPS/n/DEMOD/RATE

Properties:

Read, Write, Setting

Type:

Double

Unit:

1/s

Impedance data streaming rate. The same data rate is applied to the demodulators that are used for the impedance measurement.

/DEV…​./IMPS/n/DEMOD/SINC

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the sinc filter.

/DEV…​./IMPS/n/DEMOD/TIMECONSTANT

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Defines low pass filter time constant.

/DEV…​./IMPS/n/DISCARD/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Discarding impedance samples outside the indicated range.

/DEV…​./IMPS/n/DISCARD/LIMITLOWER

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Threshold for abs(Z) below which the impedance samples are discarded.

/DEV…​./IMPS/n/DISCARD/LIMITUPPER

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Threshold for abs(Z) above which the impedance samples are discarded.

/DEV…​./IMPS/n/ONEPERIOD/ACTIVE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables one-period averaging for low frequency impedance measurements. The LED is green when active.

/DEV…​./IMPS/n/ONEPERIOD/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables one-period averaging for low frequency impedance measurements. The LED is green when active.

/DEV…​./IMPS/n/OUTPUT/AMPLITUDE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Drive amplitude on the Signal Output.

/DEV…​./IMPS/n/OUTPUT/DEMOD

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Demodulator unit used to generate the excitation voltage on the Signal Output.

/DEV…​./IMPS/n/OUTPUT/ON

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Main switch for the Signal Output corresponding to the blue LED indicator on the instrument front panel.

/DEV…​./IMPS/n/OUTPUT/RANGE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Selects the output voltage range.

/DEV…​./IMPS/n/OUTPUT/SELECT

Properties:

Read

Type:

Integer (enumerated)

Unit:

None

Selects the output channel that the excitation voltage drives.

0

sigout0, signal_output0

Signal Output 1

/DEV…​./IMPS/n/VOLTAGE/DEMODSELECT

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Demodulator used for voltage measurement in case of a four-terminal impedance measurement.

/DEV…​./IMPS/n/VOLTAGE/INPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the voltage input used for a four-terminal impedance measurement.

0

voltage_input0

Voltage Input 1

8

auxin0, auxiliary_input0

Aux In 1

9

auxin1, auxiliary_input1

Aux In 2

/DEV…​./IMPS/n/VOLTAGE/INVERT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

If enabled, the voltage input signal is inverted.

/DEV…​./IMPS/n/VOLTAGE/RANGE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Input voltage range for the impedance measurement.

/DEV…​./IMPS/n/VOLTAGE/SCALING

Properties:

Read, Write, Setting

Type:

Double

Unit:

V/V

The scaling factor will be applied to the voltage measurement done with an Aux In input.

/DEV…​./IMPS/n/CALIB/INTERNAL/ACTIVE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates if the internal calibration is applied to the measurement data.

/DEV…​./IMPS/n/CALIB/INTERNAL/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the internal calibration. This ensures that the input range gains match over the full frequency range. With enabled internal calibration the device fulfills the impedance accuracy specification. The internal calibration is a prerequisite to apply a user compensation.

/DEV…​./IMPS/n/CALIB/INTERNAL/SMOOTH

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables smoothing of the internal calibration data. This results in lower noise in the measured data.

/DEV…​./IMPS/n/CALIB/USER/ACTIVE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates that a valid user compensation is active. If active the impedance data streams deliver amplitude and phase corrected data based on the impedance user compensation.

/DEV…​./IMPS/n/CALIB/USER/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the user compensation of the impedance data. The user compensation is correcting parasitics and delays caused by the external setup. The user compensation is applied on top of the internal impedance calibration.

/DEV…​./IMPS/n/CALIB/USER/SMOOTH

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables smoothing of the compensation data. This results in lower noise in the measured data.

/DEV…​./IMPS/n/CONFIDENCE/COMPENSATION/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the indication of strong compensation in the plots. A strong compensation diminishes the measurement accuracy of the parameter.

/DEV…​./IMPS/n/CONFIDENCE/COMPENSATION/RATIO

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Strength of the compensation that will trigger the strong compensation warning.

/DEV…​./IMPS/n/CONFIDENCE/FREQLIMIT/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the frequency limit detection based on the used current input range. Only relevant when Range Control is set to Manual.

/DEV…​./IMPS/n/CONFIDENCE/LOWDUT2T/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables a warning when measuring a low impedance (100k) with a 2 point contact.

/DEV…​./IMPS/n/CONFIDENCE/LOWDUT2T/RATIO

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

When measuring with 2 point contacts, too low impedance of DUT will trigger the Low DUT 2T warning.

/DEV…​./IMPS/n/CONFIDENCE/ONEPERIOD/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the detection of unreliable data points where data sample loss leads to an invalid one-period average. Try reducing the data transfer rate.

/DEV…​./IMPS/n/CONFIDENCE/OPENDETECT/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the open terminal detection for 4-terminal measurements.

/DEV…​./IMPS/n/CONFIDENCE/OPENDETECT/RATIO

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Open terminal detection ratio. An open terminal is reported if the excitation calculated from current and voltage drop differs more than the specified factor from the driving voltage.

/DEV…​./IMPS/n/CONFIDENCE/OVERFLOW/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the overload detection for current and voltage.

/DEV…​./IMPS/n/CONFIDENCE/QFACTOR/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the detection of negative Q or D factors. Negative Q or D factors mean the measured impedance does not correspond to the chosen Representation. This can be due to an erroneous compensation, a bad choice of the Representation, or noise.

/DEV…​./IMPS/n/CONFIDENCE/SUPPRESSION/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

The Suppression Confidence Indicator indicates if one of the two parameters of a circuit representation cannot be calculated reliably from the measured impedance. This is the case if a small variation in one (dominant) representation parameter creates a strong variation of the other (suppressed) representation parameter. Such an error amplification indicates that the measurement of the secondary parameter is unreliable.

/DEV…​./IMPS/n/CONFIDENCE/SUPPRESSION/RATIO

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Error amplification limit for which a secondary parameter is marked unreliable. Larger gain values mean larger warning tolerances. A gain value between 10 and 100 is best.

/DEV…​./IMPS/n/CONFIDENCE/UNDERFLOW/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the underflow detection for current and voltage.

/DEV…​./IMPS/n/CONFIDENCE/UNDERFLOW/RATIO

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

The underflow condition is met if the measured amplitude is lower than the specified ratio relative to full scale.

/DEV…​./IMPS/n/CURRENT/PID/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

If enabled, the PID value is used for the impedance calculation instead of the measured value at the current input.

MODS (Modulation)

/DEV…​./MODS/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the modulation.

/DEV…​./MODS/n/FREQDEV

Properties:

Read, Write, Setting

Type:

Double

Unit:

Hz

FM mode peak deviation value.

/DEV…​./MODS/n/FREQDEVENABLE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

In FM mode, choose to work with either modulation index or peak deviation. The modulation index equals peak deviation divided by modulation frequency.

0

modulation_index

Use modulation index.

1

peak_deviation

Use peak deviation.

/DEV…​./MODS/n/INDEX

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

FM modulation index: The modulation index equals peak deviation divided by modulation frequency.

/DEV…​./MODS/n/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the modulation mode.

0

am

AM Modulation

1

fm

FM Modulation

2

manual

Manual

/DEV…​./MODS/n/OUTPUT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select Signal Output.

0

none

None

1

sigout0, signal_output0

Signal Output 1

/DEV…​./MODS/n/CARRIER/AMPLITUDE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Set the carrier amplitude

/DEV…​./MODS/n/CARRIER/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable the modulation

/DEV…​./MODS/n/CARRIER/HARMONIC

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Set the harmonic of the carrier frequency. 1 = Fundamental

/DEV…​./MODS/n/CARRIER/INPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select Signal Input for the carrier demodulation

0

sigin0, signal_input0

Sig In 1

1

currin0, current_input0

Curr In 1

2

trigin0, trigger_input0

Trigger Input 1

3

trigin1, trigger_input1

Trigger Input 2

4

auxout0, auxiliary_output0

Aux Out 1

5

auxout1, auxiliary_output1

Aux Out 2

6

auxout2, auxiliary_output2

Aux Out 3

7

auxout3, auxiliary_output3

Aux Out 4

8

auxin0, auxiliary_input0

Aux In 1

9

auxin1, auxiliary_input1

Aux In 2

174

demod_constant_input

Demodulate a constant input. This results in a sine wave of the frequency specified by the demodulator’s oscillator with an amplitude of 1 (at lower frequencies; higher frequencies will be attenuated). The maximum possible frequency is limited by the demodulator sampling rate and bandwidth; use demodulator order 1 for the least attenuation in demodulator output. This signal may be used with the auxiliary outputs, PID and Threshold Unit for advanced measurement and control tasks. When the demodulator output is written to an auxiliary output, the resulting signal can also be used as a second output channel (for low frequencies).

/DEV…​./MODS/n/CARRIER/ORDER

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Filter order used for carrier demodulation

1

1st order filter 6 dB/oct

2

2nd order filter 12 dB/oct

3

3rd order filter 18 dB/oct

4

4th order filter 24 dB/oct

5

5th order filter 30 dB/oct

6

6th order filter 36 dB/oct

7

7th order filter 42 dB/oct

8

8th order filter 48 dB/oct

/DEV…​./MODS/n/CARRIER/OSCSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the oscillator for the carrier signal.

0

Oscillator 1

1

Oscillator 2

2

Oscillator 3

3

Oscillator 4

/DEV…​./MODS/n/CARRIER/PHASESHIFT

Properties:

Read, Write, Setting

Type:

Double

Unit:

degree

Phase shift applied to the reference input of the carrier demodulator and also to the carrier signal on the Signal Outputs

/DEV…​./MODS/n/CARRIER/TIMECONSTANT

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Sets the integration time constant or in other words, the cutoff frequency of the low-pass filter for the carrier demodulation.

/DEV…​./MODS/n/SIDEBANDS/n/AMPLITUDE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Set the amplitude of the sideband components.

/DEV…​./MODS/n/SIDEBANDS/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable the signal generation for the respective sideband

/DEV…​./MODS/n/SIDEBANDS/n/HARMONIC

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Set harmonic of the sideband frequencies. 1 = fundamental

/DEV…​./MODS/n/SIDEBANDS/n/INPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select Signal Input for the sideband demodulation

0

sigin0, signal_input0

Sig In 1

1

currin0, current_input0

Curr In 1

2

trigin0, trigger_input0

Trigger Input 1

3

trigin1, trigger_input1

Trigger Input 2

4

auxout0, auxiliary_output0

Aux Out 1

5

auxout1, auxiliary_output1

Aux Out 2

6

auxout2, auxiliary_output2

Aux Out 3

7

auxout3, auxiliary_output3

Aux Out 4

8

auxin0, auxiliary_input0

Aux In 1

9

auxin1, auxiliary_input1

Aux In 2

174

demod_constant_input

Demodulate a constant input. This results in a sine wave of the frequency specified by the demodulator’s oscillator with an amplitude of 1 (at lower frequencies; higher frequencies will be attenuated). The maximum possible frequency is limited by the demodulator sampling rate and bandwidth; use demodulator order 1 for the least attenuation in demodulator output. This signal may be used with the auxiliary outputs, PID and Threshold Unit for advanced measurement and control tasks. When the demodulator output is written to an auxiliary output, the resulting signal can also be used as a second output channel (for low frequencies).

/DEV…​./MODS/n/SIDEBANDS/n/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Enabling of the first sideband and selection of the position of the sideband relative to the carrier frequency for manual mode.

0

off

Off: First sideband is disabled. The sideband demodulator behaves like a normal demodulator.

1

upper

C + M: First sideband to the right of the carrier

2

lower

C - M: First sideband to the left of the carrier

/DEV…​./MODS/n/SIDEBANDS/n/ORDER

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Filter order used for sideband demodulation

1

1st order filter 6 dB/oct

2

2nd order filter 12 dB/oct

3

3rd order filter 18 dB/oct

4

4th order filter 24 dB/oct

5

5th order filter 30 dB/oct

6

6th order filter 36 dB/oct

7

7th order filter 42 dB/oct

8

8th order filter 48 dB/oct

/DEV…​./MODS/n/SIDEBANDS/n/OSCSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the oscillator for the second sideband.

0

Oscillator 1

1

Oscillator 2

2

Oscillator 3

3

Oscillator 4

/DEV…​./MODS/n/SIDEBANDS/n/PHASESHIFT

Properties:

Read, Write, Setting

Type:

Double

Unit:

degree

Phase shift applied to the reference input of the sideband demodulator and also to the sideband signal on the Signal Outputs

/DEV…​./MODS/n/SIDEBANDS/n/TIMECONSTANT

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Sets the integration time constant or in other words, the cutoff frequency of the low-pass filter for the sideband demodulation.

OSCS (Oscillators)

/DEV…​./OSCS/n/FREQ

Properties:

Read, Write, Setting

Type:

Double

Unit:

Hz

Frequency control for each oscillator.

PIDS

/DEV…​./PIDS/n/CENTER

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Sets the center value for the PID output. After adding the Center value, the signal is clamped to Center + Lower Limit and Center + Upper Limit.

/DEV…​./PIDS/n/D

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

PID derivative gain.

/DEV…​./PIDS/n/DLIMITTIMECONSTANT

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

The cutoff of the low-pass filter for the D limitation given as time constant. When set to 0, the low-pass filter is disabled.

/DEV…​./PIDS/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable the PID controller.

/DEV…​./PIDS/n/ERROR

Properties:

Read

Type:

Double

Unit:

Dependent

Error = Set point - PID Input.

/DEV…​./PIDS/n/I

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

PID integral gain I.

/DEV…​./PIDS/n/INPUT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select input source of PID controller.

0

demod_x

Demodulator X

1

demod_y

Demodulator Y

2

demod_r

Demodulator R

3

demod_theta

Demodulator Theta

4

auxin, auxiliary_input

Aux Input

5

auxout, auxiliary_output

Aux Output

/DEV…​./PIDS/n/INPUTCHANNEL

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Select input channel of PID controller.

/DEV…​./PIDS/n/KEEPINT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

Dependent

If enabled, the accumulated integral error is maintained upon restart of the PID. If is disabled, the integral error is set to zero when the PID is disabled.

/DEV…​./PIDS/n/LIMITLOWER

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Sets the lower limit for the PID output. After adding the Center value, the signal is clamped to Center + Lower Limit and Center + Upper Limit.

/DEV…​./PIDS/n/LIMITUPPER

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Sets the upper limit for the PID output. After adding the Center value, the signal is clamped to Center + Lower Limit and Center + Upper Limit.

/DEV…​./PIDS/n/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Sets the operation mode of the PID module.

0

pid

PID

1

pll

PLL (phase locked loop)

2

extref

ExtRef (external reference)

/DEV…​./PIDS/n/OUTPUT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select output of the PID controller.

0

sigout, signal_output

Feedback to the main signal output amplitudes

1

oscillator_frequency

Feedback to any of the internal oscillator frequencies

2

demod_phase

Feedback to any of the 8 demodulator phase set points

3

auxout_offset, auxiliary_output_offset

Feedback to any of the 4 Auxiliary Output’s Offset

4

sigout_offset, signal_output_offset

Feedback to the main Signal Output offset adjustment

/DEV…​./PIDS/n/OUTPUTCHANNEL

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Select the output channel of the driven output of PID controller.

/DEV…​./PIDS/n/P

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

PID Proportional gain P.

/DEV…​./PIDS/n/PHASEUNWRAP

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the phase unwrapping to track phase errors past the +/-180 degree boundary and increase PLL bandwidth.

/DEV…​./PIDS/n/RATE

Properties:

Read, Write, Setting

Type:

Double

Unit:

1/s

PID sampling rate and update rate of PID outputs. Needs to be set substantially higher than the targeted loop filter bandwidth.

/DEV…​./PIDS/n/SETPOINT

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

PID controller setpoint

/DEV…​./PIDS/n/SHIFT

Properties:

Read

Type:

Double

Unit:

Dependent

Difference between the current output value Out and the Center. Shift = P*Error + I*Int(Error, dt) + D*dError/dt

/DEV…​./PIDS/n/VALUE

Properties:

Read

Type:

Double

Unit:

Dependent

Gives the current PID output value.

/DEV…​./PIDS/n/DEMOD/ADCSELECT

Properties:

Read

Type:

Integer (enumerated)

Unit:

None

Indicates the signal source which is connected to the chosen input demodulator channel.

0

sigin0, signal_input0

Signal Input 1 is connected to the corresponding demodulator.

1

currin0, current_input0

Current Input 1 is connected to the corresponding demodulator.

2

trigin0, trigger_input0

Trigger Input 1 is connected to the corresponding demodulator.

3

trigin1, trigger_input1

Trigger Input 2 is connected to the corresponding demodulator.

4

auxout0, auxiliary_output0

Auxiliary Output 1 is connected to the corresponding demodulator.

5

auxout1, auxiliary_output1

Auxiliary Output 2 is connected to the corresponding demodulator.

6

auxout2, auxiliary_output2

Auxiliary Output 3 is connected to the corresponding demodulator.

7

auxout3, auxiliary_output3

Auxiliary Output 4 is connected to the corresponding demodulator.

8

auxin0, auxiliary_input0

Auxiliary Input 1 is connected to the corresponding demodulator.

9

auxin1, auxiliary_input1

Auxiliary Input 2 is connected to the corresponding demodulator.

/DEV…​./PIDS/n/DEMOD/HARMONIC

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Multiplier of the for the reference frequency of the current demodulator.

/DEV…​./PIDS/n/DEMOD/ORDER

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the filter roll off between 6 dB/oct and 48 dB/oct of the current demodulator.

1

1st order filter 6 dB/oct

2

2nd order filter 12 dB/oct

3

3rd order filter 18 dB/oct

4

4th order filter 24 dB/oct

5

5th order filter 30 dB/oct

6

6th order filter 36 dB/oct

7

7th order filter 42 dB/oct

8

8th order filter 48 dB/oct

/DEV…​./PIDS/n/DEMOD/TIMECONSTANT

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Defines the characteristic time constant (cut off) of the demodulator filter used as an input.

/DEV…​./PIDS/n/PLL/AUTOMODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

This defines the type of automatic adaptation of parameters in the PID.

0

no_adaption

No automatic adaption.

1

pid_coeffs

The coefficients of the PID controller are automatically set.

2

pid_coeffs_filter_low_bw

The PID coefficients, the filter bandwidth and the output limits are automatically set using a low bandwidth.

3

pid_coeffs_filter_high_bw

The PID coefficients, the filter bandwidth and the output limits are automatically set using a high bandwidth.

4

pid_all

All parameters of the PID including the center frequency are adapted.

/DEV…​./PIDS/n/PLL/LOCKED

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates when the PID, configured as PLL, is locked.

/DEV…​./PIDS/n/SETPOINTTOGGLE/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the setpoint toggle.

/DEV…​./PIDS/n/SETPOINTTOGGLE/RATE

Properties:

Read, Write, Setting

Type:

Double

Unit:

Hz

Defines the rate of setpoint toggling. Note that possible values are logarithmically spaced with a factor of 4 between values.

/DEV…​./PIDS/n/SETPOINTTOGGLE/SETPOINT

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Defines the setpoint value used for setpoint toggle.

/DEV…​./PIDS/n/STREAM/EFFECTIVERATE

Properties:

Read

Type:

Double

Unit:

1/s

Current rate of the PID stream data sent to PC. Defined based on Max Rate.

/DEV…​./PIDS/n/STREAM/ERROR

Properties:

Read, Stream

Type:

Double

Unit:

Dependent

PID Error = Set point - PID Input.

/DEV…​./PIDS/n/STREAM/OVERFLOW

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates the streaming fifo overflow state. 0 = OK, 1 = overflow.

/DEV…​./PIDS/n/STREAM/RATE

Properties:

Read, Write, Setting

Type:

Double

Unit:

1/s

Target Rate for PID output data sent to PC. This value defines the applied decimation for sending data to the PC. It does not affect any other place where PID data are used.

/DEV…​./PIDS/n/STREAM/SHIFT

Properties:

Read, Stream

Type:

Double

Unit:

Dependent

Gives the difference between the current output value and the center value. Shift = P*Error + I*Int(Error, dt) + D*dError/dt

/DEV…​./PIDS/n/STREAM/VALUE

Properties:

Read, Stream

Type:

Double

Unit:

Dependent

Gives the current PID output value.

SCOPES

/DEV…​./SCOPES/n/CHANNEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Activates the scope channels.

1

Only channel 1 is active.

2

Only channel 2 is active.

3

both

Both, channel 1 and 2 are active.

/DEV…​./SCOPES/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the acquisition of scope shots.

/DEV…​./SCOPES/n/LENGTH

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Defines the length of the recorded Scope shot in number of samples.

/DEV…​./SCOPES/n/SINGLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Puts the Scope into single shot mode.

/DEV…​./SCOPES/n/TIME

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Defines the time base of the scope from the divider exponent of the instrument’s clock base. The resulting sampling time is 2^n/clockbase.

0

60 MHz

1

30 MHz

2

15 MHz

3

7.5 MHz

4

3.75 MHz

5

1.88 MHz

6

938 kHz

7

469 kHz

8

234 kHz

9

117 kHz

10

58.6 kHz

11

29.3 kHz

12

14.6 kHz

13

7.32 kHz

14

3.66 kHz

15

1.83 kHz

/DEV…​./SCOPES/n/TRIGCHANNEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the trigger source signal.

0

sigin0, signal_input0

Signal Input 1

1

currin0, current_input0

Current Input 1

2

trigin0, trigger_input0

Trigger Input 1

3

trigin1, trigger_input1

Trigger Input 2

4

auxout0, auxiliary_output0

Aux Output 1. Requires an installed digitizer (DIG) option.

5

auxout1, auxiliary_output1

Aux Output 2. Requires an installed digitizer (DIG) option.

6

auxout2, auxiliary_output2

Aux Output 3. Requires an installed digitizer (DIG) option.

7

auxout3, auxiliary_output3

Aux Output 4. Requires an installed digitizer (DIG) option.

8

auxin0, auxiliary_input0

Aux Input 1

9

auxin1, auxiliary_input1

Aux Input 2

10

demod1

Osc φ Demod 2

11

demod3

Osc φ Demod 4

14

trigout0, trigger_output0

Trigger Output 1

15

trigout1, trigger_output1

Trigger Output 2

16

demod0_x

Demod 1 X. Requires an installed digitizer (DIG) option.

17

demod1_x

Demod 2 X. Requires an installed digitizer (DIG) option.

18

demod2_x

Demod 3 X. Requires an installed digitizer (DIG) option.

19

demod3_x

Demod 4 X. Requires an installed digitizer (DIG) option.

32

demod0_y

Demod 1 Y. Requires an installed digitizer (DIG) option.

33

demod1_y

Demod 2 Y. Requires an installed digitizer (DIG) option.

34

demod2_y

Demod 3 Y. Requires an installed digitizer (DIG) option.

35

demod3_y

Demod 4 Y. Requires an installed digitizer (DIG) option.

48

demod0_r

Demod 1 R. Requires an installed digitizer (DIG) option.

49

demod1_r

Demod 2 R. Requires an installed digitizer (DIG) option.

50

demod2_r

Demod 3 R. Requires an installed digitizer (DIG) option.

51

demod3_r

Demod 4 R. Requires an installed digitizer (DIG) option.

64

demod0_theta

Demod 1 Θ. Requires an installed digitizer (DIG) option.

65

demod1_theta

Demod 2 Θ. Requires an installed digitizer (DIG) option.

66

demod2_theta

Demod 3 Θ. Requires an installed digitizer (DIG) option.

67

demod3_theta

Demod 4 Θ. Requires an installed digitizer (DIG) option.

80

pid0_value

PID 1 value. Requires an installed digitizer (DIG) option.

81

pid1_value

PID 2 value. Requires an installed digitizer (DIG) option.

82

pid2_value

PID 3 value. Requires an installed digitizer (DIG) option.

83

pid3_value

PID 4 value. Requires an installed digitizer (DIG) option.

144

pid0_shift

PID 1 Shift. Requires an installed digitizer (DIG) option.

145

pid1_shift

PID 2 Shift. Requires an installed digitizer (DIG) option.

146

pid2_shift

PID 3 Shift. Requires an installed digitizer (DIG) option.

147

pid3_shift

PID 4 Shift. Requires an installed digitizer (DIG) option.

208

pid0_error

PID 1 Error. Requires an installed digitizer (DIG) option.

209

pid1_error

PID 2 Error. Requires an installed digitizer (DIG) option.

210

pid2_error

PID 3 Error. Requires an installed digitizer (DIG) option.

211

pid3_error

PID 4 Error. Requires an installed digitizer (DIG) option.

224

tu0_filtered

TU 1 Filtered Value. Requires an installed digitizer (DIG) option.

225

tu1_filtered

TU 2 Filtered Value. Requires an installed digitizer (DIG) option.

226

tu2_filtered

TU 3 Filtered Value. Requires an installed digitizer (DIG) option.

227

tu3_filtered

TU 4 Filtered Value. Requires an installed digitizer (DIG) option.

/DEV…​./SCOPES/n/TRIGDELAY

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Trigger position relative to reference. A positive delay results in less data being acquired before the trigger point, a negative delay results in more data being acquired before the trigger point.

/DEV…​./SCOPES/n/TRIGENABLE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

When triggering is enabled scope data are acquired every time the defined trigger condition is met.

0

on

ON: Trigger based scope shot acquisition

1

off

OFF: Continuous scope shot acquisition

/DEV…​./SCOPES/n/TRIGFALLING

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

When set (1), enables falling edge triggering. This settings is synchronized with the settings done in the /TRIGSLOPE node.

/DEV…​./SCOPES/n/TRIGFORCE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Forces a trigger event.

/DEV…​./SCOPES/n/TRIGHOLDOFF

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Defines the time before the trigger is rearmed after a recording event.

/DEV…​./SCOPES/n/TRIGHOLDOFFCOUNT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Defines the trigger event number that will trigger the next recording after a recording event. A value of '1' will start a recording for each trigger event.

/DEV…​./SCOPES/n/TRIGHOLDOFFMODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the holdoff mode.

0

time

Holdoff is defined as time (s).

1

number_of_events

Holdoff is defined as number of events.

/DEV…​./SCOPES/n/TRIGLEVEL

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Defines the trigger level.

/DEV…​./SCOPES/n/TRIGREFERENCE

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Trigger reference position relative to the acquired data. Default is 50% (0.5) which results in a reference point in the middle of the acquired data.

/DEV…​./SCOPES/n/TRIGRISING

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

When set (1), enables rising edge triggering. This settings is synchronized with the settings done in the /TRIGFALLING node.

/DEV…​./SCOPES/n/TRIGSLOPE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Sets on which slope of the trigger signal the scope should trigger. This setting is synchronized with the settings done in the /TRIGFALLING and /TRIGRISING nodes.

0

none

None

1

rising

Rising edge triggered.

2

falling

Falling edge triggered.

3

both

Triggers on both the rising and falling edge.

/DEV…​./SCOPES/n/TRIGSTATE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

When 1, indicates that the trigger signal satisfies the conditions of the trigger.

/DEV…​./SCOPES/n/WAVE

Properties:

Read, Stream

Type:

ZIScopeWave

Unit:

None

Contains the scope shot data.

/DEV…​./SCOPES/n/SEGMENTS/COUNT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Specifies the number of segments to be recorded in device memory. The maximum scope shot size is given by the available memory divided by the number of segments. This functionality requires the DIG option.

/DEV…​./SCOPES/n/SEGMENTS/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable segmented scope recording. This allows for full bandwidth recording of scope shots with a minimum dead time between individual shots. This functionality requires the DIG option.

/DEV…​./SCOPES/n/STREAM/RATE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

Hz

Streaming Rate of the scope channels. The streaming rate can be adjusted independent from the scope sampling rate. The maximum rate depends on the interface used for transfer. Note: scope streaming requires the DIG option.

4

3.75_MHz

3.75 MHz

5

1.88_MHz

1.88 MHz

6

938_kHz

938 kHz

7

469_kHz

469 kHz

8

234_kHz

234 kHz

9

117_kHz

117 kHz

10

58.6_kHz

58.6 kHz

11

29.3_kHz

29.3 kHz

12

14.6_kHz

14.6 kHz

13

7.32_kHz

7.32 kHz

14

3.66_kHz

3.66 kHz

15

1.83_kHz

1.83 kHz

/DEV…​./SCOPES/n/STREAM/SAMPLE

Properties:

Read, Stream

Type:

ZIScopeWave

Unit:

None

Streaming node containing scope sample data. Note: scope streaming requires the DIG option.

/DEV…​./SCOPES/n/TRIGGATE/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

If enabled the trigger will be gated by the trigger gating input signal. This feature requires the DIG option.

/DEV…​./SCOPES/n/TRIGGATE/INPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal source used for trigger gating if gating is enabled. This feature requires the DIG option.

0

trigin0_high, trigger_input0_high

Only trigger if the Trigger Input 1 is at high level.

1

trigin0_low, trigger_input0_low

Only trigger if the Trigger Input 1 is at low level.

2

trigin1_high, trigger_input1_high

Only trigger if the Trigger Input 2 is at high level.

3

trigin1_low, trigger_input1_low

Only trigger if the Trigger Input 2 is at low level.

/DEV…​./SCOPES/n/TRIGHYSTERESIS/ABSOLUTE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Defines the voltage the source signal must deviate from the trigger level before the trigger is rearmed again. Set to 0 to turn it off. The sign is defined by the Edge setting.

/DEV…​./SCOPES/n/TRIGHYSTERESIS/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the mode to define the hysteresis strength. The relative mode will work best over the full input range as long as the analog input signal does not suffer from excessive noise.

0

absolute

Selects absolute hysteresis.

1

relative

Selects a hysteresis relative to the adjusted full scale signal input range.

/DEV…​./SCOPES/n/TRIGHYSTERESIS/RELATIVE

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Hysteresis relative to the adjusted full scale signal input range. A hysteresis value larger than 1 (100%) is allowed.

/DEV…​./SCOPES/n/CHANNELS/n/BWLIMIT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects between sample decimation and sample averaging. Averaging avoids aliasing, but may conceal signal peaks.

0

on

On: Selects sample averaging for sample rates lower than the maximal available sampling rate.

1

off

OFF: Selects sample decimation for sample rates lower than the maximal available sampling rate.

/DEV…​./SCOPES/n/CHANNELS/n/FULLSCALE

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Indicates the full scale value of the scope channel.

/DEV…​./SCOPES/n/CHANNELS/n/INPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the scope input signal.

0

sigin0, signal_input0

Signal Input 1

1

currin0, current_input0

Current Input 1

2

trigin0, trigger_input0

Trigger Input 1

3

trigin1, trigger_input1

Trigger Input 2

4

auxout0, auxiliary_output0

Aux Output 1. Requires an installed digitizer (DIG) option.

5

auxout1, auxiliary_output1

Aux Output 2. Requires an installed digitizer (DIG) option.

6

auxout2, auxiliary_output2

Aux Output 3. Requires an installed digitizer (DIG) option.

7

auxout3, auxiliary_output3

Aux Output 4. Requires an installed digitizer (DIG) option.

8

auxin0, auxiliary_input0

Aux Input 1

9

auxin1, auxiliary_input1

Aux Input 2

10

demod1

Osc φ Demod 2

11

demod3

Osc φ Demod 4

14

trigout0, trigger_output0

Trigger Output 1

15

trigout1, trigger_output1

Trigger Output 2

16

demod0_x

Demod 1 X. Requires an installed digitizer (DIG) option.

17

demod1_x

Demod 2 X. Requires an installed digitizer (DIG) option.

18

demod2_x

Demod 3 X. Requires an installed digitizer (DIG) option.

19

demod3_x

Demod 4 X. Requires an installed digitizer (DIG) option.

32

demod0_y

Demod 1 Y. Requires an installed digitizer (DIG) option.

33

demod1_y

Demod 2 Y. Requires an installed digitizer (DIG) option.

34

demod2_y

Demod 3 Y. Requires an installed digitizer (DIG) option.

35

demod3_y

Demod 4 Y. Requires an installed digitizer (DIG) option.

48

demod0_r

Demod 1 R. Requires an installed digitizer (DIG) option.

49

demod1_r

Demod 2 R. Requires an installed digitizer (DIG) option.

50

demod2_r

Demod 3 R. Requires an installed digitizer (DIG) option.

51

demod3_r

Demod 4 R. Requires an installed digitizer (DIG) option.

64

demod0_theta

Demod 1 Θ. Requires an installed digitizer (DIG) option.

65

demod1_theta

Demod 2 Θ. Requires an installed digitizer (DIG) option.

66

demod2_theta

Demod 3 Θ. Requires an installed digitizer (DIG) option.

67

demod3_theta

Demod 4 Θ. Requires an installed digitizer (DIG) option.

80

pid0_value

PID 1 value. Requires an installed digitizer (DIG) option.

81

pid1_value

PID 2 value. Requires an installed digitizer (DIG) option.

82

pid2_value

PID 3 value. Requires an installed digitizer (DIG) option.

83

pid3_value

PID 4 value. Requires an installed digitizer (DIG) option.

144

pid0_shift

PID 1 Shift. Requires an installed digitizer (DIG) option.

145

pid1_shift

PID 2 Shift. Requires an installed digitizer (DIG) option.

146

pid2_shift

PID 3 Shift. Requires an installed digitizer (DIG) option.

147

pid3_shift

PID 4 Shift. Requires an installed digitizer (DIG) option.

160

Reserved for future use.

161

Reserved for future use.

208

pid0_error

PID 1 Error. Requires an installed digitizer (DIG) option.

209

pid1_error

PID 2 Error. Requires an installed digitizer (DIG) option.

210

pid2_error

PID 3 Error. Requires an installed digitizer (DIG) option.

211

pid3_error

PID 4 Error. Requires an installed digitizer (DIG) option.

240

Reserved for future use.

241

Reserved for future use.

242

Reserved for future use.

243

Reserved for future use.

/DEV…​./SCOPES/n/CHANNELS/n/LIMITLOWER

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Lower limit of the scope full scale range. For demodulator, PID, Boxcar, and AU signals the limit should be adjusted so that the signal covers the specified range to achieve optimal resolution.

/DEV…​./SCOPES/n/CHANNELS/n/LIMITUPPER

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Upper limit of the scope full scale range. For demodulator, PID, Boxcar, and AU signals the limit should be adjusted so that the signal covers the specified range to achieve optimal resolution.

/DEV…​./SCOPES/n/CHANNELS/n/OFFSET

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Indicates the offset value of the scope channel.

/DEV…​./SCOPES/n/STREAM/ENABLES/n

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable scope streaming for the specified channel. This allows for continuous recording of scope data on the plotter and streaming to disk. Note: scope streaming requires the DIG option.

SIGINS

/DEV…​./SIGINS/n/AC

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Defines the input coupling for the Signal Inputs. AC coupling inserts a high-pass filter.

0

dc

OFF: DC coupling

1

ac

ON: AC coupling

/DEV…​./SIGINS/n/AUTORANGE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Automatic adjustment of the Range to about two times the maximum signal input amplitude measured over about 100 ms.

/DEV…​./SIGINS/n/DIFF

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Switches between single ended (OFF) and differential (ON) measurements.

0

off

OFF: Single ended voltage input

1

on

ON: Differential voltage input

/DEV…​./SIGINS/n/FLOAT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Switches the input between floating (ON) and connected to ground (OFF). This setting applies both to the voltage and the current input. It is recommended to discharge the test device before connecting or to enable this setting only after the signal source has been connected to the Signal Input in grounded mode.

0

off

OFF: GND connected

1

on

ON: Floating

/DEV…​./SIGINS/n/IMP50

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Switches between 50 Ohm (ON) and 10 M Ohm (OFF).

0

10_MOhm

OFF: 10 M Ohm

1

50_Ohm

ON: 50 Ohm

/DEV…​./SIGINS/n/MAX

Properties:

Read, Write

Type:

Double

Unit:

None

Indicates the maximum measured value at the input normalized to input range.

/DEV…​./SIGINS/n/MIN

Properties:

Read, Write

Type:

Double

Unit:

None

Indicates the minimum measured value at the input normalized to input range.

/DEV…​./SIGINS/n/ON

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the signal input.

/DEV…​./SIGINS/n/RANGE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Defines the gain of the analog input amplifier. The range should exceed the incoming signal by roughly a factor two including a potential DC offset. The instrument selects the next higher available range relative to a value inserted by the user. A suitable choice of this setting optimizes the accuracy and signal-to-noise ratio by ensuring that the full dynamic range of the input ADC is used.

/DEV…​./SIGINS/n/SCALING

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Applies the given scaling factor to the input signal.

/DEV…​./SIGINS/n/RANGESTEP/TRIGGER

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Switches to the next appropriate input range such that the range fits best with the measured input signal amplitude.

SIGOUTS

/DEV…​./SIGOUTS/n/ADD

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

The signal supplied to the Aux Input 1 is added to the signal output. For differential output the added signal is a common mode offset.

/DEV…​./SIGOUTS/n/AUTORANGE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

If enabled, selects the most suited output range automatically.

/DEV…​./SIGOUTS/n/DIFF

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Switch between single-ended output (OFF) and differential output (ON). In differential mode the signal swing is defined between Signal Output +V / -V.

/DEV…​./SIGOUTS/n/IMP50

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the load impedance between 50 Ohm and HiZ. The impedance of the output is always 50 Ohm. For a load impedance of 50 Ohm the displayed voltage is half the output voltage to reflect the voltage seen at the load.

0

high_impedance

HiZ

1

50_Ohm

50 Ohm

/DEV…​./SIGOUTS/n/OFFSET

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Defines the DC voltage that is added to the dynamic part of the output signal.

/DEV…​./SIGOUTS/n/ON

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enabling/Disabling the Signal Output. Corresponds to the blue LED indicator on the instrument front panel.

/DEV…​./SIGOUTS/n/OVER

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates that the signal output is overloaded.

/DEV…​./SIGOUTS/n/RANGE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Sets the output voltage range. The instrument selects the next higher available range.

/DEV…​./SIGOUTS/n/AMPLITUDES/n

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Sets the peak amplitude that the oscillator assigned to the given demodulation channel contributes to the signal output.

/DEV…​./SIGOUTS/n/ENABLES/n

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

V

Enables individual output signal amplitude. When the MD option is used, it is possible to generate signals being the linear combination of the available demodulator frequencies.

STATS

/DEV…​./STATS/CPULOAD

Properties:

Read

Type:

Double

Unit:

%

Indicates the total CPU load on the machine where the data server is running.

/DEV…​./STATS/DATASERVERCPULOAD

Properties:

Read

Type:

Double

Unit:

%

Indicates the CPU load of the data server.

/DEV…​./STATS/DATASERVERMEMLOAD

Properties:

Read

Type:

Double

Unit:

%

Indicates the memory usage of the data server.

/DEV…​./STATS/MEMLOAD

Properties:

Read

Type:

Double

Unit:

%

Indicates the total memory usage of the machine where the data server is running.

/DEV…​./STATS/CMDSTREAM/BANDWIDTH

Properties:

Read

Type:

Double

Unit:

Mbit/s

Command streaming bandwidth usage on the physical network connection between device and data server.

/DEV…​./STATS/CMDSTREAM/BYTESRECEIVED

Properties:

Read

Type:

Integer (64 bit)

Unit:

B

Number of bytes received on the command stream from the device since session start.

/DEV…​./STATS/CMDSTREAM/BYTESSENT

Properties:

Read

Type:

Integer (64 bit)

Unit:

B

Number of bytes sent on the command stream from the device since session start.

/DEV…​./STATS/CMDSTREAM/PACKETSLOST

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of command packets lost since device start. Command packets contain device settings that are sent to and received from the device.

/DEV…​./STATS/CMDSTREAM/PACKETSRECEIVED

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of packets received on the command stream from the device since session start.

/DEV…​./STATS/CMDSTREAM/PACKETSSENT

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of packets sent on the command stream to the device since session start.

/DEV…​./STATS/CMDSTREAM/PENDING

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of buffers ready for receiving command packets from the device.

/DEV…​./STATS/CMDSTREAM/PROCESSING

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of buffers being processed for command packets. Small values indicate proper performance. For a TCP/IP interface, command packets are sent using the TCP protocol.

/DEV…​./STATS/DATASTREAM/BANDWIDTH

Properties:

Read

Type:

Double

Unit:

Mbit/s

Data streaming bandwidth usage on the physical network connection between device and data server.

/DEV…​./STATS/DATASTREAM/BYTESRECEIVED

Properties:

Read

Type:

Integer (64 bit)

Unit:

B

Number of bytes received on the data stream from the device since session start.

/DEV…​./STATS/DATASTREAM/PACKETSLOST

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of data packets lost since device start. Data packets contain measurement data.

/DEV…​./STATS/DATASTREAM/PACKETSRECEIVED

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of packets received on the data stream from the device since session start.

/DEV…​./STATS/DATASTREAM/PENDING

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of buffers ready for receiving data packets from the device.

/DEV…​./STATS/DATASTREAM/PROCESSING

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of buffers being processed for data packets. Small values indicate proper performance. For a TCP/IP interface, data packets are sent using the UDP protocol.

/DEV…​./STATS/PHYSICAL/FANSPEED

Properties:

Read

Type:

Double

Unit:

RPM

Speed of the internal cooling fan.

/DEV…​./STATS/PHYSICAL/OVERTEMPERATURE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

This flag is set to 1 if the temperature of the FPGA exceeds 85°C. It will be reset to 0 after a restart of the device.

/DEV…​./STATS/PHYSICAL/FPGA/AUX

Properties:

Read

Type:

Double

Unit:

V

Supply voltage of the FPGA.

/DEV…​./STATS/PHYSICAL/FPGA/CORE

Properties:

Read

Type:

Double

Unit:

V

Core voltage of the FPGA.

/DEV…​./STATS/PHYSICAL/FPGA/TEMP

Properties:

Read

Type:

Double

Unit:

°C

Internal temperature of the FPGA.

/DEV…​./STATS/PHYSICAL/TEMPERATURES/n

Properties:

Read

Type:

Double

Unit:

°C

Internal temperature measurements.

/DEV…​./STATS/PHYSICAL/VOLTAGES/n

Properties:

Read

Type:

Double

Unit:

V

Internal voltage measurements.

STATUS

/DEV…​./STATUS/ADC0MAX

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The maximum value on Signal Input 1 (ADC0) during 100 ms.

/DEV…​./STATUS/ADC0MIN

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The minimum value on Signal Input 1 (ADC0) during 100 ms

/DEV…​./STATUS/ADC1MAX

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The maximum value on Signal Input 2 (ADC1) during 100 ms.

/DEV…​./STATUS/ADC1MIN

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The minimum value on Signal Input 2 (ADC1) during 100 ms

/DEV…​./STATUS/FIFOLEVEL

Properties:

Read

Type:

Double

Unit:

None

USB FIFO level: Indicates the USB FIFO fill level inside the device. When 100%, data is lost

/DEV…​./STATUS/TIME

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The current timestamp.

/DEV…​./STATUS/FLAGS/BINARY

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

A set of binary flags giving an indication of the state of various parts of the device. Bit 0: Signal Input 1 overflow, Bit 1: Current Input 1 overflow, Bit 2: Analog PLL fail, Bit 3: Output 1 DAC OK, Bit 4: Output 2 DAC OK, Bit 5: Signal Output 1 clipping, Bit 6: Signal Output 2 clipping, Bit 7: Ext Ref 1 Locked, Bit 8: Ext Ref 2 Locked, Bit 9:Ext Ref 3 Locked, Bit 10:Ext Ref 4 Locked, Bit 11: Sample Loss, Bits 12 - 13: Trigger In 1, Bits 14 - 15: Trigger In 2, Bits 16 - 17: Trigger In 3, Bits 18 - 19: Trigger In 4, Bit 20: PLL 1 locked, Bit 21: PLL 2 locked, Bit 22: PLL 3 locked, Bit 23: PLL 4 locked, Bit 24: Rubidium clock locked, Bit 25: AU Cartesian 1 Overflow, Bit 26: AU Cartesian 2 Overflow, Bit 27: AU Polar 1 Overflow, Bit 28: AU Polar 2 Overflow.

/DEV…​./STATUS/FLAGS/PACKETLOSSTCP

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Flag indicating if tcp packages have been lost.

/DEV…​./STATUS/FLAGS/PACKETLOSSUDP

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Flag indicating if udp packages have been lost.

SYSTEM

/DEV…​./SYSTEM/ACTIVEINTERFACE

Properties:

Read

Type:

String

Unit:

None

Currently active interface of the device.

/DEV…​./SYSTEM/EXTCLK

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

10 MHz reference clock source.

0

internal

Internal 10 MHz clock is used as the frequency and time base reference.

1

external

An external 10 MHz clock is used as the frequency and time base reference. Provide a clean and stable 10 MHz reference to the appropriate back panel connector.

/DEV…​./SYSTEM/FPGAREVISION

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

HDL firmware revision.

/DEV…​./SYSTEM/FWLOG

Properties:

Read

Type:

String

Unit:

None

Returns log output of the firmware.

/DEV…​./SYSTEM/FWLOGENABLE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Enables logging to the fwlog node.

/DEV…​./SYSTEM/FWREVISION

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Revision of the device-internal controller software.

/DEV…​./SYSTEM/IDENTIFY

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Setting this node to 1 will cause the device to blink the power led for a few seconds.

/DEV…​./SYSTEM/INTERFACESPEED

Properties:

Read

Type:

String

Unit:

None

Speed of the currently active interface (USB only).

/DEV…​./SYSTEM/JUMBO

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Enables jumbo frames (4k) on the TCP/IP interface. This will reduce the load on the PC and is required to achieve maximal throughput. Make sure that jumbo frames (4k) are enabled on the network card as well. If one of the devices on the network is not able to work with jumbo frames, the connection will fail.

/DEV…​./SYSTEM/OWNER

Properties:

Read

Type:

String

Unit:

None

Returns the current owner of the device (IP).

/DEV…​./SYSTEM/PORTTCP

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Returns the current TCP port used for communication to the dataserver.

/DEV…​./SYSTEM/PORTUDP

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Returns the current UDP port used for communication to the dataserver.

/DEV…​./SYSTEM/PREAMPENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the preamplifier.

/DEV…​./SYSTEM/SAVEPORTS

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Flag indicating that the TCP and UDP ports should be saved.

/DEV…​./SYSTEM/SHUTDOWN

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Sending a '1' to this node initiates a shutdown of the operating system on the MFLI device. It is recommended to trigger this shutdown before switching the device off with the hardware switch at the back side of the device.

/DEV…​./SYSTEM/STALL

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Indicates if the network connection is stalled.

/DEV…​./SYSTEM/BOARDREVISIONS/n

Properties:

Read

Type:

String

Unit:

None

Hardware revision of the FPGA base board

/DEV…​./SYSTEM/COMPDELAY/CALIBRATE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Perform automatic calibration of the input delay compensation.

/DEV…​./SYSTEM/IMPEDANCE/APPLICATION

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the Impedance application

0

lcr

LCR Impedance Measurement: General-purpose settings for measuring components at finite frequency.

1

dc

DC Impedance Measurement: Settings for measuring resistance at zero frequency.

/DEV…​./SYSTEM/IMPEDANCE/FILTER

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Switch between application-based or manually configured impedance settings. A parameter set given by an Application mode can be fine-tuned by changing to Advanced mode. Changing back to Application mode will reset the parameters.

0

application

Application: The impedance settings are adjusted to fit best the selected application.

1

advanced

Advanced: The impedance settings are manually configured.

/DEV…​./SYSTEM/IMPEDANCE/PRECISION

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the Impedance precision and measurement speed by automatically adjusting the filter bandwidth. If the sweeper module is in impedance application mode the precision setting will also control the sweeper measurement speed.

0

low

Low → fast settling: Medium accuracy/precision is optimized for fast response.

1

high

High → medium settling: High accuracy/precision takes more settling time.

2

very_high

Very high → slow settling: Very high accuracy/precision uses long settling time due to very low bandwidth.

/DEV…​./SYSTEM/PRESET/BUSY

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates if presets are currently loaded.

/DEV…​./SYSTEM/PRESET/DEFAULT

Properties:

Read, Write

Type:

Integer (enumerated)

Unit:

None

Indicates the preset which is used as default preset at start-up of the device.

0

factory

Select factory preset as default preset.

1

Select the preset stored in internal flash memory at position 1 as default preset.

2

Select the preset stored in internal flash memory at position 2 as default preset.

3

Select the preset stored in internal flash memory at position 3 as default preset.

4

Select the preset stored in internal flash memory at position 4 as default preset.

5

Select the preset stored in internal flash memory at position 5 as default preset.

6

Select the preset stored in internal flash memory at position 6 as default preset.

/DEV…​./SYSTEM/PRESET/ERASE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Erase the selected preset.

/DEV…​./SYSTEM/PRESET/ERROR

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates if the last operation was illegal. Successful: 0, Error: 1.

/DEV…​./SYSTEM/PRESET/INDEX

Properties:

Read, Write

Type:

Integer (enumerated)

Unit:

None

Select between factory preset or presets stored in internal flash memory.

0

factory

Select factory preset.

1

Select the preset stored in internal flash memory at position 1.

2

Select the preset stored in internal flash memory at position 2.

3

Select the preset stored in internal flash memory at position 3.

4

Select the preset stored in internal flash memory at position 4.

5

Select the preset stored in internal flash memory at position 5.

6

Select the preset stored in internal flash memory at position 6.

/DEV…​./SYSTEM/PRESET/LOAD

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Load the selected preset.

/DEV…​./SYSTEM/PRESET/SAVE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Save the actual setting as preset.

/DEV…​./SYSTEM/PROPERTIES/FREQRESOLUTION

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The number of bits used to represent a frequency.

/DEV…​./SYSTEM/PROPERTIES/FREQSCALING

Properties:

Read

Type:

Double

Unit:

None

The scale factor to use to convert a frequency represented as a freqresolution-bit integer to a floating point value.

/DEV…​./SYSTEM/PROPERTIES/MAXFREQ

Properties:

Read

Type:

Double

Unit:

None

The maximum oscillator frequency that can be set.

/DEV…​./SYSTEM/PROPERTIES/MAXTIMECONSTANT

Properties:

Read

Type:

Double

Unit:

None

The maximum demodulator time constant that can be set.

/DEV…​./SYSTEM/PROPERTIES/MINFREQ

Properties:

Read

Type:

Double

Unit:

None

The minimum oscillator frequency that can be set.

/DEV…​./SYSTEM/PROPERTIES/MINTIMECONSTANT

Properties:

Read

Type:

Double

Unit:

None

The minimum demodulator time constant that can be set.

/DEV…​./SYSTEM/PROPERTIES/NEGATIVEFREQ

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates whether negative frequencies are supported.

/DEV…​./SYSTEM/PROPERTIES/TIMEBASE

Properties:

Read

Type:

Double

Unit:

s

Minimal time difference between two timestamps. The value is equal to 1/(maximum sampling rate).

/DEV…​./SYSTEM/COMPDELAY/DELAYS/n

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Current values of the compensation delays. 0: Signal Input 0, 1: Signal Input 1, 2: Aux Inputs, 3: Trigger Inputs, 4: Loopbacks

/DEV…​./SYSTEM/IMPEDANCE/CALIB/CABLELENGTH

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Length of cables (One way) used in measurement set up.

0

off

Off: cable length compensation is turned off.

1

1_m

Cable length is set to 1 m.

2

2_m

Cable length is set to 2 m.

3

3_m

Cable length is set to 3 m.

/DEV…​./SYSTEM/NICS/n/DEFAULTGATEWAY

Properties:

Read, Write

Type:

String

Unit:

None

Default gateway configuration for the network connection.

/DEV…​./SYSTEM/NICS/n/DEFAULTIP4

Properties:

Read, Write

Type:

String

Unit:

None

IPv4 address of the device to use if static IP is enabled.

/DEV…​./SYSTEM/NICS/n/DEFAULTMASK

Properties:

Read, Write

Type:

String

Unit:

None

IPv4 mask in case of static IP.

/DEV…​./SYSTEM/NICS/n/GATEWAY

Properties:

Read

Type:

String

Unit:

None

Current network gateway.

/DEV…​./SYSTEM/NICS/n/IP4

Properties:

Read

Type:

String

Unit:

None

Current IPv4 of the device.

/DEV…​./SYSTEM/NICS/n/JUMBO

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Stored setting for jumbo frames. Will be applied after reboot.

/DEV…​./SYSTEM/NICS/n/MAC

Properties:

Read

Type:

String

Unit:

None

Current MAC address of the device network interface.

/DEV…​./SYSTEM/NICS/n/MASK

Properties:

Read

Type:

String

Unit:

None

Current network mask.

/DEV…​./SYSTEM/NICS/n/SAVEIP

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

If written, this action will program the defined static IP address to the device.

/DEV…​./SYSTEM/NICS/n/STATIC

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Enable this flag if the device is used in a network with fixed IP assignment without a DHCP server.

/DEV…​./SYSTEM/UPDATE/LABONE/BUSY

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Device is updating.

/DEV…​./SYSTEM/UPDATE/LABONE/DATA

Properties:

Read, Write

Type:

ZIVectorData

Unit:

None

Node which accepts the Binary file to update the device.

/DEV…​./SYSTEM/UPDATE/LABONE/DONE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Updating has finished.

/DEV…​./SYSTEM/UPDATE/LABONE/ERROR

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

An error occurred during the update.

/DEV…​./SYSTEM/UPDATE/LABONE/PROGRESS

Properties:

Read

Type:

Double

Unit:

None

A value between 0 and 1 indicating the update progress.

/DEV…​./SYSTEM/UPDATE/LABONE/START

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

If set to 1 the device starts the update.

/DEV…​./SYSTEM/IMPEDANCE/CALIB/INTERNAL/ALLOWSMOOTHING

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Indicates whether smoothing can de applied to the device internal compensation data.

/DEV…​./SYSTEM/IMPEDANCE/CALIB/INTERNAL/DATA

Properties:

Read, Write

Type:

ZIVectorData

Unit:

None

Contains the user compensation data in binary form.

/DEV…​./SYSTEM/IMPEDANCE/CALIB/INTERNAL/INFO

Properties:

Read

Type:

String

Unit:

None

Contains general information about the device internal compensation data.

/DEV…​./SYSTEM/IMPEDANCE/CALIB/INTERNAL/STORE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Store the compensation data persistently on the device. The compensation will be loaded automatically on every power-up.

/DEV…​./SYSTEM/IMPEDANCE/CALIB/INTERNAL/VALID

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Indicates whether the device internal calibration data is valid (1 = valid, 0 = invalid).

/DEV…​./SYSTEM/IMPEDANCE/CALIB/USER/ALLOWSMOOTHING

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Indicates whether smoothing can de applied to the user calibration data.

/DEV…​./SYSTEM/IMPEDANCE/CALIB/USER/DATA

Properties:

Read, Write

Type:

ZIVectorData

Unit:

None

Contains the user compensation data in binary form.

/DEV…​./SYSTEM/IMPEDANCE/CALIB/USER/INFO

Properties:

Read

Type:

String

Unit:

None

Contains general information about the user compensation data.

/DEV…​./SYSTEM/IMPEDANCE/CALIB/USER/VALID

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Indicates whether the user compensation data is valid (1 = valid, 0 = invalid).

/DEV…​./SYSTEM/IMPEDANCE/FREQLIMIT2T/n/FREQ

Properties:

Read

Type:

Double

Unit:

None

Indicates the limit of a frequency range for 2-terminal impedance measurements.

/DEV…​./SYSTEM/IMPEDANCE/FREQLIMIT2T/n/RANGE

Properties:

Read

Type:

Double

Unit:

None

Indicates the minimum input current range that can be used at frequencies at or above the value in the corresponding freq node for 2-terminal impedance measurements.

/DEV…​./SYSTEM/IMPEDANCE/FREQLIMIT4T/n/FREQ

Properties:

Read

Type:

Double

Unit:

None

Indicates the limit of a frequency range for 4-terminal impedance measurements.

/DEV…​./SYSTEM/IMPEDANCE/FREQLIMIT4T/n/RANGE

Properties:

Read

Type:

Double

Unit:

None

Indicates the minimum input current range that can be used at frequencies at or above the value in the corresponding freq node for 4-terminal impedance measurements.

/DEV…​./SYSTEM/PRESET/RECORDS/n/FEATURES

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Properties of the preset.

/DEV…​./SYSTEM/PRESET/RECORDS/n/LABEL

Properties:

Read, Write

Type:

String

Unit:

None

Name of this preset.

/DEV…​./SYSTEM/PRESET/RECORDS/n/TIMESTAMP

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Not used.

/DEV…​./SYSTEM/PRESET/RECORDS/n/VALID

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

True if a valid preset is stored.

TRIGGERS

/DEV…​./TRIGGERS/IN/n/AUTOTHRESHOLD

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Automatically adjust the trigger threshold. The level is adjusted to fall in the center of the applied transitions.

/DEV…​./TRIGGERS/IN/n/LEVEL

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Trigger voltage level at which the trigger input toggles between low and high. Use 50% amplitude for digital input and consider the trigger hysteresis.

/DEV…​./TRIGGERS/OUT/n/PULSEWIDTH

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Defines the minimal pulse width for the case of Scope events written to the trigger outputs of the device.

/DEV…​./TRIGGERS/OUT/n/SOURCE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal assigned to the trigger output.

0

disabled

The output trigger is disabled.

1

demod1_phase

Oscillator phase of demod 2 (trigger output channel 1) or demod 4 (trigger output channel 2).

2

scope_trigger

Scope Trigger. Requires the DIG Option.

3

scope_not_trigger

Scope /Trigger. Requires the DIG Option.

4

scope_armed

Scope Armed. Requires the DIG Option.

5

scope_not_armed

Scope /Armed. Requires the DIG Option.

6

scope_active

Scope Active. Requires the DIG Option.

7

scope_not_active

Scope /Active. Requires the DIG Option.

36

th_logic_unit0_out

Threshold Logic Unit 1 output.

37

th_logic_unit1_out

Threshold Logic Unit 2 output.

38

th_logic_unit2_out

Threshold Logic Unit 3 output.

39

th_logic_unit3_out

Threshold Logic Unit 4 output.

52

mds_sync_out

MDS Sync Out.

TU (Threshold Unit)

/DEV…​./TU/LOGICUNITS/n/INTERNALVALUE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Show the value after logical combination but before output settings. The value integrated over some time. Values are 1: low, 2: high, 3: was low and high in the period.

/DEV…​./TU/LOGICUNITS/n/INVERT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Changes the output signal to low-active.

/DEV…​./TU/LOGICUNITS/n/KEEP

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Hold the output state indefinitely once it has changed to the activated state.

/DEV…​./TU/LOGICUNITS/n/PULSEWIDTH

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Minimum pulse width for the generated output signal. The width of pulses shorter than this time will be extended.

/DEV…​./TU/LOGICUNITS/n/VALUE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Shows the output value of the logic unit. The value integrated over some time. Values are 1: low, 2: high, 3: was low and high in the period.

/DEV…​./TU/THRESHOLDS/n/ACTIVATIONTIME

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Minimum duration of threshold violation needed before the output is activated. This can be used as a glitch filter.

/DEV…​./TU/THRESHOLDS/n/DEACTIVATIONTIME

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Minimum duration of threshold compliance needed before the output is deactivated.

/DEV…​./TU/THRESHOLDS/n/INPUT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal source to be used in the threshold unit.

0

demod_x

Demod X

1

demod_y

Demod Y

2

demod_r

Demod R

3

demod_theta

Demod Theta

5

pid_out

PID Out

6

boxcar

Boxcar

7

au_cartesian

AU Cartesian

8

au_polar

AU Polar

9

pid_shift

PID Shift

10

pid_error

PID Error

50

dio

DIO

51

trigin, trigger_input

Trigger In

52

trigout, trigger_output

Trigger Out

53

input_overload_v

Input Overload (V)

54

input_overload_i

Input Overload (I)

55

output_overload

Output Overload

56

auxin_overload, auxiliary_input_overload

Aux input Overload

57

auxout_overload, auxiliary_output_overload

Aux Output Overload

58

pid_output_overload

PID Output Overload

59

tu_output

TU Output Value

/DEV…​./TU/THRESHOLDS/n/INPUTCHANNEL

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Select the channel according to the selected signal source.

/DEV…​./TU/THRESHOLDS/n/INTERNALVALUE

Properties:

Read

Type:

Integer (64 bit)

Unit:

Dependent

Shows the value after threshold but before minimum time. The value integrated over some time. Values are 1: low, 2: high, 3: was low and high in the period.

/DEV…​./TU/THRESHOLDS/n/VALUE

Properties:

Read

Type:

Integer (64 bit)

Unit:

Dependent

Shows the threshold value at the threshold output. The value integrated over some time. Values are 1: low, 2: high, 3: was low and high in the period.

/DEV…​./TU/LOGICUNITS/n/INPUTS/n/CHANNEL

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Selects threshold channel to be used as input.

/DEV…​./TU/LOGICUNITS/n/INPUTS/n/NOT

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Inverts the input signal.

/DEV…​./TU/LOGICUNITS/n/OPS/n/VALUE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Logical operation applied to the signals to the left and right of the control.

0

off

No logical operation selected. No additional signals will be used to generate the output.

1

and

Use a logical AND operation.

2

or

Use a logical OR operation.

3

xor

Use a logical XOR operation.

/DEV…​./TU/THRESHOLDS/n/FILTER/ABS

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Takes the absolute value of an analog input signal.

/DEV…​./TU/THRESHOLDS/n/FILTER/ENABLE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Enables the low-pass filter applied to the analog input signal

/DEV…​./TU/THRESHOLDS/n/FILTER/FILTEREDVALUE

Properties:

Read

Type:

Double

Unit:

Dependent

Shows the value after the low-pass filter.

/DEV…​./TU/THRESHOLDS/n/FILTER/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the analysis mode defining the output signal.

0

above_upper

Enable if the Signal is above Upper Threshold.

1

below_lower

Enable if the Signal is below Lower Threshold.

2

outside_range

Enable if the Signal is outside the range [Lower Threshold, Upper Threshold].

3

crossing_both_rising

Enable if the Signal crosses Upper Threshold from below Lower Threshold. The difference between Upper an Lower Threshold defines the threshold hysteresis.

4

crossing_both_falling

Enable if the Signal crosses Lower Threshold from above Upper Threshold. The difference between Upper an Lower Threshold defines the threshold hysteresis.

/DEV…​./TU/THRESHOLDS/n/FILTER/THRESHOLDHIGH

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Upper threshold used to generate the output. In Falling Edge mode, this parameter defines the hysteretic behavior as the output state is reset only when the signal crosses Upper Threshold from below.

/DEV…​./TU/THRESHOLDS/n/FILTER/THRESHOLDLOW

Properties:

Read, Write, Setting

Type:

Double

Unit:

Dependent

Lower threshold used to generate the output. In Rising Edge mode, this parameter defines the hysteretic behavior as the output state is reset only when the signal crosses Lower Threshold from above.

/DEV…​./TU/THRESHOLDS/n/FILTER/TIMECONSTANT

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Defines the characteristic time constant (cut off) of the low-pass filter applied to the analog input signal.

ZI (LabOne Data Server Nodes)

/ZI/ABOUT/COMMIT

Properties:

Read

Type:

String

Unit:

None

Contains the commit hash of the source code used to build this version of the LabOne software.

/ZI/ABOUT/COPYRIGHT

Properties:

Read

Type:

String

Unit:

None

Holds the copyright notice.

/ZI/ABOUT/DATASERVER

Properties:

Read

Type:

String

Unit:

None

Contains information about the Zurich Instruments Data Server.

/ZI/ABOUT/FWREVISION

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Contains the revision of the device firmware.

/ZI/ABOUT/REVISION

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Contains the revision number of the Zurich Instruments Data Server.

/ZI/ABOUT/VERSION

Properties:

Read

Type:

String

Unit:

None

Contains the version of the LabOne software.

/ZI/CLOCKBASE

Properties:

Read

Type:

Double

Unit:

None

A fallback clock frequency that can be used by clients for calculating time bases when no other is available.

/ZI/CONFIG/OPEN

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Enable communication with the LabOne Data Server from other computers in the network.

0

local

Communication only possible with the local machine.

1

network

Communication possible with other machines in the network.

/ZI/CONFIG/PORT

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The IP port on which the LabOne Data Server listens.

/ZI/DEBUG/LEVEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Set the logging level (amount of detail) of the LabOne Data Server.

0

trace

Trace. Messages designated as traces are logged.

1

debug

Debug. Messages designated as debugging info are logged.

2

info

Info. Messages designated as informational are logged.

3

status

Status. Messages designated as status info are logged.

4

warning

Warning. Messages designated as warnings are logged.

5

error

Error. Messages designated as errors are logged.

6

fatal

Fatal. Messages designated as fatal errors are logged.

/ZI/DEBUG/LOG

Properties:

Read

Type:

String

Unit:

None

Returns the logfile text of the LabOne Data Server.

/ZI/DEBUG/LOGPATH

Properties:

Read

Type:

String

Unit:

None

Returns the path of the log directory.

/ZI/DEVICES/CONNECTED

Properties:

Read

Type:

String

Unit:

None

Contains a list of devices connected to the LabOne Data Server.

/ZI/DEVICES/DISCOVER

Properties:

Read, Write

Type:

String

Unit:

None

Not used.

/ZI/DEVICES/VISIBLE

Properties:

Read

Type:

String

Unit:

None

Contains a list of devices in the network visible to the LabOne Data Server.

/ZI/MDS/GROUPS/n/DEVICES

Properties:

Read, Write, Setting

Type:

String

Unit:

None

Contains a list of devices in this synchronization group.

/ZI/MDS/GROUPS/n/KEEPALIVE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Set by the MDS module to indicate control over this synchronization group.

/ZI/MDS/GROUPS/n/LOCKED

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Indicates whether the device group is locked by a MDS module.

/ZI/MDS/GROUPS/n/STATUS

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Indicates the status the synchronization group.

-1

Error. An error occurred in the synchronization process.

0

New

1

Sync

2

Alive

/ZI/SYSTEM/USAGEDATA

Properties:

Read

Type:

String

Unit:

None

Contains a JSON formatted string giving usage information about the LabOne Software (which tabs/modules used, error conditions).