KaptureControlGui/KCG/Documentation/source/Dev/backendinterface.rst

.. _backendinterface:

BackendInterface Module
=======================

.. module:: backendinterface

This module contains several methods to interface with the board. It also contains several mostly internal
used methods prefixed `_bif_`. Those methods will not be covered here and are not intended for public use.
Methods intended for public use are prefixed `bk_`.

.. py:method:: bk_start_board()

    Method that handles starting of the board.

.. py:method:: bk_calibrate()

    Method that handles calibration of the board.

.. py:method:: bk_sync_board()

    Method that handles synchronisation of the board.

.. py:method:: bk_write_values(defaults=False)

    Method that handles writing values to the board.
    :param bool defaults: If True default values will be written (and updated in board.config)

.. py:method:: bk_stop_board()

    Method that handles stopping of the board.

.. py:method:: bk_soft_reset()

    Method that handles soft resetting the board.

.. py:method:: bk_update_config(key, value)

    Method that updates the board config.

    :param str key: Config key
    :param any value: New value

.. py:method:: bk_get_config(key)

    Method to get the current config for key

    :param str key: Config key

.. py:method:: bk_change_num_of_orbits(value, [silent=False])

    Method to change the number of orbits to observe on the board

    :param int value: Number of orbits to observe
    :param bool silent: Do not notify observers when updating the config

.. py:method:: bk_change_num_of_skipped_orbits(value[, silent=False])

    Method to change the number of orbits to skip on the board

    :param int value: Number of orbits to skip
    :param bool silent: Do not notify observers when updating the config

.. py:method:: bk_change_count(value[, silent=False])

    Method to change the number of acquisitions

    :param int value: Number of acquisitions
    :param bool silent: Do not notify observers when updating the config

.. py:method:: bk_change_wait(value[, silent=False])

    Method to change the wait time between acquisitions

    :param int value: Wait time in seconds
    :param bool silent: Do not notify observers when updating the config

.. py:method:: bk_change_build_spectrograms(value[, silent=False])

    Method to set whether to build spectrograms or not

    :param bool value: Build or not
    :param bool silent: Do not notify observers when updating the config

.. py:method:: bk_change_pilot_bunch(value[, silent=False])

    Method to set whether to simulate pilot bunch or not

    :param bool value: Simulate or not
    :param bool silent: Do not notify observers when updating the config

.. py:method:: bk_acquire()

    Toggle acquisition

.. py:method:: bk_single_read()

    Perform a single read

.. py:method:: bk_continuous_read([interval=100])

    Toggle continuous read

    :param int interval: Interval in msec to wait between reads

.. py:method:: bk_board_connected()

    Check if board is connected and recognized

    :return: True if board is connected and recognized, False if not
    :rtype: bool

.. py:method:: bk_get_temperature()

    Get the current temperature of the board

    :return: Current board temperature in degree celsius
    :rtype: int