X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fuart%2F__init__.py;h=ce6136f1b2b706a4180760c05e285965d8c18001;hb=15a60d37d4ea14c460068ce4c0e6befdb918692f;hp=4267d83b915acc688da19e171d4313baed8b379b;hpb=64c29e28e0efa184319f7831b3eca18c7f73f7d0;p=libsigrokdecode.git diff --git a/decoders/uart/__init__.py b/decoders/uart/__init__.py index 4267d83..ce6136f 100644 --- a/decoders/uart/__init__.py +++ b/decoders/uart/__init__.py @@ -1,5 +1,5 @@ ## -## This file is part of the sigrok project. +## This file is part of the libsigrokdecode project. ## ## Copyright (C) 2012 Uwe Hermann ## @@ -14,9 +14,27 @@ ## 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 +## along with this program; if not, see . ## -from .uart import * +''' +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