Merge branch 'main' into fix/middle-mouse-button-begining

README.md

@@ -1,31 +1,41 @@
 # nRF Connect Power Profiler
 
-Power Profiler app for
-[nRF Connect](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher).
-
-## Introduction
-
-_nRF Connect Power Profiler_ is a tool to communicate with the
+nRF Connect Power Profiler is a tool to communicate with the
 [Power Profiler Kit II (PPK2)](https://www.nordicsemi.com/Software-and-tools/Development-Tools/Power-Profiler-Kit-2),
 an affordable and flexible tool to obtain real-time current measurements of your
-designs. It also supports the
-[older, first version of the Power Profiler Kit](https://www.nordicsemi.com/Software-and-tools/Development-Tools/Power-Profiler-Kit).
+designs.
+
 The PPK measures current consumption for a connected Nordic Development Kit or
 any external board. It gives a detailed picture of the current profile for the
 user application.
 
-All functionality is described in the
-[User Guide](https://infocenter.nordicsemi.com/topic/ug_ppk2/UG/ppk/PPK_user_guide_Intro.html)
-(If you use the first version of the hardware, there is a different
-[User Guide for the PPK 1](https://infocenter.nordicsemi.com/topic/ug_ppk/UG/ppk/PPK_user_guide_Intro.html)).
-
 ![screenshot](resources/screenshot.png)
 
+The support for
+[Power Profiler Kit (PPK1)](https://www.nordicsemi.com/Software-and-tools/Development-Tools/Power-Profiler-Kit)
+has been deprecated since the
+[nRF Connect Power Profiler v4.0.0-beta1](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md).
+The last application version to support PPK1 is
+[v3.5.5](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md)
+with
+[nRF Connect for Desktop v4.4.0](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher/blob/main/Changelog.md).
+
 ## Installation
 
-See the
-[InfoCenter](https://infocenter.nordicsemi.com/index.jsp?topic=%2Fstruct_nrftools%2Fstruct%2Fnrftools_nrfconnect.html)
-pages for information on how to install the application.
+nRF Connect Power Profiler is installed from nRF Connect from Desktop. For
+detailed steps, see
+[Installing nRF Connect for Desktop apps](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/installing_apps.html)
+in the nRF Connect from Desktop documentation.
+
+## Documentation
+
+Read the
+[nRF Connect Power Profiler](https://docs.nordicsemi.com/bundle/nrf-connect-ppk/page/index.html)
+official documentation for information about its UI and features.
+
+(The documentation is valid for PPK2. If you use the first version of the
+hardware, see the
+[online documentation for PPK1](https://docs.nordicsemi.com/bundle/ug_ppk/page/UG/ppk/PPK_user_guide_Intro.html)).
 
 ## Development
 

doc/docs/index.md

@@ -7,4 +7,8 @@ The PPK measures current consumption for a connected Nordic Development Kit or a
 ## Supported devices
 
 - Power Profiler Kit II (PPK2)
-- Power Profiler Kit (PPK1)
+
+## Deprecated support
+
+The support for [Power Profiler Kit (PPK1)](https://www.nordicsemi.com/Software-and-tools/Development-Tools/Power-Profiler-Kit) has been deprecated since the [nRF Connect Power Profiler v4.0.0-beta1](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md). The last application version to support PPK1 is [v3.5.5](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md) with [nRF Connect for Desktop v4.4.0](https://github.com/NordicSemiconductor/pc-nrfconnect-launcher/blob/main/Changelog.md).
+If you use the first version of the hardware, see the [online documentation for PPK1](https://docs.nordicsemi.com/bundle/ug_ppk/page/UG/ppk/PPK_user_guide_Intro.html).

doc/docs/overview.md

@@ -3,3 +3,233 @@
 The nRF Connect Power Profiler app has two views that provide detailed power consumption information.
 
 ![nRF Connect Power Profiler default view at startup](./screenshots/ppk2_standard_view.png "nRF Connect Power Profiler default view at startup")
+
+## Select Device
+
+Once you connect a device to the system, it becomes visible and available when you click on the **Select device** drop-down list. You can choose a device from the list of connected devices to perform further actions on the device such as programming.
+
+You can access the following options by selecting the arrow under the device name.
+
+- Show the device at the top of the list by making it favorite.
+- Rename the device.
+- View device COM ports.
+
+## Device panel sections before device selection
+
+Before you select a device, you can only load a power profiler file, open a link to an online purchase page, check documentation, or configure temporary disk data.
+
+### Load
+
+The **Load** button lets you open a `.ppk2` or a `.ppk` power profiler file.
+
+!!! note "Note"
+      Loading a `.ppk` file will automatically convert it to a `.ppk2` file.
+      The new file will be saved next to the original `.ppk` file.
+
+      Support for converting `.ppk` files will be removed in the future.
+
+### Temp disk
+
+![Temp disk data controls](./screenshots/ppk2_temp_disk_data.png "Temp disk data controls")
+
+These options only appear before selecting the device or when the device is selected and in the [**Data logger** sampling mode](#sampling-tabs).
+
+Here you can set the root directory where the sampling file will be saved by default and define how much hard drive space you want to keep free when you start sampling.
+The sampling will automatically stop when the hard drive has less than the defined amount.
+
+## Device panel sections after device selection
+
+More options become available after selecting a device. Some options are specific to the chosen sampling mode.
+
+![nRF Connect Power Profiler default view after selecting a device](./screenshots/ppk2_standard_view_connected.png "nRF Connect Power Profiler default view after selecting a device")
+
+### Power supply mode
+
+![Power supply mode options in the Device panel](./screenshots/ppk2_device_panel_mode.png "Power supply mode options in the Device panel")
+
+Here you can select one of the power supply modes for the PPK2, depending on your hardware setup:
+
+| Mode                              | PPK LED color | Description                                                                                          |
+|-----------------------------------|---------------|------------------------------------------------------------------------------------------------------|
+| **Source meter**                  | Breathing red | In this mode, Device Under Test (DUT) is [supplied power by the PPK2](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_source_meter.html). You can **Set supply voltage** output to the DUT by using the slider or typing the required voltage. |
+| **Ampere meter**                  | Breathing blue| In this mode, DUT is [supplied power from an external source](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html).       |
+
+Both modes let you **Enable power output** on or off, which turns DUT on or off. The **Ampere meter** mode, when selected, turns this option on by default.
+
+### Sampling parameters
+
+Here you can select the sampling parameters. The parameters are different depending on the sampling mode.
+
+This is also where you can **Start** sampling.
+
+![Start button](./screenshots/ppk2_device_panel_sampling_start.PNG "Start button")
+
+After sampling starts, the **Start** button changes to **Stop**.
+Before you can start sampling again, [**Save/Export**](#other-options) the session data or take a [**Screenshot**](#other-options)
+If you don't, you will be prompted about saving any unsaved sampling data before you start sampling again.
+
+#### Data logger parameters
+
+![Sampling parameters for Data logger](./screenshots/ppk2_device_panel_sampling_live.png "Sampling parameters for Data logger")
+
+When sampling in the **Data logger** mode, you can select the amount of samples per second that will be recorded.
+The slider lets you select different values up to 100 000 samples per second (100 kHz).
+You can also specify how long the sampling is supposed to last (**forever** by default).
+
+After pressing **Start**, the sampling lasts to the moment the sampling time value is reached.
+If you specified the sampling to last **forever**, the sampling will last until you manually **Stop** it or until the [**Disk full trigger**](#temp-disk) limit is reached.
+
+Based on the chosen options, the Power Profiler application estimates the disk space usage.
+
+#### Scope parameters
+
+![Sampling parameters for Scope](./screenshots/ppk2_device_panel_sampling_trigger.png "Sampling parameters for Scope")
+
+When sampling in the **Scope** mode, the sampling starts only when the specified **Length** and **Level** values are reached.
+The sampling always happens at 100 000 samples per second (100 kHz).
+
+The following table lists all available Scope parameters.
+
+| Option                            | Description                                                                                          |
+|-----------------------------------|------------------------------------------------------------------------------------------------------|
+| **Length**                        | Total time before and after the **Level** current value is reached. The application will try to record the trigger at the middle of the provided value.  |
+| **Level**                         | The current value at which the trigger takes place. The trigger always happens at the rising edge. After you record some data, you can also set this value using an arrow in the **Data logger** chart.</br></br>![Arrow for setting Level value](./screenshots/ppk2_device_panel_sampling_trigger_arrow.PNG "Arrow for setting Level value")        |
+| **Single**                        | Select this option to stop sampling after one trigger event takes place.       |
+| **Continuous**                    | Select this option to continue sampling after one trigger event, and display trigger events until you click **Stop**. The first trigger must be fulfilled for the specified **Length** before another trigger can be displayed.       |
+
+### Display options
+
+The following table lists the available display options.
+
+| Option                            | Description                                                                                          |
+|-----------------------------------|------------------------------------------------------------------------------------------------------|
+| **Timestamps**                    | Show or hide the timestamps at the bottom of the sampling chart.                                     |
+| **Relative** and **Absolute**     | Select how the time value of the **Timestamps** is to be displayed: relative to the start of the sampling or using machine time (UTC, adjusted per time zone of the machine settings).<br/><br/>If you [**Load**](#device-panel-sections) an old `.ppk` file, the timestamp value will not be shown because of the lack of metadata.         |
+| **Digital channels**              | Show or hide the [digital channels](#digital-channels) under the sampling chart.                     |
+| **Show Minimap**                  | Toggle to show or hide the navigable minimap under the **Data logger**'s chart. You can use the minimap to inspect the logged sampling results and navigate quickly in the time range of the recording. |
+
+### Save options
+
+The following options let you save the results of the sampling. They are only available for selection after you start logging sampling data.
+
+| Option                            | Description                                                                                          |
+|-----------------------------------|------------------------------------------------------------------------------------------------------|
+| **Save/Export**                   | Available only after sampling is stopped. Saves the results of the data sampling to a `.ppk2` file, which you can [**Load**](#device-panel-sections) in a new session of nRF Connect Power Profiler. |
+| **Screenshot**                    | Saves the current data from either the **Data logger** or the **Scope** view as a PNG image.                                          |
+
+### Advanced configuration
+
+The advanced configuration panel gives you access to filter tuning and lets you adjust gains for all individual ranges.
+
+#### Gains
+
+![Advanced configuration for gains](./screenshots/ppk2_advanced_gains.PNG "Advanced controls for gains")
+
+If any of the ranges (see [Measurement resolution](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/ppk_measure_resolution.html#ppk_measure_resolution__table_b3l_3ty_bdb)) has an offset, use these configuration options to add a positive or negative gain to the calculated measurement values.
+
+#### Spike filter
+
+![Advanced configuration for spike filter](./screenshots/ppk2_advanced_spike.PNG "Advanced controls for spike filter")
+
+Whenever a dynamic range switching occurs, induced inductance may cause the first samples to be higher than the actual value.
+
+Use the sliders to set the following:
+
+- Samples to smooth - The number of samples after a dynamic range switch to apply the filer.
+- Coefficient for range 1–4 - The magnitude of the spike filter for range 1–4. The higher the value, the more filtering will be applied.
+- Coefficient for range 5 - The magnitude of the spike filter for range 5. The higher the value, the more filtering will be applied.
+
+#### Voltage limit
+
+![Advanced configuration for voltage limit](./screenshots/ppk2_advanced_voltage.PNG "Advanced controls for voltage limit")
+
+Use this control to set the voltage limit for the measurement.
+
+## Sampling mode tabs
+
+nRF Connect Power Profiler comes with two sampling modes: **Data logger** and **Scope**.
+
+- The **Data logger** sampling mode lets you examine the power continuously over a period of time.
+  It has its own [sampling parameters](#data-logger-parameters) and lets you use the **Live Now** toggle to jump back to displaying the live measurement.
+
+    ![Data logger mode at work](./screenshots/ppk2_logger_tab.PNG "Data logger mode at work")
+
+- The **Scope** sampling mode lets you sample only when the values specified for the **Length** and **Level** [sampling parameters](#real-time-parameters) have been reached.
+  You can use the blue slider on the Y-axis to dynamically select the value of the **Level** parameter.
+
+    ![Scope mode at work](./screenshots/ppk2_scope_tab.PNG "Scope mode at work")
+
+Both modes have their own [sampling parameters](#sampling-parameters), but share most of the sampling chart UI, explained in the following sections.
+
+## Sampling chart
+
+This is the area where you can track and inspect the measurements being recorded.
+
+The following actions are common to both sampling modes:
+
+- Hover over the chart to display detailed measurement values.
+- Click and hold the left mouse button over the chart and drag the mouse to scroll the chart right and left.
+- Toggle **Lock Y-axis** to prevent the Y-axis changing its values dynamically when you scroll the chart. You can also manually set the values for locking Y-axis in [chart settings](#chart-settings).
+- Use the time frame value buttons to scale the X-axis size.
+- Make [selection](#window-and-selection) of a specific fragment of the measurement.
+
+![Measurement chart](./screenshots/ppk2_chart.PNG "Measurement chart")
+
+### Chart settings
+
+You can access the chart settings by clicking the gear icon in the top left corner, next to the **Lock Y-axis** toggle.
+Here you can set the values for locking the Y-axis and enable the logarithmic Y-axis.
+
+![Chart settings](./screenshots/ppk2_chart_settings.PNG "Chart settings")
+
+### Minimap
+
+This is the summary of the whole measurement for scrolling and search, both in Y-axis and [logarithmic Y-axis](#chart-settings).
+It is only available in the **Data logger** sampling mode.
+
+![Minimap scrolling](./screenshots/minimap_live_view_gif.gif "Minimap scrolling")
+
+### Window and selection
+
+The bottom sections of the sampling chart display the average and maximum measurement values for the selected time interval:
+
+- **Window** displays values for the measurement from start to finish. Selecting a different time frame value changes the values shown.
+
+    ![Window section](./screenshots/ppk2_window.PNG "Window section")
+
+- **Selection** displays values for a part of the measurements.
+
+    ![Selection section](./screenshots/ppk2_selection_zoom.PNG "Selection section")
+
+    You can make a selection in the measurement chart by pressing **Shift** and dragging the left mouse button. The selected part is highlighted in grey and included between two grey sliders.
+
+    ![Example of selection](./screenshots/ppk2_selection.PNG "Example of selection")
+
+### Digital channels
+
+The digital signals are visible in the charting section below the current measurement.
+
+![Digital channels](./screenshots/ppk2_digital_channels.PNG "Digital channels")
+
+The digital signals are connected to the PPK2's Logic port as described in [Logic port](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/logic_port.html). To view the digital values, enable digital channels and zoom in on the main chart until the values are visible.
+
+To select which digital channels you see, use the **Digital channels** menu in [**Display options**](#display-options).
+
+## Feedback tab
+
+The Feedback tab lets you send feedback about nRF Connect Power Profiler application to the application development team.
+
+## About tab
+
+Here you can view application information, restore settings to default, access source code, and documentation. You also can find information on the selected device, access support tools, and enable verbose logging.
+
+![nRF Connect for Desktop Power Profiler About tab](./screenshots/ppk2_about_tab.png "nRF Connect for Desktop Power Profiler About tab")
+
+## Log
+
+The Log panel allows you to view the most important log events, tagged with a timestamp. Each time you open the app, a new session log file is created. You can find the Log panel and its controls, below the main application Window.
+
+- When troubleshooting, to view more detailed information than shown in the Log panel, use **Open log file** to open the current log file in a text editor.
+- To clear the information currently displayed in the Log panel, use **Clear Log**. The contents of the log file are not affected.
+- To hide or display the Log panel in the user interface, use **Show Log**.
+- To freeze Log panel scrolling, use **Autoscroll Log**.

doc/docs/revision_history.md

@@ -2,6 +2,7 @@
 
 | Date       | Description                                                                                          |
 |------------|------------------------------------------------------------------------------------------------------|
+| 2024-03-14 | Updated the documentation for the nRF Connect Power Profiler [v4.0.0](https://github.com/NordicSemiconductor/pc-nrfconnect-ppk/blob/main/Changelog.md).    |
 | 2024-02-07 | Separated the application documentation from the [PPK2 hardware documentation](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/PPK_user_guide_Intro.html).    |
 | 2022-08-16 | Updated the following topics based on nRF9160 DK v0.9.0 or later:</br></br>- Quick start</br></br>- [Measuring current in Source Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_source_meter.html)</br></br>- [Measuring current in Ampere Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html) |
 | 2021-11-01 | - Updated [Measuring current in Ampere Meter mode](https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/measure_current_ampere_meter.html)</br></br>- Editorial changes     |