Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gnuradio/gr-bokehgui
Web based display for GNU Radio applications
https://github.com/gnuradio/gr-bokehgui
bokeh gnuradio hacktoberfest
Last synced: 3 months ago
JSON representation
Web based display for GNU Radio applications
- Host: GitHub
- URL: https://github.com/gnuradio/gr-bokehgui
- Owner: gnuradio
- License: gpl-3.0
- Created: 2017-05-05T06:27:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-30T09:08:16.000Z (5 months ago)
- Last Synced: 2024-07-09T20:19:54.687Z (4 months ago)
- Topics: bokeh, gnuradio, hacktoberfest
- Language: C++
- Homepage:
- Size: 784 KB
- Stars: 78
- Watchers: 7
- Forks: 25
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docs.bokeh.org/en/2.4.2/)'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
1. GNU Radio 3.9.5 or 3.10
2. [Bokeh library above 2.3.1, and below 3.0](https://docs.bokeh.org/en/2.3.2/) (earlier versions cause the waterfall display to crash, and WidgetBox has been removed in later versions)
3. NodeJS >= 14
4. Netstat or ss to check open ports (optionnal)
## Installation
### Using source code
1. Make sure that you have satisfied all dependency listed above.
2. Clone the latest code
```
$ git clone https://github.com/gnuradio/gr-bokehgui.git
```
3. Build with CMake:
```
$ cd gr-bokehgui/
$ mkdir build
$ cd build/
$ cmake ../
$ make
$ sudo make install
```
If you're running Linux, then always remember to do the following command after installing any library:
```
$ sudo ldconfig
```
## Working with the module
The complete tutorial for the module is available [here](http://kartikpatel.in/GSoC2017/tutorial/). 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.
[](https://www.youtube.com/watch?v=EyNOE9icNVc)
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](https://github.com/gnuradio/gr-bokehgui/issues/).
## 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](https://wiki.gnuradio.org/index.php/Development).
## Contact
For queries or feedbacks, drop a mail to [discuss-gnuradio](mailto:[email protected]).
## License
The project is licensed under GPLv3. See LICENSE for terms.