rfnoc_modtool1
Rfnoc oot module management tool
Usage
rfnoc_modtool [COMMAND]
[OPTIONS]
Overview
Create and manage RFNoC OOT modules.
Commands
Run rfnoc_modtool COMMAND --help for more information on a specific command.
- create
-
Create a new RFNoC OOT module.
- add
-
Add a new block to an existing RFNoC OOT module.
- add-gr-oot
-
Add GNU Radio OOT Module.
- add-gr-block
-
Add GNU Radio block to an existing GNU Radio OOT module.
- add-grc
-
Add GNU Radio GRC bindings for an existing block in this RFNoC OOT module.
- make-yaml
-
YAML Creation Wizard -- Generate an RFNoC block YAML descriptor file based on user input.
Creating new modules
When running rfnoc_modtool create, a new directory will be created that contains the necessary files for a new RFNoC OOT module. This directory will only contain boilerplate code, and the user will need to add their own blocks to the module.
By calling 'rfnoc_modtool add-gr-oot', the user can add a GNU Radio OOT module inside the RFNoC OOT module.
Adding blocks
When running rfnoc_modtool add, a new block will be added to an existing RFNoC OOT module. This requires previously having run rfnoc_modtool create to create the module.
Note that in order for 'rfnoc_modtool add' to succeed, the user must provide a block descriptor file in YAML format. This file describes the block and its parameters. The user can create this file manually, or use the YAML Creation Wizard by running rfnoc_modtool make-yaml. The wizard will prompt the user for the necessary information to create a valid YAML file.
Once blocks have been created, the user can add native GNU Radio blocks to enable more precise control over RFNoC blocks from GNU Radio by running 'rfnoc_modtool add-gr-block'.
To add GNU Radio GRC bindings for the blocks, call 'rfnoc_modtool add-grc'.
Examples
Create a new RFNoC OOT module called filter
rfnoc_modtool create filter cd rfnoc-filter
Use the YAML Creation Wizard to create a block descriptor file
rfnoc_modtool make-yaml
After editing the fir.yml file to describe the FIR filter block, add a block called fir to the filter module
rfnoc_modtool add fir
Now add a GNU Radio OOT module
rfnoc_modtool add-gr-oot
Add a GNU Radio block to the filter module to control the FIR RFNoC block (e.g., for better integration into the GNU Radio filter design tool)
rfnoc_modtool add-gr-block --gr-blockname rfnoc_fir fir
Expose this new block into GRC
rfnoc_modtool add-grc --binding-type native fir
Releases
2 releases since Debian 13 (Trixie); the text changed 1 time.