Tools API
=========

.. _api_cfg_man:

Configuration management
------------------------

The following class allows you to manage Cluster instruments from within Python.

.. note::
    There is also a command-line tool for this, that comes with the Qblox
    instruments, named ``qblox-cfg``. Run ``qblox-cfg help`` for its
    documentation.

.. autoclass:: qblox_instruments.ConfigurationManager

.. _api_tools_cls_and_func:

Supporting classes and functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: qblox_instruments.cfg_man.probe

.. automodule:: qblox_instruments.cfg_man.update_file

.. _api_pnp:

Plug & Play
-----------

The following class allows you to send Qblox Plug & Play commands from within
Python.

.. note::
    There is also a command-line tool for this, that comes with the Qblox
    instruments, named ``qblox-pnp``. Run ``qblox-pnp help`` for its
    documentation.

.. autoclass:: qblox_instruments.PlugAndPlay

.. _api_pnp_cls_and_func:

Supporting classes and functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: qblox_instruments.resolve

.. autoclass:: qblox_instruments.AddressInfo


Build information
-----------------

The following functions and classes allow you to programmatically retrieve version and build information for various components.

Information about Qblox Instruments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: qblox_instruments.get_build_info

.. autoclass:: qblox_instruments.BuildInfo

Information about an instrument
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: qblox_instruments.get_device_info

.. autoclass:: qblox_instruments.DeviceInfo