Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: general updates in the troubleshooting and preferences page. #1865

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ Scopy is a software oscilloscope and signal analysis toolset.

### Supported platforms
- Windows (x86-64)
- Linux flatpak (x86-64, armhf, arm64)
- Linux AppImage (x86-64, armhf, arm64)
- Linux flatpak (x86-64)
- macOS (x86-64, arm64)
- Android (aarch64)

Complete instalation and usage instructions can be found on our [Wiki](https://wiki.analog.com/university/tools/m2k/scopy) page.
Complete installation and usage instructions can be found on our [official documentation](https://analogdevicesinc.github.io/scopy/) page.

## Contributing

Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ Contents
plugins/index


user_guide/preferences
user_guide/bugReport
user_guide/troubleshooting
8 changes: 0 additions & 8 deletions docs/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,6 @@ Application Specific plugins
* :ref:`Settings <settings>`


Each plugin:
Description
Compatible
Description
Usage
Usecases


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

Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/bugReport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ Example Report

**Operating System:** Linux

**Scopy Version:** v1.2.0 or git tag
**Scopy Version:** v2.0.0 or git tag

**Firmware Version:** 0.25
**Firmware Version:** 0.33

**Steps to reproduce the bug**:

Expand Down
64 changes: 35 additions & 29 deletions docs/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,28 @@ Download

**Scopy for Windows**

* Download: `Installer for latest release (Windows 64/32-bit) <https://github.com/analogdevicesinc/scopy/releases/latest>`_
* Download: `Installer for latest release (Windows 64-bit) <https://github.com/analogdevicesinc/scopy/releases/latest>`_

**Scopy for Linux**

* Download: `Scopy Flatpak installer <https://github.com/analogdevicesinc/scopy/releases/latest>`_
* Download: `Scopy AppImage executable <https://github.com/analogdevicesinc/scopy/releases/latest>`_

**Scopy for OSX**

* Download:`OSX installer <https://github.com/analogdevicesinc/scopy/releases/latest>`_

**Scopy for Android**

* Download: `Android installer <https://github.com/analogdevicesinc/scopy/releases/latest>`_

* Google Play store link: `Scopy <https://play.google.com/store/apps/details?id=org.adi.scopy>`_
* APK soon available

**Scopy all platforms latest(nightly) builds**
**ARM64**

* Download:`Installer for latest (nightly) build <https://github.com/analogdevicesinc/scopy/releases/tag/continous>`_
* Download: `Scopy AppImage executable for ARM64 <https://github.com/analogdevicesinc/scopy/releases/latest>`_

**ARM32**

* Download: `Scopy AppImage executable for ARM32 <https://github.com/analogdevicesinc/scopy/releases/latest>`_

.. warning::

Expand All @@ -63,12 +66,13 @@ Video installation guide:

**Scopy for Linux**

Before downloading and extracting the scopy-Linux-flatpak.zip archive,
**AppImage**: Make the application executable by running **chmod +x ./Scopy.AppImage** in a command line,
then run Scopy as any other Linux executable. These steps are applicable for ARM64 and ARM32 also.

**Flatpak**: Before downloading and extracting the scopy-Linux-flatpak.zip archive,
you need to setup Flatpak `using this setup guide <https://flatpak.org/setup/>`_
for your Linux distribution.



For Ubuntu, you can use the following steps:

.. code-block::
Expand Down Expand Up @@ -111,7 +115,7 @@ Video installation guide:



**Scopy for Android**
**Scopy for Android** - APK coming soon

Tap on the downloaded .apk file to start the installation process and proceed
by hitting the “Install” button. Optionally, you may be warned that this
Expand All @@ -133,11 +137,28 @@ Run Scopy from the Desktop Shortcut / Start Menu / Installation Folder.

On Linux, you can also run it using:

.. code-block::

chmod +x Scopy.AppImage
./Scopy.AppImage

OR

.. code-block::

flatpak run org.adi.Scopy


.. tip::

If the latter raises issues related to platform display plugins use the following modified command
to solve it.

flatpak run --env=QT_QPA_PLATFORM=xcb org.adi.Scopy

QT_QPA_PLATFORM=xcb ./Scopy.AppImage


Application Overview
---------------------------------------------------------------------

Expand Down Expand Up @@ -300,20 +321,8 @@ Save & Load session
Preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/scopy-general-prefs.png
:align: center
..

Scopy Preferences can be accessed using the bottom left side **preferences
button**. On the right side of the page, preferences for each plugin
are available. More details can be found in their specific plugin
documentation section.

Clicking the **Reset Scopy** button will reset the application to a default
configuration.

Changing some of the listed preferences will require an application
restart.
Scopy allows multiple application specific user preference configurations
described :ref:`in the Scopy general preferences page <preferences>`

About page
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -437,11 +446,7 @@ User guide on how to use scripts with Scopy:
Building from source
---------------------------------------------------------------------

Complete Scopy build guides on:

* `Windows <https://wiki.analog.com/university/tools/m2k/scopy/build-windows>`_
* `Linux <https://wiki.analog.com/university/tools/m2k/scopy/build-linux>`_
* `OSX <https://wiki.analog.com/university/tools/m2k/scopy/build-osx>`_
Complete Scopy v2.0.0 build guides **coming soon**!


Source code
Expand All @@ -450,6 +455,7 @@ Source code
The source code for the entire application can be found on `github
<https://github.com/analogdevicesinc/scopy>`_


Old documentation
---------------------------------------------------------------------

Expand Down
26 changes: 26 additions & 0 deletions docs/user_guide/preferences.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _preferences:

=============================================
Scopy Preferences
=============================================

.. image:: https://raw.githubusercontent.com/analogdevicesinc/scopy/doc_resources/resources/scopy-general-prefs.png
:align: center
..

Scopy Preferences can be accessed using the bottom left side **preferences
button**. On the right side of the page, preferences for each plugin
are available. More details can be found in their specific plugin
documentation section.

The **Open** button will try to open the specific OS explorer in
order to find the preference storage file.

Clicking the **Reset Scopy** button will reset the application to a default
configuration.

Changing some of the listed preferences will require an application
restart. More details on each preference are listed below.



Loading
Loading