overview.rst 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. Overview
  2. ========
  3. Starting the Gui
  4. ----------------
  5. When the Gui is started, it reads the config file (see :ref:`config`).
  6. If configured to ask for a sessionname or similar
  7. the Gui will ask on Startup using a small popup window that appears before the main Window will show.
  8. |gui_name| consists of mainly two page style views. You can change them by clicking on the large arrowhead shaped
  9. icons on the left and right of the gui or by clicking on the same icons in the top right hand corner.
  10. Control View
  11. ------------
  12. |gui_name| will start in control view.
  13. Located in this View are several Buttons to control KAPTURE Boards.
  14. #. :ref:`skip_init` - Skip the intialisation process.
  15. #. Prepare Board - This Starts, Calibrates and Synchronizes the Board and sets Default values used for operation.
  16. #. Soft Reset - Perform a Soft Reset
  17. #. Board Off - Shut the Board off
  18. #. Down Arrow - This will expand an advanced Control interface. The following buttons will be visible
  19. #. Start Board - Send the Board the Signal to Start
  20. #. Calibrate - Send the Board the Signal to Calibrate itself
  21. #. Synchronize - Send the Board the Signal to Synchronize components
  22. #. Set Defaults - Send the Board the Default Values
  23. #. Check Status - Check the Status of the Board
  24. .. _skip_init:
  25. Skip Initialisation
  26. '''''''''''''''''''
  27. If you need to restart the Gui but do not want to do a full preparation (which will reset values you set before) you
  28. can use Skip Initialisation. This reads all necessary values from the Board and puts the Gui in a state where you can
  29. use it as if you hadn't closed it.
  30. .. caution:: Skip Initialisation is dangerous. If you did not prepare the board before using Skip Initialisation
  31. It won't work properly if at all.
  32. Multi View
  33. ----------
  34. Multi View is the second view of |gui_name|. This ist the main view during operation. From here
  35. you can control the boards various settings via sub-windows and you can start or stop acquisitions.
  36. Each sub-window controls different aspects of the board. To open them you can either click on one of the toolbar
  37. buttons at the top, use the main windows menu or use keyboard shortcuts (which are shown as tooltips on the
  38. toolbar buttons).
  39. You see on the left a pane with an (at the beginning) empty white box. This box is or will be the
  40. list of open plot windows. When ever you open a plot window (be it for live or for data plots) it will appear
  41. here and you can left click on each entry to bring this plot window to focus.
  42. Below that white box is a information section about the different connected boards. Clicking on the text there will
  43. open the acquire settings window.
  44. At the bottom of the pane on the left side are Buttons and tickboxes (if more than one board is connected) to start
  45. acquisitions or to create a manual measurement-log entry.
  46. Advanced Table View
  47. -------------------
  48. This View lets you view the current content of different registers on the board.
  49. To enable this View simply enable the "Enable Advanced Table View" option in the settings (see :ref:`settings`).
  50. Here you can also set certain bits in the editable register at the bottom of this view.
  51. .. note::
  52. To actually write the values in the editable registertable to the board you have to press `Write Values to Board`.
  53. .. caution::
  54. `Clear Input` will only clear the ticks in the gui. It will not change values on the board.