HF2LI Lock-in Amplifier

https://docs.zhinst.com/hf2_user_manual/
Admin
The HF2LI Lock-in Amplifier is a high-performance instrument for precise measurement of small AC...
Tokens:71,814
Snippets:388
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run LabOne Linux Installation Script

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command executes the LabOne installation script with administrator privileges. The script guides the user through the installation process, offering options for installing the Data Server, Web Server, documentation, APIs, and udev support.

```bash
sudo bash install.sh
```

--------------------------------

### Navigate to LabOne Installation Directory

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command changes the current directory to the newly extracted LabOne installer directory, preparing for the installation script execution.

```bash
cd LabOneLinux<arch>-<release>-<revision>
```

--------------------------------

### Run ziRTK Installation Script

Source: https://docs.zhinst.com/hf2_user_manual/real_time_option

Executes the main installation script for ziRTK with root privileges, initiating the guided setup process. Users can also make the script executable and run it directly.

```bash
sudo bash install.sh
```

--------------------------------

### Start LabOne Web Server with Custom Data Directory on Windows

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command starts the LabOne Web Server from its installation directory on Windows, specifying a non-default path for saving measured data. It ensures that all user-generated data is stored in the designated custom directory, such as 'C:\data', instead of the default user home directory.

```CMD
C:\Program Files\Zurich Instruments\LabOne\WebServer> ziWebServer --data-path "C:\data"
```

--------------------------------

### Start LabOne Web Server on Linux

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command launches the LabOne Web Server (`ziWebServer`) on a Linux system. The web server is essential for accessing the LabOne User Interface through a web browser, listening by default on port 8006.

```bash
$ ziWebServer
```

--------------------------------

### Display LabOne Web Server Command-Line Help

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command displays the available command-line arguments and options for the LabOne Web Server. It is useful for understanding and customizing the server's behavior, allowing users to discover how to configure its operation.

```Shell
$ ziWebServer --help
```

--------------------------------

### Run LabOne Uninstall Script with Administrator Rights on Linux

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command executes the LabOne uninstallation script with superuser privileges on a Linux system. The script guides the user through the process of removing the LabOne software package from the system.

```bash
$ sudo bash uninstall_LabOne<arch>-<release>-<revision>.sh
```

--------------------------------

### Display LabOne Data Server Command-Line Help (HF2)

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command shows the command-line help for the LabOne Data Server, specifically for HF2 devices. It provides a list of arguments to configure the Data Server's behavior and understand its capabilities.

```Shell
$ ziServer --help
```

--------------------------------

### Extract LabOne Linux Installer Tarball

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command extracts the LabOne Linux installation package from a gzipped tar archive. The `xzvf` options stand for extract, verbose, gzip, and file respectively.

```bash
tar xzvf LabOneLinux<arch>-<release>-<revision>.tar.gz
```

--------------------------------

### Determine Linux System Architecture

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command is used in a command line terminal to determine the system's architecture (e.g., x86_64 or aarch64), which is crucial for downloading the correct LabOne installer package.

```bash
uname -m
```

--------------------------------

### Manually Start LabOne HF2 Data Server on Linux

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command manually initiates the HF2 Data Server (`ziServer`) on a Linux system. This step is necessary if `udev` support is not configured or if the server did not launch automatically upon instrument connection.

```bash
$ ziServer
```

--------------------------------

### Access LabOne Application Contents via Command Line

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command navigates to the resources directory within the LabOne application package on macOS. It demonstrates how to handle spaces in directory names by escaping them with a backslash.

```bash
cd /Applications/LabOne\ XX.XX.app/Contents/Resources
```

--------------------------------

### Navigate to LabOne Default Installation Directory on Linux

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command changes the current working directory to the default installation path for LabOne software on a Linux system. This is a prerequisite step before executing the uninstallation script.

```bash
$ cd /opt/zi/
```

--------------------------------

### Execute Real-time Development Environment Installation Script

Source: https://docs.zhinst.com/hf2_user_manual/real_time_option

After downloading and unzipping the ziRTK software bundle into the Cygwin home folder, use these commands within the Cygwin shell to navigate to the extracted directory and run the guided installation script for the Real-time development environment.

```bash
cd ziRTK-Win-[VERSION]
bash install.sh
```

--------------------------------

### Install Software Requirements for ziRTK on Debian

Source: https://docs.zhinst.com/hf2_user_manual/real_time_option

This command installs the necessary ia32_libs for 32-bit program execution on 64-bit systems and make for compiling examples, both required for ziRTK tools on Debian-based Linux distributions.

```bash
sudo apt-get install ia32_libs make
```

--------------------------------

### Check LabOne HF2 Data Server Status on Linux

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/software_installation

This command uses the `ziService` utility to check if the HF2 Data Server (`ziServer`) is currently running on a Linux system. It's a crucial first step before attempting to start the server manually.

```bash
$ ziService status
```

--------------------------------

### Navigate to Extracted ziRTK Directory

Source: https://docs.zhinst.com/hf2_user_manual/real_time_option

Changes the current working directory to the newly extracted ziRTK installation folder, which contains the setup script.

```bash
cd ziRTK-Linux-[VERSION]
```

--------------------------------

### Scripting Instrument Commands

Source: https://docs.zhinst.com/hf2_user_manual/programming

This snippet presents an example sequence of commands that can be used in a script to configure various instrument settings. It demonstrates changing directories, setting signal output states, ranges, amplitudes, enabling/disabling channels, and configuring oscillator frequencies and demodulator parameters.

```CLI
cd [.zinode]#/DEVX#
SIGOUTS/*/ON 0
SIGOUTS/0/RANGE 1
SIGOUTS/0/AMPLITUDES/0 1
SIGOUTS/0/ENABLES/* 0
SIGOUTS/0/ENABLES/0 1
OSCS/0/FREQ 300000
SIGINS/0/RANGE 10
DEMODS/0/ORDER 2
DEMODS/0/RATE 1000
```

--------------------------------

### Install GNU Make for ziRTK

Source: https://docs.zhinst.com/hf2_user_manual/real_time_option

Ensures the 'make' development package, essential for compiling ziRTK components, is installed on the system.

```bash
sudo apt-get install make
```

--------------------------------

### Navigate and Inspect Connected Instruments via CLI

Source: https://docs.zhinst.com/hf2_user_manual/programming

Learn the fundamental commands to connect to ziServer, list connected instruments (ZI node, DEVX node), navigate to the ziServer node, and read all values within its tree. This helps in understanding the initial setup and available devices.

```CLI
ls
cd zi
ls
/ ?
```

--------------------------------

### Locate ziRTK HTML Documentation Paths

Source: https://docs.zhinst.com/hf2_user_manual/real_time_option

Provides typical file system paths where the HTML version of the ziRTK user manual and reference documentation can be found after installation on Linux and Windows systems.

```plaintext
[INSTALLPATH]/ziRTK/doc/html/index.html
```

```plaintext
C:\cygwin\usr\share\zi\ziRTK-XX.XX\doc\html\index.html
```

```plaintext
/opt/zi/ziRTK/doc/html/index.html
```

--------------------------------

### Locating LabOne Log Files on Windows

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/trouble_shooting

This snippet provides the default file paths for LabOne Data Server and Web Server log files on Windows operating systems, distinguishing between service-started and manually-started server instances. It also includes a tip for accessing hidden AppData folders.

```Filesystem Path
C:\Windows\ServiceProfiles\LocalService\AppData\Local\Temp\Zurich Instruments\LabOne\ziServerLog
```

```Filesystem Path
C:\Users\[USER]\AppData\Local\Temp\Zurich Instruments\LabOne\ziServerLog
```

```Filesystem Path
C:\Users\[USER]\AppData\Local\Temp\Zurich Instruments\LabOne\ziWebServerLog
```

```Shell
%AppData%\..
```

--------------------------------

### Examples of Getting and Setting Instrument Node Values

Source: https://docs.zhinst.com/hf2_user_manual/programming

This snippet provides practical examples of how to retrieve and modify instrument node values using the defined syntax. It demonstrates querying values for multiple leaves, a single leaf, setting a single leaf's value, and setting multiple leaves' values in a single command.

```CLI
about/* ?             // return values of leaves at path
devx/demods/0/* ?
/zi/config/* ?

/devx/demods/0/adcselect ?     // return value at path
/devx/demods/0/adcselect 0     // set value of leaf

/devx/demods/0/adcselect /devx/demods/1/adcselect 1
                               // multiple set value
```

--------------------------------

### Locating LabOne Log Files on Linux and macOS

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/trouble_shooting

This snippet provides the default file paths for LabOne Data Server and Web Server log files on Linux and macOS operating systems, distinguishing between manually-started and automatically-started (udev rule) server instances.

```Filesystem Path
/tmp/ziServerLog_[USER]
```

```Filesystem Path
/tmp/ziServerLog_root
```

```Filesystem Path
/tmp/ziWebServerLog_[USER]
```

--------------------------------

### Get Node Description with Python daq.help

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

This snippet demonstrates how to use the `daq.help` command in the LabOne Python API to retrieve detailed information about a specific instrument node. It shows how to initialize the `ziDAQServer` and then call `help` with the node's path, returning properties like access rights, data type, and units.

```Python
    daq = zhinst.core.ziDAQServer('localhost', 8004, 6)
    daq.help('/dev2006/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
```

--------------------------------

### Perform Batch Operations with Wildcards in CLI

Source: https://docs.zhinst.com/hf2_user_manual/programming

Demonstrates the power of wildcard symbols (`*`) for applying settings to multiple similar parameters simultaneously. Examples include checking the frequency of all oscillators and changing all frequencies to a new value, significantly simplifying bulk configurations.

```CLI
cd ..
*/freq ?
*/freq 3600000
```

--------------------------------

### APIDOC: Overview of Instrument App Icons and Functions

Source: https://docs.zhinst.com/hf2_user_manual/functional_description/labone_overview

This section provides a comprehensive list of app icons available in the instrument's user interface, detailing their associated controls/tools, options/ranges (represented by SVG filenames), and a brief description of their functionality. The availability of specific icons may depend on installed upgrade options.

```APIDOC
AppIcons:
  Lock-in:
    OptionRange: "btn_mnu_demod_um.svg"
    Description: "Quick overview and access to all the settings and properties for signal generation and demodulation."
  Lock-in MF:
    OptionRange: "btn_mnu_demod_um.svg"
    Description: "Quick overview and access to all the settings and properties for signal generation and demodulation."
  Files:
    OptionRange: "btn_mnu_files_um.svg"
    Description: "Access settings and measurement data files on the host computer."
  Numeric:
    OptionRange: "btn_mnu_numerical_um.svg"
    Description: "Access to all continuously streamed measurement data as numerical values."
  Plotter:
    OptionRange: "btn_mnu_plotter_um.svg"
    Description: "Displays various continuously streamed measurement data as traces over time (roll mode)."
  Scope:
    OptionRange: "btn_mnu_scope_um.svg"
    Description: "Displays shots of data samples in time and frequency domain (FFT) representation."
  DAQ:
    OptionRange: "btn_mnu_daq_um.svg"
    Description: "Provides complex trigger functionality on all continuously streamed data samples and time domain display."
  Spectrum:
    OptionRange: "btn_mnu_zoomfft_um.svg"
    Description: "Provides FFT functionality to all continuously streamed measurement data."
  Sweeper:
    OptionRange: "btn_mnu_sweep_um.svg"
    Description: "Sweep frequencies, voltages, and other quantities over a defined range and display various response functions including statistical operations."
  Aux:
    OptionRange: "btn_mnu_auxiliary_um.svg"
    Description: "Controls all settings regarding the auxiliary inputs and auxiliary outputs."
  In/Out:
    OptionRange: "btn_mnu_inout_um.svg"
    Description: "Gives access to all controls relevant for the Signal Inputs and Signal Outputs of each channel."
  DIO:
    OptionRange: "btn_mnu_dio_um.svg"
    Description: "Gives access to all controls relevant for the digital inputs and outputs including DIO, Trigger Inputs, Trigger Outputs, and Marker Outputs."
  Config:
    OptionRange: "btn_mnu_mainconfig_um.svg"
    Description: "Provides access to software configuration."
  Device:
    OptionRange: "btn_mnu_device_um.svg"
    Description: "Provides instrument specific settings."
  PID:
    OptionRange: "btn_mnu_pid_um.svg"
    Description: "Features all control, analysis, and simulation capabilities of the PID controllers."
```

--------------------------------

### Extract ziRTK Bundle Archive

Source: https://docs.zhinst.com/hf2_user_manual/real_time_option

Extracts the compressed ziRTK software bundle from its tar.gz archive into the current directory, preparing it for installation.

```bash
tar xzf ziRTK-[build number]-linux.tar.gz
```

--------------------------------

### Define Instrument Path Syntax

Source: https://docs.zhinst.com/hf2_user_manual/programming

This snippet defines the syntax for constructing paths to instrument nodes. It specifies how to form path lists, use absolute paths starting from the root, employ wildcards for all nodes at a given hierarchy, and navigate up one level using '..'.

```Custom Syntax
path_list = path [path]
path = [/|/..|*]name[/name|*|**]
```

--------------------------------

### Download LabOne Net Link Data with C#.NET WebClient

Source: https://docs.zhinst.com/hf2_user_manual/functional_description/saving_data

This C#.NET example demonstrates how to use the WebClient object to download LabOne Net Link data from the LabOne WebServer. It retrieves the data as a byte array and converts it to a string. Further parsing of the CSV content is indicated as a next step.

```C#
using System;
using System.Text;
using System.Net;

namespace ExampleCSV
{
  class Program
  {
    static void Main(string[] args)
    {
      try
      {
        WebClient wc = new WebClient();
        byte[] buffer = wc.DownloadData("http://127.0.0.1:8006/netlink?id=c0p1t6p1cfplotmath&ziSessionId=0");
        String doc = Encoding.ASCII.GetString(buffer);
        // Parse here CSV lines and extract data
        // ...
        Console.WriteLine(doc);
      } catch (Exception e) {
        Console.WriteLine("Caught exception: " + e.Message);
      }
    }
  }
 }
```

--------------------------------

### Syntax for Getting and Setting Instrument Node Values

Source: https://docs.zhinst.com/hf2_user_manual/programming

This snippet outlines the fundamental syntax for interacting with instrument node values. It shows how to query the value of a specific path using 'path ?' and how to set values for single or multiple nodes using 'path value' or 'path_list value'.

```Custom Syntax
path ?
path_list value
```

--------------------------------

### Enable/Disable Auto Start

Source: https://docs.zhinst.com/hf2_user_manual/functional_description/config

This setting controls whether the session manager dialog is bypassed during startup. If enabled, the dialog is skipped when the selected device is available; otherwise, it reactivates in case of errors or disconnected devices.

```APIDOC
name: Auto Start
values: ON, OFF
description: Skip session manager dialog at start-up if selected device is available. In case of an error or disconnected device the session manager will be reactivated.
```

--------------------------------

### LabOne Settings Dialog Buttons

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/device_connectivity

Details the functionality of buttons available in the LabOne settings dialog, explaining their actions related to loading and managing UI and device settings.

```APIDOC
Settings Dialog Buttons:
  Open:
    Description: Loads the settings from the selected settings file. The "Include Device Settings" button controls whether only UI settings or both UI and device settings are loaded.
  Include Device Settings:
    Description: Controls which part of the selected settings file is loaded when "Open" is clicked. If enabled, both device and UI settings are loaded.
  Auto Start:
    Description: Skips the session dialog at start-up if the selected device is available. Loads default UI settings with unchanged device settings.
```

--------------------------------

### LabOne Settings File Columns

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/device_connectivity

Describes the various columns displayed in the LabOne Saved Settings table, providing details on their purpose and functionality for managing settings files.

```APIDOC
Settings File Columns:
  Favorite Marker (star icon):
    Description: Allows grouping favorite settings files. Activating the star groups chosen files at the top/bottom. The marker is saved to the settings file.
  Name:
    Description: The name of the settings file. In the file system, the file name has the extension .md.
  Date:
    Description: The date and time the settings file was last written.
  Comment:
    Description: Allows a comment to be stored in the settings file. Clicking the field allows typing a text, useful for describing measurement conditions.
  Device Type:
    Description: The instrument type with which this settings file was saved.
```

--------------------------------

### Run LabOne UI in Chrome Application Mode

Source: https://docs.zhinst.com/hf2_user_manual/getting_started/device_connectivity

This snippet shows how to create a desktop shortcut for Google Chrome to run the LabOne User Interface in application mode, removing standard browser controls for an improved user experience. It specifies the target path for the shortcut.

```Shell
path\to\chrome.exe -app=http://127.0.0.1:8006
```

--------------------------------

### CLI Commands for Instrument Navigation

Source: https://docs.zhinst.com/hf2_user_manual/programming

This snippet lists the command-line interface commands used for navigating the instrument's hierarchical tree structure. Commands include 'sel' (or 'cd') for changing directories, 'ls' for listing contents, 'tr' for displaying the complete tree, and 'info' for retrieving help strings.

```CLI
sel or cd [?|..|path]
ls [path]
tr [path]
info [path]
```

--------------------------------

### Instrument Settings for Quartz Resonance Sweep

Source: https://docs.zhinst.com/hf2_user_manual/tutorials/tutorial_pll

This table lists the recommended settings for the Lock-in and Sweeper tabs to perform a frequency sweep and determine the resonance of a quartz resonator. These settings are applicable for instruments without the HF2-MF Multi-frequency option installed.

```APIDOC
Table 1: Settings: sweep the measurement frequency
| Tab     | Sub-tab | Section            | # | Label                 | Setting / Value / State |
|---------|---------|--------------------|---|-----------------------|-------------------------|
| Lock-in | All     | Signal Outputs     | 1 | Amp (V)               | 100.0 m / ON            |
| Lock-in | All     | Signal Outputs     | 1 | Output 1              | ON                      |
| Lock-in | All     | Signal Inputs      | 1 | 50 Ω                  | ON                      |
| Lock-in | All     | Signal Inputs      | 1 | Diff                  | OFF                     |
| Lock-in | All     | Demodulators       | 1 | Osc                   | 1                       |
| Lock-in | All     | Demodulators       | 1 | Input                 | Sig In 1                |
| Lock-in | All     | Data Transfer      | 1 | Enable                | ON                      |
| Sweeper | Control | Horizontal         |   | Sweep Param.          | Osc 1 Frequency         |
| Sweeper | Control | Vertical Axis Groups |   | Signal Type / Channel | Demod Θ / 1             |
| Sweeper | Control | Vertical Axis Groups |   | Add Signal            | click                   |
| Sweeper | Control | Vertical Axis Groups |   | Signal Type / Channel | Demod R / 1             |
| Sweeper | Control | Vertical Axis Groups |   | Add Signal            | click                   |
| Sweeper | Control | Horizontal         |   | Start (Hz)            | 1 M                     |
| Sweeper | Control | Horizontal         |   | Stop (Hz)             | 3 M                     |
| Sweeper | History |                    |   | Length                | 2                       |
| Sweeper | Control | Settings           |   | Dual Plot             | ON                      |
| Sweeper | Control | Settings           |   | Run/Stop              | ON                      |
```

--------------------------------

### PID Controller and Device Model Configuration

Source: https://docs.zhinst.com/hf2_user_manual/functional_description/pid

Detailed API documentation for configuring PID controller behavior, demodulator settings, and various Device Under Test (DUT) models. Includes parameters for optimization, filtering, harmonic control, model-specific settings, and performance monitoring.

```APIDOC
PID Advise Mode:
  Description: Select the PID coefficients that are optimized. Other PID coefficients remain unchanged but are used during optimization, allowing fixed values while optimizing the rest. Advise time increases significantly with the number of parameters to be optimized.
  Options:
    - P: Only optimize the proportional gain.
    - I: Only optimize the integral gain.
    - PI: Only optimize the proportional and the integral gain.
    - PID: Optimize the proportional, integral, and derivative gains.

Demodulator Filter Parameters:
  Filter BW (numeric Value): Defines the low-pass filter characteristic of the selected demodulator input.
  Auto Bandwidth (ON / OFF): Adjusts the demodulator bandwidth to fit best to the specified target bandwidth of the full system. If disabled, a demodulator bandwidth too close to the target bandwidth may cause overshoot and instability. In special cases, the demodulator bandwidth can also be selected smaller than the target bandwidth.
  Filter Order:
    Description: Selects the filter roll off between 6 dB/oct and 48 dB/oct of the modelled demodulator.
    Options:
      - 1: 1st order filter 6 dB/oct
      - 2: 2nd order filter 12 dB/oct
      - 3: 3rd order filter 18 dB/oct
      - 4: 4th order filter 24 dB/oct
      - 5: 5th order filter 30 dB/oct
      - 6: 6th order filter 36 dB/oct
      - 7: 7th order filter 42 dB/oct
      - 8: 8th order filter 48 dB/oct

Demodulator Harmonic Parameter:
  Harmonic (1 to 1023): Multiplier for the reference frequency of the modelled demodulator.

DUT Model Parameters:
  DUT Model:
    Description: Type of model used for the external device to be controlled by the PID. A detailed description of the transfer function for each model is found in the previous section.
    Options:
      - All Pass: The external device is modelled by an all pass filter. Parameters to be configured are delay and gain.
      - LP 1st: The external device is modelled by a first-order low-pass filter. Parameters to be configured are delay, gain and filter bandwidth.
      - LP 2nd: The external device is modelled by a second-order low-pass filter. Parameters to be configured are delay, gain, resonance frequency and damping ratio.
      - Resonator Frequency: The external device is modelled by a resonator. Parameters to be configured are delay, center frequency and quality factor.
      - Internal PLL: The DUT is the internal oscillator locked to an external signal through a phase-locked loop. The parameter to be configured is the delay.
      - VCO: The external device is modelled by a voltage controlled oscillator. Parameters to be configured are delay, gain and bandwidth.
      - Resonator Amplitude: The external device is modelled by a resonator. Parameters to be configured are delay, gain, center frequency and quality factor.

DUT Model Common Parameters:
  Delay (numeric value): Parameter that determines the earliest response for a step change. This parameter does not affect the shape of the DUT transfer function.
  Gain (numeric value): Parameter that determines the gain of the DUT transfer function.
  BW (Hz) (numeric value): Parameter that determines the bandwidth of the first-order low-pass filter respectively the bandwidth of the VCO.
  Damping Ratio (numeric value): Parameter that determines the damping ratio of the second-order low-pass filter.
  Res Freq (numeric value): Parameter that determines the resonance frequency of the modelled resonator.
  Q (numeric value): Parameter that determines the quality factor of the modelled resonator.

PID Coefficient Parameters:
  P (numeric value): Proportional gain P coefficient used for calculation of the response of the PID model. The parameter can be optimized with PID advise or changed manually. The parameter only gets active on the PID after pressing the button To PLL.
  I/Ti (numeric value): Integral gain coefficient I or time constant Ti=P/I used for calculation of the response of the PID model. The parameter can be optimized with PID advise or changed manually. The parameter only gets active on the PID after pressing the button To PLL.
  D/Td (numeric value): Integral gain coefficient D or time constant Td=D/P used for calculation of the response of the PID model. The parameter can be optimized with PID advise or changed manually. The parameter only gets active on the PID after pressing the button To PLL.

PID Performance Metrics:
  BW (Hz) (numeric value): Simulated bandwidth of the full close loop model with the current PID settings. This value should be larger than the target bandwidth.
  Target BW LED (green/red): Green indicates that the target bandwidth can be achieved. For very high PID bandwidth, the target bandwidth might be only achieved using marginal stable PID settings. In this case, try to lower the bandwidth or optimize the loop delays of the PID system.
  PM (deg) (numeric value): Simulated phase margin of the PID with the current settings. The phase margin should be greater than 45 deg for internal PLL and 60 deg for all other DUT for stable conditions. An Infinite value is shown if no unity gain crossing is available to determine a phase margin.
```

--------------------------------

### API Documentation for scopes/n/wave

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

Samples of scope-waveforms.

```APIDOC
Path: /dev..../scopes/n/wave
Description: Samples of scope-waveforms.
Properties: Read, Stream
Type: ZIScopeWave
Unit: 
```

--------------------------------

### PID Advisor Configuration Settings

Source: https://docs.zhinst.com/hf2_user_manual/tutorials/tutorial_pid

This section outlines the recommended settings for configuring and running the PID Advisor to simulate a Resonator Amplitude Device Under Test (DUT). These settings are applied within the PID tab, across various sub-tabs and sections, to achieve a target bandwidth and stable feedback loop.

```APIDOC
PID Advisor Settings:
  - Tab: PID
    Sub-tab: Advisor
    Section: Advisor
    Label: Target BW (Hz)
    Setting: 1 k
  - Tab: PID
    Sub-tab: Advisor
    Section: Advisor
    Label: Advise Mode
    Setting: PI
  - Tab: PID
    Sub-tab: Advisor
    Section: Demodulator Settings
    Label: Filter BW / Auto Bandwidth
    Setting: ON
  - Tab: PID
    Sub-tab: Advisor
    Section: DUT Model
    Label: DUT Model
    Setting: Resonator Amplitude
  - Tab: PID
    Sub-tab: Advisor
    Section: DUT Model
    Label: Delay
    Setting: 0.0 s
  - Tab: PID
    Sub-tab: Advisor
    Section: DUT Model
    Label: Gain
    Setting: 0.040
  - Tab: PID
    Sub-tab: Advisor
    Section: DUT Model
    Label: Center Frequency
    Setting: 1.8 M
  - Tab: PID
    Sub-tab: Advisor
    Section: DUT Model
    Label: Q
    Setting: 12.8 k
  - Tab: PID
    Sub-tab: Display
    Label: Display
    Setting: Step Response
  - Tab: PID
    Sub-tab: Advisor
    Section: Advisor
    Label: Advise
    Setting: ON
```

--------------------------------

### Access CLI Command Reference

Source: https://docs.zhinst.com/hf2_user_manual/programming

Provides the command to view a complete list of all available commands within the text-based interface. It also notes that the interface is case-insensitive, aiding user interaction.

```CLI
help
```

--------------------------------

### HF2 Instrument Node: Setting Signal Input AC Mode

Source: https://docs.zhinst.com/hf2_user_manual/programming

This example demonstrates how to set a specific parameter on the HF2 Instrument. It shows enabling the AC mode for the first signal input by assigning the value '1' to the '/devx/sigins/0/ac' node. This is a common way to configure instrument settings via the node hierarchy.

```APIDOC
/devx/sigins/0/ac = 1
```

--------------------------------

### Sweeper Minimum Settling Time

Source: https://docs.zhinst.com/hf2_user_manual/functional_description/sweeper

Minimum wait time in seconds between a sweep parameter change and the recording of the next sweep point. This parameter can be used to define the required settling time of the experimental setup. The effective wait time is the maximum of this value and the demodulator filter settling time determined from the Inaccuracy value specified.

```APIDOC
Sweeper Parameter:
  Name: Min Settling Time (s)
  Type: numeric value
  Description: Minimum wait time in seconds between a sweep parameter change and the recording of the next sweep point.
  Purpose: Defines the required settling time of the experimental setup.
  Effective Wait Time: Maximum of this value and the demodulator filter settling time (determined from Inaccuracy).
```

--------------------------------

### API Node: /dev..../auxins/n/sample

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

Provides auxiliary input samples. This node supports reading and streaming of sample data.

```APIDOC
/dev..../auxins/n/sample:
  Properties: Read, Stream
  Type: ZIAuxInSample
  Unit: 
  Description: Auxiliary input samples.
```

--------------------------------

### API Documentation for /dev..../pids/n/tipprotect/enable

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

Enable TipProtect for the PID controller.

```APIDOC
Path: /dev..../pids/n/tipprotect/enable
Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: Boolean
Values:
  0: OFF
  1: ON
```

--------------------------------

### Define HF2 MOD 2 Parameters for FM Signal Generation

Source: https://docs.zhinst.com/hf2_user_manual/tutorials/tutorial_frequency_modulation

These settings in the MOD 2 section of the Modulation tab define the characteristics of the FM signal to be generated. It specifies the carrier frequency, modulation frequency, modulation index, and enables the FM generation with a defined carrier amplitude. This setup results in an FM signal with a carrier and two sidebands.

```APIDOC
MOD 2 Enable: ON
Carrier Oscillator (Osc)/Frequency: Osc 1 / 1 MHz
Sideband 1 Oscillator (Osc)/Frequency: Osc 2 / 100 kHz
Carrier Mode/Enable: FM / ON
Generation Carrier Amplitude/Enable: 100 mV / ON
Generation Index: 0.1
```

--------------------------------

### API Documentation for scopes/n/enable

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

Enables the scope.

```APIDOC
Path: /dev..../scopes/n/enable
Description: Enables the scope.
Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit: Boolean
Enumerated Values:
  0: Scope off
  1: Scope on
```

--------------------------------

### Sweeper Tab Control Sub-tab Parameters

Source: https://docs.zhinst.com/hf2_user_manual/functional_description/sweeper

Documents the various controls and parameters available under the 'Control' sub-tab of the Sweeper UI. This includes options for sweep initiation (Run/Stop, Single), parameter copying (Copy From X-Axis, Copy From X-Cursors), defining sweep ranges (Start, Stop, Length), monitoring progress, selecting the sweep parameter, and configuring sweep modes and axis displays.

```APIDOC
Control/Tool: Run/Stop
  Option/Range: [Image Button]
  Description: Runs the sweeper continuously.
Control/Tool: Single
  Option/Range: [Image Button]
  Description: Runs the sweeper once.
Control/Tool: Copy From X-Axis
  Option/Range: 
  Description: Takes over start and stop value from the X-axis.
Control/Tool: Copy From X-Cursors
  Option/Range: 
  Description: Takes over start and stop value from X-cursors. Button is disabled when one or both X cursors are not visible.
Control/Tool: Start (unit)
  Option/Range: numeric value
  Description: Start value of the sweep parameter. The unit adapts according to the selected sweep parameter.
Control/Tool: Stop (unit)
  Option/Range: numeric value
  Description: Stop value of the sweep parameter. The unit adapts according to the selected sweep parameter.
Control/Tool: Length
  Option/Range: integer value
  Description: Sets the number of measurement points.
Control/Tool: Progress
  Option/Range: 0 to 100%
  Description: Reports the sweep progress as ratio of points recorded.
Control/Tool: Sweep Param
  Option/Range: [Image Button]
  Description: Selects the parameter to be swept. Navigate through the tree view that appears and click on the required parameter. The available selection depends on the configuration of the device.
Control/Tool: Sweep Mode
  Option/Range: 
  Description: Select the scanning type, default is sequential (incremental scanning from start to stop value)
    Sequential: Sequential sweep from Start to Stop value
    Binary: Non-sequential sweep continues increase of resolution over entire range
    Bidirectional: Sequential sweep from Start to Stop value and back to Start again
    Reverse: Reverse sweep from Stop to Start value
Control/Tool: X Distribution
  Option/Range: Linear / Logarithmic
  Description: Selects between linear and logarithmic distribution of the sweep parameter.
Control/Tool: Remaining
  Option/Range: numeric value
  Description: Reporting of the remaining time of the current sweep. A valid number is only displayed once the sweeper has been started. An undefined sweep time is indicated as NaN.
Control/Tool: Invert Y Axis
  Option/Range: ON / OFF
  Description: The xy-plot is displayed with inverted y-axis. This mode is used for Nyquist plots that allow for displaying -imag(z) on the y-axis and real(z) on the x-axis.
Control/Tool: X Signal
  Option/Range: [Image Button]
  Description: Selects the signal that defines the x-axis for xy-plots. The available selection depends on the configuration of the device. Displaying the selected signal source will result in a diagonal straight line.
```

--------------------------------

### API Documentation for /dev..../pids/n/setpoint

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

Target settle point.

```APIDOC
Path: /dev..../pids/n/setpoint
Properties: Read, Write, Setting
Type: Double
Unit: [INPUT Unit]
```

--------------------------------

### API Documentation for /dev..../pids/n/setpointselect

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

Set point selection.

```APIDOC
Path: /dev..../pids/n/setpointselect
Properties: Read, Write, Setting
Type: Integer (enumerated)
Unit:
Values:
  0: Manual Setpoint
  1: Auxiliary Input 1
  2: Auxiliary Input 2
  3: PID n
```

--------------------------------

### API Documentation for /dev..../mods/n/sample

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

Provides access to the modulation samples data stream from the device.

```APIDOC
/dev..../mods/n/sample
  Properties: Read, Stream
  Type: ZIDemodSample
  Unit:
```

--------------------------------

### Scripting Batch Settings for CLI

Source: https://docs.zhinst.com/hf2_user_manual/programming

Describes a method for scripting multiple settings by manually compiling them into a file. The syntax `path value` is used, allowing users to copy-paste a sequence of commands into the terminal for batch execution, recognized by ziServer.

```CLI
path value
```

--------------------------------

### Explore HF2 Instrument Device Hierarchy via CLI

Source: https://docs.zhinst.com/hf2_user_manual/programming

Demonstrates how to navigate into the specific HF2 instrument hierarchy (DEVX node) using relative or absolute paths. The `ls` command is used to list all leaves, representing configurable settings or readable measurement data fields within the device.

```CLI
cd ../devx
cd /devx/
ls
```

--------------------------------

### Configure HF2 Instrument for Signal Acquisition

Source: https://docs.zhinst.com/hf2_user_manual/tutorials/tutorial_simple_loop

This snippet outlines the settings required in the LabOne UI to acquire signals from Signal Input 1. It includes adjusting the input source, trigger, sampling rate, and input range to ensure proper signal capture and prevent clipping.

```APIDOC
LabOne UI Configuration for Signal Acquisition:
  Scope Settings:
    Signal Input: Signal Input 1
    Trigger Signal: Signal Input 1
    Sampling Rate: 210 MS, 10 us
    Run / Stop: RUN
  Signal Input 1 Settings:
    Range: 1 V
    AC / 50 / Diff: ON / OFF / OFF
```

--------------------------------

### Enable Demodulated Sample Streaming

Source: https://docs.zhinst.com/hf2_user_manual/functional_description/lock_in

Activates data acquisition and streaming of demodulated samples to the host computer for a specific demodulator, enabling visualization and analysis in LabOne measurement tools.

```APIDOC
Parameter: Enable Streaming
  Type: ON / OFF
  Description: Enables data acquisition and streaming of demodulated samples to the host computer for the corresponding demodulator.
  Effect:
    Activates corresponding element in numeric tab.
    Allows visualization and analysis in LabOne measurement tools.
  Note: Increasing active demodulators increases load on physical connection to host.
```

--------------------------------

### Configure HF2 Output 1 for Signal of Interest Generation

Source: https://docs.zhinst.com/hf2_user_manual/tutorials/tutorial_external_reference

This table details the LabOne UI settings for generating a separate signal of interest on Output 1, which will be demodulated using the external reference. It includes output range, demodulator, and oscillator settings.

```APIDOC
Output 1 range: 1 V
Demodulator 7 Amp 1: 1.0 V / ON
Oscillator 1 frequency: 1 MHz
Demodulator 1 En/Rate: ON / 100 Hz
Signal Input 1 range / AC / 50 / Diff: 1.3 V / ON / OFF / OFF
```

--------------------------------

### PLL and Display Configuration Parameters

Source: https://docs.zhinst.com/hf2_user_manual/functional_description/pll

Documentation for parameters and controls available in the PLL tab and its Display sub-tab, detailing their function, range, and impact on the system. This includes settings for demodulator bandwidth, filter order, PID gains, simulation rates, and various display options for system response plots.

```APIDOC
PLL Tab Parameters:
  Auto Bandwidth:
    Type: ON / OFF
    Description: Adjusts the demodulator bandwidth to fit best to the specified target bandwidth of the full system. If disabled, a demodulator bandwidth too close to the target bandwidth may cause overshoot and instability. In special cases the demodulator bandwidth can also be selected smaller than the target bandwidth.
  Filter BW:
    Type: numeric Value
    Description: Defines the low-pass filter characteristic of the selected demodulator input.
  Filter Order:
    Description: Selects the filter roll off between 6 dB/oct and 48 dB/oct of the modelled demodulator.
    Options:
      1: 1st order filter 6 dB/oct
      2: 2nd order filter 12 dB/oct
      3: 3rd order filter 18 dB/oct
      4: 4th order filter 24 dB/oct
      5: 5th order filter 30 dB/oct
      6: 6th order filter 36 dB/oct
      7: 7th order filter 42 dB/oct
      8: 8th order filter 48 dB/oct
  P:
    Type: numeric value
    Description: Proportional gain P coefficient used for calculation of the response of the PID model. The parameter can be optimized with PID advise or changed manually. The parameter only gets active on the PID after pressing the button To PLL.
  I/Ti:
    Type: numeric value
    Description: Integral gain coefficient I or time constant Ti=P/I used for calculation of the response of the PID model. The parameter can be optimized with PID advise or changed manually. The parameter only gets active on the PID after pressing the button To PLL.
  D/Td:
    Type: numeric value
    Description: Integral gain coefficient D or time constant Td=D/P used for calculation of the response of the PID model. The parameter can be optimized with PID advise or changed manually. The parameter only gets active on the PID after pressing the button To PLL.
  Rate (Hz):
    Type: RT load dependent
    Description: PID sampling rate used for simulation. The advisor will update the rate to match with the specified target bandwidth. A sampling rate close to the target bandwidth and excessive higher bandwidth will results in a simulation mismatch.
  BW (Hz):
    Type: numeric value
    Description: Simulated bandwidth of the full close loop PLL with the current PID settings. This value should be larger than the target bandwidth.
  Target BW LED:
    Type: green/red
    Description: Green indicates that the target bandwidth can be achieved. For very high PLL bandwidth the target bandwidth might be only achieved using marginal stable PID settings.
  PM (deg):
    Type: numeric value
    Description: Simulated phase margin of the PID with the current settings. The phase margin should be greater than 45 deg for stable conditions. An Infinite value is shown if no unity gain crossing is available to determine a phase margin.
  Stable LED:
    Type: green/red
    Description: Green indicates that the phase margin is fulfilled and the PID system should be stable.
  To PLL:
    Type: button
    Description: Copy the PLL Advisor settings to the PLL.

Display Sub-tab Parameters:
  Advanced:
    Type: ON / OFF
    Description: Enables manual selection of display and advice properties. If disabled the display and advise settings are automatically with optimized default values.
  Display:
    Description: Select the display mode used for rendering the system frequency or time response.
    Options:
      Bode Magnitude: Display the Bode magnitude plot.
      Bode Phase: Display the Bode phase plot.
      Step Resp: Display the step response plot.
  Start (Hz):
    Type: numeric value
    Description: Start frequency for Bode plot display. For disabled advanced mode the start value is automatically derived from the system properties and the input field is read-only.
  Stop (Hz):
    Type: numeric value
    Description: Stop frequency for Bode plot display. For disabled advanced mode the stop value is automatically derived from the system properties and the input field is read-only.
  Start (s):
    Type: numeric value
    Description: Start time for step response display. For disabled advanced mode the start value is zero and the field is read-only.
  Stop (s):
    Type: numeric value
    Description: Stop time for step response display. For disabled advanced mode the stop value is automatically derived from the system properties and the input field is read-only.
  Response In:
    Description: Start point for the plant response simulation for open or closed loops. In closed loop configuration all elements from output to input will be included as feedback elements.
    Options:
      Demod Input: Start point is at the demodulator input.
      Setpoint: Start point is at the setpoint in front of the PID.
      PID Output: Start point is at PID output.
      Instrument Output: Start point is at the instrument output.
      DUT Output: Start point is at the DUT output and instrument input.
  Response Out:
    Description: End point for the plant response simulation for open or closed loops. In closed loop configuration all elements from output to input will be included as feedback elements.
    Options:
      PID Output: End point is at PID output.
      Instrument Output: End point is at the instrument output.
      DUT Output: End point is at the DUT output and instrument input.
```

--------------------------------

### Configure LabOne UI Scope to Acquire Reference Signal

Source: https://docs.zhinst.com/hf2_user_manual/tutorials/tutorial_external_reference

This table outlines the LabOne UI Scope settings necessary to observe the generated reference signal from Signal Input 2, including trigger and sampling rate configurations.

```APIDOC
Scope Signal Input: Signal Input 2
Scope Trigger Signal: Signal Input 2
Scope Sampling rate: 53 MSa, 39 us
```

--------------------------------

### API Documentation for /dev..../pids/n/tipprotect/pll

Source: https://docs.zhinst.com/hf2_user_manual/nodedoc

Selects a PLL for TipProtect.

```APIDOC
Path: /dev..../pids/n/tipprotect/pll
Properties: Read, Write, Setting
Type: Integer
Unit:
```
Tokens:
Raw