Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
Signed-off-by: Andrei-Fabian-Pop <[email protected]>
  • Loading branch information
Andrei-Fabian-Pop committed Sep 12, 2024
1 parent 62c3253 commit 0836139
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 1 deletion.
36 changes: 36 additions & 0 deletions docs/plugins/debugger/debugger.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _debugger:

Debugger
================================================================================

This instrument represents the fist version of the debugger tool, also available in the
first version of Scopy. It is composed of 2 parts, the `DEVICE SELECTION` and the
`REGISTER MAP SETTINGS`.

TODO: insert picture

TODO: figure out paragraph stuff

Device Selection

This part contains information such as the:

Context information
TODO: insert picture


#. Selected Device
#. Selected Channel (or `Global` for device specific attributes)
#. Selected Channel Attribute (or Device Attribute if the channel selection is set to `Global`)
#. The value of the selected attribute (this can contain constraints such as a specific list of choices)
#. The Filename of the selected attribute

..
Context controls
TODO: insert picture

#. Attribute `read` button
#. Attribute `write` button


6 changes: 6 additions & 0 deletions docs/plugins/debugger/iioexplorer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _iioexplorer:

IIO Explorer
================================================================================

kndkjsad
30 changes: 30 additions & 0 deletions docs/plugins/debugger/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _debugger_index:


Debugger
---------------------------------------------------------------------
The debugger plugin is used to examine IIO contexts and modify individual IIO attributes,
as well as examining the structure of an IIO context. The more important attributes are
also available in the other plugins, but this tool provides a full overview of the whole
context, giving the user the ability to read/modify every individual attribute. This
makes it easier to configure any board in specific ways.

Overview
---------------------------------------------------------------------
This plugin is generic and can work with any valid context. It is composed of one
instrument that has 2 versions. The default version (version 2) is the IIO Explorer.
Users also have the ability to load version one of the debugger plugin by accessing the
`Preferences` panel on the left side and unchecking the `Use debugger V2 plugin` box.

TODO: Insert picture maybe ?

Contents
---------------------------------------------------------------------

The plugin contains 1 instrument that can be the Debugger (v1) or the IIO Explorer (v2):

.. toctree::
:maxdepth: 3

debugger
iioexplorer
3 changes: 2 additions & 1 deletion docs/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ General IIO plugins

* :ref:`Datalogger <datalogger>`

* Debugger
* :ref:`Debugger <debugger>`

* :ref:`Register Map <registermap>`

Expand Down Expand Up @@ -61,6 +61,7 @@ Contents
:maxdepth: 3

datalogger/datalogger
debugger/index
registermap/registermap
m2k/index
pqm/index
Expand Down

0 comments on commit 0836139

Please sign in to comment.