From: Uwe Hermann <redacted>
Date: Thu, 12 Sep 2013 07:07:53 +0000 (+0200)
Subject: uart: Move OUTPUT_PROTO format description to pd.py.
X-Git-Tag: libsigrokdecode-0.3.0~323
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=4cace3b8485ffd04ed5c07ee81be812c7284c37b;p=libsigrokdecode.git

uart: Move OUTPUT_PROTO format description to pd.py.

This is information that a user (when viewing PD info in a GUI/CLI)
should not see (and doesn't care to see), it is meant for developers only.

Thus, make it a comment in pd.py instead.
---

diff --git a/decoders/uart/__init__.py b/decoders/uart/__init__.py
index a8b7303..a0c9cef 100644
--- a/decoders/uart/__init__.py
+++ b/decoders/uart/__init__.py
@@ -38,25 +38,6 @@ 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.
-
-Protocol output format:
-
-UART packet:
-[<packet-type>, <rxtx>, <packet-data>]
-
-This is the list of <packet-type>s and their respective <packet-data>:
- - 'STARTBIT': The data is the (integer) value of the start bit (0/1).
- - 'DATA': The data is the (integer) value of the UART data. Valid values
-   range from 0 to 512 (as the data can be up to 9 bits in size).
- - 'PARITYBIT': The data is the (integer) value of the parity bit (0/1).
- - 'STOPBIT': The data is the (integer) value of the stop bit (0 or 1).
- - 'INVALID STARTBIT': The data is the (integer) value of the start bit (0/1).
- - 'INVALID STOPBIT': The data is the (integer) value of the stop bit (0/1).
- - 'PARITY ERROR': The data is a tuple with two entries. The first one is
-   the expected parity value, the second is the actual parity value.
- - TODO: Frame error?
-
-The <rxtx> field is 0 for RX packets, 1 for TX packets.
 '''
 
 from .pd import *
diff --git a/decoders/uart/pd.py b/decoders/uart/pd.py
index 5aa3e4a..af2e51c 100644
--- a/decoders/uart/pd.py
+++ b/decoders/uart/pd.py
@@ -22,6 +22,27 @@
 
 import sigrokdecode as srd
 
+'''
+Protocol output format:
+
+UART packet:
+[<packet-type>, <rxtx>, <packet-data>]
+
+This is the list of <packet-type>s and their respective <packet-data>:
+ - 'STARTBIT': The data is the (integer) value of the start bit (0/1).
+ - 'DATA': The data is the (integer) value of the UART data. Valid values
+   range from 0 to 512 (as the data can be up to 9 bits in size).
+ - 'PARITYBIT': The data is the (integer) value of the parity bit (0/1).
+ - 'STOPBIT': The data is the (integer) value of the stop bit (0 or 1).
+ - 'INVALID STARTBIT': The data is the (integer) value of the start bit (0/1).
+ - 'INVALID STOPBIT': The data is the (integer) value of the stop bit (0/1).
+ - 'PARITY ERROR': The data is a tuple with two entries. The first one is
+   the expected parity value, the second is the actual parity value.
+ - TODO: Frame error?
+
+The <rxtx> field is 0 for RX packets, 1 for TX packets.
+'''
+
 # Used for differentiating between the two data directions.
 RX = 0
 TX = 1