Manual: Add session save/restore, PD selector dialog
authorSoeren Apel <soeren@apelpie.net>
Thu, 14 Mar 2019 11:08:44 +0000 (12:08 +0100)
committerSoeren Apel <soeren@apelpie.net>
Thu, 14 Mar 2019 11:08:44 +0000 (12:08 +0100)
manual/acquisition.txt
manual/analysis.txt
manual/decoders.txt

index 685c9cd..05c50f3 100644 (file)
@@ -15,7 +15,7 @@ program even when you don't have any hardware to use it with.
 
 The device selector offers two methods to choose the device to use. If you click on the small
 arrow on the side, you see a list of devices PulseView has recognized. If the device you want
-to use it listed, you can just select it here to use it.
+to use is listed, you can just select it here.
 
 image::device_selector_dropdown.png[]
 
index 7aa487b..bc2c11d 100644 (file)
@@ -63,7 +63,7 @@ There are some decoders available that analyze the data instead of decoding it.
 You can make use of them to examine various properties of the signals that are
 of interest to you.
 
-Their names are:
+Among them are:
 
 * Counter - counts pulses and/or groups of pulses (i.e. words)
 * Guess bitrate - guesses the bitrate when using a serial protocol
@@ -72,6 +72,7 @@ Their names are:
 
 === Other Features
 
+==== Signal Label Area Resizing
 Trace Views also allow you to maximize the viewing area by minimizing the area
 occupied by the label area on the left. To do this, simply position the mouse
 cursor at the right edge of the label area (or left edge of the viewing area).
@@ -80,5 +81,20 @@ Your mouse cursor will change shape and you now can drag the border.
 This way, you can give signals long, expressive names without clogging up the
 view area.
 
-Also, you can create multiple views by clicking on the "New View" button on
-the very left of the toolbar. Those can be rearranged as you wish.
+==== Multiple Views
+You can create multiple views by clicking on the "New View" button on the very
+left of the toolbar. These can be rearranged as you wish.
+
+==== Session Saving/Restoring
+When closing PulseView, it automatically saves the sessions you currently have
+open, including the signal configuration and any protocol decoders you might
+have added. The next time you start it again, it'll be restored to its
+previous state.
+
+This metadata is also saved with every .sr file you save so that the next time
+you open the .sr file, your signal configurations, views and decoders are
+restored. These metadata files have the ending .pvs (PulseView Setup) and can
+be edited in any text editor if you wish to change something manually.
+
+Additionally, you can save or load this metadata at any time using the
+save/load buttons.
index d2ca15a..d50a698 100644 (file)
@@ -50,14 +50,15 @@ image::pv_decoders_3.png[]
 With the stacked decoder added, we can now see that PulseView has decoded the meaning
 of the I²C commands, so that we don't need to bother searching the reference manual.
 In this view, we can see that the I²C packet was a command to read the date and time,
-which was then reported to be 10.03.2013 23:35:30. 
+which was then reported to be 10.03.2013 23:35:30.
 
-There are all kinds of stacked decoders available, but keep in mind that they're not
-shown in the decoder menu. Stacked decoders require a lower-level decoder first before
-they become stackable. Most of the time, they require either the UART, I²C or SPI decoder.
+In this example, we added the I²C and DS1307 decoders separately. However, when opening
+the decoder selector window, you can also double-click on the DS1307 decoder and PulseView
+will try to auto-resolve the dependencies needed to use this decoder. In case there are
+ambiguities (e.g. when several different protocol decoders offer 'uart' output), it will
+ask you to choose which one to use.
 
-You can check the https://sigrok.org/wiki/Protocol_decoders[List of Protocol Decoders]
-to see which protocol decoders have been created already.
+For a list of available and planned protocol decoders, you can https://sigrok.org/wiki/Protocol_decoders[check the wiki].
 
 === Using Decoders on Analog Signals