From: Soeren Apel Date: Wed, 24 Oct 2018 06:47:11 +0000 (+0200) Subject: Manual: Add PD troubleshooting section X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=a0241dc5b5496927dbd275a95a0992cf37a81a85;p=pulseview.git Manual: Add PD troubleshooting section --- diff --git a/manual/decoders.txt b/manual/decoders.txt index aef3034b..186f7e53 100644 --- a/manual/decoders.txt +++ b/manual/decoders.txt @@ -78,6 +78,30 @@ as you can now visually understand where the ranges for high and low are placed. Aside from the default conversion threshold(s), you can choose from a few common presets or enter custom values as well. They take the form "0.0V" and "0.0V/0.0V", respectively. +=== Troubleshooting + +In case a protocol decoder doesn't provide the expected result, there are several things +you can check. The first check you should perform is whether the time unit in the ruler +is given as "sa". This is short for "samples" and means that the device didn't provide +a sample rate and so PulseView has no way of showing a time scale in seconds or +fractions thereof. While some decoders can run without timing information, others +cannot. + +If a protocol decoder runs but shows you annotations that don't seem to make any sense, +it's worth double-checking the decoder settings. One common source of error is the +baud rate, for example. For example, the CAN protocol decoder doesn't know what baud rate +is used on the bus that you captured, so it could be that a different baud rate is used +than the one you set. Also, if this is still not the reason for the malfunction, it's +worth checking whether any of the signals have been captured inverted. Again using the +CAN bus as an example, the decoder will decode the signal just fine if it's inverted but +it'll show data even when the signal looks "idle". + +When a protocol decoder stops execution because of a bug in the decoder itself, you +will be presented a static red message in the protocol decoder's display area. +In that case, you check the log output in the settings menu. There you'll find the Python +error description which you can use to either debug the decoder (and let us know of the +fix) or you can copy that information and file a bug report so that we can fix it. + === Exporting Annotations If you want to postprocess annotations that were generated by a protocol decoder, you