Device Node Tree

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

/DEV

/DEV…​./CLOCKBASE

Properties:

Read

Provides clockbase value for the device

SYSTEM

/DEV…​./SYSTEM/EXTCLK

Properties:

Read, Write, Setting

Type:

bool

Boolean value switching from internal to external clock.

When using external clock, make sure that a clock generator is connected to the Clock In connector.

/DEV…​./SYSTEM/HWREVISION

Properties:

Read

The revision of the main-board.

/DEV…​./SYSTEM/SYNCENABLE

Properties:

Read, Write, Setting

Type:

bool

Boolean value enabling multi-device timestamp synchronization over ZSync.

When synchronizing timestamps between devices make sure that an appropriate cable is connected between the ZSync ports of the leader and follower devices.

/DEV…​./SYSTEM/SYNCRESET

Properties:

Read, Write, Setting

Type:

bool

Boolean value activating timestamp reset over ZSync.

When synchronizing timestamps between devices make sure that an appropriate cable is connected between the ZSync ports of the leader and follower devices.

/DEV…​./SYSTEM/SYNCTIME

Properties:

Read

Unit:

s

The timestamp to load when timestamp reset is activated.

/DEV…​./SYSTEM/ACTIVEINTERFACE

Properties:

Read

Node providing the active interface of the device.

/DEV…​./SYSTEM/PROPERTIES/MINFREQ

Unit:

Hz

Minimum oscillator frequency of the device.

/DEV…​./SYSTEM/PROPERTIES/MAXFREQ

Unit:

Hz

Maximum oscillator frequency of the device.

/DEV…​./SYSTEM/PROPERTIES/NEGATIVEFREQ

Type:

bool

Device does support negative frequencies.

/DEV…​./SYSTEM/PROPERTIES/TIMEBASE

Properties:

Read

Unit:

s

Time base of the device.

/DEV…​./SYSTEM/PROPERTIES/FREQRESOLUTION

Properties:

Read

Unit:

bits

Frequency resolution of the device.

/DEV…​./SYSTEM/PROPERTIES/MINTIMECONSTANT

Properties:

Read

Unit:

s

Minimum filter time constant of the device.

/DEV…​./SYSTEM/PROPERTIES/MAXTIMECONSTANT

Properties:

Read

Unit:

s

Maximum filter time constant of the device.

FEATURES

/DEV…​./FEATURES/SERIAL

Properties:

Read

Node providing the serial number of the device.

/DEV…​./FEATURES/DEVTYPE

Properties:

Read

Node providing a string about the type of device.

/DEV…​./FEATURES/OPTIONS

Properties:

Read

Node giving information on enabled options.

Reading this node returns a string containing a newline-separated list of all installed options.

/DEV…​./FEATURES/CODE

Properties:

Write

Type:

byte array

Node providing a mechanism to write feature codes.

STATUS

/DEV…​./STATUS/TIME

Properties:

Read

Unit:

s

The current timestamp.

/DEV…​./STATUS/FLAGS/BINARY

Properties:

Read

Unit:

bit-coded

A binary representation of all flags.

When multiple flags are set the values are or-ed.

/DEV…​./STATUS/FLAGS/PLLLOCK

Properties:

Read

Type:

bool

Flag indicating if the internal PLL for clock generation has locked.

/DEV…​./STATUS/FLAGS/DCMLOCK

Properties:

Read

Type:

bool

Flag indicating if the internal digital clock manager (DCM) has locked.

/DEV…​./STATUS/FLAGS/FX2RX

Properties:

Read

Type:

bool

Flag indicating if the device receives data via USB.

/DEV…​./STATUS/FLAGS/PKGLOSS

Properties:

Read

Type:

bool

Flag indicating that the device lost data when sending via USB.

/DEV…​./STATUS/FLAGS/MIXERCLIP/n

Properties:

Read

Type:

bool

Flag indicating that this mixer-channel is clipping.

/DEV…​./STATUS/FLAGS/ADCCLIP/n

Properties:

Read

Type:

bool

Flag indicating that this ADC-channel is clipping.

/DEV…​./STATUS/FLAGS/SCOPESKIPPED

Properties:

Read

Type:

bool

Flag indicating that scope data has been skipped.

This happens when too much data is being sent over USB.

/DEV…​./STATUS/FLAGS/DEMODSAMPLELOSS

Properties:

Read

Type:

bool

Flag indicating that demodulator data has been lost.

/DEV…​./STATUS/FIFOLEVEL

Properties:

Read

Unit:

Percent

Percentage of TX FIFO used.

/DEV…​./STATUS/ADC0MIN

Properties:

Read

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

/DEV…​./STATUS/ADC0MAX

Properties:

Read

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

/DEV…​./STATUS/ADC1MIN

Properties:

Read

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

/DEV…​./STATUS/ADC1MAX

Properties:

Read

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

/DEV…​./STATUS/ECHOWRITE

Properties:

Write

Type:

integer

32 bits written to this node will be echoed back via ECHOREAD node.

/DEV…​./STATUS/ECHOREAD

Properties:

Read

32 bits written to ECHOWRITE node are echoed here.

STATS

/DEV…​./STATS/BYTESSENT

Properties:

Read

Unit:

Bytes

Total amount of bytes sent via USB.

/DEV…​./STATS/BYTESRECEIVED

Properties:

Read

Unit:

Bytes

Total amount of bytes received via USB.

/DEV…​./STATS/MEANPOLLCNT

Properties:

Read

Unit:

Polls/Second

Average poll-count.

/DEV…​./STATS/MEANMSGCNT

Properties:

Read

Unit:

Messages/Second

Average message-count.

/DEV…​./STATS/PHYSICAL/1V2

Properties:

Read

Unit:

Volts

Actual voltage of the 1.2 Volts supply.

/DEV…​./STATS/PHYSICAL/1V8

Properties:

Read

Unit:

Volts

Actual voltage of the 1.8 Volts supply.

/DEV…​./STATS/PHYSICAL/2V5

Properties:

Read

Unit:

Volts

Actual voltage of the 2.5 Volts supply.

/DEV…​./STATS/PHYSICAL/3V3

Properties:

Read

Unit:

Volts

Actual voltage of the 3.3 Volts supply.

/DEV…​./STATS/PHYSICAL/5V0

Properties:

Read

Unit:

Volts

Actual voltage of the 5.0 Volts supply.

/DEV…​./STATS/PHYSICAL/TEMP

Properties:

Read

Unit:

Degrees Celsius

Actual temperature.

/DEV…​./STATS/PHYSICAL/OVERTEMPERATURE

Properties:

Read

Type:

bool

Too high FPGA temperature detected during session.

DEMODS

/DEV…​./DEMODS/n/ADCSELECT

Properties:

Read, Write, Setting

Type:

integer (range: 0-5)

Unit:

Index

Selects the index of the signal input for the demodulator.

/DEV…​./DEMODS/n/ORDER

Properties:

Read, Write, Setting

Type:

integer (range: 1-8 default: 4)

Unit:

Order

Selects the order of the low-pass filter.

/DEV…​./DEMODS/n/TIMECONSTANT

Properties:

Read, Write, Setting

Type:

double (default:0.010164)

Unit:

s

Sets the time constant of the low-pass filter.

The time constant is set for each stage of the low-pass filter. The total time constant and bandwidth depends on the selected order.

/DEV…​./DEMODS/n/RATE

Properties:

Read, Write, Setting

Type:

double

Unit:

Hz

The number of output values sent to the computer per second.

/DEV…​./DEMODS/n/ENABLE

Properties:

Read, Write, Setting

Type:

bool

Enables the demodulator data stream.

/DEV…​./DEMODS/n/TRIGGER

Properties:

Read, Write, Setting

Type:

integer

Unit:

bit-coded

Sets the trigger- and gating-functionality of the demodulator.

The triggers are configured by the bits of an integer. When multiple bits/triggers are set, they are or-ed. If trigger is set to 0 then demodulator data is sent continuously.

/DEV…​./DEMODS/n/OSCSELECT

Properties:

Read, Write, Setting

Type:

integer

Unit:

Index

Index of the oscillator used to demodulate the signal.

/DEV…​./DEMODS/n/HARMONIC

Properties:

Read, Write, Setting

Type:

integer (range: 1-1023 default: 1)

Unit:

Harmonic

The harmonic of the base frequency to be used.

Selecting 1 chooses the fundamental frequency.

/DEV…​./DEMODS/n/FREQ

Properties:

Read

Unit:

Hz

Frequency to of the demodulator.

/DEV…​./DEMODS/n/PHASESHIFT

Properties:

Read, Write, Setting

Type:

double

Unit:

deg

The phase shift of the demodulator.

/DEV…​./DEMODS/n/SINC

Properties:

Read, Write, Setting

Type:

bool

Boolean value enabling Sinc filter functionality.

/DEV…​./DEMODS/n/SAMPLE

Properties:

Read

Samples of the demodulator are given out at this node.

OSCS

/DEV…​./OSCS/n/FREQ

Properties:

Read, Write, Setting

Type:

double (range:0-100E6 default:1E6)

Unit:

Hz

Frequency to of the oscillator.

MODS

/DEV…​./MODS/n/ENABLE

Properties:

Read, Write, Setting

Type:

bool

Enables the modulation.

/DEV…​./MODS/n/OUTPUT

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Modulation output.

/DEV…​./MODS/n/MODE

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Modulation mode.

/DEV…​./MODS/n/FREQDEVENABLE

Properties:

Read, Write, Setting

Type:

bool

In FM mode, enable peak deviation.

/DEV…​./MODS/n/FREQDEV

Properties:

Read, Write, Setting

Type:

double

Unit:

V

In FM mode, set peak deviation value.

/DEV…​./MODS/n/INDEX

Properties:

Read, Write, Setting

Type:

double

In FM mode, set modulation index value. The modulation index equals peak deviation divided by modulation frequency.

/DEV…​./MODS/n/RATE

Properties:

Read, Write, Setting

Type:

double

Unit:

Hz

The number of output values sent to the computer per second.

/DEV…​./MODS/n/TRIGGER

Properties:

Read, Write, Setting

Type:

integer

Unit:

bit-coded

Sets the trigger- and gating-functionality of the demodulator.

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

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Signal Input for the carrier demodulation.

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

Properties:

Read, Write, Setting

Type:

integer (range: 1-8 default: 4)

Unit:

Order

Filter order for carrier demodulation.

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

Properties:

Read, Write, Setting

Type:

double

Unit:

s

Sets the time constant of the carrier low-pass filter.

The time constant is set for each stage of the low-pass filter. The total time constant and bandwidth depends on the selected order.

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

Properties:

Read, Write, Setting

Type:

integer

Unit:

Index

Index of the oscillator used to demodulate the signal.

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

Properties:

Read, Write, Setting

Type:

integer (range: 1-1023 default: 1)

Unit:

Harmonic

Harmonic of the carrier frequency.

Selecting 1 chooses the fundamental frequency.

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

Properties:

Read, Write, Setting

Type:

double

Unit:

deg

The phase shift of the carrier demodulator.

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

Properties:

Read, Write, Setting

Type:

bool

Enables the carrier data stream.

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

Properties:

Read, Write, Setting

Type:

double

Unit:

Gain

Carrier amplitude. Fraction of the output range added to the output signal.

Multiply this value with the range setting to obtain voltage in V.

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

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Sideband selector.

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

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Signal Input for the sideband demodulation.

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

Properties:

Read, Write, Setting

Type:

integer (range: 1-8 default: 4)

Unit:

Order

Filter order for sideband demodulation.

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

Properties:

Read, Write, Setting

Type:

double

Unit:

s

Sets the time constant of the sideband low-pass filter.

The time constant is set for each stage of the low-pass filter. The total time constant and bandwidth depends on the selected order.

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

Properties:

Read, Write, Setting

Type:

integer

Unit:

Index

Index of the oscillator used to demodulate the signal.

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

Properties:

Read, Write, Setting

Type:

integer (range: 1-1023 default: 1)

Unit:

Harmonic

Harmonic of the sideband frequency.

Selecting 1 chooses the fundamental frequency.

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

Properties:

Read, Write, Setting

Type:

double

Unit:

deg

The phase shift of the sideband demodulator.

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

Properties:

Read, Write, Setting

Type:

bool

Enables the sideband data stream.

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

Properties:

Read, Write, Setting

Type:

double

Unit:

Gain

Sideband amplitude Fraction of the output range added to the output signal.

Multiply this value with the range setting to obtain voltage in V.

/DEV…​./MODS/n/RAWMODE

Properties:

Read, Write

Type:

integer (default: 0)

/DEV…​./MODS/n/RAWFMCOEFF

Properties:

Read, Write

Type:

double (range:0-12.56618 default:0)

/DEV…​./MODS/n/RAWSIDEBAND

Properties:

Read, Write

Type:

integer (default: 0)

/DEV…​./MODS/n/SAMPLE

Properties:

Read

Modulation Samples.

PLLS

/DEV…​./PLLS/n/ADCSELECT

Properties:

Read, Write, Setting

Type:

integer (range: 0-5)

Unit:

Index

Selects an input for the PLL.

/DEV…​./PLLS/n/AUTOCENTER

Properties:

Read, Write, Setting

Type:

bool

Switches auto-center.

/DEV…​./PLLS/n/FREQCENTER

Properties:

Read, Write, Setting

Type:

double (range:0-100E6)

Unit:

Hz

Selects a center frequency.

/DEV…​./PLLS/n/FREQRANGE

Properties:

Read, Write, Setting

Type:

double (range:0-100E6)

Unit:

Hz

Selects a frequency range for the PLL.

/DEV…​./PLLS/n/ENABLE

Properties:

Read, Write, Setting

Type:

bool

Enables the PLL.

/DEV…​./PLLS/n/ERROR

Properties:

Read

Unit:

deg

Error of the PLL.

/DEV…​./PLLS/n/AUTOTIMECONSTANT

Properties:

Read, Write, Setting

Type:

bool

Switches external time constant control.

/DEV…​./PLLS/n/TIMECONSTANT

Properties:

Read, Write, Setting

Type:

double (default:0)

Unit:

s

The external time constant.

/DEV…​./PLLS/n/AUTOPID

Properties:

Read, Write, Setting

Type:

bool

Switches external PID.

/DEV…​./PLLS/n/P

Properties:

Read, Write, Setting

Type:

double (range:-36458.33-36458.33 default:0)

Unit:

Hz/deg

Proportional gain of the PID controller.

/DEV…​./PLLS/n/I

Properties:

Read, Write, Setting

Type:

double (range:-8198252.90-8198190.35 default:0)

Unit:

Hz^2/deg

Integral gain of the PID controller.

/DEV…​./PLLS/n/D

Properties:

Read, Write, Setting

Type:

double (range:-0.00002-0.00002 default:0)

Unit:

1/deg

Derivative gain of the PID.

/DEV…​./PLLS/n/FREQDELTA

Properties:

Read

Unit:

Hz

Frequency deviation from center frequency.

/DEV…​./PLLS/n/ADCTHRESHOLD

Properties:

Read, Write, Setting

Type:

integer (range: -4096-4095 default: 100)

Threshold for edge detection.

Full scale corresponds to -4096 and 4095.

/DEV…​./PLLS/n/AUXAVG

Properties:

Read, Write, Setting

Type:

integer (range: 0-128 default: 8)

Delta frequency averaging control.

/DEV…​./PLLS/n/SETPOINT

Properties:

Read, Write, Setting

Type:

double

Unit:

deg

The setpoint in degrees of the PLL.

/DEV…​./PLLS/n/HARMONIC

Properties:

Read, Write, Setting

Type:

integer (range: 1-1023 default: 1)

Unit:

Harmonic

The harmonic of the base frequency to be used.

Selecting 1 chooses the fundamental frequency.

/DEV…​./PLLS/n/ORDER

Properties:

Read, Write, Setting

Type:

integer (range: 1-8 default: 4)

Unit:

Order

Selects the order of the low-pass filter.

/DEV…​./PLLS/n/RATE

Properties:

Read

Unit:

Samples/s

Update rate information.

/DEV…​./PLLS/n/OSCSELECT

Properties:

Read

Unit:

Index

Index of the oscillator used.

/DEV…​./PLLS/n/DEMODSELECT

Properties:

Read

Unit:

Index

Source demodulator.

/DEV…​./PLLS/n/LOCKED

Properties:

Read

Type:

bool

Lock indicator for the PLL.

PIDS

/DEV…​./PIDS/n/INPUT

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Selects the input for the PID.

/DEV…​./PIDS/n/INPUTCHANNEL

Properties:

Read, Write, Setting

Type:

integer (default: 0)

If applicable, selects the channel of the selected INPUT.

Sets the input channel index for the selected INPUT, i.e., 0,1,2 etc.. The available channels depend on the input type.

/DEV…​./PIDS/n/OUTPUT

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Selects the output for the PID.

/DEV…​./PIDS/n/OUTPUTCHANNEL

Properties:

Read, Write, Setting

Type:

integer (default: 6)

If applicable, selects the channel of the selected OUTPUT.

Sets the input channel index for the selected OUTPUT, i.e., 0,1,2 etc.. The available channels depend on the output type

/DEV…​./PIDS/n/OUTPUTDEFAULTENABLE

Properties:

Read, Write, Setting

Type:

bool

If OUTPUTDEFAULTENABLE is set, the value specified by OUTPUTDEFAULT will be applied when the PID is switched off.

None

/DEV…​./PIDS/n/OUTPUTDEFAULT

Properties:

Read, Write, Setting

Type:

double (default:0.100)

If OUTPUTDEFAULTENABLE is set, this node specifies the value to be applied.

None

/DEV…​./PIDS/n/P

Properties:

Read, Write, Setting

Type:

double (default:1)

Unit:

[OUTPUT Unit]/[INPUT Unit]

Proportional gain.

Sets the proportional gain for the error signal. Negative feedback corresponds to a negative gain.

/DEV…​./PIDS/n/I

Properties:

Read, Write, Setting

Type:

double (default:10)

Unit:

[OUTPUT Unit]/[INPUT Unit]/s

Proportional gain for integrator.

Sets the proportional gain for the integrated (accumulated) error signal. Negative feedback corresponds to a negative gain.

/DEV…​./PIDS/n/D

Properties:

Read, Write, Setting

Type:

double (default:0.001)

Unit:

[OUTPUT Unit]/[INPUT Unit]*s

Proportional gain for differentiator.

Sets the proportional gain for the differentiated error signal. Negative feedback corresponds to a negative gain.

/DEV…​./PIDS/n/SETPOINT

Properties:

Read, Write, Setting

Type:

double (default:0.1)

Unit:

[INPUT Unit]

Target settle point.

/DEV…​./PIDS/n/SETPOINTSELECT

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Set point selection.

/DEV…​./PIDS/n/MONITOROFFSET

Properties:

Read, Write, Setting

Type:

double (default:0.0)

Offset for the monitor output.

/DEV…​./PIDS/n/MONITORSCALE

Properties:

Read, Write, Setting

Type:

double (default:1.0)

Scale for the monitor output.

/DEV…​./PIDS/n/ERROR

Properties:

Read

Unit:

[OUTPUT Unit]

Shows the error value.

The calculated error is : ERROR = SETPOINT - IN.

/DEV…​./PIDS/n/CENTER

Properties:

Read, Write, Setting

Type:

double (default:0.1)

Unit:

[OUTPUT Unit]

Sets the output center point.

/DEV…​./PIDS/n/RANGE

Properties:

Read, Write, Setting

Type:

double (default:0.5)

Unit:

[OUTPUT Unit]

Sets the output range.

The limits for the output are : OUT = [CENTER - RANGE,CENTER + RANGE] with RANGE > 0.0.

/DEV…​./PIDS/n/SHIFT

Properties:

Read

Unit:

[OUTPUT Unit]

Shows the output shift.

The calculated output value is : OUT = CENTER + SHIFT.

/DEV…​./PIDS/n/ENABLE

Properties:

Read, Write, Setting

Type:

bool

Enable PID controller.

/DEV…​./PIDS/n/RATE

Properties:

Read

Unit:

Samples/s

Control update rate.

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

Properties:

Read, Write, Setting

Type:

bool

Enable TipProtect for the PID controller.

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

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Selects a PLL for TipProtect.

/DEV…​./PIDS/n/TIPPROTECT/ACTIVE

Properties:

Read

Type:

bool

Indicates whether TipProtect is active.

/DEV…​./PIDS/n/TIPPROTECT/ACTIVETIMECONSTANT

Properties:

Read, Write, Setting

Type:

double (range:0-100E6)

Unit:

s

Time constant when TipProtect is active.

Time constant for low-pass filtering the PLL error² when TipProtect is active, i.e., when waiting to re-enable the PID controller.

/DEV…​./PIDS/n/TIPPROTECT/ACTIVETHRESHOLD

Properties:

Read, Write, Setting

Type:

double (range:0-129600)

Unit:

deg²

Threshold for the active state.

Threshold for PLL error² when TipProtect is active, i.e., when waiting to re-enable the PID controller.

/DEV…​./PIDS/n/TIPPROTECT/INACTIVETIMECONSTANT

Properties:

Read, Write, Setting

Type:

double (range:0-100E6)

Unit:

s

Time constant when TipProtect is inactive.

Time constant for low-pass filtering the PLL error² when TipProtect is inactive, i.e., when waiting to disable the PID controller.

/DEV…​./PIDS/n/TIPPROTECT/INACTIVETHRESHOLD

Properties:

Read, Write, Setting

Type:

double (range:0-129600)

Unit:

deg²

Threshold for the inactive state.

Threshold for PLL error² when TipProtect is inactive, i.e., when waiting to disable the PID controller.

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

Properties:

Read, Write

Type:

integer (range: 0-5)

Unit:

Index

Selects the index of the signal input for the demodulator.

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

Properties:

Read, Write, Setting

Type:

integer (range: 1-8 default: 4)

Unit:

Order

Selects the order of the low-pass filter.

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

Properties:

Read, Write, Setting

Type:

double (default:0.010164)

Unit:

s

Sets the time constant of the low-pass filter.

The time constant is set for each stage of the low-pass filter. The total time constant and bandwidth depends on the selected order.

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

Properties:

Read, Write, Setting

Type:

integer (range: 1-1023 default: 1)

Unit:

Harmonic

The harmonic of the base frequency to be used.

Selecting 1 chooses the fundamental frequency.

SIGINS

/DEV…​./SIGINS/n/RANGE

Properties:

Read, Write, Setting

Type:

double (range:0.0001-2 default:1.2)

Unit:

V

Voltage range for the signal input.

/DEV…​./SIGINS/n/AC

Properties:

Read, Write, Setting

Type:

bool

Boolean value setting for AC coupling of the Signal Input.

/DEV…​./SIGINS/n/IMP50

Properties:

Read, Write, Setting

Type:

bool

Boolean value enabling 50 Ohm input impedance termination.

/DEV…​./SIGINS/n/DIFF

Properties:

Read, Write, Setting

Type:

bool

Boolean value switching differential input mode.

SIGOUTS

/DEV…​./SIGOUTS/n/ON

Properties:

Read, Write, Setting

Type:

bool

Switches the output on and off.

/DEV…​./SIGOUTS/n/ADD

Properties:

Read, Write, Setting

Type:

bool

Switches the output adder on and off.

/DEV…​./SIGOUTS/n/RANGE

Properties:

Read, Write, Setting

Type:

double (default:1.00)

Unit:

V

Selects the output range for the Signal Output.

/DEV…​./SIGOUTS/n/OFFSET

Properties:

Read, Write, Setting

Type:

double (default:0.00)

Unit:

Gain

Offset added to the Signal Output.

Multiply this value with the range setting to obtain offset voltage in V.

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

Properties:

Read, Write, Setting

Type:

integer

Switches a channel in the mixer on and off.

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

Properties:

Read, Write, Setting

Type:

double

Unit:

Gain

Fraction of the output range added to the output signal.

Multiply this value with the range setting to obtain voltage in V.

/DEV…​./SIGOUTS/n/WAVEFORMS/n

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Waveforms for a channel in the mixer.

For hardware revisions 1.4 and lower, the output signal range for rectangular output is limited to 1 V.

SCOPES

/DEV…​./SCOPES/n/ENABLE

Properties:

Read, Write, Setting

Type:

bool

Enables the scope.

/DEV…​./SCOPES/n/CHANNEL

Properties:

Read, Write, Setting

Type:

integer (range: 0-3 default: 0)

Unit:

Index

Selects the channel for which scope data should be provided.

/DEV…​./SCOPES/n/TRIGCHANNEL

Properties:

Read, Write, Setting

Type:

integer (range: -2-11 default: -1)

Unit:

Index

Selects the channel which should be used as source for the scope’s trigger.

/DEV…​./SCOPES/n/BWLIMIT

Properties:

Read, Write, Setting

Type:

bool

The bandwidth-limit for the scope.

/DEV…​./SCOPES/n/TRIGEDGE

Properties:

Read, Write, Setting

Type:

integer (default: 1)

Selects whether the scope should trigger on rising or falling edge.

/DEV…​./SCOPES/n/TRIGLEVEL

Properties:

Read, Write, Setting

Type:

integer (range: -32768-32767 default: 0)

Unit:

LSB

Level at which a trigger is raised.

Full scale is covered by min and max values

/DEV…​./SCOPES/n/TRIGHOLDOFF

Properties:

Read, Write, Setting

Type:

double (range:0-65.535 default:0.250)

Unit:

s

Time to wait for re-arming the trigger after one occurred.

/DEV…​./SCOPES/n/TIME

Properties:

Read, Write, Setting

Type:

integer (range: 0-7 default: 0)

Timescale of the scope wave (logarithmic decimation).

Determines the decimation of the sample rate. The following formulas apply: span = 2^val * 10 us, sample rate = 210 MSamples/2^val

/DEV…​./SCOPES/n/WAVE

Properties:

Read

Samples of scope-waveforms.

DIOS

/DEV…​./DIOS/n/EXTCLK

Properties:

Read, Write, Setting

Type:

bool

Selects whether an external clock source should be used.

The external clock needs to be applied to the DIO connector when this node is set to 1.

/DEV…​./DIOS/n/DECIMATION

Properties:

Read, Write, Setting

Type:

integer (range: 0-65535 default: 256)

Decimation for the sample rate of the DIO.

/DEV…​./DIOS/n/DRIVE

Properties:

Read, Write, Setting

Type:

integer (range: 0-3 default: 0)

Selects if the outputs should be driven.

/DEV…​./DIOS/n/OUTPUT

Properties:

Read, Write, Setting

Type:

integer (range: 0-65535 default: 0)

Bits to output.

/DEV…​./DIOS/n/SYNCSELECT0

Properties:

Read, Write, Setting

Type:

integer (range: 0-8 default: 8)

Source to output the sync signal on bit 0.

/DEV…​./DIOS/n/SYNCSELECT1

Properties:

Read, Write, Setting

Type:

integer (range: 0-8 default: 8)

Source to output the sync signal on bit 1.

/DEV…​./DIOS/n/INPUT

Properties:

Read

Samples of the input.

AUXINS

/DEV…​./AUXINS/n/AVERAGING

Properties:

Read, Write, Setting

Type:

integer (range: 1-32768 default: 256)

Averaging of the samples.

/DEV…​./AUXINS/n/SAMPLE

Properties:

Read

Auxiliary input samples.

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

Properties:

Read

Unit:

V

Input 0 value.

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

Properties:

Read

Unit:

V

Input 1 value.

AUXOUTS

/DEV…​./AUXOUTS/n/VALUE

Properties:

Read

Unit:

V

Output value.

/DEV…​./AUXOUTS/n/OUTPUTSELECT

Properties:

Read, Write, Setting

Type:

integer

Signal to be given out.

/DEV…​./AUXOUTS/n/DEMODSELECT

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Unit:

Index

Source demodulator.

/DEV…​./AUXOUTS/n/SCALE

Properties:

Read, Write, Setting

Type:

double

Scaling of the signal which is given out.

/DEV…​./AUXOUTS/n/OFFSET

Properties:

Read, Write, Setting

Type:

double (range:-2560-2560 default:0)

Unit:

V

Value to be added to the output.

The offset value is applied after scaling.

CPUS

/DEV…​./CPUS/n/WORKLOAD

Properties:

Read

Usage of the processor-time.

/DEV…​./CPUS/n/PROGRAM

Properties:

Write

Type:

byte array

Node to write user programs to.

/DEV…​./CPUS/n/OUTPUT

Node containing the standard output stream written by the real time program.

/DEV…​./CPUS/n/USERREGS/n

Properties:

Read, Write, Setting

Type:

integer

General purpose register.

ZCTRLS

/DEV…​./ZCTRLS/n/CAMP/AVAILABLE

Properties:

Read

Type:

bool

1 when HF2CA is connected to the corresponding ZCtrl port.

/DEV…​./ZCTRLS/n/CAMP/R

Properties:

Read, Write, Setting

Type:

integer (default: 0)

Unit:

Ohm

Chooses a value for the shunt-resistor.

/DEV…​./ZCTRLS/n/CAMP/GAIN

Properties:

Read, Write, Setting

Type:

integer (default: 1)

Unit:

Gain

Switches between factor 1 and 10 gain.

/DEV…​./ZCTRLS/n/CAMP/DC

Properties:

Read, Write, Setting

Type:

bool

Switches between AC coupling and DC coupling.

/DEV…​./ZCTRLS/n/CAMP/SINGLEENDED

Properties:

Read, Write, Setting

Type:

bool

Switches between differential and single-ended input.

/DEV…​./ZCTRLS/n/TAMP/AVAILABLE

Properties:

Read

Type:

bool

1 when HF2TA is connected to the corresponding ZCtrl port.

/DEV…​./ZCTRLS/n/TAMP/BIASOUT

Properties:

Read, Write, Setting

Type:

double (default:0)

Unit:

V

Switches between internal and external bias.

/DEV…​./ZCTRLS/n/TAMP/EXTBIAS

Properties:

Read, Write, Setting

Type:

bool

Switches the external bias.

/DEV…​./ZCTRLS/n/TAMP/n/CURRENTGAIN

Properties:

Read, Write, Setting

Type:

integer (default: 1000)

Unit:

Gain

Chooses a value for the current gain.

/DEV…​./ZCTRLS/n/TAMP/n/DC

Properties:

Read, Write, Setting

Type:

bool

Switches between AC and DC Mode.

/DEV…​./ZCTRLS/n/TAMP/n/VOLTAGEGAIN

Properties:

Read, Write, Setting

Type:

integer (default: 1)

Unit:

Gain

Chooses a value for the voltage gain.

/DEV…​./ZCTRLS/n/TAMP/n/OFFSET

Properties:

Read, Write, Setting

Type:

double (default:0)

Unit:

V

Adjust offset value.

ZI (LabOne Data Server Nodes)

/ZI/ABOUT/VERSION

Properties:

Read

The version of this program.

/ZI/ABOUT/REVISION

Properties:

Read

The revision of this program.

/ZI/ABOUT/COMMIT

Properties:

Read

The commit hash of this program.

/ZI/ABOUT/FWREVISION

Properties:

Read

The revision of the used firmware.

/ZI/ABOUT/COPYRIGHT

Properties:

Read

The copyright string of this program.

/ZI/ABOUT/DATASERVER

Properties:

Read

The name identifier of this data server.

/ZI/CONFIG/PORT

Properties:

Read, Write

Type:

integer (range: 1024-65535 default: 8005)

Configures the TCP/IP port on which the ziServer listens.

/ZI/CONFIG/OPEN

Properties:

Read, Write

Type:

bool

Configures whether the ziServer should be open for connections from outside the local host.

/ZI/TREES

Messages on tree changes.

This node sends out a message every time a device is connected or disconnected or its tree has changed.

/ZI/MDS/GROUPS/n/DEVICES

Properties:

Read, Write

Type:

byte array

Devices in this group.

/ZI/MDS/GROUPS/n/STATUS

Properties:

Read, Write

Type:

integer (default: 0)

Status of the synchronization in this group.

/ZI/MDS/GROUPS/n/LOCKED

Properties:

Read, Write

Type:

bool (default: false)

Group is locked.

/ZI/MDS/GROUPS/n/KEEPALIVE

Properties:

Write

Type:

bool (default: false)

Acquire lock on this group.

/ZI/CLOCKBASE

Properties:

Read

Provides timebase value for the server nodes