diff --git a/docs/plugins/debugger/debugger.rst b/docs/plugins/debugger/debugger.rst new file mode 100644 index 000000000..fac623b01 --- /dev/null +++ b/docs/plugins/debugger/debugger.rst @@ -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 + + diff --git a/docs/plugins/debugger/iioexplorer.rst b/docs/plugins/debugger/iioexplorer.rst new file mode 100644 index 000000000..a646537aa --- /dev/null +++ b/docs/plugins/debugger/iioexplorer.rst @@ -0,0 +1,6 @@ +.. _iioexplorer: + +IIO Explorer +================================================================================ + +kndkjsad diff --git a/docs/plugins/debugger/index.rst b/docs/plugins/debugger/index.rst new file mode 100644 index 000000000..7f7b49ef3 --- /dev/null +++ b/docs/plugins/debugger/index.rst @@ -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 diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 255c827ef..970753d57 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -13,7 +13,7 @@ General IIO plugins * :ref:`Datalogger ` -* Debugger +* :ref:`Debugger ` * :ref:`Register Map ` @@ -61,6 +61,7 @@ Contents :maxdepth: 3 datalogger/datalogger + debugger/index registermap/registermap m2k/index pqm/index