Hier Blocks and Parameters

This tutorial describes how to create a hierarchical block, or Hier block, in GRC.

The previous tutorial, Streams and Vectors, describes the differences between Streams and Vectors. The next tutorial, Creating Your First Block, describes how to use the Embedded Python Block to create a signal processing block in GNU Radio.

Creating the Initial Flowgraph
A hier block is used as a wrapper to simplify multiple GNU Radio blocks into a single block. The example hier block will be a frequency shifter block which multiplies a Signal Source against an input signal.



The first step is creating the flowgraph. Drag and drop the following blocks into the workspace:
 * 1) Signal Source
 * 2) Multiply
 * 3) Noise Source
 * 4) Low Pass Filter
 * 5) Throttle
 * 6) QT GUI Frequency Sink
 * 7) QT GUI Range

Connect the blocks:



Update the QT GUI Range properties:
 * Id: frequency
 * Default Value: 0
 * Start: -samp_rate/2
 * Stop: samp_rate/2

Update the Low Pass Filter properties:
 * Cutoff Freq (Hz): samp_rate/4
 * Transition Width (Hz): samp_rate/8

Create The Hier Block
Click and drag in the workspace window to select the Signal Source and Multiply blocks including the connection between them:



Right-click on one of the highlighted blocks and select More > Create Hier:



A flowgraph is created in a new GRC tab:



Double-click the Options block and edit the properties:
 * Id: FrequencyShifter
 * Title: Frequency Shifter Block
 * Generate Options: Hier Block



The remaining properties will then change, showing the Category:



The Category is where the block can be found in the block library on the right hand of GRC. The hier block will be located under GRC Hier Blocks, instead of Core where the rest of the GNU Radio blocks are located.

Save the flowgraph.

Variables vs Parameters
A variable is different than a parameter in GNU Radio. A parameter creates an interface for the hier block to accept a value from an external source, whereas a variable only exists internally to the hier block:



For example, the samp_rate variable can only be accessed from within the hier block:



The samp_rate needs to be converted to a parameter so it can be updated from another block in the larger flowgraph. Delete the samp_rate variable and add a Parameter block into the GRC workspace:



Edit the Parameter properties:
 * Id: samp_rate
 * Label: Sample Rate
 * Type: Float



Add a second Parameter:
 * Id: frequency
 * Label: Frequency
 * Type: float



Add the frequency parameter to the Signal Source Frequency property:



The flowgraph should look like:



Input and Output Ports
A pad is used to specify input and output ports on a hier block. Add a Pad Source and Pad Sink to the flowgraph to act as the in and out ports:



Generate the Hier Block Code
Click Generate the flow graph to create the hier block source code:



A Python .py file and YAML .yml file will be created. For GNU Radio v3.8 the files will be created in your home directory:

/home/$USER/.grc_gnuradio/



For GNU Radio v3.10, the files will be created in the directory where the .grc file is saved. Please create the .grc_gnuradio directory and copy the .py and .yml files there:

$ mkdir /home/$USER/.grc_gnuradio $ cp FrequencyShifter.block.yml /home/$USER/.grc_gnuradio/ $ cp FrequencyShifter.py /home/$USER/.grc_gnuradio/

GRC needs to update the internal list of the blocks before the Frequency Shifter block can be used in a flowgraph. Click the Reload Blocks button:



There is a new category GRC Hier Blocks in the block library below Core, and the Frequency Shifter Block can be used in flowgraphs:





Using the Hier Block
The hier block can now be used in a flowgraph. Return the starting flowgraph and delete the Signal Source and Multiply blocks:



Add the Frequency Shifter Block to the workspace and connect it to the rest of the flowgraph:



Edit the Frequency Shifter Block properties by adding the samp_rate and frequency variables:



Running the flowgraph will bring up the QT GUI Frequency Sink window with the QT QUI Range slider:



Dragging the frequency slider will pass the value through the Frequency Shifter Block parameter causing the signal's center frequency to be modified:



Deleting a Hier Block
A hier block can be cleared from GRC memory by removing the files from.

In a terminal, move to the  directory:

cd /home/$USER/.grc_gnuradio

Then remove the files.

Warning! The  command cannot be undone!

For GNU Radio v3.8 the delete command is:

rm FrequencyShifter.py FrequencyShifter.py.block.yml



For GNU Radio v3.10 the delete command is:

rm FrequencyShifter.py FrequencyShifter.block.yml

Click the Reload Blocks button to update GRC's memory of blocks, clearing it of the Frequency Shifter block:



The GRC Hier Blocks category is deleted and only the Core blocks remain:



The next tutorial, Creating Your First Block, describes how to use the Embedded Python Block to create a signal processing block in GNU Radio.