Volumio Plugin Manager 1.1.6

Manage Volumio plugins through Socket.IO from the command line.

Tested with:

• Volumio 3.x and 4.x on Raspberry Pi
• miniDSP SHD running Volumio 3.x

Requirements

• Python 3.8 or later
• Network access to the Volumio device
• The python-socketio package

Installation

Create and activate a virtual environment (recommended):

python3 -m venv .venv
source .venv/bin/activate

Install the required package:

pip install "python-socketio[client]"

Save volumio_plugin_manager.py in the current directory, then verify the available commands:

python volumio_plugin_manager.py --help

Connecting to a Volumio device

The default device address is http://volumio.local:3000.

Use --host to connect to another device:

python volumio_plugin_manager.py --host http://volumio2.local:3000 --list

List plugins

List the plugins installed on the target device and the plugins offered by its catalog:

python volumio_plugin_manager.py --list

The available catalog is filtered by the target device. For example, a MiniDSP SHD only receives plugins that Volumio declares compatible with its minidspshd/buster/armhf variant.

To view the standard Raspberry Pi catalog, query a Raspberry Pi Volumio device:

python volumio_plugin_manager.py \
  --host http://volumio.local:3000 \
  --list

Display plugin information

Show the installed version, available version, selected variant, and download URL:

python volumio_plugin_manager.py --info calmradio

Install a catalog plugin

Install a plugin from the catalog of the target device:

python volumio_plugin_manager.py --install calmradio

The script automatically selects the best available variant. It prioritizes the MiniDSP SHD Buster variant, then the standard Volumio Buster variant.

Enable a plugin

Enable an installed but disabled plugin:

python volumio_plugin_manager.py --activate calmradio

The command waits for Volumio to confirm that the plugin is enabled.

Install a plugin from a ZIP URL

Install a Volumio plugin ZIP archive hosted outside the official catalog:

python volumio_plugin_manager.py --install-url "https://example.org/my_plugin.zip"

The ZIP file name is used as the plugin name. For example, radio_paradise.zip is installed as radio_paradise.

Only install archives from trusted sources. A Volumio plugin may execute its bundled installation script on the player.

Radio Paradise historical archive

Install the historical Radio Paradise archive:

python volumio_plugin_manager.py --install-url \
  "https://raw.githubusercontent.com/volumio/volumio-plugins/ea1e832f049f10ed0903c06c654510dae787dc34/plugins/volumio/armhf/music_service/radio_paradise/radio_paradise.zip"

Then enable it:

python volumio_plugin_manager.py --activate radio_paradise

Install a specific platform variant

Some plugins are available for the standard Raspberry Pi Volumio platform but are not listed in the MiniDSP SHD catalog. If a plugin is compatible with standard Buster ARMHF, install that explicit variant:

python volumio_plugin_manager.py \
  --install-variant radio_paradise \
  --variant volumio/buster/armhf

Then enable it:

python volumio_plugin_manager.py --activate radio_paradise

Use explicit variants carefully. A plugin can depend on hardware-specific drivers or system packages and may not work on every device.

Restart a plugin

python volumio_plugin_manager.py --restart calmradio

Update a plugin

Update a plugin when a newer version is available in the target device catalog:

python volumio_plugin_manager.py --update calmradio

Remove a plugin

python volumio_plugin_manager.py --remove calmradio

Debugging

Show diagnostic messages:

python volumio_plugin_manager.py --list --debug

Show the complete Socket.IO data received from Volumio:

python volumio_plugin_manager.py --list --debug-json

Use --debug-json when a command does not complete or a plugin does not appear in the catalog. It is possible to combine the --debug and --debug-json commands for even more detailed output.