ZIBaseModule#

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

Bases: ZIInstrument

Generic toolkit driver for a LabOne Modules.

All module specific class are derived from this class. It exposes the nodetree and also implements common functions valid for all modules. It also can be used directly, e.g. for modules that have no special class in toolkit.

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

execute()

Start the module execution.

progress()

Progress of the execution.

read()

Read scope data.

subscribe(signal)

Subscribe to a node.

unsubscribe(signal)

Unsubscribe from a node.

wait_done(*[, timeout, sleep_time])

Waits until the module is finished.

Attributes

raw_module

Underlying zhinst.core module.