diff options
Diffstat (limited to 'decoders/uart/pd.py')
| -rw-r--r-- | decoders/uart/pd.py | 21 |
1 files changed, 21 insertions, 0 deletions
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 |