]>
Commit | Line | Data |
---|---|---|
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, see <http://www.gnu.org/licenses/>. | |
18 | ## | |
19 | ||
20 | ''' | |
21 | This protocol decoder tries to guess the bitrate / baudrate of the | |
22 | communication on the specified channel. | |
23 | ||
24 | Typically this will be used to guess / detect the baudrate used in a UART | |
25 | communication snippet, but it could also be used to guess bitrates of certain | |
26 | other protocols or buses. | |
27 | ||
28 | It should be noted that this is nothing more than a simple guess / heuristic, | |
29 | and that there are various cases in practice where the detection of the | |
30 | bitrate or baudrate will not necessarily have the expected result. | |
31 | ||
32 | The precision of the estimated bitrate / baudrate will also depend on the | |
33 | samplerate used to sample the respective channel. For good results it is | |
34 | recommended to use a logic analyzer samplerate that is much higher than | |
35 | the expected bitrate/baudrate that might be used on the channel. | |
36 | ||
37 | The last annotation emitted by the decoder will be the best bitrate guess. | |
38 | ''' | |
39 | ||
40 | from .pd import Decoder |