Skip to main content
Ctrl+K

zhinst-qcodes

  • First Steps
  • Examples
  • Refactoring
  • Package Documentation
  • Changelog
    • License
    • About
  • First Steps
  • Examples
  • Refactoring
  • Package Documentation
  • Changelog
  • License
  • About

Section Navigation

  • ZISession
  • HDAWG
  • MFLI
  • MFIA
  • PQSC
  • SHFQA
  • SHFQC
  • SHFSG
  • UHFLI
  • UHFQA
  • HF2
  • ZIDevice
  • SHFLI
  • GHFLI
  • qcodes
    • device_creator
      • GHFLI
      • HDAWG
      • HF2
      • MFIA
      • MFLI
      • PQSC
      • SHFLI
      • SHFQA
      • SHFQC
      • SHFSG
      • UHFLI
      • UHFQA
      • ZIDevice
    • driver
      • devices
        • base
        • hdawg
        • pqsc
        • shfqa
        • shfqc
        • shfsg
        • uhfli
        • uhfqa
      • modules
        • base_module
        • daq_module
        • device_settings_module
        • impedance_module
        • pid_advisor_module
        • precompensation_advisor_module
        • scope_module
        • shfqa_sweeper
        • sweeper_module
    • qcodes_adaptions
      • init_nodetree
      • tk_node_to_parameter
      • tk_node_to_qcodes_list
      • NodeDict
        • to_dict
      • ZIChannelList
        • print_readable_snapshot
        • snapshot
      • ZIInstrument
        • print_readable_snapshot
        • snapshot
      • ZINode
        • print_readable_snapshot
        • snapshot
      • ZIParameter
        • get_as_event
        • snapshot_base
        • subscribe
        • unsubscribe
        • wait_for_state_change
        • node_info
        • tk_node
        • zi_node
      • ZISnapshotHelper
        • get
        • print_readable_snapshot
        • snapshot
        • is_running
    • session
      • Devices
        • connected
        • update_device_properties
        • visible
      • ModuleHandler
        • create_awg_module
        • create_daq_module
        • create_device_settings_module
        • create_impedance_module
        • create_mds_module
        • create_pid_advisor_module
        • create_precompensation_advisor_module
        • create_qa_module
        • create_scope_module
        • create_shfqa_sweeper
        • create_sweeper_module
        • awg
        • daq
        • device_settings
        • impedance
        • mds
        • pid_advisor
        • precompensation_advisor
        • qa
        • scope
        • shfqa_sweeper
        • sweeper
      • Session
        • connect_device
        • disconnect_device
        • poll
        • sync
        • daq_server
        • is_hf2_server
        • server_host
        • server_port
        • toolkit_session
      • ZISession
  • Package Documentation
  • qcodes
  • qcodes_adaptions
  • ZIChannelList
  • print_readable_snapshot

print_readable_snapshot#

ZIChannelList.print_readable_snapshot(update: bool = True, max_chars: int = 80) → None[source]#

Prints a readable version of the snapshot.

The readable snapshot includes the name, value and unit of each parameter. A convenience function to quickly get an overview of the status of an instrument.

Parameters:
  • update (bool) – If True, update the state by querying the instrument. If False, just use the latest values in memory. This argument gets passed to the snapshot function.

  • max_chars (int) – the maximum number of characters per line. The readable snapshot will be cropped if this value is exceeded. Defaults to 80 to be consistent with default terminal width.

Return type:

None

previous

ZIChannelList

next

snapshot

On this page
  • ZIChannelList.print_readable_snapshot()

This Page

  • Show Source

© Copyright 2020, Zurich Instruments AG.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.16.1.