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

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2014 Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com>
##
## 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, see <http://www.gnu.org/licenses/>.
##

'''
This protocol decoder retrieves the timing jitter between two digital signals.

It allows to define a clock source channel and a resulting signal channel.
Each time a significant edge is detected in the clock source, we calculate the
elapsed time before the resulting signal answers and report the timing jitter.
'''

from .pd import Decoder
Commit	Line	Data
c2049e2c SB	1	##
	2	## This file is part of the libsigrokdecode project.
	3	##
	4	## Copyright (C) 2014 Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com>
	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
4539e9ca	17	## along with this program; if not, see <http://www.gnu.org/licenses/>.
c2049e2c SB	18	##
	19
	20	'''
	21	This protocol decoder retrieves the timing jitter between two digital signals.
	22
	23	It allows to define a clock source channel and a resulting signal channel.
	24	Each time a significant edge is detected in the clock source, we calculate the
	25	elapsed time before the resulting signal answers and report the timing jitter.
	26	'''
	27
	28	from .pd import Decoder