[libsigrokdecode.git] / decoders / guess_bitrate / __init__.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## 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
##

'''
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.

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
bitrate or baudrate will not necessarily have the expected result.

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 *
Commit	Line	Data
56c93143 UH	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
6a15597a	23	communication on the specified channel. Typically this will be used to
56c93143 UH	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
6a15597a	32	samplerate used to sample the respective channel. For good results it is
56c93143	33	recommended to use a logic analyzer samplerate that is much higher than
6a15597a	34	the expected bitrate/baudrate that might be used on the channel.
56c93143 UH	35	'''
	36
	37	from .pd import *
	38