QCM-QRM API
===========

The QCM/QRM module is responsible for adding the parameters to a single module of a Cluster using
:func:`~qblox_instruments.qcodes_drivers.module.add_qcodes_params` and :class:`~qblox_instruments.qcodes_drivers.module.Module`
respectively. The resulting parameters are module type dependent and are described at the bottom of this page. Each module also
adds the parameters for 6 sequencers, the parameters of which are described in :doc:`/api_reference/sequencer`.

.. autoclass:: qblox_instruments.qcodes_drivers.module.Module

.. autofunction:: qblox_instruments.qcodes_drivers.module.add_qcodes_params

.. autofunction:: qblox_instruments.qcodes_drivers.module.invalidate_qcodes_parameter_cache

.. autofunction:: qblox_instruments.qcodes_drivers.module.get_item


.. Note::
  On this page, :code:`QRM, QCM, QRM_RF, QCM_RF` refer to instances of :py:class:`~qblox_instruments.qcodes_drivers.module.Module` of the respective module type.


Cluster QCoDeS parameters
-------------------------

`QCoDeS <https://microsoft.github.io/Qcodes/>`_ parameters generated by :class:`~qblox_instruments.qcodes_drivers.module.Module`.

Cluster QCM parameters
^^^^^^^^^^^^^^^^^^^^^^

.. include:: ../_build/cluster_qcm_param.rst
.. include:: ../_build/methods_cluster_qcm_param.rst

Cluster QCM-RF parameters
^^^^^^^^^^^^^^^^^^^^^^^^^

.. include:: ../_build/cluster_qcm_rf_param.rst
.. include:: ../_build/methods_cluster_qcm_rf_param.rst

Cluster QRM parameters
^^^^^^^^^^^^^^^^^^^^^^

.. include:: ../_build/cluster_qrm_param.rst
.. include:: ../_build/methods_cluster_qrm_param.rst

Cluster QRM-RF parameters
^^^^^^^^^^^^^^^^^^^^^^^^^

.. include:: ../_build/cluster_qrm_rf_param.rst
.. include:: ../_build/methods_cluster_qrm_rf_param.rst