9c7e6a47aba7d2912d0c2c7981a85129bc04e8cb
[libsigrokdecode.git] / decoders / guess_bitrate / __init__.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
5 ##
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either version 2 of the License, or
9 ## (at your option) any later version.
10 ##
11 ## This program is distributed in the hope that it will be useful,
12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 ## GNU General Public License for more details.
15 ##
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19 ##
20
21 '''
22 This protocol decoder tries to guess the bitrate / baudrate of the
23 communication on the specified channel. Typically this will be used to
24 guess / detect the baudrate used in a UART communication snippet, but it
25 could also be used to guess bitrates of certain other protocols or buses.
26
27 It should be noted that this is nothing more than a simple guess / heuristic,
28 and that there are various cases in practice where the detection of the
29 bitrate or baudrate will not necessarily have the expected result.
30
31 The precision of the estimated bitrate / baudrate will also depend on the
32 samplerate used to sample the respective channel. For good results it is
33 recommended to use a logic analyzer samplerate that is much higher than
34 the expected bitrate/baudrate that might be used on the channel.
35 '''
36
37 from .pd import *
38