gr-bokehgui: Web based display for GNU Radio
Overview
The module provides various sinks and widgets to allow interaction with the live GNU Radio applications remotely over the network. The module uses Bokeh's client API and streaming features. Using widgets and plots from Bokeh, the module enables the GUI for GNU Radio that renders in web browser. Just like gr-qtgui, it is fully integrated with GRC to allow easy use.
The module was first developed as a part of Google Summer of Code 2017 by Kartik Patel.
Dependency
- GNU Radio 3.9.5 or 3.10
- Bokeh library above 2.3.1, and below 3.0 (earlier versions cause the waterfall display to crash, and WidgetBox has been removed in later versions)
- NodeJS >= 14
- Netstat or ss to check open ports (optionnal)
Installation
Using source code
- Make sure that you have satisfied all dependency listed above.
- Clone the latest code
$ git clone https://github.com/gnuradio/gr-bokehgui.git
- Build with CMake:
$ cd gr-bokehgui/
$ mkdir build
$ cd build/
$ cmake ../
$ make
$ sudo make install
Working with the module
The complete tutorial for the module is available here. The tutorial covers setting up guide, using sinks and widgets in GRC and guide to the placement of the elements.
Quick Glance
For the following flowgraph:
The output should be as follows:
The following Youtube video provides quick glance over the module and basic procedures.
The test_bokehgui.grc example flowgraph contains all the plots and most widgets to check that everything works correctly.
Bugs reporting:
Kindly report any bugs or issues on Github.
Contributing to the project
If you want to contribute to the module, feel free to add the pull request. Please read the contribution guidelines of GNU Radio here.
Contact
For queries or feedbacks, drop a mail to discuss-gnuradio.
License
The project is licensed under GPLv3. See LICENSE for terms.