X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fguess_bitrate%2F__init__.py;h=21f0cb8bbd933ef701170ac01917b8351c029dae;hb=HEAD;hp=9c7e6a47aba7d2912d0c2c7981a85129bc04e8cb;hpb=6a15597a7b3f901b566b7bfc8c484a14e0fb6a11;p=libsigrokdecode.git diff --git a/decoders/guess_bitrate/__init__.py b/decoders/guess_bitrate/__init__.py index 9c7e6a4..a02bf18 100644 --- a/decoders/guess_bitrate/__init__.py +++ b/decoders/guess_bitrate/__init__.py @@ -14,15 +14,16 @@ ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; if not, write to the Free Software -## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +## along with this program; if not, see . ## ''' This protocol decoder tries to guess the bitrate / baudrate of the -communication on the specified channel. Typically this will be used to -guess / detect the baudrate used in a UART communication snippet, but it -could also be used to guess bitrates of certain other protocols or buses. +communication on the specified channel. + +Typically this will be used to guess / detect the baudrate used in a UART +communication snippet, but it could also be used to guess bitrates of certain +other protocols or buses. It should be noted that this is nothing more than a simple guess / heuristic, and that there are various cases in practice where the detection of the @@ -32,7 +33,8 @@ The precision of the estimated bitrate / baudrate will also depend on the samplerate used to sample the respective channel. For good results it is recommended to use a logic analyzer samplerate that is much higher than the expected bitrate/baudrate that might be used on the channel. -''' -from .pd import * +The last annotation emitted by the decoder will be the best bitrate guess. +''' +from .pd import Decoder