Node Documentation¶
This section describes all the nodes in the PID Advisor Module node tree organized by branch.
advancedmode¶
/advancedmode ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
If enabled, automatically calculate the start and stop value used in the Bode and step response plots.
auto¶
/auto ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
If enabled, automatically trigger a new optimization process upon an input parameter value change.
bode¶
/bode ¶
| Properties: | Read |
| Type: | ZIAdvisorWave |
| Unit: | None |
Contains the resulting bode plot of the PID simulation.
bw¶
calculate¶
/calculate ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Set to 1 to start the PID Advisor's modelling process and calculation of optimal parameters. The module sets calculate to 0 when the calculation is finished.
demod¶
/demod/harmonic ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Only relevant when /DEV.../PIDS/n/INPUT is configured to be a demodulator output. Specifies the demodulator's harmonic to use in the PID Advisor model. This value will be transferred to the instrument node (/DEV..../DEMODS/m/HARMONIC) when the PID is enabled.
/demod/order ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Only relevant when /DEV.../PIDS/n/INPUT is configured to be a demodulator output. Specifies the demodulator's order to use in the PID Advisor model. This value will be transferred to the instrument node (/DEV..../DEMODS/m/ORDER) when the PID is enabled.
/demod/timeconstant ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Seconds |
Only relevant when /DEV.../PIDS/n/INPUT is configured to be a demodulator output and pidAdvisor/pid/autobw=0. Specify the demodulator's timeconstant to use in the PID Advisor model. This value will be transferred to the instrument node (/DEV..../DEMODS/m/TIMECONSTANT) when the PID is enabled.
device¶
/device ¶
| Properties: | Read, Write |
| Type: | String |
| Unit: | None |
Device string specifying the device for which the PID advisor is performed.
display¶
/display/freqstart ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Hz |
Start frequency for Bode plot. If advancedmode=0 the start value is automatically derived from the system properties.
/display/timestart ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Seconds |
Start time for step response. If advancedmode=0 the start value is 0.
dut¶
/dut/damping ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | None |
Damping of the second order low pass filter.
/dut/delay ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Seconds |
IO Delay of the feedback system describing the earliest response for a step change.
/dut/fcenter ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Hz |
Resonant frequency of the of the modelled resonator.
/dut/gain ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Depends on Input, Output, and DUT model |
Gain of the DUT transfer function.
/dut/source ¶
| Properties: | Read, Write |
| Type: | Integer (enumerated) |
| Unit: | None |
Specifies the model used for the external DUT (device under test) to be controlled by the PID.
| Value | Description |
|---|---|
| 1 | "low_pass_1st_order": Low-pass first order. |
| 2 | "low_pass_2nd_order": Low-pass second order. |
| 3 | "resonator_frequency": Resonator frequency. |
| 4 | "internal_pll": Internal PLL. |
| 5 | "vco": Voltage-controlled oscillator (VCO). |
| 6 | "resonator_amplitude": Resonator amplitude. |
impulse¶
/impulse ¶
| Properties: | Read |
| Type: | ZIAdvisorWave |
| Unit: | None |
Reserved for future use - not yet supported.
index¶
/index ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
The 0-based index of the PID on the instrument to use for parameter detection.
pid¶
/pid/autobw ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
If enabled, adjust the demodulator bandwidth to fit best to the specified target bandwidth of the full system. In this case, demod/timeconstant is ignored.
/pid/autolimit ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
If enabled, set the instrument PID limits based upon the calculated bw value.
/pid/d ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | (Output Unit . s) / Input Unit |
The initial value to use in the Advisor for the differential gain. After optimization has finished it contains the optimal value calculated by the Advisor.
/pid/dlimittimeconstant ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Seconds |
The initial value to use in the Advisor for the differential filter timeconstant gain. After optimization has finished it contains the optimal value calculated by the Advisor.
/pid/i ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Output Unit / (Input Unit . s) |
The initial value to use in the Advisor for the integral gain. After optimization has finished it contains the optimal value calculated by the Advisor.
/pid/mode ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Select PID Advisor mode. Bit encoded: bit 0 -- optimize P gain; bit 1 -- optimize I gain; bit 2 -- optimize D gain; bit 3 -- optimize D filter limit
/pid/p ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Output Unit / Input Unit |
The initial value to use in the Advisor for the proportional gain. After optimization has finished it contains the optimal value calculated by the Advisor.
/pid/rate ¶
| Properties: | Read, Write |
| Type: | Double |
| Unit: | Hz |
PID Advisor sampling rate of the PID control loop.
/pid/type ¶
| Properties: | Read, Write |
| Type: | String |
| Unit: | None |
HF2 instruments only. Specify whether to model the instrument's PLL or PID hardware unit when dut/source=4 (internal PLL).
pm¶
/pm ¶
| Properties: | Read |
| Type: | Double |
| Unit: | deg |
Simulated phase margin of the PID with the current settings. The phase margin should be greater than 45 deg and preferably greater than 65 deg for stable conditions.
pmfreq¶
progress¶
/progress ¶
| Properties: | Read |
| Type: | Double |
| Unit: | None |
Reports the progress of a PID Advisor action as a value between 0 and 1.
response¶
/response ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Set to 1 to calculate the Bode and the step response plot data from the current pid/* parameters (only relevant when auto=0). The module sets response back to 0 when the plot data has been calculated.
stable¶
/stable ¶
| Properties: | Read |
| Type: | Integer (64 bit) |
| Unit: | None |
If equal to 1, the PID Advisor found a stable solution with the given settings. If equal to 0, the solution was deemed instable - revise your settings and rerun the PID Advisor.
step¶
/step ¶
| Properties: | Read |
| Type: | ZIAdvisorWave |
| Unit: | None |
The resulting step response data of the PID Advisor's simulation.
targetfail¶
/targetfail ¶
| Properties: | Read |
| Type: | Integer (64 bit) |
| Unit: | None |
A value of 1 indicates the simulated PID BW is smaller than the Target BW.
tf¶
/tf/closedloop ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Switch the response calculation mode between closed or open loop.
/tf/input ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Start point for the plant response simulation for open or closed loops.
/tf/output ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
End point for the plant response simulation for open or closed loops.
todevice¶
/todevice ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Set to 1 to transfer the calculated PID advisor data to the device, the module will immediately reset the parameter to 0 and configure the instrument's nodes.
tune¶
/tune ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
If enabled, optimize the instrument's PID parameters so that the noise of the closed- loop system gets minimized. The HF2 doesn't support tuning.
tuner¶
/tuner/mode ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Select tuner mode. Bit encoded: bit 0 -- tune P gain; bit 1 -- tune I gain; bit 2 -- tune D gain; bit 3 -- tune D filter limit