Skip to content

Commit

Permalink
doc: refactor files to match guidelines
Browse files Browse the repository at this point in the history 
Signed-off-by: IonutMuthi <[email protected]>
  • Loading branch information
@IonutMuthi
IonutMuthi committed Aug 21, 2024
1 parent 5b375cb commit 4bbc6b6
Show file tree
Hide file tree
Showing 18 changed files with 1,308 additions and 578 deletions.
138 changes: 89 additions & 49 deletions doc/plugins/datalogger/datalogger.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,61 +3,82 @@
Datalogger
================================================================================


General Description
---------------------------------------------------------------------



The data logger tool is used to :

1. Display data as one of the following options :
* Signal
* Text
* Seven Segment Display
2. Save data to file
3. Import data from file
1. Display data as one of the following options :

* Signal

* Text

* Seven Segment Display

2. Save data to file

3. Import data from file



.. image:: ../../resources/datalogger/datalogger.png
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger.png
:align: center


* Pressing the “+” (1) button will generate a new tool
* Print button (2) will allow user to save current visible plot to a .pdf format allowing user to print it
* Data on each channel attributes is shown in the right menu (3) when clicking on a channel.

.. image:: ../../resources/datalogger/datalogger5.PNG
* Print button (2) will allow user to save current visible plot to a .pdf

format allowing user to print it

* Data on each channel attributes is shown in the right menu (3) when clicking

on a channel.

.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger5.PNG
:align: center

Display Signals
---------------------------------------------------------------------

Using the left side menu (1) user can select from the available device channels that will be displayed on the plot. The data is plotted in time based on the starting time (2), the starting time reflects when the tool started collecting data and will reset on user pressing “Clear” (3). The data that will be displayed is collected from the device on pressing “Run/Stop” (4) button. The data collected will be removed on pressing “Clear” this will also reset the starting time. To use this option click “Plot” (5) button on the bottom right
Using the left side menu (1) user can select from the available device channels
that will be displayed on the plot. The data is plotted in time based on the
starting time (2), the starting time reflects when the tool started collecting
data and will reset on user pressing “Clear” (3). The data that will be
displayed is collected from the device on pressing “Run/Stop” (4) button.
The data collected will be removed on pressing “Clear” this will also reset
the starting time. To use this option click “Plot” (5) button on the bottom
right

.. image:: ../../resources/datalogger/datalogger1.png
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger1.png
:align: center

Display Text
---------------------------------------------------------------------

Using the left side menu user can select from the available devices, for the selected device channels last read value and the unit of measurement will be displayed in text format
Using the left side menu user can select from the available devices, for the
selected device channels last read value and the unit of measurement will be
displayed in text format

To use this option click “Text” button on the bottom right

.. image:: ../../resources/datalogger/datalogger2.png
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger2.png
:align: center


Display Seven Segment
---------------------------------------------------------------------

Using the left side menu user can select from the available devices, for the selected device channels last read value, minimum and maximum recorded values and the unit of measurement will be displayed in seven segment display format
Using the left side menu user can select from the available devices, for the
selected device channels last read value, minimum and maximum recorded values
and the unit of measurement will be displayed in seven segment display format

To use this option click “7 Segment” button on the bottom right

.. image:: ../../resources/datalogger/datalogger3.png
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger3.png
:align: center

---------------------------------------------------------------------
Expand All @@ -66,72 +87,91 @@ Settings
--------------------------------------------------------------------


The gear button in the top right corner of the plugin will open the settings allowing user to alter configurations as follow
The gear button in the top right corner of the plugin will open the settings
allowing user to alter configurations as follow

1. Changing the title in settings from “DataMonitor” will reflect in the tool name
1. Changing the title in settings from “DataMonitor” will reflect
in the tool name

.. image:: ../../resources/datalogger/datalogger_settings_1.PNG
:scale: 80 %
:alt: alternate text
:align: right
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger_settings_1.PNG
:alt: alternate text
:align: right


.. image:: ../../resources/datalogger/datalogger_settings_2.PNG
:scale: 80 %
:alt: alternate text
:align: right
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger_settings_2.PNG
:alt: alternate text
:align: right

|
2. X-AXIS : settings for x axis
1. X-AXIS : settings for x axis

2.1. Toggle between displaying real time or delta values (Use
UTC date and time) . Real time values are based on the system time, delta
values consider starting point as 0 and represents the amount of time passed
since then.

2.1. Toggle between displaying real time or delta values (Use UTC date and time) . Real time values are based on the system time, delta values consider starting point as 0 and represents the amount of time passed since then.
2.2. Toggle “LIVE PLOTTING”

* when enabled will update the plot to the current time

2.2. Toggle “LIVE PLOTTING”
* when enabled will update the plot to the current time for each read
* when disabled will allow user to pick a date and a time to go to on the plot
for each read

* when disabled will allow user to pick a date and a
time to go to on the plot

2.3. Delta represents the interval displayed on the plot
2.3. Delta represents the interval displayed on the plot

|
.. image:: ../../resources/datalogger/datalogger_settings_4.PNG
:scale: 80 %
:alt: alternate text
:align: right
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger_settings_4.PNG
:alt: alternate text
:align: right

|
3. Y-AXIS: settings for y axis
1. Y-AXIS: settings for y axis

3.1. Autoscale option changes the minimum and maximum of Y-Axis to fit all values recorded
3.1. Autoscale option changes the minimum and maximum of Y-Axis
to fit all values recorded

3.2. Min and Max values will update the minimum respectively the maximum values of Y-Axis, this only works if **Autoscale** is off
3.2. Min and Max values will update the minimum respectively
the maximum values of Y-Axis, this only works if **Autoscale** is off

4. Curve settings affect all curves on the plot user can set the curves thickness and style
2. Curve settings affect all curves on the plot user can set the curves
thickness and style

5. Plot settins are used to show/hide plot items
3. Plot settins are used to show/hide plot items

6. Settings for seven segment section allow user to set precision of display values and toggle on/off the minimum and maximum values
4. Settings for seven segment section allow user to set precision of
display values and toggle on/off the minimum and maximum values

7. Data logging section is used for saving and importing data from and to a specified CSV file like the one bellow
5. Data logging section is used for saving and importing data from and
to a specified CSV file like the one bellow

|
.. image:: ../../resources/datalogger/datalogger_settings_5.PNG
:align: center
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/datalogger/datalogger_settings_5.PNG
:align: center


Save data
--------------------------------------------------------------------

To save data to file there are two options

1. Toggle “Live data logging” on this will save to file data on each read for all enabled channels
1. Toggle “Live data logging” on this will save to file data on
each read for all enabled channels

2. Pressing “Save data” will override the selected CSV file with all the recorded values of the enabled channels
2. Pressing “Save data” will override the selected CSV file with
all the recorded values of the enabled channels

Import data
--------------------------------------------------------------------

On importing data a special menu is added containing the channels from file. Each channel contains the data from the CSV file from it's column, no extra data will be added to those channels when tool is recording. By pressing the “x” button all imported data is removed. Importing data multiple times from same CSV file will override current imported data Importing data from different CSV files will create new menus like the one bellow for each file
On importing data a special menu is added containing the channels from file.
Each channel contains the data from the CSV file from it's column, no extra
data will be added to those channels when tool is recording. By pressing the
“x” button all imported data is removed. Importing data multiple times from
same CSV file will override current imported data Importing data from different
CSV files will create new menus like the one bellow for each file
48 changes: 30 additions & 18 deletions doc/plugins/m2k/digitalio.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Digital IO

General description
-------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------

.. image:: ../../resources/m2k/digitalio/scopy_2018-05-15_16-46-33.png
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/m2k/digitalio/scopy_2018-05-15_16-46-33.png
:alt: alternate text
:align: right

Expand All @@ -27,11 +27,11 @@ General description


Use Cases
-------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------

**IO operation**

.. image:: ../../resources/m2k/digitalio/scopy_2018-05-15_16-51-11.png
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/m2k/digitalio/scopy_2018-05-15_16-51-11.png
:alt: alternate text
:align: right

Expand All @@ -43,12 +43,16 @@ Use Cases

4. Monitor channel 0 using voltmeter/scope/logic analyzer

5. Set channel 0 as output by clicking the direction button Channel 7 input state is the same as channel 0 output state Voltmeter shows the same state (5V/0V) as channel 0 output state
5. Set channel 0 as output by clicking the direction button Channel 7 input
state is the same as channel 0 output state Voltmeter shows the same state
(5V/0V) as channel 0 output state


6. Change channel 0 output state by clicking it (multiple times) Channel 7 input state is the same as channel 0 output state Voltmeter shows the same state (5V/0V) as channel 0 output state
6. Change channel 0 output state by clicking it (multiple times) Channel 7
input state is the same as channel 0 output state Voltmeter shows the same
state (5V/0V) as channel 0 output state

-------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------

**Grouped operation**

Expand All @@ -65,7 +69,8 @@ Use Cases

2. Start digital IO instrument

3. Also monitor these connections with a logic analyzer (use breadboard to split the connection)
3. Also monitor these connections with a logic analyzer (use breadboard to
split the connection)

4. Set DIO 0-7 to Grouped interface

Expand All @@ -74,8 +79,8 @@ Use Cases

6. Set each DIO8-15 output states at random


DIO 0 – 7 grouped value should be the binary value of channels 8-15. Logic analyzer should show the same results
DIO 0 – 7 grouped value should be the binary value of channels 8-15. Logic
analyzer should show the same results

7. Set all channels 8-15 to input

Expand All @@ -87,20 +92,22 @@ Channels 8-15 input state should represent that value in binary

Logic analyzer should show the same results

.. image:: ../../resources/m2k/digitalio/scopy_2018-05-15_17-11-24.png
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/m2k/digitalio/scopy_2018-05-15_17-11-24.png
:align: center

-------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------

**Interaction with pattern generator**

1. Start digital IO instrument

2. Generate clock signals on channels 0 and 8

In the digitalIO the group as well as channel 8 should have a red highlight indicating that the pattern generator has ownership of the channels.
In the digitalIO the group as well as channel 8 should have a red highlight
indicating that the pattern generator has ownership of the channels.

The user cannot interact with those channels. Logic analyzer shows clock signal correctly generated at channels 0 and 8
The user cannot interact with those channels. Logic analyzer shows clock signal
correctly generated at channels 0 and 8

3. Connect channel 10 to channel 11

Expand All @@ -110,13 +117,18 @@ The user cannot interact with those channels. Logic analyzer shows clock signal

Channel 11 input state follows channel 10 output state

Rest of the channels work properly. The user can set direction and output state and can read input state
Rest of the channels work properly. The user can set direction and output state
and can read input state

6. While running, set a clock signal on channel 10 in the pattern generator Channel 10 has a red highlight, the user cannot interact with it anymore. Channel 11 input state might flicker indicating that a signal can be read from channel 11.
6. While running, set a clock signal on channel 10 in the pattern generator
Channel 10 has a red highlight, the user cannot interact with it anymore.
Channel 11 input state might flicker indicating that a signal can be read from
channel 11.

Logic analyzer shows a new clock signal generated at channel 10 which can also be read on channel 11
Logic analyzer shows a new clock signal generated at channel 10 which can also
be read on channel 11

.. image:: ../../resources/m2k/digitalio/scopy_2018-05-15_17-13-47.png
.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/m2k/digitalio/scopy_2018-05-15_17-13-47.png
:align: center

7. Stop the pattern generator
Expand Down
Loading

0 comments on commit 4bbc6b6

Please sign in to comment.