| layout | title | permalink |
|---|---|---|
page |
OpenWebRX+ Plugins Home |
/ |
OpenWebRX+ Plugins is a community-driven collection of plugins that extend OpenWebRX+ with new features, UI enhancements, and integrations for SDR receivers.
This repository provides a set of plugins for OpenWebRX+, allowing users to customize and enhance their SDR experience. Plugins are grouped into:
- Receiver Plugins: Enhance the receiver UI and add new features.
- Map Plugins: Add new layers or features to the map interface.
Each plugin is documented in its own folder.
- Find your
htdocsfolder and set a helper variable:
export OWRX_FOLDER=$(dirname "$(find / -name openwebrx.js 2>/dev/null | head -n1)")- Create the folders and download the
init.jssample file:
mkdir -p "$OWRX_FOLDER/plugins/receiver"
cd "$OWRX_FOLDER/plugins/receiver"
wget https://0xaf.github.io/openwebrxplus-plugins/receiver/init.js.sample -O init.js- Edit the
init.jsfile and load the desired plugins:
${EDITOR-nano} init.js- Keep the top two
Plugins.loadlines (utils, notify). They are shared dependencies. Add or remove names inPluginsToLoadto pick which plugins you want. - Refresh the OpenWebRX+ page to see the changes. If nothing changes, restart varnish/nginx as noted below.
| Name | Description |
|---|---|
| freq_scanner | Adds a frequency scanner)(Joerg) |
| smeter | Show S-Meter (needs calibration!)(Joerg) |
| search_bookmarks | Search all OWRX bookmarks and click to tune (Yannis) |
| toggle_scannable | Toggle the scannable state of bookmarks with right mouse button |
| tune_precise | Add buttons for precise frequency tuning (LZ2DMV) |
| mouse_freq | Show frequency under cursor on the waterfall |
| doppler | Track Doppler shift/effect of satellites |
| magic_key | Set MagicKey without typing it in the browser's address bar |
| screenshot | Take screenshot of the waterfall |
| screen_reader | Provide spoken notifications for accessibility |
| antenna_switcher | Antenna switching for Raspberry Pi devices (LZ2DMV) |
| tune_checkbox | Enable mouse-scroll to zoom by default (LZ2DMV) |
| frequency_far_jump | Jump to a frequency outside the current profile (LZ2DMV) |
| (deprecated) Add keyboard shortcuts | |
| colorful_spectrum | Colorize the spectrum analyzer |
| connect_notify | Send/receive notifications on user connect/disconnect |
| sort_profiles | Sort profiles by name |
| utils | Utility plugin, required by many plugins |
| notify | Notification utility plugin |
| example | Example plugin for developers |
| example_theme | Example theme plugin for developers |
| Name | Description |
|---|---|
| (deprecated) Add Maidenhead (QTH) grid to the map |
| Name | Description |
|---|---|
| owrxantswitcher | Switch antenna ports using a WebAPI on the server. |
-
Find your OpenWebRX+
htdocsfolder
Use the following command to locate it:find / -name openwebrx.js
-
Typical locations for
htdocs:/opt/openwebrx/htdocs/usr/lib/python3/dist-packages/htdocs
-
Create the plugins folders if they doesn't exist
mkdir -p /path/to/htdocs/plugins/{receiver,map} -
Create or edit the
init.jsfile inside the coresponding plugin type folder (receiver or map)
Use the provided templates: -
Add plugin loading lines to your
init.jsfile if you're not using the provided init.js - see Beginner Quickstart
Use the async pattern so dependencies load first:(async () => { await Plugins.load('https://0xaf.github.io/openwebrxplus-plugins/receiver/utils/utils.js'); await Plugins.load('https://0xaf.github.io/openwebrxplus-plugins/receiver/notify/notify.js'); await Plugins.load('https://0xaf.github.io/openwebrxplus-plugins/receiver/tune_precise/tune_precise.js'); })();
-
Raspberry Pi:
If using Raspberry Pi images, a caching service (varnish) may prevent plugins from loading immediately after editinginit.js.
Restart services to clear cache:sudo systemctl restart varnish nginx
-
Docker:
For Docker images (openwebrxplus), bind-mount the plugins folder and follow the above instructions. See Docker image documentation for details.
If you want to create new plugins:
- Get familiar with the OWRX+ JS codebase.
- Review the example plugin and example theme plugin.
- Develop plugins locally in
$OWRX_FOLDER/plugins/{type}/your_plugin/. - Load local plugins by folder name:
Plugins.load('your_plugin'); - Load remote plugins by URL (example for map plugin):
Plugins.load('https://0xaf.github.io/openwebrxplus-plugins/map/layer_qth_maidenhead/layer_qth_maidenhead.js');
- Each plugin lives in
plugins/{receiver|map}/plugin_name/and has a matching JS entry fileplugin_name.js. Plugins.<name>.init()must returntrueon success; returnfalse(or nothing truthy) to abort when a prerequisite is missing.- Set
_version(for dependency checks) andno_css = trueif you do not want the loader to fetchplugin_name.cssautomatically. - By default, the loader tries to load a sibling CSS file after the JS. If you ship CSS, leave
no_cssunset. - Load dependencies explicitly with
await Plugins.load('dependency')before loading plugins that need them.
To host plugins on GitHub, use GitHub Pages for correct JS Content-Type.
Contributions are welcome!
- Submit pull requests, providing the same structure for the folders as the rest of the plugins.
- For major changes, open an issue first to discuss.
- Please follow the style of existing plugins and documentation.
Use these plugins at your own risk. No warranty is provided.
For support, contact LZ2SLL or join the OWRX+ Telegram Chat.
Q: My plugin changes are not visible after editing init.js.
A: If using Raspberry Pi images, restart varnish and nginx as described above.
Q: Where do I put my local plugins?
A: In the htdocs/plugins/receiver or htdocs/plugins/map folder of your OpenWebRX+ installation.
Q: How do I load a plugin from a URL?
A: Use Plugins.load('https://.../plugin_name/plugin_name.js'); in your init.js.
This project is licensed under the MIT License.