Device Node Tree

This chapter contains reference documentation for the settings and measurement data available on UHFQA 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 UHFQA 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.

4

awg

Select one of the AWG Outputs for auxiliary output when running the AWG in four-channel mode. The AWG option needs to be installed.

5

pid

Select PID Out as the output option.

6

boxcar

Select Boxcar as the output option.

7

au_cartesian

Select AU Cartesian as the output option.

8

au_polar

Select AU Polar as the output option.

9

pid_shift

Select PID Shift as the output option.

10

pid_error

Select PID Error as the output option.

12

pulse_counter

Select Pulse Counter 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

AWGS

/DEV…​./AWGS/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Activates the AWG.

/DEV…​./AWGS/n/READY

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

AWG has a compiled wave form and is ready to be enabled.

/DEV…​./AWGS/n/SINGLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Puts the AWG into single shot mode.

/DEV…​./AWGS/n/TIME

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

AWG sampling rate. The numeric values are rounded for display purposes. The exact values are equal to the base sampling rate (1.8 GHz) divided by 2^n, where n is the node value. This value is used by default and can be overridden in the Sequence program.

0

1.80_GHz

1.80 GHz

1

900_MHz

900 MHz

2

450_MHz

450 MHz

3

225_MHz

225 MHz

4

113_MHz

112.5 MHz

5

56.3_MHz

56.25 MHz

6

28.1_MHz

28.12 MHz

7

14.1_MHz

14.06 MHz

8

7.03_MHz

7.03 MHz

9

3.52_MHz

3.52 MHz

10

1.76M_Hz

1.76 MHz

11

878.91_kHz

878.91 kHz

12

439_kHz

439.45 kHz

13

220_kHz

219.73 kHz

/DEV…​./AWGS/n/DIO/DATA

Properties:

Read

Type:

ZIVectorData

Unit:

None

A vector of 32-bit integers representing the values on the DIO interface.

/DEV…​./AWGS/n/ELF/CHECKSUM

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Checksum of the uploaded ELF file.

/DEV…​./AWGS/n/ELF/DATA

Properties:

Read, Write

Type:

ZIVectorData

Unit:

None

Contains the data of the uploaded ELF file.

/DEV…​./AWGS/n/ELF/LENGTH

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Length of the compiled ELF file.

/DEV…​./AWGS/n/ELF/MEMORYUSAGE

Properties:

Read

Type:

Double

Unit:

None

Size of the uploaded ELF file relative to the size of the main memory.

/DEV…​./AWGS/n/ELF/NAME

Properties:

Read

Type:

ZIVectorData

Unit:

None

The name of the uploaded ELF file.

/DEV…​./AWGS/n/ELF/PROGRESS

Properties:

Read

Type:

Double

Unit:

%

The percentage of the sequencer program already uploaded to the device.

/DEV…​./AWGS/n/SEQUENCER/ASSEMBLY

Properties:

Read

Type:

ZIVectorData

Unit:

None

Displays the current sequence program in compiled form. Every line corresponds to one hardware instruction and requires one clock cycle (4.44 ns) for execution.

/DEV…​./AWGS/n/SEQUENCER/CONTINUE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Reserved for future use.

/DEV…​./AWGS/n/SEQUENCER/MEMORYUSAGE

Properties:

Read

Type:

Double

Unit:

None

Size of the current sequence program relative to the device cache memory. The cache memory provides space for 1024 instructions.

/DEV…​./AWGS/n/SEQUENCER/NEXT

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Reserved for future use.

/DEV…​./AWGS/n/SEQUENCER/PC

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Current position in the list of sequence instructions during execution.

/DEV…​./AWGS/n/SEQUENCER/PROGRAM

Properties:

Read

Type:

ZIVectorData

Unit:

None

Displays the source code of the current sequence program.

/DEV…​./AWGS/n/SEQUENCER/STATUS

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Status of the sequencer on the instrument. Bit 0: sequencer is running; Bit 1: reserved; Bit 2: sequencer is waiting for a) waveform playback to finish, b) prefetch to finish, or c) trigger to arrive; Bit 3: AWG has detected an error

/DEV…​./AWGS/n/USERREGS/n

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Integer user register value. The sequencer has reading and writing access to the user register values during run time.

/DEV…​./AWGS/n/WAVEFORM/DESCRIPTORS

Properties:

Read

Type:

ZIVectorData

Unit:

None

JSON-formatted string containing a dictionary of various properties of the current waveform: name, filename, function, channels, marker bits, length, timestamp.

/DEV…​./AWGS/n/WAVEFORM/MEMORYUSAGE

Properties:

Read

Type:

Double

Unit:

%

Amount of the used waveform data relative to the device cache memory. The cache memory provides space for 32 kSa of waveform data. Memory Usage over 100% means that waveforms must be loaded from the main memory (128 MSa per channel) during playback, which can lead to delays.

/DEV…​./AWGS/n/AUXTRIGGERS/n/CHANNEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the digital trigger source signal.

0

trigin0, trigger_input0

Trigger In 1

1

trigin1, trigger_input1

Trigger In 2

2

trigin2, trigger_input2

Trigger In 3

3

trigin3, trigger_input3

Trigger In 4

4

trigout0, trigger_output0

Trigger Out 1

5

trigout1, trigger_output1

Trigger Out 2

6

trigout2, trigger_output2

Trigger Out 3

7

trigout3, trigger_output3

Trigger Out 4

/DEV…​./AWGS/n/AUXTRIGGERS/n/SLOPE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal edge that should activate the trigger. The trigger will be level sensitive when the Level option is selected.

0

level_sensitive

Level sensitive trigger

1

rising_edge

Rising edge trigger

2

falling_edge

Falling edge trigger

3

both_edges

Rising or falling edge trigger

/DEV…​./AWGS/n/AUXTRIGGERS/n/STATE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

State of the Auxiliary Trigger: No trigger detected/trigger detected.

/DEV…​./AWGS/n/DIO/DELAY/INDEX

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Index of the bit on the DIO interface for which the delay should be changed.

/DEV…​./AWGS/n/DIO/DELAY/VALUE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Corresponding delay value to apply to the given bit of the DIO interface in units of 450 MHz clock cycles. Valid values are 0 to 3.

/DEV…​./AWGS/n/DIO/STROBE/INDEX

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Select the DIO bit to use as the STROBE signal.

/DEV…​./AWGS/n/DIO/STROBE/SLOPE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal edge of the STROBE signal for use in timing alignment.

0

off

Off

1

rising_edge

Rising edge trigger

2

falling_edge

Falling edge trigger

3

both_edges

Rising or falling edge trigger

/DEV…​./AWGS/n/DIO/VALID/INDEX

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Select the DIO bit to use as the VALID signal to indicate a valid input is available.

/DEV…​./AWGS/n/DIO/VALID/POLARITY

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Polarity of the VALID bit that indicates that a valid input is available.

0

none

None: VALID bit is ignored.

1

low

Low: VALID bit must be logical zero.

2

high

High: VALID bit must be logical high.

3

both

Both: VALID bit may be logical high or zero.

/DEV…​./AWGS/n/OUTPUTS/n/AMPLITUDE

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Amplitude in units of full scale of the given AWG Output. The full scale corresponds to the Range voltage setting of the Signal Outputs.

/DEV…​./AWGS/n/OUTPUTS/n/ENABLES/n

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Enables the driving of the given AWG output channel.

/DEV…​./AWGS/n/OUTPUTS/n/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select between plain mode, amplitude modulation, and advanced mode.

0

plain

Plain: AWG Output goes directly to Signal Output.

1

modulation

Modulation: AWG Output 1 (2) is multiplied with oscillator signal of demodulator 4 (8).

2

advanced

Advanced: Output of AWG channel 1 (2) modulates demodulators 1-4 (5-8) with independent envelopes.

/DEV…​./AWGS/n/SWEEP/AWGTRIGS/n

Properties:

Read, Write

Type:

Double

Unit:

Dependent

Node used by the sweeper module for fast index sweeps. When selected as sweep grid the sweeper module will switch into a fast index based scan mode. This mode can be up to 1000 times faster than conventional node sweeps. The sequencer program must support this functionality. See section 'AWG Index Sweep' of the UHF user manual for more information.

/DEV…​./AWGS/n/TRIGGERS/n/CHANNEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the signal source for the analogue trigger.

0

sigin0, signal_input0

Signal Input 1

1

sigin1, signal_input1

Signal Input 2

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

demod3

Osc φ Demod 4

11

demod7

Osc φ Demod 8

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.

20

demod4_x

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

21

demod5_x

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

22

demod6_x

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

23

demod7_x

Demod 8 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.

36

demod4_y

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

37

demod5_y

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

38

demod6_y

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

39

demod7_y

Demod 8 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.

52

demod4_r

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

53

demod5_r

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

54

demod6_r

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

55

demod7_r

Demod 8 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.

68

demod4_theta

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

69

demod5_theta

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

70

demod6_theta

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

71

demod7_theta

Demod 8 Θ. 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.

96

boxcar0

Boxcar 1. Requires an installed digitizer (DIG) option.

97

boxcar1

Boxcar 2. Requires an installed digitizer (DIG) option.

112

au_cartesian0

AU Cartesian 1. Requires an installed digitizer (DIG) option.

113

au_cartesian1

AU Cartesian 2. Requires an installed digitizer (DIG) option.

128

au_polar1

Au Polar 2. 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.

176

awg_marker0

AWG Marker 1. Requires an installed digitizer (DIG) option.

177

awg_marker1

AWG Marker 2. Requires an installed digitizer (DIG) option.

178

awg_marker2

AWG Marker 3. Requires an installed digitizer (DIG) option.

179

awg_marker3

AWG Marker 4. Requires an installed digitizer (DIG) option.

192

awg_trigger0

AWG Trigger 1. Requires an installed digitizer (DIG) option.

193

awg_trigger1

AWG Trigger 2. Requires an installed digitizer (DIG) option.

194

awg_trigger2

AWG Trigger 3. Requires an installed digitizer (DIG) option.

195

awg_trigger3

AWG Trigger 4. 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.

/DEV…​./AWGS/n/TRIGGERS/n/FALLING

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Sets a falling edge trigger.

/DEV…​./AWGS/n/TRIGGERS/n/FORCE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Allows to manually force a trigger.

/DEV…​./AWGS/n/TRIGGERS/n/GATE/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

If enabled the trigger will be gated by the trigger gating input signal.

/DEV…​./AWGS/n/TRIGGERS/n/GATE/INPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal source used for trigger gating if gating is enabled.

0

trigin2, trigger_input2

Trigger In 3

1

trigin3, trigger_input3

Trigger In 4

/DEV…​./AWGS/n/TRIGGERS/n/HYSTERESIS/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…​./AWGS/n/TRIGGERS/n/HYSTERESIS/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 (V).

1

relative

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

/DEV…​./AWGS/n/TRIGGERS/n/HYSTERESIS/RELATIVE

Properties:

Read, Write, Setting

Type:

Double

Unit:

%

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

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

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Defines the analog trigger level.

/DEV…​./AWGS/n/TRIGGERS/n/RISING

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Sets a rising edge trigger.

/DEV…​./AWGS/n/TRIGGERS/n/SLOPE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal edge that should activate the trigger. The trigger will be level sensitive when the Level option is selected.

0

level_sensitive

Level sensitive trigger

1

rising_edge

Rising edge trigger

2

falling_edge

Falling edge trigger

3

both_edegs

Rising or falling edge trigger

/DEV…​./AWGS/n/TRIGGERS/n/STATE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

State of the Trigger: No trigger detected/trigger detected.

/DEV…​./AWGS/n/WAVEFORM/WAVES/n

Properties:

Read, Write

Type:

ZIVectorData

Unit:

None

The waveform data in the instrument’s native format for the given playWave waveform index. This node will not work with subscribe as it does not push updates. For short vectors get may be used. For long vectors (causing get to time out) getAsEvent and poll can be used. The index of the waveform to be replaced can be determined using the Waveform sub-tab in the AWG tab of the LabOne User Interface.

CLOCKBASE

/DEV…​./CLOCKBASE

Properties:

Read

Type:

Double

Unit:

Hz

Returns the internal clock frequency of the device.

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

The DIO is internally clocked with a frequency of 56.25 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.

2

internal

The DIO is internally clocked with a frequency of 50 MHz.

/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.

1

awg_sequencer_commands

Enables setting of DIO output values by AWG sequencer commands.

2

qa_result

Enables setting of DIO output values by QA results.

4

qa_result_qccs

Enables setting of DIO output values by QA results compatible with the QCCS.

/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.

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.

OSCS (Oscillators)

/DEV…​./OSCS/n/FREQ

Properties:

Read, Write, Setting

Type:

Double

Unit:

Hz

Frequency control for each oscillator.

QAS

/DEV…​./QAS/n/DELAY

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Delay in units of samples that adjusts the time at which the integration starts in relation to the trigger signal of the weighted integration units.

/DEV…​./QAS/n/BYPASS/CROSSTALK

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Bypass the Crosstalk matrix in order to reduce the latency through the system.

/DEV…​./QAS/n/BYPASS/DESKEW

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Bypass the Deskew matrix in order to reduce the latency through the system.

/DEV…​./QAS/n/BYPASS/ROTATION

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Bypass the complex Rotation in order to reduce the latency through the system.

/DEV…​./QAS/n/CROSSTALK/BYPASS

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Bypass the Crosstalk matrix in order to reduce the latency through the system.

/DEV…​./QAS/n/INTEGRATION/ERRORS

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of hold-off violations detected in the INTEGRATION unit since last reset.

/DEV…​./QAS/n/INTEGRATION/LENGTH

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Integration time of all weighted integration units specified in units of samples. A maximum of 4096 samples can be integrated, which corresponds to 2.3 µs.

/DEV…​./QAS/n/INTEGRATION/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Operation mode of all weighted integration units.

0

normal

Normal mode. The integration weights are given by the user-programmed filter memory 1

1

spectroscopy

Spectroscopy mode. The integration weights are generated by a digital oscillator. This mode offers enhanced frequency resolution.

/DEV…​./QAS/n/MONITOR/ACQUIRED

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates the index of the acquisition that will be performed on the next trigger.

/DEV…​./QAS/n/MONITOR/AVERAGES

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

log2 of the number of averages to perform, i.e. 0 means no averaging, 1 means 2 values are averaged, etc. Maximum setting is 15 meaning 2^15 values are averaged.

/DEV…​./QAS/n/MONITOR/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable the trigger inputs of the MONITOR from the AWG.

/DEV…​./QAS/n/MONITOR/ERRORS

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of hold-off errors detected since last reset.

/DEV…​./QAS/n/MONITOR/LENGTH

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

The time duration of each capture in samples. A maximum of 4096 samples can be captured, which corresponds to 2.3 µs.

/DEV…​./QAS/n/MONITOR/RESET

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Reset the Input Monitor and prepare it for a new measurement.

/DEV…​./QAS/n/RESULT/ACQUIRED

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates the index of the acquisition that will be performed on the next trigger.

/DEV…​./QAS/n/RESULT/AVERAGES

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

log2 of the number of averages to perform, i.e. 0 means no averaging, 1 means 2 values are averaged, etc. Maximum setting is 15 meaning 2^15 values are averaged.

/DEV…​./QAS/n/RESULT/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable the trigger inputs of the MONITOR from the AWG.

/DEV…​./QAS/n/RESULT/ERRORS

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of hold-off errors detected since last reset.

/DEV…​./QAS/n/RESULT/LENGTH

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Number of data points to record. One data point corresponds to a single averaged output of the selected source.

/DEV…​./QAS/n/RESULT/MODE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the order of the result logger.

0

experiment_first

Experiment first.

1

average_first

Average first.

/DEV…​./QAS/n/RESULT/RESET

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Reset the Result Logger and prepare it for a new measurement.

/DEV…​./QAS/n/RESULT/SOURCE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Select the signal source of the Result Logger.

0

result_after_crosstalk_unit

Result after crosstalk unit.

1

result_after_threshold_unit

Result after Threshold unit.

2

result_after_rotation_unit

Result after Rotation unit.

4

correlation_after_crosstalk_unit

Correlation unit after the Crosstalk unit.

5

correlation_after_threshold_unit

Correlation unit after the Threshold unit.

/DEV…​./QAS/n/ROTATIONS/n

Properties:

Read, Write, Setting

Type:

Complex Double

Unit:

None

Rotation coefficient applied to the signals after integration. The values are defined as complex floating point numbers.

/DEV…​./QAS/n/CORRELATIONS/n/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable correlation for a given channel.

/DEV…​./QAS/n/CORRELATIONS/n/SOURCE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Controls the source with which correlation should be made. Selecting the same source as the readout channel number is effectively self-correlation.

/DEV…​./QAS/n/CROSSTALK/ROWS/n/COLS/n

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Transformation coefficients for each channel as a 10×10 matrix. The values are defined as floating point numbers. In hardware, the coefficients are implemented as 17-bit signed integers.

/DEV…​./QAS/n/DESKEW/ROWS/n/COLS/n

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

Implements a 2×2 matrix multiplication. The two input signals are treated as a vector with two elements and the result is a vector as well.

/DEV…​./QAS/n/INTEGRATION/SOURCES/n

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Controls the routing of the input signals to the INTEGRATION units.

0

sigin0_real_sigin1_imag

Signal input 1 to real part, Signal input 2 to imaginary part.

1

sigin1_real_sigin0_imag

Signal input 2 to real part, Signal input 1 to imaginary part

/DEV…​./QAS/n/INTEGRATION/TRIGGER/CHANNEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the trigger channel for the weighted integration.

0

Trigger 1

1

Trigger 2

2

Trigger In 3

3

Trigger In 4

7

AWG Integration Trigger (default)

/DEV…​./QAS/n/INTEGRATION/WEIGHTS/n/IMAG

Properties:

Read, Write, Setting

Type:

ZIVectorData

Unit:

None

The weight functions to be applied on the imaginary part of the input signal. The weights are written as vectors. In the hardware the weights are implemented as 17-bit integers.

/DEV…​./QAS/n/INTEGRATION/WEIGHTS/n/REAL

Properties:

Read, Write, Setting

Type:

ZIVectorData

Unit:

None

The weight functions to be applied on the real part of the input signal. The weights are written as vectors. In the hardware the weights are implemented as 17-bit integers.

/DEV…​./QAS/n/MONITOR/INPUTS/n/WAVE

Properties:

Read

Type:

ZIVectorData

Unit:

V

The results of the data acquired for Signal Input in units of volts.

/DEV…​./QAS/n/MONITOR/TRIGGER/CHANNEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the trigger channel for the input averaging.

0

Trigger 1

1

Trigger 2

2

Trigger In 3

3

Trigger In 4

7

AWG Monitor Trigger (default)

/DEV…​./QAS/n/RESULT/DATA/n/WAVE

Properties:

Read

Type:

ZIVectorData

Unit:

V

The results of the data acquired for Signal Input in units of volts.

/DEV…​./QAS/n/RESULT/STATISTICS/DATA/n/ERRORS

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of state errors measured for this channel. A state error occurs when there is a discrepancy between the measured state of this channel and the state that is predicted based on the configured state table.

/DEV…​./QAS/n/RESULT/STATISTICS/DATA/n/FLIPS

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of flips measured for this channel. A flip is defined as a change in qubit state from one measurement to the next.

/DEV…​./QAS/n/RESULT/STATISTICS/DATA/n/ONES

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Number of logical ones measured for this channel.

/DEV…​./QAS/n/RESULT/STATISTICS/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable automatic readout of the STATISTICS results.

/DEV…​./QAS/n/RESULT/STATISTICS/LENGTH

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

The number of data points to record. One data point corresponds to a single averaged output of the selected source.

/DEV…​./QAS/n/RESULT/STATISTICS/RESET

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Reset the STATISTICS results in preparation for a new measurement.

/DEV…​./QAS/n/RESULT/STATISTICS/STATEERRORS

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Number of STATEMAP violations detected during measurement.

/DEV…​./QAS/n/RESULT/STATISTICS/STATEMAP

Properties:

Read, Write, Setting

Type:

ZIVectorData

Unit:

None

Defines the state table. The node has one entry for each possible state, i.e. 32 entries in case of five readout channels. The value of each entry defines the expected next state as a simple bit mask mapped to an unsigned integer.

/DEV…​./QAS/n/THRESHOLDS/n/CORRELATION/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the correlation for the given channel.

/DEV…​./QAS/n/THRESHOLDS/n/CORRELATION/SOURCE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Select the channel with which correlation should be made. Selecting the same channel as the readout channel number corresponds to self-correlation.

/DEV…​./QAS/n/THRESHOLDS/n/LEVEL

Properties:

Read, Write, Setting

Type:

Double

Unit:

None

The discretization level applied to the output of the Crosstalk Suppression matrix.

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

1.80 GHz

1

900 MHz

2

450 MHz

3

225 MHz

4

113 MHz

5

56.2 MHz

6

28.1 MHz

7

14.0 MHz

8

7.03 MHz

9

3.50 MHz

10

1.75 MHz

11

880 kHz

12

440 kHz

13

220 kHz

14

110 kHz

15

54.9 kHz

16

27.5 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

sigin1, signal_input1

Signal Input 2

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

demod3

Osc φ Demod 4

11

demod7

Osc φ Demod 8

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.

20

demod4_x

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

21

demod5_x

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

22

demod6_x

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

23

demod7_x

Demod 8 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.

36

demod4_y

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

37

demod5_y

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

38

demod6_y

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

39

demod7_y

Demod 8 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.

52

demod4_r

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

53

demod5_r

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

54

demod6_r

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

55

demod7_r

Demod 8 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.

68

demod4_theta

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

69

demod5_theta

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

70

demod6_theta

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

71

demod7_theta

Demod 8 Θ. 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.

96

boxcar0

Boxcar 1. Requires an installed digitizer (DIG) option.

97

boxcar1

Boxcar 2. Requires an installed digitizer (DIG) option.

112

au_cartesian0

AU Cartesian 1. Requires an installed digitizer (DIG) option.

113

au_cartesian1

AU Cartesian 2. Requires an installed digitizer (DIG) option.

128

au_polar0

AU Polar 1. Requires an installed digitizer (DIG) option.

129

au_polar1

Au Polar 2. 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.

176

awg_marker0

AWG Marker 1. Requires an installed digitizer (DIG) option.

177

awg_marker1

AWG Marker 2. Requires an installed digitizer (DIG) option.

178

awg_marker2

AWG Marker 3. Requires an installed digitizer (DIG) option.

179

awg_marker3

AWG Marker 4. Requires an installed digitizer (DIG) option.

192

awg_trigger0

AWG Trigger 1. Requires an installed digitizer (DIG) option.

193

awg_trigger1

AWG Trigger 2. Requires an installed digitizer (DIG) option.

194

awg_trigger2

AWG Trigger 3. Requires an installed digitizer (DIG) option.

195

awg_trigger3

AWG Trigger 4. 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.

/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.

6

28.1_MHz

28.1 MHz

7

14_MHz

14.0 MHz

8

7.03_MHz

7.03 MHz

9

3.5_MHz

3.50 MHz

10

1.75_MHz

1.75 MHz

11

880_kHz

880 kHz

12

440_kHz

440 kHz

13

220_kHz

220 kHz

14

110_kHz

110 kHz

15

54.9_kHz

54.9 kHz

16

27.5_kHz

27.5 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

trigin2_high, trigger_input2_high

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

1

trigin2_low, trigger_input2_low

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

2

trigin3_high, trigger_input3_high

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

3

trigin3_low, trigger_input3_low

Only trigger if the Trigger Input 4 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

sigin1, signal_input1

Signal Input 2

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

demod3

Osc φ Demod 4

11

demod7

Osc φ Demod 8

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.

20

demod4_x

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

21

demod5_x

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

22

demod6_x

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

23

demod7_x

Demod 8 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.

36

demod4_y

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

37

demod5_y

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

38

demod6_y

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

39

demod7_y

Demod 8 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.

52

demod4_r

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

53

demod5_r

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

54

demod6_r

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

55

demod7_r

Demod 8 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.

68

demod4_theta

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

69

demod5_theta

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

70

demod6_theta

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

71

demod7_theta

Demod 8 Θ. 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.

96

boxcar0

Boxcar 1. Requires an installed digitizer (DIG) option.

97

boxcar1

Boxcar 2. Requires an installed digitizer (DIG) option.

112

au_cartesian0

AU Cartesian 1. Requires an installed digitizer (DIG) option.

113

au_cartesian1

AU Cartesian 2. Requires an installed digitizer (DIG) option.

128

au_polar1

Au Polar 2. 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.

176

awg_marker0

AWG Marker 1. Requires an installed digitizer (DIG) option.

177

awg_marker1

AWG Marker 2. Requires an installed digitizer (DIG) option.

178

awg_marker2

AWG Marker 3. Requires an installed digitizer (DIG) option.

179

awg_marker3

AWG Marker 4. Requires an installed digitizer (DIG) option.

192

awg_trigger0

AWG Trigger 1. Requires an installed digitizer (DIG) option.

193

awg_trigger1

AWG Trigger 2. Requires an installed digitizer (DIG) option.

194

awg_trigger2

AWG Trigger 3. Requires an installed digitizer (DIG) option.

195

awg_trigger3

AWG Trigger 4. 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.

/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/BW

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Bandwidth of input aliasing filter at 600 MHz (ON) or 900 MHz (OFF) cut off frequency.

/DEV…​./SIGINS/n/DIFF

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Switch input mode between normal (OFF), inverted, and differential. The differential modes are implemented digitally and are not suited for analog common-mode rejection.

0

Off

1

Inverted

3

in1_minus_in0

Input 2 - Input 1

4

in0_minus_in1

Input 1 - Input 2

/DEV…​./SIGINS/n/IMP50

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

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

0

1_MOhm

OFF: 1 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.

SIGOUTS

/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/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/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/CURRENTS/n

Properties:

Read

Type:

Double

Unit:

mA

Internal current measurements.

/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: Signal Input 2 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/FX2REVISION

Properties:

Read

Type:

String

Unit:

None

USB firmware revision.

/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/POWERCONFIGDATE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Contains the date of power configuration (format is: (year << 16) | (month << 8) | day)

/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/STALL

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Indicates if the network connection is stalled.

/DEV…​./SYSTEM/UPDATE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Requests update of the device firmware and bitstream from the dataserver.

/DEV…​./SYSTEM/XENPAKENABLE

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates whether the 10 gigabit ethernet option is installed and enabled.

/DEV…​./SYSTEM/AWG/CHANNELGROUPING

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Sets the channel grouping mode of the device.

0

groups_of_2

Use the outputs in groups of 2. One sequencer program controls 2 outputs (use /dev…​./awgs/0..4/).

1

groups_of_4

Use the outputs in groups of 4. One sequencer program controls 4 outputs (use /dev…​./awgs/0/ and /dev…​./awgs/2/)

2

groups_of_8

Use the outputs in groups of 8. One sequencer program controls 8 outputs (use /dev…​./awgs/0/). Requires 8 channel device.

/DEV…​./SYSTEM/BOARDREVISIONS/n

Properties:

Read

Type:

String

Unit:

None

Hardware revision of the FPGA base board

/DEV…​./SYSTEM/CALIB/AUTO

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables an automatic instrument self calibration about 16 min after start up. In order to guarantee the full specification, it is recommended to perform a self calibration after warm-up of the device.

/DEV…​./SYSTEM/CALIB/CALIBRATE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Initiates self calibration to improve input digitizer linearity.

/DEV…​./SYSTEM/CALIB/NEXT

Properties:

Read

Type:

Integer (64 bit)

Unit:

s

Remaining seconds until the first calibration is executed or a recalibration is requested.

/DEV…​./SYSTEM/CALIB/REQUIRED

Properties:

Read

Type:

Integer (enumerated)

Unit:

None

State of device self calibration.

0

Device is warmed-up and self calibrated.

1

It is recommended to manually execute a self calibration to assure operation according to specifications.

2

Device is warming up and will automatically execute a self calibration after 16 minutes.

/DEV…​./SYSTEM/CALIB/TEMPTHRESHOLD

Properties:

Read, Write, Setting

Type:

Double

Unit:

°C

When the temperature changes by the specified amount, it is recommended to rerun the self calibration.

/DEV…​./SYSTEM/CALIB/TIMEINTERVAL

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

s

Time interval for which the self calibration is valid. After this time it is recommended to rerun the auto calibration.

/DEV…​./SYSTEM/COMPDELAY/CALIBRATE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Perform automatic calibration of the input delay compensation.

/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/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/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/IMP50

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Trigger input impedance: When on, the trigger input impedance is 50 Ohm, when off 1 k Ohm.

/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/DELAY

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Trigger delay, controls the fine delay of the trigger output. The resolution is 78 ps.

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

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

When on, the bidirectional trigger on the front panel is in output mode. When off, the trigger is in input mode.

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

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

Defines the minimal pulse width for the case of Scope and AWG Trigger/Active 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

demod3_phase

Oscillator phase of demod 4 (trigger output channel 1) or demod 8 (trigger output channel 2). Trigger event is output for each zero crossing of the oscillator phase.

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.

8

awg_marker0

AWG Marker 1. Requires the AWG Option.

9

awg_marker1

AWG Marker 2. Requires the AWG Option.

10

awg_marker2

AWG Marker 3. Requires the AWG Option.

11

awg_marker3

AWG Marker 4. Requires the AWG Option.

20

awg_active

AWG Active. Requires the AWG Option.

21

awg_waiting

AWG Waiting. Requires the AWG Option.

22

awg_fetching

AWG Fetching. Requires the AWG Option.

23

awg_playing

AWG Playing. Requires the AWG Option.

32

awg_trigger0

AWG Trigger 1. Requires the AWG Option.

33

awg_trigger1

AWG Trigger 2. Requires the AWG Option.

34

awg_trigger2

AWG Trigger 3. Requires the AWG Option.

35

awg_trigger3

AWG Trigger 4. Requires the AWG Option.

51

mds_clock_out

MDS Clock Out.

52

mds_sync_out

MDS Sync Out.

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).