search

doctorfree / RoonCommandLine

The Roon Command Line project provides Bash and Python scripts to enable command line control of the Roon audio system over a local network.
https://rooncommand.dev
Apache License 2.0
24 stars 3 forks source link
audio bash command-line linux python python-script roon shell streaming

readme

"The cosmic operating system uses a command line interface. It runs on something like a teletype, with lots of noise and heat; punched-out bits flutter down into its hopper like drifting stars. The demiurge sits at his teletype, pounding out one command line after another, specifying the values of fundamental constants of physics:

universe -G 6.672e-11 -e 1.602e-19 -h 6.626e-34 -protonmass 1.673e-27

and when he’s finished typing out the command line, his right pinky hesitates above the enter key for an aeon or two, wondering what’s going to happen; then down it comes—and the whack you hear is another Big Bang."

― Neal Stephenson, In the Beginning...Was the Command Line

Table of contents

  1. Overview
  2. Requirements
  3. Installation
    1. Debian Package installation
    2. RPM Package installation
    3. Scripted Linux installation
    4. Mac OS X installation
    5. Unattended installation
    6. Post installation configuration
      1. Zone groupings and defaults
      2. SSH public key authentication
    7. Manual installation
  4. Upgrades
  5. Remote deployment
    1. RoonCommandLine Light deployment
  6. Removal
  7. Documentation
  8. Screenshots
  9. Troubleshooting
  10. Usage
    1. Roon Terminal User Interface
    2. Introduction to Using the Command Line
    3. Voice Activated Roon Control
      1. Roon Voice Commands with Siri
      2. Roon Voice Commands with Google Assistant
  11. Motivation
    1. Why would I need or want command line control of Roon
    2. Applications
    3. History
  12. Contents

Overview

The Roon Command Line project provides Bash and Python scripts to enable command line control of the Roon audio system over a local network.

Note: No modifications are made to the Roon Core. The RoonCommandLine package resides entirely on other systems within your local area network.

Currently the command line Roon control scripts provide support for:

In addition, search capabilities have been added to the scripts with partial matching facilities. Thus a substring can be supplied to use as a search term with partial matching returning albums, artists, playlists, genres, or tags which contain the specified substring (case sensitive). The special search term __all__ indicates match all albums, artists, playlists, genres, or tags.

All commands and playback can target a specified Roon output zone.

Additional detail and info can be found in the RoonCommandLine Wiki.

Command line control of Roon may be of particular interest to Roon users running a Roon Bridge or Roon Server where there is no Roon client present on that system to control Roon. However, command line control of Roon can provide significant benefit to Roon users in any environment or deployment. See the section below, Why would I need or want command line control of Roon, for a closer look at possible motivation for command line control of Roon.

Requirements

RoonCommandLine can be installed on either Linux or Mac OS X systems. It requires a Roon Core System reachable on the local network, Bash, Python 3, and the Python Roon API. The Python Roon API will be installed as part of the RoonCommandLine installation process.

Ensure that a Roon Core System is running on the local area network and Python 3 is installed on the Linux or Mac on which you wish to install the RoonCommandLine package. Most modern Linux systems will have Python 3 already installed. A good guide for installing Python 3 on Mac OS X can be found at https://docs.python-guide.org/starting/install3/osx/ and on Linux at https://docs.python-guide.org/starting/install3/linux/

Supported platforms

RoonCommandLine has been thoroughly tested on Ubuntu Linux, Fedora Linux, macOS, and on a Raspberry Pi 4. It should work on any Linux or macOS with a modern version of Bash and Python 3. Users have reported successful installation and use of RoonCommandLine on the following platforms:

AntiX 23.1, Debian 12.5.0, Linux Mint 21.3 Cinnamon, Linux Mint 21.3 XFCE, MX 23.2, Ubuntu 24.04 Desktop, Ubuntu Studio 24.04, Xubuntu 24.04 Desktop, and Zorin OS 17.1 Core.

Tell us what you're running RoonCommandLine on and we'll add it to the list.

Installation

RoonCommandLine v2.0.0 and later can be installed on Linux systems using either the Debian packaging format or the Red Hat Package Manager (RPM). Support is also included for installing on Mac OS X and Linux variants that do not support Debian or Red Hat packages. Other systems will require a manual installation described below. The scripted Linux installation procedure may also work under Microsoft's Windows Subsystem for Linux but it is as yet untested.

Debian Package installation

Many Linux distributions, most notably Ubuntu and its derivatives, use the Debian packaging system.

To tell if a Linux system is Debian based it is usually sufficient to check for the existence of the file /etc/debian_version and/or examine the contents of the file /etc/os-release.

To install on a Debian based Linux system, download the latest Debian format package from the RoonCommandLine Releases.

Install the RoonCommandLine package by executing the command

sudo apt install ./RoonCommandLine_<version>-<release>.deb

or

sudo dpkg -i ./RoonCommandLine_<version>-<release>.deb

RPM Package installation

Red Hat Linux, SUSE Linux, and their derivatives use the RPM packaging format. RPM based Linux distributions include Fedora, AlmaLinux, CentOS, openSUSE, OpenMandriva, Mandrake Linux, Red Hat Linux, and Oracle Linux.

To install on an RPM based Linux system, download the latest RPM format package from the RoonCommandLine Releases.

Install the RoonCommandLine package by executing the command

sudo yum localinstall ./RoonCommandLine_<version>-<release>.rpm

or

sudo rpm -i ./RoonCommandLine_<version>-<release>.rpm

Scripted Linux installation

NOTE: If your Linux system supports Debian or Red Hat package format installation, it is recommended to use the latest release of the RoonCommandLine package for your platform. The scripted installation described here is intended for use on those Linux platforms that do not support Debian or Red Hat format installation packages.

RoonCommandLine requires Python 3. See the Guide to installing Python on Linux for step by step instructions to install Python 3 on Linux.

Once the Python 3 dependency is met, install RoonCommandLine by cloning the RoonCommandLine repository and executing the Install script:

    git clone `https://github.com/doctorfree/RoonCommandLine.git`
    cd RoonCommandLine
    ./Install

Note: A cleaner installation can be accomplished by executing the Install script as a user with sudo privileges, not the root user. If you are not going to enable SSH support, at least make sure the user has sudo privileges.

Mac OS X installation

RoonCommandLine requires Python 3. See the excellent Hitchhiker's Guide to Python for step by step instructions to install Python 3 on Mac OS X. If you already have Homebrew installed on your Mac then you can install Python 3 with:

brew install python

Once the Python 3 dependency is met, install RoonCommandLine by cloning the RoonCommandLine repository and executing the Install script:

    git clone `https://github.com/doctorfree/RoonCommandLine.git`
    cd RoonCommandLine
    ./Install

Note: A cleaner installation can be accomplished by executing the Install script as a user with sudo privileges and as the user which will be used to SSH in to the system. If you are not going to enable SSH support, at least make sure the user has sudo privileges.

Unattended installation

Each of the installation scenarios described above may be performed without the need for user input, an unattended installation.

To perform an unattended installation:

Post installation configuration

Default settings are applied during the installation process. The primary area of post-installation configuration is setting the ZONEGROUPS and DEFAULT values in the file /usr/local/Roon/etc/roon_api.ini. The RoonCommandLine installation attempts to automate this configuration and should have provided a good starting point with default settings in roon_api.ini but you may wish to adjust these.

Zone groupings and defaults

In Roon, you can view your existing zones by visiting Settings->Audio. The names of the enabled audio devices are your zones. You can change the name of a zone by clicking the "pencil" icon next to the name in the Roon audio settings screen.

Modify roon_api.ini with your desired zone groupings and default values. In particular, set the DefaultZone value in the DEFAULT section to a zone that will be available, enabled, and one you wish to use as your primary default fallback zone. The installation picked a DefaultZone for you and you may be satisfied with that automatic setting.

Note, the DefaultZone setting is used when no zone is specified, RoonCommandLine commands all accept a -z zone argument that can be used to specify the zone to be used as well as a -G <group> that can be used to specify the zone grouping to use.

Note also that should you change the name of a Roon audio device in the future then that name change will also need to be reflected in the roon_api.ini groupings.

SSH public key authentication

If you wish to enable remote exection of the RoonCommandLine tools then it is necessary to setup SSH public key authentication. See the Troubleshooting section below for tips on configuring SSH public key authentication. The RoonCommandLine utilities can be executed locally on the same system they are installed on by enabling local access with the roon -L command. This avoids the need to enable SSH public key authentication but restricts your use of the RoonCommandLine tools to the system on which they are installed.

Note: The roon shell script is not passing credentials in the SSH invocations. SSH authentication via public key needs to be enabled and appropriate keys generated and propogated. This topic is addressed in various guides on setting up SSH. Alternatively, the roon shell script can be installed on the same system as the Python Roon API and backend scripts. In this configuration, SSH is no longer required and the roon commands can be executed locally. In order to enable local execution rather than remote execution via SSH, run the command roon -L

Another Note: References in this document to SSH are not referring to access to the Roon Core. Rather, the SSH facility can be used to remotely access the system on which the RoonCommandLine tools are installed. All communication and access to the Roon Core is accomplished via the Roon API. No changes are ever made to the Roon Core nor is any access to the Roon Core allowed other than via the API.

Manual installation

Click here to view the **manual installation instructions** There are three components to install. First, install the Python Roon API on a system which is on the same local network as your Roon Core. Note, verify you have Python 3 and pip already installed. For example, on an Ubuntu 20.04 system I have installed, it was necessary to first configure Python 3 as the default Python executable, install pip3, and then configure pip3 as the default pip: ```bash $ sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10 $ sudo apt install python3-pip $ sudo update-alternatives --install /usr/bin/pip pip /usr/bin/pip3 1 ``` Once you have verified Python 3 and pip are installed appropriately, install the Python Roon API: ```bash $ sudo python3 -m pip install roonapi ``` **Important Note:** recent releases of Debian based systems (e.g. Ubuntu) are enforcing a requirement that Python modules are installed in a virtual environment. To install `roonapi` in a Python virtual environment, use the following commands: ```bash sudo python3 -m venv /usr/local/Roon/venv sudo /usr/local/Roon/venv/bin/python3 -m pip install roonapi ``` The second component is the Python Roon API frontend shell scripts and the Python Roon API backend Python scripts. These both get installed on the system on which the Python Roon API is installed. Copy this entire repository to the target system. Change directory into the Roon subdirectory and execute the "Install" script. This will copy the frontend shell scripts into /usr/local/Roon/bin and the backend Python scripts into /usr/local/Roon/api. For example, on the system where the Python Roon API is installed: ```bash $ mkdir -p $HOME/src $ cd $HOME/src $ git clone git@github.com:doctorfree/RoonCommandLine.git # Alternatively, download the latest release: # https://github.com/doctorfree/RoonCommandLine/releases $ cd RoonCommandLine $ ./Install # Edit the Python Roon API command line configuration file. # Several default settings are provided. You may wish to modify these. $ vi /usr/local/Roon/etc/roon_api.ini # The RoonCoreIP setting should have been configured during install. # Verify the RoonCoreIP setting is correct. # If you do not know your Roon Core IP, run the discovery script $ /usr/local/Roon/bin/get_core_ip # Authorize the extension when prompted # In a Roon Remote client window click "Settings" -> "Extensions" -> "Enable" ``` The third component is the "roon" shell script and its configuration files. These should be copied to a location in your shell execution PATH on all of the systems from which you wish to issue command line Roon controls but chose not to install the RoonCommandLine package there (see the section below on [Remote deployment](#remote-deployment)). # The username and ip address of the Python Roon API server were # configured during installation. Verify these settings in the # roon script are correct. # # Copy the "roon" script to all systems on which you wish to use # the Python Roon API command line tools, every system you want to # enable as a command line Roon remote. Each system must be able to # access the Python Roon API installed system via SSH # # If you wish to run the roon front end script on the same system on # which the Python Roon API is installed, then execute the command # "roon -L" on that system. This will enable local execution of the # Roon Command Line scripts rather than remote execution via SSH.

Upgrades

If you are upgrading from a previous version of RoonCommandLine, starting with Version 2.0.5, customizations made to /usr/local/Roon/etc/roon_api.ini will be preserved. Unfortunately, upgrading from versions prior to 2.0.5 will not preserve those customizations without some manual effort.

If you are upgrading from 2.0.4 or earlier it will be necessary to either:

or

The latter, copying roon_api.ini to /tmp/_roon_api_ini_.save, allows the upgrade to automatically preserve your customizations.

If you are upgrading from 2.0.5 or later this should not be necessary but a backup prior to upgrading is recommended anyway.

Remote deployment

Recommended deployment of the RoonCommandLine package is to install the entire package on every system from which you wish to execute Roon control commands. This deployment ensures you have all commands available without the need to configure SSH public key authentication. If you install the entire package on every system you wish to use for Roon command line control then you can disregard the following instructions on "RoonCommandLine Light" deployment.

RoonCommandLine Light deployment

Not all systems satisfy the RoonCommandLine requirement of Python 3 and Pip. On those systems that do not satisfy the Python/Pip requirement it is possible to install just the roon command and RoonCommandLine configuration files.

After copying /usr/local/bin/roon and the /usr/local/Roon/etc/ directory to the target system on which you wish to run Roon commands, perform the following setup:

sudo mkdir -p /usr/local/bin
sudo cp roon /usr/local/bin/roon
sudo chmod 755 /usr/local/bin/roon
# Edit the `server` and `user` settings near the top of the script
sudo vi /usr/local/bin/roon
sudo mkdir /usr/local/Roon
sudo mkdir /usr/local/Roon/etc
sudo cp etc/pyroonconf /usr/local/Roon/etc/pyroonconf
sudo cp etc/roon_api.ini /usr/local/Roon/etc/roon_api.ini
# Make the RoonCommandLine configuration directory writeable by your user
USER=`id -u -n`
GROUP=`id -g -n`
sudo chown -R ${USER}:${GROUP} /usr/local/Roon/etc
sudo chmod 755 /usr/local/Roon/etc
sudo chmod 644 /usr/local/Roon/etc/*

Note A "RoonCommandLine Light" deployment of this nature not only requires significant manual setup but will also require the configuration of SSH public key authentication between the target system and a system on which the RoonCommandLine package was installed. For this reason, it is recommended that deployments install the entire package on every system, eliminating the need for extensive manual configuration and SSH public key authentication.

Removal

On Debian based Linux systems where the RoonCommandLine package was installed using the RoonCommandLine Debian format package, remove the RoonCommandLine package by executing the command:

    sudo apt remove rooncommandline

or

    sudo dpkg -r rooncommandline

On RPM based Linux systems where the RoonCommandLine package was installed using the RoonCommandLine RPM format package, remove the RoonCommandLine package by executing the command:

    sudo yum remove RoonCommandLine

or

    sudo rpm -e RoonCommandLine

On Mac OS X systems, the RoonCommandLine scripts, patches, and configuration can be removed by executing the "Uninstall" script in the RoonCommandLine source directory:

    git clone git@github.com:doctorfree/RoonCommandLine.git
    cd RoonCommandLine
    ./Uninstall

Documentation

All RoonCommandLine commands have manual pages. Execute man <command-name> to view the manual page for a command. The roon frontend is the primary user interface for the RoonCommandLine commands and the manual page for roon can be viewed with the command man roon. Most commands also have help/usage messages that can be viewed with the -u argument option, e.g. roon -u.

The manual page for the primary RoonCommandLine user interface, roon, can be viewed by issueing the command:

Manual pages for each RoonCommandLine backend command can be viewed by issueing any of the following commands:

Screenshots

List tracks containing "Satin" by Artists containing "Moody"
Play first track containing "Satin" by Artists containing "Moody"

Interactive menus when invoked with no arguments

Troubleshooting

The most common difficulty encountered during initial setup of the Roon Command Line package is the configuration of public key authentication in SSH. This allows the "roon" command on your systems to execute Roon Command Line commands remotely without the need to enter credentials. There are many guides available on the Internet that provide instructions on configuring public key SSH authentication. For instance, see https://www.ssh.com/academy/ssh/command#configuring-public-key-authentication or https://serverpilot.io/docs/how-to-use-ssh-public-key-authentication/

Make sure the SSH service is running on the Python Roon API system.

Alternatively, install both the roon command and the Python Roon API on the same system and run the roon commands locally, avoiding the need for SSH. To enable local execution of the roon command line tools, issue the command:

`roon -L`

In some cases the initial installation may fail to configure the system properly. The Roon Command Line install creates two configuration files:

`/usr/local/Roon/etc/pyroonconf`

and

`/usr/local/Roon/etc/roon_api.ini`

These two configuration files are the first place to look when you encounter an issue. The /usr/local/Roon/etc/pyroonconf file contains 3 settings:

- The path to the Python User Base folder where the Python Roon API dist-packages
  directory is located
- A variable used to determine if the Python Roon API patch has been applied
- The currently active Roon Zone name used by the Roon Commmand Line

The /usr/local/Roon/etc/roon_api.ini file contains default values for album name, artist, genre, playlist, tag, and zone as well as the name of a file that contains a token used to authenticate with the Roon Core and the Roon Core IP address. Verify the settings in roon_api.ini are valid and correct. The most common issue will be an incorrect Roon Core IP address setting. You can verify this address is correct by comparing it to the value displayed in your Roon Remote window at

`Settings -> General`

under "ROON CORE".

Much of the Roon Command Line setup is automatically configured during the execution of the ./Install script. If you have some expertise in Bash scripting you can examine this script to see what commands were issued.

Another area that may be causing problems is the installation of the Python Roon API package and its ability to communicate with your Roon Core. To debug problems I have found it useful to SSH in to the system running the Python Roon API package and run commands by hand there. For example, rather than running "roon -l zones" command which remotely runs the list_zones command, SSH in as the configured user and run:

    cd /usr/local/Roon/api
    python list_zones.py -z all

This eliminates SSH and remote execution as well as the intermediate shell script used to execute the python script. Similar python commands can be issued directly on the Python Roon API system in the /usr/local/Roon/api directory.

Verify that the "roon" frontend command shell script has been configured properly. Open the roon shell script in an editor and find the two lines near the top of the file that set the "server" and "user" shell variables. Verify that the "server" variable is set to the correct IP address of the Python Roon API server and that the "user" variable is set to the username used in the SSH commands to execute the Python commands on the Python Roon API server. These should have been set for you automatically during the installation process but may have been misconfigured.

Usage

Note: The first time you execute the roon command you may have to enable the Python Roon API extension by clicking "Settings" -> "Extensions" -> "Enable" in a Roon Remote client window. On most systems this will not be necessary as this was performed during initial installation.

The Python Roon API scripts must be installed on a system that is on the same local network as the Roon Core. The roon shell script is the primary user interface. It accepts a wide variety of arguments and sends a command to the Python Roon API system which then communicates with the Roon Core.

If no arguments are provided to the roon command then an interactive dialog is presented from which the user can select commands and queries.

Click here to view the **roon command usage message** ``` Usage: roon -A album -a artist -C composer -D destination zone -m -n -N -O -F [from zone] -f [on|onlog|off|status] -g genre -G zone_group -i -I -l [albums|artists|artalbums|albtracks|arttracks|composers|comalbums| genres|genalbums|genartists|playlists|playtracks|tags|zones] -c [group|ungroup|play|play_all|pause|pause_all|stop|stop_all| next|previous|shuffle|unshuffle|repeat|unrepeat|mute|mute_all] -s search -p playlist -T track -t tag -z zone -L -S -r radio -X ex_album -x ex_artist [-EuU] Where: -A album selects an album to play -a artist selects an artist to list/play -B installs the Roon Community GUI -b opens the Roon Community GUI -C composer selects a composer to play -D 'destination zone' specifies the zone to transfer current queue to -F 'from zone' specifies the zone to transfer from (default: last played) -g genre selects a genre to list/play -i displays zone information (combine with '-z zone' for extended info on a specified zone, otherwise display info on all zones) -I installs the Roon TUI terminal user interface for Roon and exits -f [on|onlog|off|status] enables/disables fading/logging in specified zone 'on' enables fading, 'onlog' fading and logging, 'off' disables fading (combine with '-z zone' for 'fading' in that zone) -m indicates show the RoonCommandLine menu -n displays 'now playing' information for zones actively playing -N displays 'now playing' information for all zones (combine with '-z zone' for 'now playing' in only that zone) -O opens 'Roon TUI' terminal user interface for Roon if available -p playlist selects a playlist to play -G zone_group specifies a zone grouping specified in roon_api.ini -L setup roon to execute local commands rather than remote via SSH -S Set Roon defaults in roon_api.ini -l [albums|artists|artalbums|albtracks|arttracks|composers|comalbums| genres|genalbums|genartists|playlists|playtracks|tags|zones] indicates list albums, artists, albums by artist, composers, albums by composers, genres, albums in genre, artists in genre, playlists, tags, or Roon zones -r radio selects a live radio stream to play -s search specifies a term to search for in the lists retrieved with -l -T track specifies a track to play -t tag selects an tag to play -z zone selects the Roon Zone in which to play -c [group|ungroup|play|play_all|pause|pause_all|playpause|stop|stop_all| next|previous|shuffle|unshuffle|repeat|unrepeat|mute|mute_all] issues the command in the selected zone 'mute' toggles the zone's muted or unmuted state 'mute_all' toggles all zones' muted or unmuted state 'pause_all' pauses playback in all zones 'play_all' begins playback in all zones 'stop_all' stops playback in all zones and releases devices 'shuffle' enables the zone's shuffled setting 'unshuffle' disables the zone's shuffled setting 'repeat' enables the zone's looping setting 'repeat' disables the zone's looping setting -v volume sets the volume level in the selected zone The volume argument has the format [g:][r:][s:]num Where 'g' indicates set volume for all zones in the group 'r' specifies use relative method volume setting 's' specifies use relative_step method volume setting 'num' can be absolute, relative, and negative or positive -X ex_album specifies a string to exclude from album/genre names -x ex_artist specifies a string to exclude from artist/composer/playlist names -u displays a full usage message with examples -U displays a usage message without examples -E displays examples with no usage message Combine '-a artist' and '-A album' to play an album by a specified artist Combine '-a artist' and '-T track' to play a track by a specified artist Combine '-a artist' or '-A album' with '-g genre' to play an artist or album in a specified genre Special search term '__all__' matches all entries Special name 'default' plays the default setting in roon_api.ini ```
Click here to view the **roon command example invocations** ``` Example invocations Play artist: roon -a "Deep Purple" Play album by artist: roon -a "Deep Purple" -A Burn Play track by artist: roon -a "Aretha Franklin" -T Think Play artist in specified zone: roon -a "Jethro Tull" -z "Mac Pro DAC" Play genre: roon -g Classical Play default live radio: roon -r default Play playlist: roon -p "Bowie Favs" Play next track: roon -c next Stop play in specified zone: roon -c stop -z Kitchen Mute/Unmute a specified zone: roon -c mute -z "Mac Pro DAC" Mute/Unmute all zones: roon -c mute_all List all playlists containing the string 'Best': roon -l playlists -s Best List albums by artist: roon -l artalbums -a "Deep Purple" List artists containing the string 'Will' in the 'Country' genre: roon -l genartists -a Will -g Country List albums containing the string 'Magic' in the 'Rock' genre: roon -l genalbums -A Magic -g Rock Play artist containing the string 'Willie' in the 'Country' genre: roon -a Willie -g Country Play album containing the string 'Magic' in the 'Rock' genre: roon -A Magic -g Rock Group the zones listed in roon_api.ini Group_foobar: roon -G foobar -c group Set the volume level to 50 in the currently active zone roon -v 50 Decrease the volume level by 10 in the currently active zone roon -v r:-10 Set the volume level to 40 in all zones grouped with the zone named 'Mac Pro DAC' roon -v g:40 -z 'Mac Pro DAC' Increase the volume level by 20 in all zones grouped with the zone named 'Mac Pro DAC' roon -v g:r:20 -z 'Mac Pro DAC' Get info on all Roon zones roon -i Get extended info on Roon zone named 'Mac Pro DAC' roon -i -z 'Mac Pro DAC' Get now playing info on all zones regardless of state roon -N Get now playing info on all zones actively playing roon -n Get now playing info on Roon zone named 'Mac Pro DAC' roon -n -z 'Mac Pro DAC' Enable volume fading in default Roon zone roon -f on Disable volume fading in default Roon zone roon -f off NOTE: Use quotes to specify media names which contain spaces. For example, to play the album 'Love Bomb': roon -A "Love Bomb" ```

When playing media from the command line it is possible to specify a substring with which a partial match can be made. In order to play media, either the full name of the desired media or enough of a substring to uniquely match should be supplied. This applies to playing an album, artist, composer, genre, playlist, or tag. For example, the command "roon -a Tull" would play media by artist "Jethro Tull" unless there were multiple artist name matches to the substring "Tull". All partial matching is case sensitive - "roon -a tull" would not match "Jethro Tull".

If multiple matches are found, the first match in the list is played. To narrow a search, exclusion filtering can be performed. Use the -x string argument to specify an exclusion substring for artist, composer, and playlist library searches. Use the -X string argument to specify an exclusion substring for album and genre library searches.

In a large Roon library where multiple matches may be frequent and large, one approach is to first list the media you wish to play and based on the list of matches returned construct exclusion arguments that narrow the matches to a list whose first element is the media you wish to play. For example:

roon -l genalbums -g Classical -A Mozart

might return the following:

Albums in Classical genre with Mozart in name :

Berliner Philharmoniker plays Mozart Bruch: Violin Concerto No. 1, Op. 26 - Mozart: Violin Concerto No. 1, K. 207 Mozart: Concertos For Two Pianos K 242 & 365; Kozeluch: Four Hands Piano Concerto Mozart - Great Recordings Resonances (Mozart, Berg, Liszt, Bartok, Gluck)

If you tried to play media using these arguments then the first in the list would be played - "Berliner Philharmoniker plays Mozart". But you want to play the second one performed byy Bruch. This can be accomplished either by modifying the album search term or by using an album exclusion filter:

roon -l genalbums -g Classical -A Mozart -X Berliner

would list the "Violin Concerto No. 1, Op. 26" by Mozart fist. Alternately,

roon -l genalbums -g Classical -A "Mozart: Violin"

would also list the concerto first. Another search route for this album would be by searching albums by composer rather than albums by genre:

roon -l comalbums -C Mozart -A "Violin Concerto"

Listing/playing media in the Roon Library "Composers" category searches the entire Roon database of available Composers rather than limiting the search to the albums or artists etc in your library. This opens up a pretty wide search field of composers and their works.

Finally, to play the media you have located using one of the listing techniques described above, simply re-run the same command used to list the media only remove the -l <listingtype> arguments. For example, if the listing command:

roon -l genalbums -g Classical -A Mozart -X Berliner

produced a search result to your liking and you now wish to play the first entry in that returned list, remove the -l genalbums argument and re-run the command:

roon -g Classical -A Mozart -X Berliner

Any listing command can be turned into a play command in a similar manner.

Roon Terminal User Interface

Beginning with RoonCommandLine version 2.1.2 support for the Roon TUI terminal user interface for Roon is included in RoonCommandLine. The roon-tui command can be installed with the roon command and act as a lightweight Roon Remote for the terminal.

The Roon TUI project is maintained by TheAppgineer organization, authors of the Roon Extension Manager. Roon TUI uses its own developed Rust port of the Roon API.

Roon TUI installation and use

Roon TUI can be installed with the command roon -I and opened with the command roon -O. The RoonCommandLine menu interface can also be used to install and open roon-tui.

The RoonCommandLine installation of roon-tui installs the binary as ~/.local/bin/roon-tui or /opt/homebrew/bin/roon-tui on macOS.

RoonCommandLine includes a front-end wrapper for roon-tui, installed as /usr/local/Roon/bin/roontui which serves to locate the roon-tui configuration file and log in ~/.config/roon-tui/.

The roon-tui terminal user interface for Roon can be executed either with the wrapper, roontui or with roon -O. Executing roon-tui directly will attempt to use and write the configuration and log files in the directory where roon-tui is located. Recommended usage is either with roontui or, if no options are required, roon -O.

The roontui wrapper usage message:

Usage: roontui [OPTIONS]
Options:
  -b, --binary <BINARY>     Path to the roon-tui binary
  -c, --config <CONFIG>     Path to the config.json file
  -i, --ip <IP>             IP address of the Server, disables server discovery
  -p, --port <PORT>         Port number of the Server [default: 9330]
  -l, --log <LOG>           Path to the log file
  -v, --verbose             Enable verbose logging to file
  -u, --no-unicode-symbols  Disable the use of Unicode symbols
  -U, --upgrade             Upgrade roon-tui if a newer version is available
  -h, --help                Print help
  -V, --version             Print version

Defaults:
  Binary location:          ~/.local/bin/roon-tui
  Configuration location:   ~/.config/roon-tui/config.json
  Log file location:        ~/.config/roon-tui/roon-tui.log

Roon TUI Upgrades

Roon TUI can be upgraded with the command roontui -U.

Authorizing Roon TUI Core Access

On first execution the outside border of the UI will be highlighted without any views active, this indicates that pairing with a Roon Core has to take place. Use your Roon Remote and select Settings→Extensions from the hamburger menu and then Enable Roon TUI.

Roon TUI Key Bindings

Global (useable in all views)
Tab Switch between views
Shift-Tab Reverse switch between views
Ctrl-z Open zone selector
Ctrl-g Open zone grouping
Ctrl-Space, Ctrl-p Play / Pause
Ctrl-e Pause at End of Track
Ctrl-↑ Volume up
Ctrl-↓ Volume down
Ctrl-→ Next track
Ctrl-← Previous track
Ctrl-q Toggle through Queue Modes
Ctrl-a Append tracks according Queue Mode
Ctrl-h Open help screen
Ctrl-c Quit
Common list controls
↑ Move up
↓ Move down
Home Move to top
End Move to bottom
Page Up Move page up
Page Down Move page down
Browse View
Enter Select
Esc Move level up
Ctrl-Home Move to top level
F5 Refresh
a...z Multi-character jump to item
Backspace Step back in multi-character jump
Queue View
Enter Play from here
Now Playing View
m Mute
u Unmute
+ Volume up
- Volume down
r Toggle Repeat
s Toggle Shuffle
Zone Select Popup
Enter Select Zone
Esc Back to previous view
Delete Delete inactive preset
Zone Grouping Popup
Space Add or remove output from group
Enter Activate Grouping
s Save as preset
Esc Back to previous view
Text Input
Enter Confirm input
Esc Cancel input

Introduction to Using the Command Line

The command line has a long and storied history in computing. Read some of that history, learn how to open a command line terminal window on various systems, how to get started using the command line, and see some examples of why the command line interface is so powerful by reading the RoonCommandLine wiki article Introduction to Using the Command Line.

This introduction to the command line includes an example of how to automate playback of Roon playlists in specified Roon zones at designated times of day.

Voice Activated Roon Control

RoonCommandLine can be used to provide a command line interface for the remote execution of commands via SSH or other facilities such as Google Assistant. In this way, voice control of Roon can be implemented on mobile devices or other "smart" devices. Example implementations using Apple Siri and Google Assistant are described in the following RoonCommandLine Wiki articles.

Roon Voice Commands with Siri

The RoonCommandLine Wiki article "Roon Voice Commands with Siri" describes in detail how to setup Roon voice commands using Apple Shortcuts on an iOS device. This method utilizes Siri to recognize the voice commands and run the Shortcut which uses SSH to execute the command.

Roon Voice Commands with Google Assistant

The RoonCommandLine Wiki article "Roon Voice Commands with Google Assistant" describes in detail how to setup Roon voice commands using the MMM-GoogleAssistant and MMM-Detector modules on a MagicMirror. This method utilizes Google Assistant recipes to control Roon with voice commands.

Motivation

Why would I need or want command line control of Roon

One might reasonably ask "Why would I need or want command line control of my Roon audio system"? Truth be told, most Roon users do not need or want command line control of Roon or any other software. They are happy with the graphical user interfaces they use and never ever see a command line prompt. So the answer to that question is almost always "You don't".

However, some users (mostly old propeller head codgers) are comfortable at the command line and prefer to use it over the tedious mouse clicks required to get anything done in a graphical user interface. Different lanes for different brains.

I would say the most significant use case for command line control of anything is automation. For example, if I want to schedule playback of specified music in specific zones triggered by some event, then command line control can be used to implement this. That can be done via Cron jobs, play something in some zone at scheduled times. Or playback of specified songs in selected zones could be triggered by some event like when a particular face is recognized by my smart mirror or when my smart lights are turned to a particular profile. I use command line control of Roon coupled with Apple Siri voice commands that trigger an SSH shortcut to run the command. There are many use cases for automation using command line utilities.

The other main use case for command line control is simple convenience. If you spend a lot of time in a Shell environment then it is just easier to type a command that plays what you would like to hear where you want to hear it than it is to switch windows, bring up a GUI, click a few times to find what you want, and click to play it, then go back to your terminal window and Shell env. Most people do not live in a Shell environment like I do so this use case is not that significant.

Finally, the command line interface and the associated Roon API can provide capabilities not available in the Roon GUI. Searching, listing, and filtering can be augmented by the plethora of tools available in a typical Shell environment. You can pipe the output of a Roon command to grep, sed, awk, and other standard utilities to produce results unavailable in the GUI. That is, command line control along with the API and Shell utilities/builtins can extend the capabilities of the Roon audio system. The RoonCommandLine package also enables some features not easily available in the Roon GUI. One of these, preconfigured Zone Grouping, allows the RoonCommandLine user to easily and quickly switch between any of the preconfigured zone groupings in /usr/local/Roon/etc/roon_api.ini. Yes, you can change the zone grouping in Roon but it takes quite a few actions on the user's part to accomplish this. In my household I find it frequently desirable to be able to switch zone groupings easily and quickly and I can do so by configuring these presets to my typical use cases. Another feature of RoonCommandLine not easily found in the Roon GUI is the ability to search the Roon Database for tracks by an artist and other combinations of search filters. While the Roon GUI has an exceptional filtering mechanism, try doing a search for all tracks containing the string "Love" by the artists with name containg the string "Beatles". It's quick and easy to do with a single RoonCommandLine command.

Applications

Stream Spotify from a Raspberry Pi into Roon

Roon Community Moderator, René, describes how to stream Spotify from a Raspberry Pi into Roon as a Live Radio station in a Roon Community Forum Post. The setup integrates the HQPlayer up-sampling media player with the Roon Entrypoints extension, RoonCommandLine, and Apple Shortcuts turning a spare Pi into an audio web stream that Roon can take in as a Live Radio station. Pretty incredible and fairly easy.

Note that the expensive component in this setup is HQPlayer which is only needed for its up-sampling and not required.

History

This project began as an attempt to control Roon with Siri voice commands. Several users had posted in the Roon forums various ways to use Siri to control Roon. These usually took the form of a fake device in HomeBridge that then communicates with HomeKit and Siri. This seemed cool but maybe overkill. I was able to get Siri voice control of Roon working with simple SSH shortcuts that execute Python scripts which utilize the Roon API to control Roon.

Apple SSH shortcuts can be used to execute commands on systems that allow SSH access. I used an Ubuntu 20.10 system recently installed to install the Python Roon API project (pip install roonapi) and quickly cobbled together a Python script based on one of the examples in that project. The Python script accepts an argument specifying an artist name in my Roon library. It then uses the Roon API to play music from my library by that artist in the specified zone.

On my iPhone I then created shortcuts which use the “Run script over SSH” option for Apple Scripting shortcuts. The shortcuts execute a Bash command which is a shell script that executes the Python script with appropriate arguments. It all seems to work. I did run into a few gotchas. It seems with current Python/Pip installs you need to specify an environment variable telling Python where the Pip modules are located. So I needed a login shell to pick that up but I could not figure out how to tell the Apple shortcut to give me an SSH login shell. The Python env variable is set in the shell script the SSH session executes.

Currently this project has morphed primarily into a set of command line tools to control various aspects of Roon remotely. There is still the capability to augment this command line control with Siri voice commands that trigger an Apple Shortcut which executes a command via SSH. But what we have here in the repository are the command line tools.

RoonCommandLine v2.0.0 introduced Debian and RPM format package installation accompanied with extensive automated configuration. In most environments, deployment of this package will require little to no manual configuration.

Contents

roon - Frontend that provides the primary user interface to communicate commands via the Python Roon API. Recommended usage is to issue Roon commands and queries via the roon frontend rather than executing the following commands directly.

get_core_ip - Retrieve the Roon Core IP address

get_zone_info - Retrieve zone information

get_zone_remaining - Get remaining play time in zone

get_zones - Get zones

get_zone_volume - Get volume in zone

play_album - Frontend for playing a specified album in my Roon library

play_artist - Frontend for playing a specified artist in my Roon library

play_artist_album - Play album by artist

play_artist_track - Play track by artist

play_composer - Play composer

play_composer_album - Play album by composer

play_genre_album - Play album in genre

play_genre_artist - Play artist in genre

play_genre - Frontend to play a specified genre

play_playlist - Frontend to play a specified playlist

play_radio - Frontend for playing Live Radio in a Roon zone

play_tag - Frontend to play a specified tag

play_track - Frontend to play a specified track

list_albums - Search and list the available Albums in your Roon Library

list_artists - Search and list the available Artists in your Roon Library

list_artist_albums - List albums by artist

list_artist_tracks - List tracks by artist

list_composer_albums - List albums by composer

list_composers - List composers

list_genre_albums - List albums in genre

list_genre_artists - List artists in genre

list_playlist_tracks - List tracks in playlist

list_genres - Search and list the available Genres in your Roon Library

list_playlists - Search and list the available Roon Playlists

list_radio - Search and list the available Roon Live Radio Stations

list_tags - Search and list the available Roon Library tags

list_zones - List the available Roon Zones

now_playing - Display currently playing track in zone or all zones

roon_fade - Enable/disable volume fade out and fade in for tracks in zone

set_volume - Set the volume level of selected Roon Zone

set_zone - Set the Roon Zone in which subsequent commands will run

set_zone_group - Set one of the Roon Zone groupings specified in roon_api.ini

zone_command - Frontend for commands to be issued in the selected Roon Zone (e.g. play, pause, pause_all, mute, mute_all, next track, previous track)

LICENSE - Apache License version 2.0

NOTICE - Copyright notice

Install - Installation script

Uninstall - Removal script

macInstall - Installation script for Mac OS (called from Install)

usage.txt - Frontend "roon" script usage documentation

api/ - Python scripts to call the Roon API with appropriate arguments

patches/ - Patches to the Python Roon API to extend its capabilities

Connect

ronrecord.com doctorfree | YouTube ronrecord | Twitter ronrecord | LinkedIn doctorfree | Instagram doctorfree | Mastodon