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

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012 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, see <http://www.gnu.org/licenses/>.
##

'''
UART (Universal Asynchronous Receiver Transmitter) is a simple serial
communication protocol which allows two devices to talk to each other.

This decoder should work on all "UART-like" async protocols with one
start bit (0), 5-9 databits, an (optional) parity bit, and one or more
stop bits (1), in this order.

It can be run on one signal line (RX or TX) only, or on two lines (RX + TX).

There are various standards for the physical layer specification of the
signals, including RS232, (TTL) UART, RS485, and others. However, the logic
level of the respective pins is only relevant when acquiring the data via
a logic analyzer (you have to select the correct logic analyzer and/or
the correct place where to probe). Once the data is in digital form and
matches the "UART" description above, this protocol decoder can work with
it though, no matter whether the source was on TTL UART levels, or RS232,
or others.
'''

from .pd import Decoder
Commit	Line	Data
64c29e28	1	##
50bd5d25	2	## This file is part of the libsigrokdecode project.
64c29e28 UH	3	##
	4	## Copyright (C) 2012 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
4539e9ca	17	## along with this program; if not, see <http://www.gnu.org/licenses/>.
64c29e28 UH	18	##
64c29e28 UH	19
8e828d2a	20	'''
4c3b1846	21	UART (Universal Asynchronous Receiver Transmitter) is a simple serial
8e828d2a UH	22	communication protocol which allows two devices to talk to each other.
8e828d2a UH	23
3091f4e0	24	This decoder should work on all "UART-like" async protocols with one
4c3b1846	25	start bit (0), 5-9 databits, an (optional) parity bit, and one or more
3091f4e0 UH	26	stop bits (1), in this order.
	27
	28	It can be run on one signal line (RX or TX) only, or on two lines (RX + TX).
	29
	30	There are various standards for the physical layer specification of the
	31	signals, including RS232, (TTL) UART, RS485, and others. However, the logic
	32	level of the respective pins is only relevant when acquiring the data via
	33	a logic analyzer (you have to select the correct logic analyzer and/or
	34	the correct place where to probe). Once the data is in digital form and
	35	matches the "UART" description above, this protocol decoder can work with
	36	it though, no matter whether the source was on TTL UART levels, or RS232,
	37	or others.
8e828d2a UH	38	'''
8e828d2a UH	39
95d11271	40	from .pd import Decoder