LabOne API documentation

  • Python API
  • C API
  • .NET API
  • MATLAB API
  • core
    • compile_seqc
    • AwgModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • DataAcquisitionModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • DeviceSettingsModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • ImpedanceModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • ModuleBase
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • MultiDeviceSyncModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • PidAdvisorModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • PrecompensationAdvisorModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • QuantumAnalyzerModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • RecorderModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • ScopeModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • SweeperModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • ZoomFFTModule
      • __init__
      • clear
      • execute
      • finish
      • finished
      • get
      • getDouble
      • getInt
      • getString
      • getStringUnicode
      • help
      • listNodes
      • listNodesJSON
      • progress
      • read
      • save
      • set
      • subscribe
      • trigger
      • unsubscribe
    • ziDAQServer
      • __init__
      • asyncGetAsEvent
      • asyncSetDouble
      • asyncSetInt
      • asyncSetString
      • awgModule
      • connect
      • connectDevice
      • dataAcquisitionModule
      • deviceSettings
      • disconnect
      • disconnectDevice
      • echoDevice
      • flush
      • get
      • getAsEvent
      • getAuxInSample
      • getByte
      • getComplex
      • getConnectionAPILevel
      • getDIO
      • getDebugLogpath
      • getDouble
      • getInt
      • getList
      • getSample
      • getString
      • getStringUnicode
      • help
      • impedanceModule
      • listNodes
      • listNodesJSON
      • logOff
      • logOn
      • multiDeviceSyncModule
      • pidAdvisor
      • poll
      • pollEvent
      • precompensationAdvisor
      • programRT
      • quantumAnalyzerModule
      • record
      • revision
      • scopeModule
      • set
      • setByte
      • setComplex
      • setDebugLevel
      • setDebugLevelConsole
      • setDebugLevelFile
      • setDebugLogpath
      • setDeprecated
      • setDouble
      • setInt
      • setString
      • setVector
      • subscribe
      • sweep
      • sync
      • syncSetDouble
      • syncSetInt
      • syncSetString
      • unsubscribe
      • update
      • version
      • writeDebugLog
      • zoomFFT
      • api_level
      • host
      • port
    • ziDiscovery
      • __init__
      • find
      • findAll
      • get
      • setDebugLevel
    • ziListEnum
      • __init__
      • absolute
      • all
      • basechannel
      • excludestreaming
      • excludevectors
      • getonly
      • leafsonly
      • leavesonly
      • name
      • none
      • recursive
      • settingsonly
      • streamingonly
      • subscribedonly
      • value
    • zhinst.core.errors
  • ziPython
    • zhinst.core.errors
  • Examples

Python API#

zhinst.core

Zurich Instruments LabOne Python API Driver.

zhinst.ziPython

ziPython compatibility layer.

Note

To see the Python API in action, take a look at some of the examples published on GitHub.

previous

Welcome to Zurich Instruments LabOne API documentation!

next

core

© Copyright 2023, Zurich Instruments AG.

Created using Sphinx 5.0.2.