| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 |
- .. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.
- .. module:: boards_connected
- .. _boards_connected:
- Module boards_connected
- =======================
- Discover and manage connected boards
- .. py:class:: BoardsConnected(object)
- Container for connected/available boards
- This will work as a generator and yield the available board_ids
- NOTE: this is subject to change. In the future this may yield board_names or tuples or something else
- .. py:method:: __init__(self)
- .. py:method:: _device_id(self, dev_file)
- Get the device id
- :param dev_file: the dev_file to use
- :return: string for the dev id
- .. py:method:: discover(self)
- Discover connected boards
- This is either a dummy implementation that defaults to /dev/fpga0 for every board
- it will create 'virtual' boards
- OR:
- If config.use_dev_fpga_for_detection == True use number of /dev/fpga devices and use them
- .. py:method:: has_boards(self)
- Check if at least one board is connected
- .. py:method:: board_ids(self)
- Get Board Ids as list
- .. py:method:: board_names(self)
- Get Board Names as list
- .. py:method:: get_board_name_from_id(self, board_id)
- Get the name of a board with the given board_id
- :param board_id: the board to get the name for
- :return: the name of the board with id board_id
- .. py:method:: get_board_id_from_name(self, board_name)
- Get the id of a board with the name board_name
- :param board_name: the name of the board to get the id for
- :return: the id of the board with name board_name
- .. py:method:: get_device_file(self, board_id)
- Get the device file (/dev/...) to use when communicating with the board
- :param board_id: the id of the board
- :return: the device file as string
- .. py:method:: multi_board(self)
- If multiple boards are connected this is true else false
- .. py:method:: __iter__(self)
- .. py:method:: next(self)
- .. py:method:: __getitem__(self, item)
|
