diff --git a/README.md b/README.md index 3c9e310e24..1204e1eb6d 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/index.rst b/docs/index.rst index fe5b9b82d9..775dac3d49 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,5 +29,6 @@ Contents plugins/index + user_guide/preferences user_guide/bugReport user_guide/troubleshooting diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 2ec2714416..05d0b8a674 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -51,14 +51,6 @@ Application Specific plugins * :ref:`Settings ` -Each plugin: -Description -Compatible -Description -Usage -Usecases - - Contents --------------------------------------------------------------------- diff --git a/docs/user_guide/bugReport.rst b/docs/user_guide/bugReport.rst index c06a7ee425..f343341b74 100644 --- a/docs/user_guide/bugReport.rst +++ b/docs/user_guide/bugReport.rst @@ -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**: diff --git a/docs/user_guide/index.rst b/docs/user_guide/index.rst index 1e882d5887..5d6f883b20 100644 --- a/docs/user_guide/index.rst +++ b/docs/user_guide/index.rst @@ -20,11 +20,12 @@ Download **Scopy for Windows** - * Download: `Installer for latest release (Windows 64/32-bit) `_ + * Download: `Installer for latest release (Windows 64-bit) `_ **Scopy for Linux** * Download: `Scopy Flatpak installer `_ + * Download: `Scopy AppImage executable `_ **Scopy for OSX** @@ -32,13 +33,15 @@ Download **Scopy for Android** - * Download: `Android installer `_ - - * Google Play store link: `Scopy `_ + * APK soon available - **Scopy all platforms latest(nightly) builds** + **ARM64** - * Download:`Installer for latest (nightly) build `_ + * Download: `Scopy AppImage executable for ARM64 `_ + + **ARM32** + + * Download: `Scopy AppImage executable for ARM32 `_ .. warning:: @@ -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 `_ for your Linux distribution. - - For Ubuntu, you can use the following steps: .. code-block:: @@ -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 @@ -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 --------------------------------------------------------------------- @@ -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 ` About page ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -437,11 +446,7 @@ User guide on how to use scripts with Scopy: Building from source --------------------------------------------------------------------- -Complete Scopy build guides on: - -* `Windows `_ -* `Linux `_ -* `OSX `_ +Complete Scopy v2.0.0 build guides **coming soon**! Source code @@ -450,6 +455,7 @@ Source code The source code for the entire application can be found on `github `_ + Old documentation --------------------------------------------------------------------- diff --git a/docs/user_guide/preferences.rst b/docs/user_guide/preferences.rst new file mode 100644 index 0000000000..b48c8bb756 --- /dev/null +++ b/docs/user_guide/preferences.rst @@ -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. + + + diff --git a/docs/user_guide/troubleshooting.rst b/docs/user_guide/troubleshooting.rst index 0b8d0b6b07..488cdc4502 100644 --- a/docs/user_guide/troubleshooting.rst +++ b/docs/user_guide/troubleshooting.rst @@ -1,7 +1,291 @@ .. _troubleshooting: Scopy troubleshooting guide -=========================== +=========================================================== + +Scopy v2 after Scopy v1? +------------------------------------------------------------ + +If this is the first time installing Scopy v2 after using +any Scopy v1 on your system, we **strongly** recommend to +uninstall the old Scopy properly. + +Doing this we make sure that the configuration files for +Scopy v2 are not in any way influenced by Scopy v1. + + +Any unexpected behavior? Send us the log! +------------------------------------------------------------ + +Scopy v2 brings a new logging mechanism for an easier navigation of the +debugging process. Whether starting Scopy on Linux (with **flatpak** or **appimage**), +on MacOS (from **command line**) or Windows, Scopy will display a filtered log of +operations. + +The filter is configured by default to display only a few main +components. This filter can be modified at runtime, by manipulating +the responsible environment variable: QT_LOGGING_RULES. + +This environment variable is part of the Qt mechanism for exposing +warning and debugging messages. Read more detailed information +in the official `Qt documentation `__ + +.. tip:: + + Send us the log output of Scopy to make it easier for us to reproduce + the issue! + +How to set the environment variable: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We can modify the debug output of Scopy even if the release has a +preconfigured filter. + +The default Scopy configuration is the following: + +.. code-block:: cpp + + "*.debug=false\n" + "ToolStack.debug=true\n" + "ToolManager.debug=true\n" + "DeviceManager.debug=true\n" + "Device.debug=true\n" + "TestPlugin.debug=true\n" + "Plugin.debug=true\n" + "swiotConfig.debug=true\n" + "CyclicalTask.debug=false\n" + "SWIOTPlugin.debug=true\n" + "AD74413R.debug=true\n" + "ScopyTranslations.debug=true\n" + "GRTimeSinkComponent.debug=true\n" + "GRManager.debug=true\n" + + +Using **\*.debug=false** will suppress all the debug output of Scopy. + +Now let's take some examples and check them on different Operating Systems: + +.. code-block:: shell + + ## This will disable all the output and only enable logs + ## for the ADC Plugin + "*.debug=false;ADCPlugin.debug=true" + + +Linux x86_64, arm64, arm32, MacOS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In order to modify the Scopy logging rules, open up a terminal +and run the following: + +.. code-block:: shell + + export QT_LOGGING_RULES="*.debug=false;ADCPlugin.debug=true" + +After that, run Scopy (specific to each OS type) and observe +the log output changing. + + +Windows +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In the Scopy install location on Windows you will find 2 separate +executables: **Scopy.exe** and **Scopy-console.exe**. In order to view +the debug log of Scopy, you need to run the latter: *Scopy-console.exe*. +This will not only open the Scopy window, it will also start a command +prompt in which all the output will be visible. + +In order to modify the QT_LOGGING_RULES on Windows, firstly open a +command prompt and run the following: + +.. code-block:: shell + + set QT_LOGGING_RULES="*.debug=false;ADCPlugin.debug=true" + +After that, you can run *Scopy-console.exe* from the **same** command +prompt. + + +Available configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A list of all the available Scopy class filters is: + +.. list-table:: + :widths: 50 + :header-rows: 1 + + * - SCOPY CLASS FILTER + * - AnimationPushButton + * - MapStackedWidget + * - TimeChannelComponent + * - TutorialOverlay + * - Time Y-Autoscale + * - TutorialChapter + * - PageNavigationWidget + * - TitleSpinBox + * - ScopyStatusBar + * - MenuCollapseSection + * - iioWidget + * - AttrDataStrategy + * - MultiDataStrategy + * - CmdQDeviceDataStrategy + * - CmdQChannelDataStrategy + * - ContextAttrDataStrategy + * - TriggerDataStrategy + * - DeviceDataStrategy + * - SwitchGuiStrategy + * - AttrGuiStrategy + * - TimeChannelAddon + * - GRTimePlotAddon + * - GRTimeChannel + * - RuntimeEnvironmentInfo + * - CrashReport + * - toolLauncher + * - oscilloscope + * - signalGenerator + * - voltmeter + * - powerController + * - spectrumAnalyzer + * - networkAnalyzer + * - digitalIO + * - logicAnalyzer + * - patternGenerator + * - calibration + * - calibration.manual + * - iioManager + * - plot + * - Benchmark + * - DetachedToolWindow + * - ScopyTitleManager + * - DeviceManager + * - ScopyPreferencesPage + * - ToolStack + * - EmuAddPage + * - Scopy + * - DeviceBrowser + * - InfoPageStack + * - ScopyHomeAddPage + * - PluginManager + * - Device + * - ToolMenuItem + * - Scopy_API + * - PluginRepository + * - ScopyTranslations + * - ScannedIIOContextCollector + * - IIODevice + * - ToolMenuManager + * - IIOTabWidget + * - GRManager + * - TimeSink_f + * - CmdQPingTask + * - CyclicalTask + * - CommandQueue + * - ConnectionProvider + * - IIOScanTask + * - GUITestPlugin + * - BareMinimum + * - DacPlugin + * - DacInstrument + * - DacDds + * - DacBuffer + * - DacData + * - DacDataBuilder + * - DacFileManager + * - DacDataStrategy + * - RegReadWrite + * - oscilloscope + * - signalGenerator + * - voltmeter + * - powerController + * - spectrumAnalyzer + * - networkAnalyzer + * - digitalIO + * - logicAnalyzer + * - patternGenerator + * - calibration + * - calibration.manual + * - iioManager + * - plot + * - REGISTERMAP + * - RegisterMapTable + * - RegMap_API + * - MeasurementController + * - ADCInstrument + * - ADCPlugin + * - AcqTreeNode + * - GRFFTSinkComponent + * - GRFFTChannelComponent + * - GRTimeSinkComponent + * - GRTimeChannelComponent + * - PqmRms + * - PQMLog + * - PqmAqcManager + * - PQMPlugin + * - pqm_settings + * - M2kDigitalIo + * - M2kIIOManager + * - M2kCalibrationManual + * - M2KPowerController + * - M2kSiggen + * - M2kNetworkAnalyzer + * - M2kOscilloscope + * - M2KCalibration + * - M2kSpectrumAnalyzer + * - M2kDMM + * - M2KPLUGIN + * - Benchmark + * - Plot + * - SWIOTPlugin + * - AD74413R + * - SWIOTConfig + * - SWIOTFaults + * - MAX14906 + * - DebuggerTreeView + * - DebuggerDetailsView + * - DebuggerWatchList + * - DebuggerIIOModel + * - IIODebugger + * - DEBUGGERPLUGIN + * - Benchmark + * - TestPluginIp + * - TestPlugin + * - TimeTracker + * - DataMonitor_API + * - DataMonitorSettings + * - DataLoggerPlugin + * - DataLoggerPlugin + * - DataMonitorTool + * - ApiObject + * - ResourceManager + * - VersionCache + * - Scopy_JS + * - Plugin + * - StatusBarManager + * - Preferences + +If you need to regenerate this list after updating parts of Scopy, you can +use the following command: + +.. code-block:: shell + + grep -InH -r --exclude="*.rst*" --exclude="*.mako" --exclude="*build*" --exclude="*html*" "Q_LOGGING_CATEGORY" . | sed 's/.*Q_LOGGING_CATEGORY([^,]*, *"\([^"]*\)").*/\1/' + + +Linux Wayland crash +---------------------------- + +If you are using Scopy on a Linux system with Wayland and you encounter a crash +when trying to open the application, you can run Scopy with XCB. + +.. tip:: + + flatpak run --env=QT_QPA_PLATFORM=xcb org.adi.Scopy + +.. tip:: + + QT_QPA_PLATFORM=xcb ./Scopy.AppImage + Device doesn't show up ------------------------------------- @@ -42,6 +326,9 @@ and delete (or rename) **Scopy.ini** **Scopy.ini.bak** **Preferences.ini** **Preferences.ini.bak** The preference is to rename things with a different suffix, so if you need to report a bug, the file still exists. +You can also reset these files to default using the **Reset button** from +the Preferences page. + Scopy configuration can sometimes get messed up when updating as opposed to uninstall/reinstall. If you are facing this issue, you can try uninstalling Scopy and then reinstall. @@ -114,6 +401,15 @@ or iio_info -u "ip:192.168.2.1" +Emulator not found +-------------------------------------------------------- + +If you are using any binary from the official release artifacts +and you get something similar to: *"iio-emu not found"* when +trying to use the Emulator functionality, go to **Preferences**, +use the **Reset button** to set everything to its default value +and restart Scopy. + Scopy white screen on Windows ------------------------------------- diff --git a/resources/scopy.html b/resources/scopy.html index 517d3737ba..52b6af3371 100644 --- a/resources/scopy.html +++ b/resources/scopy.html @@ -10,7 +10,7 @@

Welcome to Scopy!



Scopy is a powerful toolbox for signal analysis and generation.

-Please visit our wiki for more information about Scopy.
+Please visit our documentation for more information about Scopy.
If you need help, drop a message on our Engineer Zone.