https://github.com/geontech/gr-component_converter
GNURadio GRC to REDHAWK SDR Component conversion tooling
https://github.com/geontech/gr-component_converter
gnuradio redhawk
Last synced: 4 months ago
JSON representation
GNURadio GRC to REDHAWK SDR Component conversion tooling
- Host: GitHub
- URL: https://github.com/geontech/gr-component_converter
- Owner: Geontech
- License: gpl-3.0
- Created: 2017-08-28T17:06:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-15T14:51:38.000Z (almost 6 years ago)
- Last Synced: 2025-01-21T12:48:44.056Z (over 1 year ago)
- Topics: gnuradio, redhawk
- Language: Python
- Size: 109 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GRC to REDHAWK Component Converter
This tool ingests a GNURadio Flow Graph (GRC XML) and outputs a custom REHDAWK Component capable of representing variables and data stream ports using Properties and BULKIO Ports, respectively. The Component can then be included in an arbitrary Waveform and deployed into a network-distributed REDHAWK Domain.
## Flow Graph Requirements
1. Remove and/or disable all UI elements from the Flow Graph. If you **must** have a display output for a data stream, consider using a `redhawk_sink` block and the plotting capabilities in REDHAWK SDR's IDE or using a web-based solution such as Geon's [REST-Python][rest-python] or REDHAWK SDR's [Enterprise Integration][rei] and a suitable web UI front end.
2. Replace any hardware-specific blocks for data ingress and egress with `redhawk_source` and `redhawk_sink` blocks.
## Tool Requirements
This tool requires that all of the following be installed wherever this tool is run:
1. REDHAWK SDR 2.2.1
2. GNURadio 3.7.13
3. [GNURadio REDHAWK Integration][gr-ri]
## Installation
Install the `gr_flowgraph` REDHAWK Component Template using the associated Makefile:
```
sudo make install
```
This will load the template into the `OSSIEHOME` Python package for the REDHAWK SDR Code Generator.
## Usage
Assuming your Flow Graph has been configured to [meet the requirements](#flow-graph-requirements), conversion to a REDHAWK Component project is a single step:
```
./converter/run.py ./path_to/my_flowgraph.grc [./path_to_component]
```
The location where to store the Component definition is optional; its default is the current working directory.
> **Pybombs Users:** Source your `setup_env.sh` script before running the converter as it requires `PYTHON_PATH` to include your GNURadio installation.
## Deployment
You can then deploy (install) the Component to the `SDRROOT` as one would any typical REDHAWK Component:
```
cd COMPONENT_DIRECTORY
./build.sh
./build.sh install
```
> **Note:** The above assumes that the user running the commands is a member of the `redhawk` group so that the user has write access to the `SDRROOT`.
> **Important:** The above depends extensively on your deployment scheme. See the [GNURadio REDHAWK][gr-rh] project for more information.
[gr-rh]: https://github.com/GeonTech/gnuradio-redhawk
[gr-ri]: https://github.com/GeonTech/gr-redhawk_integration
[rest-python]: https://github.com/GeonTech/rest-python
[rei]: https://github.com/RedhawkSDR/enterprise