.. _api_spi_rack:

SPI Rack API
============

The SPI rack driver is separated into two layers:

- :ref:`api_reference/spi_rack:QCoDeS driver`: Instrument driver based on `QCoDeS <https://microsoft.github.io/Qcodes/>`_ and the instrument's native interface.

- :ref:`api_reference/spi_rack:Native interface`: Instrument API that provides control over the instrument and is an extension of the `spirack package <https://github.com/mtiggelman/SPI-rack/>`_.


QCoDeS driver
-------------

.. autoclass:: qblox_instruments.SpiRack
.. autoclass:: qblox_instruments.qcodes_drivers.spi_rack_modules.SpiModuleBase


QCoDeS instrument parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

.. include:: ../_build/spi_rack_param.rst
.. include:: ../_build/methods_spi_rack_param.rst


Native interface
----------------

.. autoclass:: qblox_instruments.native.SpiRack
.. autoclass:: qblox_instruments.native.spi_rack_modules.SpiModuleBase


S4g QCoDeS driver
-----------------

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

.. autoclass:: qblox_instruments.qcodes_drivers.spi_rack_modules.S4gModule


S4g QCoDeS parameters
^^^^^^^^^^^^^^^^^^^^^

.. include:: ../_build/s4g_param.rst
.. include:: ../_build/methods_s4g_param.rst


S4g native interface
--------------------

.. autoclass:: qblox_instruments.native.spi_rack_modules.S4gModule


D5a QCoDeS driver
-----------------

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

.. autoclass:: qblox_instruments.qcodes_drivers.spi_rack_modules.D5aModule


D5a QCoDeS parameters
^^^^^^^^^^^^^^^^^^^^^

.. include:: ../_build/d5a_param.rst
.. include:: ../_build/methods_d5a_param.rst


D5a native interface
--------------------

.. autoclass:: qblox_instruments.native.spi_rack_modules.D5aModule