Skip to content

Device Node Tree

This chapter contains reference documentation for the settings and measurement data available on SHFSG Instruments. Whilst Functional Description 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 SHFSG Instruments, organized by branch in the Node Tree.

Introduction

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 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, 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 "dev1000" are located in the tree in the branch:

/dev1000/auxouts/

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

/dev1000/auxouts/0/
/dev1000/auxouts/1/
/dev1000/auxouts/2/
/dev1000/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:

/dev1000/auxouts/0/demodselect
/dev1000/auxouts/0/limitlower
/dev1000/auxouts/0/limitupper
/dev1000/auxouts/0/offset
/dev1000/auxouts/0/outputselect
/dev1000/auxouts/0/preoffset
/dev1000/auxouts/0/scale
/dev1000/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 Exploring the Node Tree.

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:

Property Description
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 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.
Pipelined If the sequence pipeliner mode is off the value set to the node is applied immediately. Otherwise, it goes to the staging area of the sequence pipeliner instead. Multiple pipelined nodes can be programmed as part of a job definition, that is finalized by writing a one to the relevant commit node.

A node may contain data of the following types:

Integer Integer data.
Double Double precision floating point data.
String A string array.
Integer (enumerated) 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.

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.core.ziDAQServer('localhost', 8004, 6)
    daq.help('/dev1000/auxouts/0/offset')
    # Out:
    # /dev1000/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.

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.

CLOCKBASE

/dev..../clockbase

Properties: Read
Type: Double
Unit: Hz

Returns the internal clock frequency of the device.

DIOS

/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.
48 "sgchan0seq", "sgchannel0_sequencer": Enables control of DIO values by the sequencer of SG channel 1.
49 "sgchan1seq", "sgchannel1_sequencer": Enables control of DIO values by the sequencer of SG channel 2.
50 "sgchan2seq", "sgchannel2_sequencer": Enables control of DIO values by the sequencer of SG channel 3.
51 "sgchan3seq", "sgchannel3_sequencer": Enables control of DIO values by the sequencer of SG channel 4.
/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 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.

SGCHANNELS

/dev..../sgchannels/n/awg/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 "trigin4", "trigger_input4": Trigger In 5
5 "trigin5", "trigger_input5": Trigger In 6
6 "trigin6", "trigger_input6": Trigger In 7
7 "trigin7", "trigger_input7": Trigger In 8
8 "inttrig", "internal_trigger": Internal Trigger
/dev..../sgchannels/n/awg/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..../sgchannels/n/awg/auxtriggers/n/state

Properties: Read
Type: Integer (64 bit)
Unit: None

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

/dev..../sgchannels/n/awg/commandtable/clear

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Writing to this node clears all data previously loaded to the command table of the device. If the sequence pipeliner mode is not off, the command table in the sequence pipeliner staging area is cleared instead.

/dev..../sgchannels/n/awg/commandtable/data

Properties: Read, Write, Pipelined
Type: ZIVectorData
Unit: None

Data contained in the command table in JSON format.

/dev..../sgchannels/n/awg/commandtable/schema

Properties: Read
Type: ZIVectorData
Unit: None

JSON schema describing the command table JSON format (read-only).

/dev..../sgchannels/n/awg/commandtable/status

Properties: Read, Pipelined
Type: Integer (64 bit)
Unit: None

Status of the command table on the instrument. If the sequence pipeliner mode is not off, the status of the command table in the sequence pipeliner staging area is shown instead. Bit 0: data uploaded to the command table; Bit 1, Bit 2: reserved; Bit 3: uploading of data to the command table failed due to a JSON parsing error.

/dev..../sgchannels/n/awg/dio/error/timing

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

A 32-bit value indicating which bits on the DIO interface may have timing errors. A timing error is defined as an event where either the VALID or any of the data bits on the DIO interface change value at the same time as the STROBE bit.

/dev..../sgchannels/n/awg/dio/error/width

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Indicates a width (i.e. jitter) error on either the STROBE (bit 0 of the value) or VALID bit (bit 1 of the result). A width error indicates that there was jitter detected on the given bit, meaning that an active period was either shorter or longer than the configured expected width.

/dev..../sgchannels/n/awg/dio/highbits

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

32-bit value indicating which bits on the 32-bit interface are detected as having a logic high value.

/dev..../sgchannels/n/awg/dio/lowbits

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

32-bit value indicating which bits on the 32-bit interface are detected as having a logic low value.

/dev..../sgchannels/n/awg/dio/mask/shift

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Defines the amount of bit shifting to apply for the DIO wave selection in connection with playWaveDIO().

/dev..../sgchannels/n/awg/dio/mask/value

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Selects the DIO bits to be used for waveform selection in connection with playWaveDIO().

/dev..../sgchannels/n/awg/dio/state

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

When asserted, indicates that triggers are generated from the DIO interface to the AWG.

/dev..../sgchannels/n/awg/dio/strobe/index

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Select the DIO bit to use as the STROBE signal.

/dev..../sgchannels/n/awg/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..../sgchannels/n/awg/dio/strobe/width

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Specifies the expected width of active pulses on the STROBE bit.

/dev..../sgchannels/n/awg/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..../sgchannels/n/awg/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..../sgchannels/n/awg/dio/valid/width

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Expected width of an active pulse on the VALID bit.

/dev..../sgchannels/n/awg/diozsyncswitch

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Defines which interface input to use with this AWG

0 "dio": DIO interface will be used as input.
1 "zsync": ZSync interface will be used as input.
/dev..../sgchannels/n/awg/elf/checksum

Properties: Read, Pipelined
Type: Integer (64 bit)
Unit: None

Checksum of the uploaded ELF file.

/dev..../sgchannels/n/awg/elf/data

Properties: Write, Pipelined
Type: ZIVectorData
Unit: None

Accepts the data of the sequencer ELF file. If the sequence pipeliner mode is not off, the data of the ELF file goes to the staging area of the sequence pipeliner instead.

/dev..../sgchannels/n/awg/elf/length

Properties: Read, Pipelined
Type: Integer (64 bit)
Unit: None

Length of the compiled ELF file.

/dev..../sgchannels/n/awg/elf/memoryusage

Properties: Read, Pipelined
Type: Double
Unit: None

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

/dev..../sgchannels/n/awg/elf/name

Properties: Read, Pipelined
Type: ZIVectorData
Unit: None

The name of the uploaded ELF file.

/dev..../sgchannels/n/awg/elf/progress

Properties: Read, Pipelined
Type: Double
Unit: %

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

/dev..../sgchannels/n/awg/enable

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Activates the AWG.

/dev..../sgchannels/n/awg/modulation/enable

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Enable or disable digital modulation.

0 "off": Modulation off
1 "on": Modulation on
/dev..../sgchannels/n/awg/outputamplitude

Properties: Read, Write, Setting
Type: Double
Unit: None

Amplitude scale factor applied to both AWG outputs.

/dev..../sgchannels/n/awg/outputs/n/enables/n

Properties: Read
Type: Integer (64 bit)
Unit: None

Indicates the routing of the AWG signal (k index) to the digital mixer input (m index).

/dev..../sgchannels/n/awg/outputs/n/gains/n

Properties: Read, Write, Setting
Type: Double
Unit: None

Gain factor applied to the AWG Output at the given output multiplier stage. The final signal amplitude is proportional to the Range voltage setting of the Wave signal outputs.

/dev..../sgchannels/n/awg/outputs/n/hold

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Keep the last sample (constant) on the output even after the waveform program finishes.

/dev..../sgchannels/n/awg/ready

Properties: Read, Pipelined
Type: Integer (64 bit)
Unit: None

A value of True means that the AWG has a compiled waveform and is ready to be enabled. If the sequence pipeliner is not off, a value of True means that the sequence in the staging area is ready to be committed to the pipeline.

/dev..../sgchannels/n/awg/reset

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Clears the configured AWG program and resets the state to not ready.

/dev..../sgchannels/n/awg/rtlogger/clear

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Clears the logger data.

/dev..../sgchannels/n/awg/rtlogger/data

Properties: Read
Type: ZIVectorData
Unit: None

Vector node with the logged events.

/dev..../sgchannels/n/awg/rtlogger/enable

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Activates the Real-time Logger.

/dev..../sgchannels/n/awg/rtlogger/input

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Select input data of logger.

0 "dio": DIO interface will be used as input.
1 "zsync": ZSync interface will be used as input.
/dev..../sgchannels/n/awg/rtlogger/mode

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Selects the operation mode.

0 "normal": Normal: Logger starts with the AWG and overwrites old values as soon as the memory limit of 1024 entries is reached.
1 "timestamp": Timestamp-triggered: Logger starts with the AWG, waits for the first valid trigger, and only starts recording data after the time specified by the starttimestamp. Recording stops as soon as the memory limit of 1024 entries is reached.
/dev..../sgchannels/n/awg/rtlogger/starttimestamp

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Timestamp at which to start logging for timestamp-triggered mode.

/dev..../sgchannels/n/awg/rtlogger/status

Properties: Read
Type: Integer (enumerated)
Unit: None

Operation state.

0 "idle": Idle: Logger is not running.
1 "normal": Normal: Logger is running in normal mode.
2 "ts_wait": Wait for timestamp: Logger is in timestamp-triggered mode and waits for start timestamp.
3 "ts_active": Active: Logger is in timestamp-triggered mode and logging.
4 "ts_full": Log Full: Logger is in timestamp-triggered mode and has stopped logging because log is full.
/dev..../sgchannels/n/awg/rtlogger/timebase

Properties: Read
Type: Double
Unit: s

Minimal time difference between two timestamps. The value matches the AWG sequencer execution rate (4 ns)

/dev..../sgchannels/n/awg/sequencer/assembly

Properties: Read
Type: ZIVectorData
Unit: None

Displays the current sequence program in compiled form. Every line corresponds to one hardware instruction.

/dev..../sgchannels/n/awg/sequencer/continue

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Reserved for future use.

/dev..../sgchannels/n/awg/sequencer/memoryusage

Properties: Read
Type: Double
Unit: None

Size of the current Sequencer program relative to the available instruction memory of 32 kInstructions (32'768 instructions).

/dev..../sgchannels/n/awg/sequencer/next

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Reserved for future use.

/dev..../sgchannels/n/awg/sequencer/pc

Properties: Read
Type: Integer (64 bit)
Unit: None

Current position in the list of sequence instructions during execution.

/dev..../sgchannels/n/awg/sequencer/program

Properties: Read
Type: ZIVectorData
Unit: None

Displays the source code of the current sequence program.

/dev..../sgchannels/n/awg/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 trigger to arrive; Bit 3: AWG has detected an error; Bit 4: sequencer is waiting for synchronization with other channels.

/dev..../sgchannels/n/awg/sequencer/triggered

Properties: Read
Type: Integer (64 bit)
Unit: None

When 1, indicates that the AWG Sequencer has been triggered.

/dev..../sgchannels/n/awg/single

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Puts the AWG into single shot mode.

/dev..../sgchannels/n/awg/time

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

AWG sampling rate. The numeric values here are equal to the base sampling rate of 2.0 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 2.0 GHz
1 1.0 GHz
2 500 MHz
3 250 MHz
4 125 MHz
5 62.50 MHz
6 31.25 MHz
7 15.63 MHz
8 7.81 MHz
9 3.91 MHz
10 1.95 MHz
11 976.56 kHz
12 488.28 kHz
13 244.14 kHz
/dev..../sgchannels/n/awg/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..../sgchannels/n/awg/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..../sgchannels/n/awg/waveform/memoryusage

Properties: Read
Type: Double
Unit: %

Amount of the used waveform data relative to the device memory. The memory provides space for 96 kSa (98'304 Sa) of dual-channel waveform data.

/dev..../sgchannels/n/awg/waveform/playing

Properties: Read
Type: Integer (64 bit)
Unit: None

When 1, indicates if a waveform is being played currently.

/dev..../sgchannels/n/awg/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.

/dev..../sgchannels/n/awg/zsync/decoder/mask

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

8-bit value to select the bits of the message received on ZSync interface coming from the PQSC error decoder.

/dev..../sgchannels/n/awg/zsync/decoder/offset

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

The additive offset applied to the message received on ZSync interface coming from the PQSC error decoder.

/dev..../sgchannels/n/awg/zsync/decoder/shift

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

The bit shift applied to the message received on ZSync interface coming from the PQSC error decoder.

/dev..../sgchannels/n/awg/zsync/register/mask

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

4-bit value to select the bits of the message received on ZSync interface coming from the PQSC readout registers.

/dev..../sgchannels/n/awg/zsync/register/offset

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

The additive offset applied to the message received on ZSync interface coming from the PQSC readout registers.

/dev..../sgchannels/n/awg/zsync/register/shift

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

The bit shift applied to the message received on ZSync interface coming from the PQSC readout registers.

/dev..../sgchannels/n/centerfreq

Properties: Read
Type: Double
Unit: Hz

The Center Frequency of signal generation band. This value is read-only. Frequency is set through synthesizer node.

/dev..../sgchannels/n/digitalmixer/centerfreq

Properties: Read, Write, Setting
Type: Double
Unit: Hz

Set center frequency of digital mixer.

/dev..../sgchannels/n/marker/source

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Assign a signal to a marker.

0 "awg_trigger0": Trigger output is assigned to AWG Trigger 1, controlled by AWG sequencer commands.
1 "awg_trigger1": Trigger output is assigned to AWG Trigger 2, controlled by AWG sequencer commands.
2 "awg_trigger2": Trigger output is assigned to AWG Trigger 3, controlled by AWG sequencer commands.
3 "awg_trigger3": Trigger output is assigned to AWG Trigger 4, controlled by AWG sequencer commands.
4 "output0_marker0": Output is assigned to I component Marker 1.
5 "output0_marker1": Output is assigned to I component Marker 2.
6 "output1_marker0": Output is assigned to Q component Marker 1.
7 "output1_marker1": Output is assigned to Q component Marker 2.
8 "trigin0", "trigger_input0": Output is assigned to Trigger Input 1.
9 "trigin1", "trigger_input1": Output is assigned to Trigger Input 2.
10 "trigin2", "trigger_input2": Output is assigned to Trigger Input 3.
11 "trigin3", "trigger_input3": Output is assigned to Trigger Input 4.
12 "trigin4", "trigger_input4": Output is assigned to Trigger Input 5.
13 "trigin5", "trigger_input5": Output is assigned to Trigger Input 6.
14 "trigin6", "trigger_input6": Output is assigned to Trigger Input 7.
15 "trigin7", "trigger_input7": Output is assigned to Trigger Input 8.
16 "low": Output is set to low.
17 "high": Output is set to high.
/dev..../sgchannels/n/oscs/n/freq

Properties: Read, Write, Setting
Type: Double
Unit: Hz

Frequency control for each oscillator.

/dev..../sgchannels/n/output/delay

Properties: Read, Write, Setting
Type: Double
Unit: s

This value adds a delay to both the signal and trigger/marker outputs.

/dev..../sgchannels/n/output/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..../sgchannels/n/output/on

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Enables the Signal Output.

/dev..../sgchannels/n/output/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..../sgchannels/n/output/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..../sgchannels/n/output/rflfpath

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Switch between RF and LF output path.

0 "lf": LF path is used.
1 "rf": RF path is used.
/dev..../sgchannels/n/outputrouter/enable

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Enable outputrouter module

0 "off": Output-router disabled
1 "on": Output-router enabled
/dev..../sgchannels/n/outputrouter/overflowcount

Properties: Read
Type: Integer (64 bit)
Unit: None

Indicates the number of overflow events in the output-router of the corresponding channel within intervals of 200 ms. An overflow condition results in clipping of the output signal.

/dev..../sgchannels/n/outputrouter/routes/n/amplitude

Properties: Read, Write, Setting
Type: Double
Unit: None

Configure amplitude of route. Selected signal (source) is multiplied with amplitude and phase, and summed with other routes on SG-channel's output.

/dev..../sgchannels/n/outputrouter/routes/n/enable

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Enable/disable route.

0 "off": OFF: Route inactive
1 "on": ON: Route active
/dev..../sgchannels/n/outputrouter/routes/n/phase

Properties: Read, Write, Setting
Type: Double
Unit: deg

Configure phase of route. Selected signal (source) is multiplied with amplitude and phase, and summed with other routes on SG-channel's output.

/dev..../sgchannels/n/outputrouter/routes/n/source

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Select AWG channel source as input to the outputrouter.

/dev..../sgchannels/n/pipeliner/availableslots

Properties: Read
Type: Integer (64 bit)
Unit: None

Number of free slots in the sequence pipeliner queue. Sequence upload is blocked if this node is 0.

/dev..../sgchannels/n/pipeliner/commit

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Commit node data in staging area to queue of sequence pipeliner.

/dev..../sgchannels/n/pipeliner/enable

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Enable execution of sequences in pipeline.

/dev..../sgchannels/n/pipeliner/idcurrent

Properties: Read
Type: Integer (64 bit)
Unit: None

ID of sequence in staging area.

/dev..../sgchannels/n/pipeliner/idrunning

Properties: Read
Type: Integer (64 bit)
Unit: None

ID of executed sequence.

/dev..../sgchannels/n/pipeliner/maxslots

Properties: Read
Type: Integer (64 bit)
Unit: None

Maximum number of available slots in the sequence pipeliner queue.

/dev..../sgchannels/n/pipeliner/mode

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Selects the sequence pipeliner mode: off (default), batch, or queue mode. Changing the mode will reset both the sequence pipeliner and the normal AWG.

0 "off": Off: The sequence pipeliner is turned off.
1 "batch": Batch: The sequence pipeliner operates in batch mode. All sequences must be committed before the pipeliner is enabled. A batch can be executed once or multiple times.
2 "queue": Queue: The sequence pipeliner operates in queue mode. Sequences can be committed while the pipeliner is enabled. Every sequence is executed only once and the slot in the queue is then available for a new sequence.
/dev..../sgchannels/n/pipeliner/ready

Properties: Read
Type: Integer (64 bit)
Unit: None

Indicates whether a sequence can be committed to the pipeliner.

/dev..../sgchannels/n/pipeliner/repetitions/remaining

Properties: Read
Type: Integer (64 bit)
Unit: None

Number of remaining batch repetitions. This node is fixed to 1 if the sequence pipeliner is not in batch mode.

/dev..../sgchannels/n/pipeliner/repetitions/value

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Number of batch repetitions (1 to 4e6). This node is fixed to 1 if the sequence pipeliner is not in batch mode.

/dev..../sgchannels/n/pipeliner/reset

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Clears all sequences previously added to the sequence pipeliner and disables the pipeliner if it has been running before.

/dev..../sgchannels/n/pipeliner/status

Properties: Read
Type: Integer (enumerated)
Unit: None

Status of the sequence pipeliner (0: idle, 1: executing sequence, 2: waiting for next sequence to be committed (queue mode only)

0 "idle": Idle: The sequence pipeliner is idle.
1 "exec": Executing sequence: The sequence pipeliner is executing a sequence.
2 "waiting": Waiting: The sequence pipeliner is waiting for the next sequence to be committed (queue mode only).
3 "done": Done: The sequence pipeliner is still enabled but all sequences have been executed (batch mode only).
/dev..../sgchannels/n/pipeliner/timeout

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Maximal execution time per sequence in milliseconds. The execution of a sequence is aborted if the maximal execution time is reached. A value of 0 means infinity.

/dev..../sgchannels/n/sines/n/freq

Properties: Read
Type: Double
Unit: Hz

Indicates the frequency of the sines generator.

/dev..../sgchannels/n/sines/n/harmonic

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Multiplies the sine signals's reference frequency with the integer factor defined by this field.

/dev..../sgchannels/n/sines/n/i/cos/amplitude

Properties: Read, Write, Setting
Type: Double
Unit: None

Sets the peak amplitude of the cosine component on the I signal path.

/dev..../sgchannels/n/sines/n/i/enable

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Enables the sine signal to the I signal path.

/dev..../sgchannels/n/sines/n/i/sin/amplitude

Properties: Read, Write, Setting
Type: Double
Unit: None

Sets the peak amplitude of the sine component on the I signal path.

/dev..../sgchannels/n/sines/n/oscselect

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Select oscillator for generation of this sine signal.

/dev..../sgchannels/n/sines/n/phaseshift

Properties: Read, Write, Setting
Type: Double
Unit: None

Phase shift applied to sine signal.

/dev..../sgchannels/n/sines/n/q/cos/amplitude

Properties: Read, Write, Setting
Type: Double
Unit: None

Sets the peak amplitude of the cosine component on the Q signal path.

/dev..../sgchannels/n/sines/n/q/enable

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Enables the sine signal to the Q signal path.

/dev..../sgchannels/n/sines/n/q/sin/amplitude

Properties: Read, Write, Setting
Type: Double
Unit: None

Sets the peak amplitude of the sine component on the Q signal path.

/dev..../sgchannels/n/synchronization/enable

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Enable multi-channel synchronization for this channel. The program will only execute once all channels with enabled synchronization are ready.

/dev..../sgchannels/n/synthesizer

Properties: Read
Type: Integer (64 bit)
Unit: None

Index of synthesizer mapped to this channel.

/dev..../sgchannels/n/trigger/delay

Properties: Read, Write, Setting
Type: Double
Unit: s

This delay adds an offset that acts only on the trigger/marker output. The total delay to the trigger/marker output is the sum of this value and the value of the output delay node.

/dev..../sgchannels/n/trigger/imp50

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Trigger Input impedance: When on, the Trigger Input impedance is 50 Ohm; when off, 1 kOhm.

0 "1_kOhm": OFF: 1 k Ohm
1 "50_Ohm": ON: 50 Ohm
/dev..../sgchannels/n/trigger/level

Properties: Read, Write, Setting
Type: Double
Unit: V

Defines the analog Trigger level.

/dev..../sgchannels/n/trigger/value

Properties: Read
Type: Integer (64 bit)
Unit: None

Shows the value of the digital Trigger Input. The value is integrated over a period of 100 ms. Values are: 1: low; 2: high; 3: was low and high in the period.

STATS

/dev..../stats/physical/currents/n

Properties: Read
Type: Double
Unit: mA

Provides internal current readings for monitoring.

/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 a value greater than 0 when the internal temperatures are reaching critical limits.

/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/sigouts/n/currents/n

Properties: Read
Type: Double
Unit: A

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

/dev..../stats/physical/sigouts/n/temperatures/n

Properties: Read
Type: Double
Unit: °C

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

/dev..../stats/physical/sigouts/n/voltages/n

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

Provides internal temperature readings for monitoring.

/dev..../stats/physical/voltages/n

Properties: Read
Type: Double
Unit: V

Provides internal voltage readings for monitoring.

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

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 motherboard containing the FPGA.

/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.
2 "zsync": The ZSync clock is intended to be used as the frequency and time base reference.
/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.
2 "zsync": The ZSync 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 "locked": Reference clock has been locked on.
1 "error": There was an error locking onto the reference clock signal.
2 "busy": 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. When the clock output is turned on or off, all the instruments connected with ZSync links will be disconnected. The connection should be re-established manually.

/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/reset/all

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Writing to this node clears all digital mixer NCOs of the instrument.

/dev..../system/digitalmixer/reset/mode

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Configure the NCO reset mode.

0 "manual": In manual mode the instrument does not automatically reset NCOs when switching a channel from LF to RF mode.
1 "auto": In automatic mode the instrument automatically resets the NCOs of all channels whenever a channel is switched from LF to RF, in order to restore alignment.
/dev..../system/digitalmixer/reset/select

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Writing a bit mask to this node triggers a digital mixer NCO reset of the selected (bit value: 1) channels.

/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 all frontpanel LEDs to blink for 5 seconds, then return to their previous state.

/dev..../system/internaltrigger/enable

Properties: Read, Write
Type: Integer (enumerated)
Unit: None

Enable internal trigger generator.

0 "off": Generator off
1 "on": Generator on
/dev..../system/internaltrigger/holdoff

Properties: Read, Write, Setting
Type: Double
Unit: s

Hold-off time between generated triggers.

/dev..../system/internaltrigger/progress

Properties: Read
Type: Double
Unit: None

The fraction of the triggers generated so far.

/dev..../system/internaltrigger/repetitions

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Number of triggers to be generated.

/dev..../system/internaltrigger/synchronization/enable

Properties: Read, Write, Setting
Type: Integer (64 bit)
Unit: None

Enable synchronization. Trigger generation will only start once all synchronization participants have reported a ready status. Synchronization checks will be repeated with the same trigger generation settings (holdoff and repetitions) until synchronization is disabled.

/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/preset/busy

Properties: Read
Type: Integer (64 bit)
Unit: None

Indicates if presets are currently loaded.

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

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

Load the selected 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: 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/synchronization/source

Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: None

Selects the source for synchronization of channels: internal (default) or external

0 "internal": Internal: Synchronization of all channels of a device that have the corresponding synchronization setting enabled.
1 "external": External: Same as internal plus synchronization to other devices via ZSync.
/dev..../system/update

Properties: Read, Write
Type: Integer (64 bit)
Unit: None

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