Packet Communications

NOTE: This document has been revised. The previous version can be found in Packet_Communications_Test_Page.

This tutorial presents methods to transmit and receive packet data. As was shown in the QPSK and BPSK tutorials, the received bit data stream could be verified by comparing it to the (delayed) transmitted data. However, there was no way to recover the byte alignment of those bits. That is where packet processing comes into play.

Prerequisites

• QPSK Modulation / Demodulation
• BPSK Demodulation
• Polymorphic Types (PMTs)
• Stream Tags
• Message Passing

Header Format Object

The following blocks:

• Protocol_Formatter,
• Protocol_Formatter_(Async),
• Protocol_Parser,
• Packet_Header_Generator, and
• Packet_Header_Parser

use a "Header Format Object", but there is no block with that name. To create such an object, a Variable block is used. The 'Value' field can be one of several chioces depending on what type of header is needed, such as:

   * digital.header_format_default(access_code, threshold)
   * digital.header_format_crc(len_key, num_key)
   * digital.header_format_counter(access_code, threshold, bps)

Simulating Packet Comms Using Messages

In order to grasp the basics of packet processing, this section presents a transmitter and receiver simulation using standard GNU Radio blocks without any modulation or channel impairments.

Building the flowgraph

Build the following flowgraph using the details given below:

---

This flowgraph can be downloaded from Media:Pkt_8.grc.

Message Strobe

For the Message Strobe to generate a PDU, the Message PMT must be of the form

 pmt.cons(pmt.PMT_NIL,pmt.init_u8vector(9,(71,78,85,32,82,97,100,105,111)))

This specific vector has a length of 9 and the character values of "GNU Radio". It is sent twice per second.

CRC Append

The CRC Append block computes the CRC32 of the payload (message) and appends the value to it.

Variable, Id = hdr_format

The Protocol Formatter uses a Format Object to define its parameters. The one used in this example is

 hdr_format digital.header_format_default(access_key, 0)

It generates a header with the access code and the 16-bit payload length (repeated).

Protocol Formatter (Async)

The entry for the Format Obj. is 'hdr_format'. It produces separate header and payload output messages.

PDU to Tagged Stream

Converts received PDUs into a tagged stream by adding length tags.

Tagged Stream Mux

The Tagged Stream Mux combines the header and the payload into a single stream.

Correlate Access Code - Tag Stream

This block searches the input stream for a match to the given Access Code. The code is given as a string with the 32 bit value (ones and zeros).

CRC Check

The CRC Check block computes the CRC of the payload and compares it to the CRC in the message. If they match, the payload is output to the "ok" port with the CRC stripped from the message. If the CRC does not match, the entire message with CRC is output to the "fail" port.

---

Testing

1. Open a new terminal window.
2. Create a working directory, e.g. `~/GRdev`:

   mkdir ~/GRdev

3. Change to that directory:

   cd ~/GRdev

4. Assuming that you downloaded `Pkt_8.grc`, copy it to the working directory:

   cp ~/Downloads/Pkt_8.grc ./pkt_8.grc

5. Compile `pkt_8.grc`:

   grcc pkt_8.grc

6. Execute `pkt_8`:

   python3 -u pkt_8.py

7. A new window will open showing two Time Sinks which are the input and output of the 'Correlate Access Code - Tag Stream' block.
8. Once the Correlate Output shows a signal, wait one second, then terminate that window (titled `pkt_8`) by clicking the "X" in the upper right corner.
9. The terminal screen should show repeats of this message:

***** VERBOSE PDU DEBUG PRINT ******
()
pdu length =          9 bytes
pdu vector contents = 
0000: 47 4e 55 20 52 61 64 69 6f 
************************************

The "pdu vector contents" are the character codes for "GNU Radio".

Simulating Packet Comms Using Streams

Building the flowgraph

Build the following flowgraph using the details given below:

---

This flowgraph can be downloaded from Media:Str_pkt_10.grc.

File Source

The File Source reads a padded text file and outputs to a stream.

Stream to Tagged Stream

Converts a regular stream into a tagged stream by adding length tags in regular intervals.

Stream CRC32

The Stream CRC32 block computes the CRC of the payload and appends the value to it.

Protocol Formatter

The entry for the Format Obj. is 'hdr_format'. The Protocol Formatter produces the header for the packet.

Tagged Stream Mux

The Mux combines the protocol header and the payload data into one packet.

Correlate Access Code - Tag Stream

The Access Code is a string with the 32 bit value.

---

Testing

Create an input file

The success of this methodology is based on the input file being padded to a multiple of 'packet_len' bytes so that the last few bytes of the source file are not lost in a partial unprocessed packet. To create a padded file for input to the flowgraph, the following Python program can be used:

#!/usr/bin/python3
# -*- coding: utf-8 -*-

# Padded_File_Source.py

import os.path
import sys

Pkt_len = 252
_debug = 1          # set to zero to turn off diagnostics

if (len(sys.argv) < 2):
    print ('Usage: python3 Padded_File_Source.py <input file>')
    print ('Number of arguments=', len(sys.argv))
    print ('Argument List:', str(sys.argv))
    exit (1)
# test if file exists
fn = sys.argv[1]
if (_debug):
    print (fn)
if not(os.path.exists(fn)):
    print('The input file does not exist')
    exit (1)

# open input file
f_in = open (fn, 'r')

# open output file
f_out = open ("padded.txt", 'w')

while True:
    buff = f_in.read (Pkt_len)
    b_len = len(buff)
    if (_debug):
        print (b_len)
    if b_len == 0:
        print ('End of file')
        break
    while (b_len < Pkt_len):
        buff += ' '
        b_len += 1
    # write output
    f_out.write (buff)

f_in.close()
f_out.close()

Note that the 'Pkt_len' in the Python program and the 'packet_len' value in the flowgraph 'Stream to Tagged Stream' block must be the same. The output of the Python program is a file named "padded.txt".

1. In a terminal window change to `~/GRdev`:

   cd ~/GRdev

2. Copy the `Padded_File_Source.py` file above into a text file in `~/GRdev`.
3. Create a padded text file:

   python3 Padded_File_Source.py <input text file>

Choose a text file which is not very long and not a multiple of 252 bytes.

Executing the flowgraph

4. Assuming that you downloaded `Str_pkt_10.grc`, copy it to the working directory:

   cp ~/Downloads/Str_pkt_10.grc ./str_pkt_10.grc

5. Execute `gnuradio-companion`.

   gnuradio-companion

6. Open the `str_pkt_10.grc` flowgraph.
7. Right click on the 'File Source' block and select Properties.
8. Change the File path to your 'padded.text'. (Your user name will be different!)
9. Click 'Apply' and 'OK'.
10. Click 'Generate the flowgraph' or press F5.
11. Exit `gnuradio-companion` by clicking the "X" in the upper right corner of the screen.
12. On the same terminal screen, execute `str_pkt_10`:

   python3 -u str_pkt_10.py

13. A new window will open showing two Time Sinks which are the input and output of the Correlate Access Code - Tag Stream block.
14. Once the Correlate Output signal quits changing, the file transfer has finished. Terminate that window (titled `str_pkt_10`) by clicking the "X" in the upper right corner.
15. Examine the output file "output.txt". The output file will be the same as the original file, but will have trailing spaces at the end as a result of the padding.

Observations

During the development and testing for this tutorial, the following items were observed:

• The 'Header/Payload Demux' and 'Protocol Parser' blocks seem to work only with the 'digital.header_format_crc' format.
• The 'Correlate Access Code - Tag Stream' block requires the Default Header Format Obj. and expects a 32-bit access code.

---

Tested with v3.10.9.2