Creating Python OOT with gr-modtool

From GNU Radio
Revision as of 16:46, 8 March 2022 by Mattcarrick (talk | contribs)
Jump to navigation Jump to search


TODO: fill out some introductory info TODO: add the tutorial naviation bar TODO: add this tutorial to the nav bar

This tutorial was written using GNU Radio v3.10.1.1.

Open a terminal and navigate to an appropriate directory for writing software, such as the home directory:

$ cd $HOME

GNU Radio comes packaged with gr_modtool, software used to create out-of-tree (OOT) modules. An OOT module can be thought of as a collection of custom GNU Radio blocks. Create an OOT module named customModule using gr_modtool:

$ gr_modtool newmod customModule

The directory gr-customModule is created which contains all of the skeleton code for an OOT module, however it does not yet have any blocks.


Move into the directory:

$ cd gr-customModule

List all of the files and directories within the OOT module:

$ ls

The directory listing will be as follows:

apps/  cmake/  CMakeLists.txt  docs/  examples/  grc/  include/  lib/  MANIFEST.md  python/

now need to create a block within the OOT module. the block to be created will either add or subtract based on an input parameter.

$ gr_modtool add addSubtractSelector

Given a questionaire about how to define the block.

GNU Radio module name identified: customModule ('sink', 'source', 'sync', 'decimator', 'interpolator', 'general', 'tagged_stream', 'hier', 'noblock')