ZIPIDAdvisorModule#

class ZIPIDAdvisorModule(*args: Any, **kwargs: Any)[source]#

Bases: ZIBaseModule

PID Advisor Module.

The PID Advisor Module provides the functionality available in the Advisor, Tuner and Display sub-tabs of the LabOne User Interface’s PID / PLL tab. The PID Advisor is a mathematical model of the instrument’s PID and can be used to calculate PID controller parameters for optimal feedback loop performance. The controller gains calculated by the module can be easily transferred to the device via the API and the results of the Advisor’s modeling are available as Bode and step response plot data.

For a complete documentation see the LabOne user manual https://docs.zhinst.com/labone_programming_manual/pid_advisor_module.html

Parameters:

  • tk_object – Underlying zhinst-toolkit object.

  • session – Session to the Data Server.

  • name – Name of the module in QCoDeS.

  • args (Any)

  • kwargs (Any)

Return type:

Any

Methods

wait_done(*[, timeout, sleep_time])

Waits until the pid advisor is finished.

Attributes