Device Node Tree
This chapter contains reference documentation for the settings and measurement data available on HDAWG 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 HDAWG 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 "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
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.
- 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 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
daq = zhinst.core.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.
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.
AWGS
Read, Write, Setting Integer (enumerated) None Selects the digital trigger source signal. 0 Trigger In 1 1 Trigger In 2 2 Trigger In 3 3 Trigger In 4 4 Trigger Out 1 5 Trigger Out 2 6 Trigger Out 3 7 Trigger Out 4
/DEV…./AWGS/n/AUXTRIGGERS/m/CHANNEL
Properties:
Type:
Unit:
trigin0
, trigger_input0
trigin1
, trigger_input1
trigin2
, trigger_input2
trigin3
, trigger_input3
trigout0
, trigger_output0
trigout1
, trigger_output1
trigout2
, trigger_output2
trigout3
, trigger_output3
Read, Write, Setting Integer (enumerated) 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 trigger 1 Rising edge trigger 2 Falling edge trigger 3 Rising or falling edge trigger
/DEV…./AWGS/n/AUXTRIGGERS/m/SLOPE
Properties:
Type:
Unit:
level_sensitive
rising_edge
falling_edge
both_edges
Read Integer (64 bit) None State of the Auxiliary Trigger: No trigger detected/trigger detected.
/DEV…./AWGS/n/AUXTRIGGERS/m/STATE
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Writing to this node clears all data previously loaded to the command table of the device.
/DEV…./AWGS/n/COMMANDTABLE/CLEAR
Properties:
Type:
Unit:
Read, Write ZIVectorData None Data contained in the command table in JSON format.
/DEV…./AWGS/n/COMMANDTABLE/DATA
Properties:
Type:
Unit:
Read ZIVectorData None JSON schema describing the command table JSON format (read-only).
/DEV…./AWGS/n/COMMANDTABLE/SCHEMA
Properties:
Type:
Unit:
Read Integer (64 bit) None Status of the command table on the instrument. 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…./AWGS/n/COMMANDTABLE/STATUS
Properties:
Type:
Unit:
Read ZIVectorData None A vector of 32-bit integers representing the values on the DIO interface.
/DEV…./AWGS/n/DIO/DATA
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Index of the bit on the DIO interface for which the delay should be changed.
/DEV…./AWGS/n/DIO/DELAY/INDEX
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Corresponding delay value to apply to the given bit of the DIO interface in units of 150 MHz clock cycles. Valid values are 0 to 3.
/DEV…./AWGS/n/DIO/DELAY/VALUE
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) 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…./AWGS/n/DIO/ERROR/TIMING
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) 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…./AWGS/n/DIO/ERROR/WIDTH
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None 32-bit value indicating which bits on the 32-bit interface are detected as having a logic high value.
/DEV…./AWGS/n/DIO/HIGHBITS
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None 32-bit value indicating which bits on the 32-bit interface are detected as having a logic low value.
/DEV…./AWGS/n/DIO/LOWBITS
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Defines the amount of bit shifting to apply for the DIO wave selection in connection with playWaveDIO().
/DEV…./AWGS/n/DIO/MASK/SHIFT
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Selects the DIO bits to be used for waveform selection in connection with playWaveDIO().
/DEV…./AWGS/n/DIO/MASK/VALUE
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None When asserted, indicates that triggers are generated from the DIO interface to the AWG.
/DEV…./AWGS/n/DIO/STATE
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Select the DIO bit to use as the STROBE signal.
/DEV…./AWGS/n/DIO/STROBE/INDEX
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Select the signal edge of the STROBE signal for use in timing alignment. 0 Off 1 Rising edge trigger 2 Falling edge trigger 3 Rising or falling edge trigger
/DEV…./AWGS/n/DIO/STROBE/SLOPE
Properties:
Type:
Unit:
off
rising_edge
falling_edge
both_edges
Read, Write, Setting Integer (64 bit) None Specifies the expected width of active pulses on the STROBE bit.
/DEV…./AWGS/n/DIO/STROBE/WIDTH
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Select the DIO bit to use as the VALID signal to indicate a valid input is available.
/DEV…./AWGS/n/DIO/VALID/INDEX
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Polarity of the VALID bit that indicates that a valid input is available. 0 None: VALID bit is ignored. 1 Low: VALID bit must be logical zero. 2 High: VALID bit must be logical high. 3 Both: VALID bit may be logical high or zero.
/DEV…./AWGS/n/DIO/VALID/POLARITY
Properties:
Type:
Unit:
none
low
high
both
Read, Write, Setting Integer (64 bit) None Expected width of an active pulse on the VALID bit.
/DEV…./AWGS/n/DIO/VALID/WIDTH
Properties:
Type:
Unit:
Read Integer (64 bit) None Checksum of the uploaded ELF file.
/DEV…./AWGS/n/ELF/CHECKSUM
Properties:
Type:
Unit:
Write ZIVectorData None Accepts the data of the sequencer ELF file.
/DEV…./AWGS/n/ELF/DATA
Properties:
Type:
Unit:
Read Integer (64 bit) None Length of the compiled ELF file.
/DEV…./AWGS/n/ELF/LENGTH
Properties:
Type:
Unit:
Read Double None Size of the uploaded ELF file relative to the size of the main memory.
/DEV…./AWGS/n/ELF/MEMORYUSAGE
Properties:
Type:
Unit:
Read ZIVectorData None The name of the uploaded ELF file.
/DEV…./AWGS/n/ELF/NAME
Properties:
Type:
Unit:
Read Double % The percentage of the sequencer program already uploaded to the device.
/DEV…./AWGS/n/ELF/PROGRESS
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Activates the AWG.
/DEV…./AWGS/n/ENABLE
Properties:
Type:
Unit:
Read, Write, Setting Double None Deprecated, use /DEV…/AWGS/n/OUTPUTS/m/GAINS/m instead.
/DEV…./AWGS/n/OUTPUTS/m/AMPLITUDE
Properties:
Type:
Unit:
Read Integer (64 bit) None Indicates the routing of the AWG signal (k index) to the wave output or to the digital mixer input (m index).
/DEV…./AWGS/n/OUTPUTS/m/ENABLES/k
Properties:
Type:
Unit:
Read, Write, Setting Double 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…./AWGS/n/OUTPUTS/m/GAINS/k
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Keep the last sample (constant) on the output even after the waveform program finishes.
/DEV…./AWGS/n/OUTPUTS/m/HOLD
Properties:
Type:
Unit:
Read Double Hz Indicates the frequency used for this carrier. The frequency is calculated with oscillator frequency times the harmonic factor.
/DEV…./AWGS/n/OUTPUTS/m/MODULATION/CARRIERS/k/FREQ
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Multiplies the carriers’s reference frequency with the integer factor defined by this field.
/DEV…./AWGS/n/OUTPUTS/m/MODULATION/CARRIERS/k/HARMONIC
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Select oscillator for generation of this carrier.
/DEV…./AWGS/n/OUTPUTS/m/MODULATION/CARRIERS/k/OSCSELECT
Properties:
Type:
Unit:
Read, Write, Setting Double deg Phase shift applied to carrier signal.
/DEV…./AWGS/n/OUTPUTS/m/MODULATION/CARRIERS/k/PHASESHIFT
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Select modulation mode between off, sine modulation and advanced. 0 Modulation Off: AWG Output goes directly to Signal Output. 1 Sine 11: AWG Outputs 0 and 1 are both multiplied with Sine Generator signal 0. 2 Sine 22: AWG Outputs 0 and 1 are both multiplied with Sine Generator signal 1. 3 Sine 12: AWG Outputs 0 and 1 are multiplied with Sine Generator signal 0 and 1, respectively. 4 Sine 21: AWG Outputs 0 and 1 are multiplied with Sine Generator signal 1 and 0, respectively. 5 Advanced: Output modulates corresponding sines from modulation carriers. 6 Mixer Calibration: The AWG outputs are multiplied with the sum or difference of Sine Generators multiplied by gains specified. The resulting output signal is AWG1*(Sine1*Gain1 - Sine2*Gain2) + AWG2*(Sine1*Gain2 + Sine2*Gain1).
/DEV…./AWGS/n/OUTPUTS/m/MODULATION/MODE
Properties:
Type:
Unit:
off
sine00
sine11
sine01
sine10
advanced
mixer
Read Integer (64 bit) None AWG has a compiled wave form and is ready to be enabled.
/DEV…./AWGS/n/READY
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Clears the configured AWG program and resets the state to not ready.
/DEV…./AWGS/n/RESET
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Clears the logger data.
/DEV…./AWGS/n/RTLOGGER/CLEAR
Properties:
Type:
Unit:
Read ZIVectorData None Vector node with the logged events.
/DEV…./AWGS/n/RTLOGGER/DATA
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Activates the Real-time Logger.
/DEV…./AWGS/n/RTLOGGER/ENABLE
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Selects the operation mode. 0 Normal: Logger starts with the AWG and overwrites old values as soon as the memory limit of 1024 entries is reached. 1 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…./AWGS/n/RTLOGGER/MODE
Properties:
Type:
Unit:
normal
timestamp
Read, Write, Setting Integer (64 bit) None Timestamp at which to start logging for timestamp-triggered mode.
/DEV…./AWGS/n/RTLOGGER/STARTTIMESTAMP
Properties:
Type:
Unit:
Read Integer (enumerated) None Operation state. 0 Idle: Logger is not running. 1 Normal: Logger is running in normal mode. 2 Wait for timestamp: Logger is in timestamp-triggered mode and waits for start timestamp. 3 Active: Logger is in timestamp-triggered mode and logging. 4 Log Full: Logger is in timestamp-triggered mode and has stopped logging because log is full.
/DEV…./AWGS/n/RTLOGGER/STATUS
Properties:
Type:
Unit:
idle
normal
ts_wait
ts_active
ts_full
Read Double s Minimal time difference between two timestamps. The value matches the AWG sequencer execution rate.
/DEV…./AWGS/n/RTLOGGER/TIMEBASE
Properties:
Type:
Unit:
Read ZIVectorData None Displays the current sequence program in compiled form. Every line corresponds to one hardware instruction.
/DEV…./AWGS/n/SEQUENCER/ASSEMBLY
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Reserved for future use.
/DEV…./AWGS/n/SEQUENCER/CONTINUE
Properties:
Type:
Unit:
Read Double None Size of the current Sequencer program relative to the available instruction memory of 16 kInstructions (16'384 instructions).
/DEV…./AWGS/n/SEQUENCER/MEMORYUSAGE
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Reserved for future use.
/DEV…./AWGS/n/SEQUENCER/NEXT
Properties:
Type:
Unit:
Read Integer (64 bit) None Current position in the list of sequence instructions during execution.
/DEV…./AWGS/n/SEQUENCER/PC
Properties:
Type:
Unit:
Read ZIVectorData None Displays the source code of the current sequence program.
/DEV…./AWGS/n/SEQUENCER/PROGRAM
Properties:
Type:
Unit:
Read Integer (64 bit) 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…./AWGS/n/SEQUENCER/STATUS
Properties:
Type:
Unit:
Read Integer (64 bit) None When 1, indicates that the AWG Sequencer has been triggered.
/DEV…./AWGS/n/SEQUENCER/TRIGGERED
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Puts the AWG into single shot mode.
/DEV…./AWGS/n/SINGLE
Properties:
Type:
Unit:
Read, Write Double Dependent Node used by the sweeper module for fast index sweeps. When selected as sweep grid the sweeper module will switch into a fast index based scan mode. This mode can be up to 1000 times faster than conventional node sweeps. The sequencer program must support this functionality. See section 'AWG Index Sweep' of the UHF user manual for more information.
/DEV…./AWGS/n/SWEEP/AWGTRIGS/m
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Enable multi-channel synchronization for this AWG. The program will only execute once all channels with enabled synchronization are ready.
/DEV…./AWGS/n/SYNCHRONIZATION/ENABLE
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None AWG sampling rate. The numeric values here are an example when the base sample rate is the default value of 2.4 GHz and are rounded for display purposes. The exact values are equal to the base sampling rate divided by 2^n, where n is the node value. The base sample clock is the node /DEV…/SYSTEM/CLOCKS/SAMPLECLOCK/FREQ. This value is used by default and can be overridden in the Sequence program. 0 2.4 GHz 1 1.2 GHz 2 600 MHz 3 300 MHz 4 150 MHz 5 75 MHz 6 37.50 MHz 7 18.75 MHz 8 9.38 MHz 9 4.69 MHz 10 2.34 MHz 11 1.17 MHz 12 585.94 kHz 13 292.97 kHz
/DEV…./AWGS/n/TIME
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Integer user register value. The sequencer has reading and writing access to the user register values during run time.
/DEV…./AWGS/n/USERREGS/m
Properties:
Type:
Unit:
Read ZIVectorData None JSON-formatted string containing a dictionary of various properties of the current waveform: name, filename, function, channels, marker bits, length, timestamp.
/DEV…./AWGS/n/WAVEFORM/DESCRIPTORS
Properties:
Type:
Unit:
Read Double % Amount of the used waveform data relative to the device cache memory. The cache memory provides space for 256 kSa (262'144 Sa) per-channel of waveform data. Memory Usage over 100% means that waveforms must be loaded from the main memory of 64 or 512 MSa (67'108'864 Sa or 536'870'912 Sa) per-channel during playback.
/DEV…./AWGS/n/WAVEFORM/MEMORYUSAGE
Properties:
Type:
Unit:
Read Integer (64 bit) None When 1, indicates if a waveform is being played currently.
/DEV…./AWGS/n/WAVEFORM/PLAYING
Properties:
Type:
Unit:
Read, Write ZIVectorData 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…./AWGS/n/WAVEFORM/WAVES/m
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None 8-bit value to select the bits of the message received on ZSync interface coming from the PQSC error decoder.
/DEV…./AWGS/n/ZSYNC/DECODER/MASK
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None The additive offset applied to the message received on ZSync interface coming from the PQSC error decoder.
/DEV…./AWGS/n/ZSYNC/DECODER/OFFSET
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None The bit shift applied to the message received on ZSync interface coming from the PQSC error decoder.
/DEV…./AWGS/n/ZSYNC/DECODER/SHIFT
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None 4-bit value to select the bits of the message received on ZSync interface coming from the PQSC readout registers.
/DEV…./AWGS/n/ZSYNC/REGISTER/MASK
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None The additive offset applied to the message received on ZSync interface coming from the PQSC readout registers.
/DEV…./AWGS/n/ZSYNC/REGISTER/OFFSET
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None The bit shift applied to the message received on ZSync interface coming from the PQSC readout registers.
/DEV…./AWGS/n/ZSYNC/REGISTER/SHIFT
Properties:
Type:
Unit:
CLOCKBASE
Read Double Hz Returns the internal clock frequency of the device.
/DEV…./CLOCKBASE
Properties:
Type:
Unit:
CNTS (Pulse Counters)
Read, Write, Setting Integer (64 bit) None Enable the pulse counter unit.
/DEV…./CNTS/n/ENABLE
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Select the signal source used for enabling the counter in the Gated Free Running and Gated modes. 0 Trigger/Ref Input 1 (front panel). 1 Trigger/Ref Input 2 (front panel). 2 Trigger Input 3 (rear panel). 3 Trigger Input 4 (rear panel). 4 AWG Trigger 1. 5 AWG Trigger 2. 6 AWG Trigger 3. 7 AWG Trigger 4.
/DEV…./CNTS/n/GATESELECT
Properties:
Type:
Unit:
trigin0
, trigger_input0
trigin1
, trigger_input1
trigin2
, trigger_input2
trigin3
, trigger_input3
awg_trigger0
awg_trigger1
awg_trigger2
awg_trigger3
Read, Write, Setting Integer (enumerated) None Select the counter signal source. 0 DIO Bit 0. 1 DIO Bit 1. 2 DIO Bit 2. 3 DIO Bit 3. 4 DIO Bit 4. 5 DIO Bit 5. 6 DIO Bit 6. 7 DIO Bit 7. 8 DIO Bit 8. 9 DIO Bit 9. 10 DIO Bit 10. 11 DIO Bit 11. 12 DIO Bit 12. 13 DIO Bit 13. 14 DIO Bit 14. 15 DIO Bit 15. 16 DIO Bit 16. 17 DIO Bit 17. 18 DIO Bit 18. 19 DIO Bit 19. 20 DIO Bit 20. 21 DIO Bit 21. 22 DIO Bit 22. 23 DIO Bit 23. 24 DIO Bit 24. 25 DIO Bit 25. 26 DIO Bit 26. 27 DIO Bit 27. 28 DIO Bit 28. 29 DIO Bit 29. 30 DIO Bit 30. 31 DIO Bit 31. 32 Trigger/Ref Input 1 (front panel). 33 Trigger/Ref Input 2 (front panel). 34 Trigger Input 3 (rear panel). 35 Trigger Input 4 (rear panel).
/DEV…./CNTS/n/INPUTSELECT
Properties:
Type:
Unit:
trigin0
, trigger_input0
trigin1
, trigger_input1
trigin2
, trigger_input2
trigin3
, trigger_input3
Read, Write, Setting Integer (64 bit) None Sum up counter values over time.
/DEV…./CNTS/n/INTEGRATE
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Select the run mode of the counter unit. 1 Free Running: The counter runs on a repetitive time base defined by the Period field. At the beginning of each period the counter is reset, and at the end, the accumulated number of counts is output. 2 Gated Free Running: The counter runs on a repetitive time base defined by the Period field. The Gate Input signal controls when the unit counter is allowed to run. The counter as well as the timer is reset when the Gate Input signal is low. The counter will only deliver new values if the Gate Input signal is high for a time longer than the configured Period. 3 Gated: The counter is controlled with the Gate Input signal. The counter is enabled at the rising edge of the Gate Input signal and disabled at the falling edge. Pulses are counted as long as the counter is enabled. The accumulated number of counts is output on the falling edge of the Gate Input signal. 4 Time Tagging: Every pulse is detected individually and tagged with the time of the event. The Period defines the minimum hold-off time between the tagging of two subsequent pulses. If more than one pulse occurs within the window defined by the Period, then the pulses are accumulated and output at the end of the window. The Period effectively determines the maximum rate at which pulse information can be transmitted to the host PC.
/DEV…./CNTS/n/MODE
Properties:
Type:
Unit:
free_running
gated_free_running
gated
time_tagging
Read, Write, Setting Integer (enumerated) None Select the arithmetic operation (addition, subtraction) applied to the counter unit outputs. 'Other counter' refers to the grouping of the counter units: 1 with 2, and 3 with 4. 0 None 1 Add Other Counter 2 Subtract Other Counter
/DEV…./CNTS/n/OPERATION
Properties:
Type:
Unit:
none
add_other_counter
subtract_other_counter
Read, Write, Setting Double s Set the period used for the Free Running and Gated Free Running modes. Also sets the hold-off time for the Time Tagging mode.
/DEV…./CNTS/n/PERIOD
Properties:
Type:
Unit:
Read, Stream ZICntSample None Streaming node containing counter values.
/DEV…./CNTS/n/SAMPLE
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Performs a trigger event when the source signal crosses the trigger level from high to low. For dual edge triggering, select also the rising edge.
/DEV…./CNTS/n/TRIGFALLING
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Performs a trigger event when the source signal crosses the trigger level from low to high. For dual edge triggering, select also the falling edge.
/DEV…./CNTS/n/TRIGRISING
Properties:
Type:
Unit:
Read Integer (64 bit) None Counter output value.
/DEV…./CNTS/n/VALUE
Properties:
Type:
Unit:
DIOS (Digital I/O)
Read, Write, Setting Integer (64 bit) 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/DRIVE
Properties:
Type:
Unit:
Read Integer (64 bit) None Gives the value of the DIO input for those bytes where drive is disabled.
/DEV…./DIOS/n/INPUT
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) 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/INTERFACE
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Select DIO mode 0 Enables manual control of the DIO output bits. 1 Enables setting the DIO output values by AWG sequencer commands and forwards DIO input values to the AWG sequencer. The DIO interface operates at a clock frequency of 150 MHz. 2 Enables setting the DIO output values by AWG sequencer commands and forwards DIO input values to the AWG sequencer. This mode is equivalent to the mode AWG Sequencer, except for the DIO interface clock frequency which is set to 50 MHz. 3 Enables setting the DIO output values by the ZSync input values. Forwards the ZSync input values to the AWG sequencer. Forwards the DIO input values to the ZSync output. Select this mode when the instrument is connected via ZSync to a PQSC.
/DEV…./DIOS/n/MODE
Properties:
Type:
Unit:
manual
awg_sequencer_commands
dio_codeword
qccs
Read, Write, Setting Integer (64 bit) None Sets the value of the DIO output for those bytes where 'drive' is enabled.
/DEV…./DIOS/n/OUTPUT
Properties:
Type:
Unit:
FEATURES
Write String None Node providing a mechanism to write feature codes.
/DEV…./FEATURES/CODE
Properties:
Type:
Unit:
Read String None Returns the device type.
/DEV…./FEATURES/DEVTYPE
Properties:
Type:
Unit:
Read String None Returns enabled options.
/DEV…./FEATURES/OPTIONS
Properties:
Type:
Unit:
Read String None Device serial number.
/DEV…./FEATURES/SERIAL
Properties:
Type:
Unit:
OSCS (Oscillators)
Read, Write, Setting Double Hz Frequency control for each oscillator.
/DEV…./OSCS/n/FREQ
Properties:
Type:
Unit:
Read Double Hz Frequency as set by the AWG sequencer.
/DEV…./OSCS/n/FREQAWG
Properties:
Type:
Unit:
SIGOUTS
Read Integer (64 bit) None Boolean value indicating whether a blocking process is being executed on the device. For example, locking to the external reference clock.
/DEV…./SIGOUTS/n/BUSY
Properties:
Type:
Unit:
Read, Write, Setting Double s This value allows to delay the output of the signal in order to align waves.
/DEV…./SIGOUTS/n/DELAY
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Enables the direct output path. If enabled the signal will be fed directly from the DAC, reducing delay and noise. However, the range will be fixed and offset is not available any more. 0 Amplified Path 1 Direct Path
/DEV…./SIGOUTS/n/DIRECT
Properties:
Type:
Unit:
amplified_path
direct_path
Read, Write, Setting Integer (64 bit) None Enables a filter stage in the amplified path.
/DEV…./SIGOUTS/n/FILTER
Properties:
Type:
Unit:
Read Double None Maximum value transmitted to the DAC represented as a 16-bit integer in two’s complement format.
/DEV…./SIGOUTS/n/MAX
Properties:
Type:
Unit:
Read Double None Minimum value transmitted to the DAC represented as a 16-bit integer in two’s complement format.
/DEV…./SIGOUTS/n/MIN
Properties:
Type:
Unit:
Read, Write, Setting Double V Defines the DC voltage that is added to the dynamic part of the output signal.
/DEV…./SIGOUTS/n/OFFSET
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Enabling/Disabling the Signal Output. Corresponds to the blue LED indicator on the instrument front panel.
/DEV…./SIGOUTS/n/ON
Properties:
Type:
Unit:
Read Integer (64 bit) None Indicates that the signal output is overloaded.
/DEV…./SIGOUTS/n/OVER
Properties:
Type:
Unit:
Read, Write, Setting Double None Sets the amplitude of the bounce correction filter relative to the signal amplitude.
/DEV…./SIGOUTS/n/PRECOMPENSATION/BOUNCES/m/AMPLITUDE
Properties:
Type:
Unit:
Read, Write, Setting Double s Sets the delay of the bounce correction filter.
/DEV…./SIGOUTS/n/PRECOMPENSATION/BOUNCES/m/DELAY
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Enables (1) or disables (0) the bounce correction filter.
/DEV…./SIGOUTS/n/PRECOMPENSATION/BOUNCES/m/ENABLE
Properties:
Type:
Unit:
Read Integer (64 bit) None Indicates the status of the bounce correction filter: 0 = normal, 1 = overflow during the last update period (~100 ms), 2 = overflowed in the past.
/DEV…./SIGOUTS/n/PRECOMPENSATION/BOUNCES/m/STATUS
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Enables (1) or disables (0) the entire precompensation filter chain.
/DEV…./SIGOUTS/n/PRECOMPENSATION/ENABLE
Properties:
Type:
Unit:
Read, Write, Setting Double None Sets the amplitude of the exponential overshoot compensation filter relative to the signal amplitude.
/DEV…./SIGOUTS/n/PRECOMPENSATION/EXPONENTIALS/m/AMPLITUDE
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Enables (1) or disables (0) the exponential overshoot compensation filter.
/DEV…./SIGOUTS/n/PRECOMPENSATION/EXPONENTIALS/m/ENABLE
Properties:
Type:
Unit:
Read Integer (64 bit) None Indicates the status of the exponential overshoot compensation filter: 0 = normal, 1 = overflow during the last update period (~100 ms), 2 = overflowed in the past.
/DEV…./SIGOUTS/n/PRECOMPENSATION/EXPONENTIALS/m/STATUS
Properties:
Type:
Unit:
Read, Write, Setting Double s Sets the characteristic time constant of the exponential overshoot compensation filter.
/DEV…./SIGOUTS/n/PRECOMPENSATION/EXPONENTIALS/m/TIMECONSTANT
Properties:
Type:
Unit:
Read, Write, Setting ZIVectorData s Vector containing 40 coefficients of the finite impulse response (FIR) precompensation filter. The first eight coefficients correspond directly to the first eight taps of the FIR filter, while the remaining 32 coefficients are each applied to pairs of subsequent taps. In total the FIR filter kernel therefore has a length of 8 + 2*32 = 72 taps.
/DEV…./SIGOUTS/n/PRECOMPENSATION/FIR/COEFFICIENTS
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Enables (1) or disables (0) the finite impulse response (FIR) precompensation filter.
/DEV…./SIGOUTS/n/PRECOMPENSATION/FIR/ENABLE
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Indicates the status of the finite impulse response (FIR) precompensation filter: 0 = normal, 1 = overflow during the last update period (~100 ms), 2 = overflowed in the past.
/DEV…./SIGOUTS/n/PRECOMPENSATION/FIR/STATUS
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None When to react to a clearing pulse generated after the AWG Sequencer setPrecompClear instruction. 0 During the entire clearing pulse (Level). 1 At the rising edge of clearing pulse. 2 At the falling edge of the clearing pulse. 3 Both, at the rising and falling edge of the clearing pulse.
/DEV…./SIGOUTS/n/PRECOMPENSATION/HIGHPASS/m/CLEARING/SLOPE
Properties:
Type:
Unit:
entire_clearing_pulse
rising_edge
falling_edge
both_egdes
Read, Write, Setting Integer (64 bit) None Enables (1) or disables (0) the high-pass compensation filter.
/DEV…./SIGOUTS/n/PRECOMPENSATION/HIGHPASS/m/ENABLE
Properties:
Type:
Unit:
Read Integer (64 bit) None Indicates the status of the high-pass compensation filter: 0 = normal, 1 = overflow during the last update period (~100 ms), 2 = overflowed in the past.
/DEV…./SIGOUTS/n/PRECOMPENSATION/HIGHPASS/m/STATUS
Properties:
Type:
Unit:
Read, Write, Setting Double s Sets the characteristic time constant of the high-pass compensation filter.
/DEV…./SIGOUTS/n/PRECOMPENSATION/HIGHPASS/m/TIMECONSTANT
Properties:
Type:
Unit:
Read Double s The total latency introduced by the entire precompensation filter chain.
/DEV…./SIGOUTS/n/PRECOMPENSATION/LATENCY
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Resets the status flags of all precompensation filters of this output channel.
/DEV…./SIGOUTS/n/PRECOMPENSATION/STATUS/RESET
Properties:
Type:
Unit:
Read, Write, Setting Double None
/DEV…./SIGOUTS/n/RANGE
Properties:
Type:
Unit:
SINES
Read, Write, Setting Double None Sets the peak amplitude that the sine signal contributes to the signal output. Note that the last index is either 0 or 1 and will map to the pair of outputs given by the first index. (e.g. sines/3/amplitudes/0 corresponds to wave output 2)
/DEV…./SINES/n/AMPLITUDES/m
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Enables the sine signal to the signal output. Note that the last index is either 0 or 1 and will map to the pair of outputs given by the first index. (e.g. sines/3/amplitudes/0 corresponds to wave output 2)
/DEV…./SINES/n/ENABLES/m
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Multiplies the sine signals’s reference frequency with the integer factor defined by this field.
/DEV…./SINES/n/HARMONIC
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Select oscillator for generation of this sine signal.
/DEV…./SINES/n/OSCSELECT
Properties:
Type:
Unit:
Read, Write, Setting Double deg Phase shift applied to sine signal.
/DEV…./SINES/n/PHASESHIFT
Properties:
Type:
Unit:
STATS
Read Double Mbit/s Command streaming bandwidth usage on the physical network connection between device and data server.
/DEV…./STATS/CMDSTREAM/BANDWIDTH
Properties:
Type:
Unit:
Read Integer (64 bit) B Number of bytes received on the command stream from the device since session start.
/DEV…./STATS/CMDSTREAM/BYTESRECEIVED
Properties:
Type:
Unit:
Read Integer (64 bit) B Number of bytes sent on the command stream from the device since session start.
/DEV…./STATS/CMDSTREAM/BYTESSENT
Properties:
Type:
Unit:
Read Integer (64 bit) 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/PACKETSLOST
Properties:
Type:
Unit:
Read Integer (64 bit) None Number of packets received on the command stream from the device since session start.
/DEV…./STATS/CMDSTREAM/PACKETSRECEIVED
Properties:
Type:
Unit:
Read Integer (64 bit) None Number of packets sent on the command stream to the device since session start.
/DEV…./STATS/CMDSTREAM/PACKETSSENT
Properties:
Type:
Unit:
Read Integer (64 bit) None Number of buffers ready for receiving command packets from the device.
/DEV…./STATS/CMDSTREAM/PENDING
Properties:
Type:
Unit:
Read Integer (64 bit) 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/CMDSTREAM/PROCESSING
Properties:
Type:
Unit:
Read Double Mbit/s Data streaming bandwidth usage on the physical network connection between device and data server.
/DEV…./STATS/DATASTREAM/BANDWIDTH
Properties:
Type:
Unit:
Read Integer (64 bit) B Number of bytes received on the data stream from the device since session start.
/DEV…./STATS/DATASTREAM/BYTESRECEIVED
Properties:
Type:
Unit:
Read Integer (64 bit) None Number of data packets lost since device start. Data packets contain measurement data.
/DEV…./STATS/DATASTREAM/PACKETSLOST
Properties:
Type:
Unit:
Read Integer (64 bit) None Number of packets received on the data stream from the device since session start.
/DEV…./STATS/DATASTREAM/PACKETSRECEIVED
Properties:
Type:
Unit:
Read Integer (64 bit) None Number of buffers ready for receiving data packets from the device.
/DEV…./STATS/DATASTREAM/PENDING
Properties:
Type:
Unit:
Read Integer (64 bit) 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/DATASTREAM/PROCESSING
Properties:
Type:
Unit:
Read Double V Supply voltage of the FPGA.
/DEV…./STATS/PHYSICAL/FPGA/AUX
Properties:
Type:
Unit:
Read Double V Core voltage of the FPGA.
/DEV…./STATS/PHYSICAL/FPGA/CORE
Properties:
Type:
Unit:
Read Double °C Internal temperature of the FPGA.
/DEV…./STATS/PHYSICAL/FPGA/TEMP
Properties:
Type:
Unit:
Read Integer (64 bit) 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/OVERTEMPERATURE
Properties:
Type:
Unit:
Read Double A Currents of the main power supply.
/DEV…./STATS/PHYSICAL/POWER/CURRENTS/n
Properties:
Type:
Unit:
Read Double °C Temperatures of the main power supply.
/DEV…./STATS/PHYSICAL/POWER/TEMPERATURES/n
Properties:
Type:
Unit:
Read Double V Voltages of the main power supply.
/DEV…./STATS/PHYSICAL/POWER/VOLTAGES/n
Properties:
Type:
Unit:
Read Double V Supply voltage of the FPGA.
/DEV…./STATS/PHYSICAL/SLAVEFPGAS/n/AUX
Properties:
Type:
Unit:
Read Double V Core voltage of the FPGA.
/DEV…./STATS/PHYSICAL/SLAVEFPGAS/n/CORE
Properties:
Type:
Unit:
Read Double °C Internal temperature of the FPGA.
/DEV…./STATS/PHYSICAL/SLAVEFPGAS/n/TEMP
Properties:
Type:
Unit:
Read Double °C Internal temperature measurements.
/DEV…./STATS/PHYSICAL/TEMPERATURES/n
Properties:
Type:
Unit:
Read Double V Internal voltage measurements.
/DEV…./STATS/PHYSICAL/VOLTAGES/n
Properties:
Type:
Unit:
STATUS
Read Integer (64 bit) None The maximum value on Signal Input 1 (ADC0) during 100 ms.
/DEV…./STATUS/ADC0MAX
Properties:
Type:
Unit:
Read Integer (64 bit) None The minimum value on Signal Input 1 (ADC0) during 100 ms
/DEV…./STATUS/ADC0MIN
Properties:
Type:
Unit:
Read Integer (64 bit) None The maximum value on Signal Input 2 (ADC1) during 100 ms.
/DEV…./STATUS/ADC1MAX
Properties:
Type:
Unit:
Read Integer (64 bit) None The minimum value on Signal Input 2 (ADC1) during 100 ms
/DEV…./STATUS/ADC1MIN
Properties:
Type:
Unit:
Read Double None USB FIFO level: Indicates the USB FIFO fill level inside the device. When 100%, data is lost
/DEV…./STATUS/FIFOLEVEL
Properties:
Type:
Unit:
Read Integer (64 bit) None A set of binary flags giving an indication of the state of various parts of the device. Bit 11: Sample Loss.
/DEV…./STATUS/FLAGS/BINARY
Properties:
Type:
Unit:
Read Integer (64 bit) None Flag indicating if tcp packages have been lost.
/DEV…./STATUS/FLAGS/PACKETLOSSTCP
Properties:
Type:
Unit:
Read Integer (64 bit) None Flag indicating if udp packages have been lost.
/DEV…./STATUS/FLAGS/PACKETLOSSUDP
Properties:
Type:
Unit:
Read Integer (64 bit) None The current timestamp.
/DEV…./STATUS/TIME
Properties:
Type:
Unit:
SYSTEM
Read String None Currently active interface of the device.
/DEV…./SYSTEM/ACTIVEINTERFACE
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Sets the channel grouping mode of the device. 0 Use the outputs in groups of 2. One sequencer program controls 2 outputs (use /dev…./awgs/0..4/). 1 Use the outputs in groups of 4. One sequencer program controls 4 outputs (use /dev…./awgs/0/ and /dev…./awgs/2/) 2 Use the outputs in groups of 8. One sequencer program controls 8 outputs (use /dev…./awgs/0/). Requires 8 channel device.
/DEV…./SYSTEM/AWG/CHANNELGROUPING
Properties:
Type:
Unit:
groups_of_2
groups_of_4
groups_of_8
Read, Write, Setting Integer (enumerated) None Sets the oscillator control mode. 0 Oscillators are controlled by the UI/API. 1 Oscillators are controlled by the AWG sequencer.
/DEV…./SYSTEM/AWG/OSCILLATORCONTROL
Properties:
Type:
Unit:
api
awg_sequencer
Read String None Hardware revision of the FPGA base board
/DEV…./SYSTEM/BOARDREVISIONS/n
Properties:
Type:
Unit:
Read Double Hz Indicates the frequency of the reference clock.
/DEV…./SYSTEM/CLOCKS/REFERENCECLOCK/FREQ
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Reference clock source. 0 The internal clock is used as the frequency and time base reference. 1 An external clock is intended to be used as the frequency and time base reference. Provide a clean and stable 10MHz or 100MHz reference to the appropriate back panel connector. 2 A ZSync clock is intended to be used as the frequency and time base reference.
/DEV…./SYSTEM/CLOCKS/REFERENCECLOCK/SOURCE
Properties:
Type:
Unit:
internal
external
zsync
Read Integer (enumerated) None Status of the reference clock. 0 Reference clock has been locked on. 1 There was an error locking onto the reference clock signal. After an error the source is automatically switched back to internal reference clock. 2 The device is busy trying to lock onto the reference clock signal.
/DEV…./SYSTEM/CLOCKS/REFERENCECLOCK/STATUS
Properties:
Type:
Unit:
locked
error
busy
Read, Write, Setting Double Hz Indicates the frequency of the sample clock. Changing the sample clock temporarily interrupts the AWG sequencers.
/DEV…./SYSTEM/CLOCKS/SAMPLECLOCK/FREQ
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Enable the sampleclock output. 0 Sample clock output is disabled. 1 Sample clock output is enabled.
/DEV…./SYSTEM/CLOCKS/SAMPLECLOCK/OUTPUTENABLE
Properties:
Type:
Unit:
on
off
Read Integer (enumerated) None Status of the sample clock. 0 Sample clock signal is valid and has been locked on. 1 There was an error adjusting the sample clock. 2 The device is busy trying to adjust the sample clock.
/DEV…./SYSTEM/CLOCKS/SAMPLECLOCK/STATUS
Properties:
Type:
Unit:
locked
error
busy
Read Integer (64 bit) None HDL firmware revision.
/DEV…./SYSTEM/FPGAREVISION
Properties:
Type:
Unit:
Read String None Returns log output of the firmware.
/DEV…./SYSTEM/FWLOG
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Enables logging to the fwlog node.
/DEV…./SYSTEM/FWLOGENABLE
Properties:
Type:
Unit:
Read Integer (64 bit) None Revision of the device-internal controller software.
/DEV…./SYSTEM/FWREVISION
Properties:
Type:
Unit:
Read String None USB firmware revision.
/DEV…./SYSTEM/FX3REVISION
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Setting this node to 1 will cause the device to blink the power led for a few seconds.
/DEV…./SYSTEM/IDENTIFY
Properties:
Type:
Unit:
Read String None Speed of the currently active interface (USB only).
/DEV…./SYSTEM/INTERFACESPEED
Properties:
Type:
Unit:
Read String None Returns the type of the data server kernel (mdk or hpk).
/DEV…./SYSTEM/KERNELTYPE
Properties:
Type:
Unit:
Read, Write String None Default gateway configuration for the network connection.
/DEV…./SYSTEM/NICS/n/DEFAULTGATEWAY
Properties:
Type:
Unit:
Read, Write String None IPv4 address of the device to use if static IP is enabled.
/DEV…./SYSTEM/NICS/n/DEFAULTIP4
Properties:
Type:
Unit:
Read, Write String None IPv4 mask in case of static IP.
/DEV…./SYSTEM/NICS/n/DEFAULTMASK
Properties:
Type:
Unit:
Read String None Current network gateway.
/DEV…./SYSTEM/NICS/n/GATEWAY
Properties:
Type:
Unit:
Read String None Current IPv4 of the device.
/DEV…./SYSTEM/NICS/n/IP4
Properties:
Type:
Unit:
Read String None Current MAC address of the device network interface.
/DEV…./SYSTEM/NICS/n/MAC
Properties:
Type:
Unit:
Read String None Current network mask.
/DEV…./SYSTEM/NICS/n/MASK
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None If written, this action will program the defined static IP address to the device.
/DEV…./SYSTEM/NICS/n/SAVEIP
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Enable this flag if the device is used in a network with fixed IP assignment without a DHCP server.
/DEV…./SYSTEM/NICS/n/STATIC
Properties:
Type:
Unit:
Read String None Returns the current owner of the device (IP).
/DEV…./SYSTEM/OWNER
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Returns the current TCP port used for communication to the dataserver.
/DEV…./SYSTEM/PORTTCP
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Returns the current UDP port used for communication to the dataserver.
/DEV…./SYSTEM/PORTUDP
Properties:
Type:
Unit:
Read Integer (64 bit) None Contains the date of power configuration (format is: (year << 16) | (month << 8) | day)
/DEV…./SYSTEM/POWERCONFIGDATE
Properties:
Type:
Unit:
Read Integer (64 bit) None Indicates if presets are currently loaded.
/DEV…./SYSTEM/PRESET/BUSY
Properties:
Type:
Unit:
Read Integer (64 bit) None Indicates if the last operation was illegal. Successful: 0, Error: 1.
/DEV…./SYSTEM/PRESET/ERROR
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Load the selected preset.
/DEV…./SYSTEM/PRESET/LOAD
Properties:
Type:
Unit:
Read Integer (64 bit) None The number of bits used to represent a frequency.
/DEV…./SYSTEM/PROPERTIES/FREQRESOLUTION
Properties:
Type:
Unit:
Read Double None The scale factor to use to convert a frequency represented as a freqresolution-bit integer to a floating point value.
/DEV…./SYSTEM/PROPERTIES/FREQSCALING
Properties:
Type:
Unit:
Read Double None The maximum oscillator frequency that can be set.
/DEV…./SYSTEM/PROPERTIES/MAXFREQ
Properties:
Type:
Unit:
Read Double s The maximum demodulator time constant that can be set. Only relevant for lock-in amplifiers.
/DEV…./SYSTEM/PROPERTIES/MAXTIMECONSTANT
Properties:
Type:
Unit:
Read Double None The minimum oscillator frequency that can be set.
/DEV…./SYSTEM/PROPERTIES/MINFREQ
Properties:
Type:
Unit:
Read Double s The minimum demodulator time constant that can be set. Only relevant for lock-in amplifiers.
/DEV…./SYSTEM/PROPERTIES/MINTIMECONSTANT
Properties:
Type:
Unit:
Read Integer (64 bit) None Indicates whether negative frequencies are supported.
/DEV…./SYSTEM/PROPERTIES/NEGATIVEFREQ
Properties:
Type:
Unit:
Read Double s Minimal time difference between two timestamps. The value is equal to 1/(maximum sampling rate).
/DEV…./SYSTEM/PROPERTIES/TIMEBASE
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Flag indicating that the TCP and UDP ports should be saved.
/DEV…./SYSTEM/SAVEPORTS
Properties:
Type:
Unit:
Read, Write Integer (64 bit) 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/SHUTDOWN
Properties:
Type:
Unit:
Read Integer (64 bit) None HDL firmware revision of the slave FPGA.
/DEV…./SYSTEM/SLAVEREVISION
Properties:
Type:
Unit:
Read, Write Integer (64 bit) None Indicates if the network connection is stalled.
/DEV…./SYSTEM/STALL
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Selects the source for synchronization of channels: internal (default) or external 0 Internal: Synchronization of all channels of a device that have the corresponding synchronization setting enabled. 1 External: Same as internal plus synchronization to other devices via ZSync.
/DEV…./SYSTEM/SYNCHRONIZATION/SOURCE
Properties:
Type:
Unit:
internal
external
Read, Write Integer (64 bit) None Requests update of the device firmware and bitstream from the dataserver.
/DEV…./SYSTEM/UPDATE
Properties:
Type:
Unit:
TRIGGERS
Read, Write, Setting Integer (64 bit) None Trigger input impedance: When on, the trigger input impedance is 50 Ohm, when off 1 k Ohm.
/DEV…./TRIGGERS/IN/n/IMP50
Properties:
Type:
Unit:
Read, Write, Setting Double V Trigger voltage level at which the trigger input toggles between low and high. Use 50% amplitude for digital input and consider the trigger hysteresis.
/DEV…./TRIGGERS/IN/n/LEVEL
Properties:
Type:
Unit:
Read Integer (64 bit) None Shows the trigger input. The value integrated over some time. Values are 1: low, 2: high, 3: was low and high in the period.
/DEV…./TRIGGERS/IN/n/VALUE
Properties:
Type:
Unit:
Read, Write, Setting Double s Trigger delay, controls the fine delay of the trigger output. The resolution is 78 ps.
/DEV…./TRIGGERS/OUT/n/DELAY
Properties:
Type:
Unit:
Read, Write, Setting Integer (enumerated) None Assign a signal to a marker. 0 Trigger output is assigned to AWG Trigger 1, controlled by AWG sequencer commands. 1 Trigger output is assigned to AWG Trigger 2, controlled by AWG sequencer commands. 2 Trigger output is assigned to AWG Trigger 3, controlled by AWG sequencer commands. 3 Trigger output is assigned to AWG Trigger 4, controlled by AWG sequencer commands. 4 Output is assigned to Output 1 Marker 1. 5 Output is assigned to Output 1 Marker 2. 6 Output is assigned to Output 2 Marker 1. 7 Output is assigned to Output 2 Marker 2. 8 Output is assigned to Trigger Input 1. 9 Output is assigned to Trigger Input 2. 10 Output is assigned to Trigger Input 3. 11 Output is assigned to Trigger Input 4. 12 Output is assigned to Trigger Input 5. 13 Output is assigned to Trigger Input 6. 14 Output is assigned to Trigger Input 7. 15 Output is assigned to Trigger Input 8. 17 Output is set to high. 18 Output is set to low.
/DEV…./TRIGGERS/OUT/n/SOURCE
Properties:
Type:
Unit:
awg_trigger0
awg_trigger1
awg_trigger2
awg_trigger3
output0_marker0
output0_marker1
output1_marker0
output1_marker1
trigin0
, trigger_input0
trigin1
, trigger_input1
trigin2
, trigger_input2
trigin3
, trigger_input3
trigin4
, trigger_input4
trigin5
, trigger_input5
trigin6
, trigger_input6
trigin7
, trigger_input7
high
low
Read, Write, Setting Integer (64 bit) None Enables trigger streaming.
/DEV…./TRIGGERS/STREAMS/n/ENABLE
Properties:
Type:
Unit:
Read, Write, Setting Double s Sets the holdoff time of the trigger unit.
/DEV…./TRIGGERS/STREAMS/n/HOLDOFFTIME
Properties:
Type:
Unit:
Read, Write, Setting Integer (64 bit) None Masks triggers for the current stream. The mask is bit encoded where bit 0..7 are the input triggers and bit 8..11 are AWG triggers.
/DEV…./TRIGGERS/STREAMS/n/MASK
Properties:
Type:
Unit:
Read, Stream ZITriggerSample None Streaming node containing the trigger data. Note that this will only deliver data if triggers are detected.
/DEV…./TRIGGERS/STREAMS/n/SAMPLE
Properties:
Type:
Unit: