123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- .. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.
- .. module:: utils
- .. _utils:
- Module utils
- ============
- Helper methods
- .. py:method:: get_dec_from_bits(bits, msb=-1, lsb=-1)
- Get decimal values from a string represented binary string
- :param bits: the string to convert
- :param msb: the most significant bit to use
- :param lsb: the least significant bit to use
- :return: the decimal value
- .. py:method:: get_status(board_id)
- Get the satatus of the board (this is used for the status leds)
- :param board_id: the id of the board
- :return: dictionary with the bits for each led (lower case led names are the keys of this dict)
- .. py:method:: is_conneced(board_id)
- Is the board connected?
- :param board_id: the id for the board to check
- :return: True if the board is connected else False
- .. py:method:: is_active(board_id)
- Check if a board is active
- :param board_id: the board to check for
- :return: True if it is active else False
- .. py:method:: wait_for_revolutions(board_id)
- Sleep as long as the revolutions in the accelerator last to not stop the acquisition before it ended.
- :param board_id: the board to wait for?
- .. py:method:: create_new_board_config(identifier)
- This creates a new instance of BoardConfiguration and also a new instance of StatusStorage
- :param identifier: the identifier for this board (not the id)
- .. py:method:: get_board_config(id)
- Get the configuration instance for the board with the given id
- :param id: the id of the desired board
- :return: the instance of configuration
- .. py:method:: get_board_status(id)
- Get the status storage instance for the board with the given id
- :param id: the id of the desired board
- :return: the instance of the status storage
|