Node Documentation

This chapter 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 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, its 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 its 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

The node corresponds to a writable instrument configuration. The data of these nodes are persisted in snapshots of the instrument and stored in the 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 A full list of streaming nodes is available in 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, 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

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.

The Global nodes of the LabOne Data Server are listed in the Instrument Communication chapter of the LabOne Programming Manual

Reference Node Documentation

This section describes all the nodes in the data server’s node tree organized by branch.

AUXOUTS

/DEV…​./AUXOUTS/n/HIGHPRECISION/OFFSET

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

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

/DEV…​./AUXOUTS/n/HIGHPRECISION/OUTPUTCHANNEL

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Selects the channel of the selected signal source.

/DEV…​./AUXOUTS/n/HIGHPRECISION/OUTPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the signal source for the Auxiliary Output.

-1

manual

Selects Manual as the output option.

0

demod_x

Selects Demod X as the output option.

1

demod_y

Selects Demod Y as the output option.

/DEV…​./AUXOUTS/n/HIGHPRECISION/PREOFFSET

Properties:

Read, Write, Setting

Type:

Double

Unit:

unit of signal source

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

/DEV…​./AUXOUTS/n/HIGHPRECISION/SCALE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V / [unit of signal source]

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

/DEV…​./AUXOUTS/n/HIGHSPEED/OFFSET

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

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

/DEV…​./AUXOUTS/n/HIGHSPEED/OUTPUTCHANNEL

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Selects the channel of the selected signal source.

/DEV…​./AUXOUTS/n/HIGHSPEED/OUTPUTSELECT

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the signal source for the Auxiliary Output.

-1

manual

Selects Manual as the output option.

0

demod_x

Selects Demod X as the output option.

1

demod_y

Selects Demod Y as the output option.

/DEV…​./AUXOUTS/n/HIGHSPEED/PREOFFSET

Properties:

Read, Write, Setting

Type:

Double

Unit:

unit of signal source

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

/DEV…​./AUXOUTS/n/HIGHSPEED/SCALE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V / [unit of signal source]

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

CLOCKBASE

/DEV…​./CLOCKBASE

Properties:

Read

Type:

Double

Unit:

Hz

Returns the internal clock frequency of the device.

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

sigin1, signal_input1

Sig In 2

/DEV…​./DEMODS/n/BURSTLEN

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Defines how many (complex) samples should be acquired with each trigger. Reserved for future use.

/DEV…​./DEMODS/n/BYPASS

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

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

0

disabled

disabled

1

enabled

enabled

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

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates the number of times the acquisition unit is busy (still recording previous burst) and trigger is omitted. Reserved for future use.

/DEV…​./DEMODS/n/MISSEDTRIGFULL

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates the number of times the memory is full and trigger is omitted.

/DEV…​./DEMODS/n/ORDER

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the filter roll off between 6 dB/oct and 24 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

/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

4

Oscillator 5

5

Oscillator 6

6

Oscillator 7

7

Oscillator 8

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

ZIVectorData

Unit:

Dependent

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

/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) of the demodulator.

0

continuous

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

DIOS (Digital I/O)

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

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

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

/DEV…​./DIOS/n/INTERFACE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Selects the interface standard to use on the 32-bit DIO interface. A value of 0 means that a 3.3 V CMOS interface is used. A value of 1 means that an LVDS compatible interface is used.

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

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

Write

Type:

String

Unit:

None

Node providing a mechanism to enter feature codes into the instrument.

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

SCOPES

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

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Configures the number of Scope measurements to average.

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

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables averaging of Scope measurements.

/DEV…​./SCOPES/n/CHANNELS/m/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

Dependent

Enables recording for this Scope channel.

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

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the scope input signal.

0

sigin0, signal_input0

Signal Input Channel 1

1

sigin1, signal_input1

Signal Input Channel 2

8

Aux Input Channel 1

9

Aux Input Channel 2

16

auxin0, auxiliary_input0

Aux Input Channel 1

17

auxin1, auxiliary_input1

Aux Input Channel 2

/DEV…​./SCOPES/n/CHANNELS/m/WAVE

Properties:

Read

Type:

ZIVectorData

Unit:

Dependent

Contains the acquired Scope measurement data.

/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/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/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 (64 bit)

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.

/DEV…​./SCOPES/n/TRIGGER/CHANNEL

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Selects the trigger source signal.

0

chan0trigin0, channel0_trigger_input0

Channel 1, Trigger Input A. Reserved for future use.

1

chan0trigin1, channel0_trigger_input1

Channel 1, Trigger Input B. Reserved for future use.

2

chan1trigin0, channel1_trigger_input0

Channel 2, Trigger Input A. Reserved for future use.

3

chan1trigin1, channel1_trigger_input1

Channel 2, Trigger Input B. Reserved for future use.

1024

swtrig0, software_trigger0

Software Trigger 1.

/DEV…​./SCOPES/n/TRIGGER/DELAY

Properties:

Read, Write, Setting

Type:

Double

Unit:

s

The delay of a Scope measurement. A negative delay results in data being acquired before the trigger point. The resolution is 2 ns.

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

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

off

OFF: Continuous scope shot acquisition

1

on

ON: Trigger based scope shot acquisition

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

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables the signal input.

/DEV…​./SIGINS/n/OVERRANGECOUNT

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates the number of times the Signal Input was in an overrange condition within the last 200 ms. It is checked for an overrange condition every 10 ms.

/DEV…​./SIGINS/n/RANGE

Properties:

Read, Write, Setting

Type:

Double

Unit:

dBm

Sets the maximal Range of the Signal Input power. The instrument selects the closest available Range with a resolution of 5 dBm.

/DEV…​./SIGINS/n/RFPATH

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Switches between radio frequency and baseband signal paths.

0

BB

Baseband path

1

RF

Radio frequency path

SIGOUTS

/DEV…​./SIGOUTS/n/FILTER

Properties:

Read

Type:

Integer (enumerated)

Unit:

None

Reads the selected analog filter before the Signal Output.

0

lowpass_1500

Low-pass filter of 1.5 GHz.

1

lowpass_3000

Low-pass filter of 3 GHz.

2

bandpass_3000_6000

Band-pass filter between 3 GHz - 6 GHz

3

bandpass_6000_10000

Band-pass filter between 6 GHz - 10 GHz

/DEV…​./SIGOUTS/n/GENERATORS/m/AMPLITUDE

Properties:

Read, Write, Setting

Type:

Double

Unit:

V

Sets the amplitude of the generator output.

/DEV…​./SIGOUTS/n/GENERATORS/m/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enables (1) or disables (0) the generator output.

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

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

Indicates the number of times the Signal Output was in an overrange condition within the last 200 ms. It is checked for an overrange condition every 10 ms.

/DEV…​./SIGOUTS/n/RANGE

Properties:

Read, Write, Setting

Type:

Double

Unit:

dBm

Sets the maximal Range of the Signal Output power. The instrument selects the closest available Range with a resolution of 5 dBm.

/DEV…​./SIGOUTS/n/RFINTERLOCK

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Enables (1) or disables (0) the RF interlock between input and output of the same channel. If enabled, the output is always configured according to the input.

0

disabled

RF interlock disabled.

1

enabled

RF interlock enabled.

/DEV…​./SIGOUTS/n/RFPATH

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Switches between radio frequency and baseband signal paths.

0

BB

Baseband path.

1

RF

Radio frequency path.

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/AUXOUTS/n/TEMPERATURES/m

Properties:

Read

Type:

Double

Unit:

°C

Provides internal temperature readings on the Auxiliary Output board for monitoring.

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

Properties:

Read

Type:

Double

Unit:

V

Provides internal voltage measurement on the Auxiliary Output board for monitoring.

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

Properties:

Read

Type:

Double

Unit:

mA

Internal current measurements.

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

Properties:

Read

Type:

Integer (64 bit)

Unit:

RPM

Speed of the internal cooling fans for monitoring.

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

Properties:

Read

Type:

Double

Unit:

°C

Internal temperature of the FPGA’s processor system.

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

Properties:

Read

Type:

Double

Unit:

°C

Internal temperature of the FPGA.

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

Properties:

Read

Type:

Double

Unit:

A

Currents of the main power supply.

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

Properties:

Read

Type:

Double

Unit:

°C

Temperatures of the main power supply.

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

Properties:

Read

Type:

Double

Unit:

V

Voltages of the main power supply.

/DEV…​./STATS/PHYSICAL/SIGINS/n/CURRENTS/m

Properties:

Read

Type:

Double

Unit:

A

Provides internal current readings on the Signal Input board for monitoring.

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

Properties:

Read

Type:

Double

Unit:

°C

Provides internal temperature readings on the Signal Input board for monitoring.

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

Properties:

Read

Type:

Double

Unit:

V

Provides internal voltage measurement on the Signal Input board for monitoring.

/DEV…​./STATS/PHYSICAL/SIGOUTS/n/CURRENTS/m

Properties:

Read

Type:

Double

Unit:

A

Provides internal current readings on the Signal Output board for monitoring.

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

Properties:

Read

Type:

Double

Unit:

°C

Provides internal temperature readings on the Signal Output board for monitoring.

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

Properties:

Read

Type:

Double

Unit:

V

Provides internal voltage readings on the Signal Output board for monitoring.

/DEV…​./STATS/PHYSICAL/SYNTHESIZER/CURRENTS/n

Properties:

Read

Type:

Double

Unit:

A

Provides internal current readings on the Synthesizer board for monitoring.

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

Properties:

Read

Type:

Double

Unit:

°C

Provides internal temperature readings on the Synthesizer board for monitoring.

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

Properties:

Read

Type:

Double

Unit:

V

Provides internal voltage readings on the Synthesizer board for monitoring.

/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/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. Reserved for future use.

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

/DEV…​./STATUS/TIME

Properties:

Read

Type:

Integer (64 bit)

Unit:

None

The current timestamp.

SYNTHESIZERS

/DEV…​./SYNTHESIZERS/n/CENTERFREQ

Properties:

Read, Write, Setting

Type:

Double

Unit:

Hz

The Center Frequency of the detection band at the input/output of the instrument

SYSTEM

/DEV…​./SYSTEM/ACTIVEINTERFACE

Properties:

Read

Type:

String

Unit:

None

Currently active interface of the device.

/DEV…​./SYSTEM/BOARDREVISIONS/n

Properties:

Read

Type:

String

Unit:

None

Hardware revision of the FPGA base board

/DEV…​./SYSTEM/CLOCKS/REFERENCECLOCK/IN/FREQ

Properties:

Read

Type:

Double

Unit:

Hz

Indicates the frequency of the reference clock.

/DEV…​./SYSTEM/CLOCKS/REFERENCECLOCK/IN/SOURCE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

The intended reference clock source. When the source is changed, all the instruments connected with ZSync links will be disconnected. The connection should be re-established manually.

0

internal

The internal clock is intended to be used as the frequency and time base reference.

1

external

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

/DEV…​./SYSTEM/CLOCKS/REFERENCECLOCK/IN/SOURCEACTUAL

Properties:

Read

Type:

Integer (enumerated)

Unit:

None

The actual reference clock source.

0

internal

The internal clock is used as the frequency and time base reference.

1

external

An external clock is used as the frequency and time base reference.

/DEV…​./SYSTEM/CLOCKS/REFERENCECLOCK/IN/STATUS

Properties:

Read

Type:

Integer (enumerated)

Unit:

None

Status of the reference clock.

0

Reference clock has been locked on.

1

There was an error locking onto the reference clock signal.

2

The device is busy trying to lock onto the reference clock signal.

/DEV…​./SYSTEM/CLOCKS/REFERENCECLOCK/OUT/ENABLE

Properties:

Read, Write, Setting

Type:

Integer (64 bit)

Unit:

None

Enable clock signal on the reference clock output.

/DEV…​./SYSTEM/CLOCKS/REFERENCECLOCK/OUT/FREQ

Properties:

Read, Write, Setting

Type:

Double

Unit:

Hz

Select the frequency of the output reference clock. Only 10 MHz and 100 MHz are allowed.

/DEV…​./SYSTEM/DIGITALMIXER/PHASESYNCENABLE

Properties:

Read, Write, Setting

Type:

Integer (enumerated)

Unit:

None

Configures the NCO reset mode.

0

disabled

If disabled, the instrument does not automatically reset NCOs when switching a channel between BB and RF modes.

1

enabled

If enabled, the instrument automatically resets the NCOs of all channels whenever a channel is switched between BB and RF, in order to restore alignment.

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

Properties:

Read

Type:

String

Unit:

None

Returns the type of the data server kernel (mdk or hpk).

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

Properties:

Read

Type:

String

Unit:

None

Returns the current owner of the device (IP).

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

Properties:

Read

Type:

Double

Unit:

1/s

The maximum demodulator rate that can be set. Only relevant for lock-in amplifiers.

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

s

The maximum demodulator time constant that can be set. Only relevant for lock-in amplifiers.

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

s

The minimum demodulator time constant that can be set. Only relevant for lock-in amplifiers.

/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/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 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/SWTRIGGERS/n/SINGLE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

Issues a single software trigger event.

/DEV…​./SYSTEM/UPDATE

Properties:

Read, Write

Type:

Integer (64 bit)

Unit:

None

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