RoonCommandLine Contents

A brief description of the Commands, Python API scripts, and Configuration files contained in the RoonCommandLine project along with links to each.

Commands

• /usr/local/bin/roon Shell script 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.
• /usr/local/bin/clone_pyroon - Shell script to retrieve the pyroon project source code from Github and apply my patches
• /usr/local/bin/get_core_ip - Shell script to retrieve the Roon Core IP address
• /usr/local/bin/get_zone_info - Returns zones, their groupings, and their grouping compatibilities
• /usr/local/bin/get_zones - Returns comma separated list of zones
• /usr/local/bin/play_album - Shell script frontend for playing a specified album in my Roon library
• /usr/local/bin/play_artist - Shell script frontend for playing a specified artist in my Roon library
• /usr/local/bin/play_artist_album - Shell script frontend for playing a specified album by artist in my Roon library
• /usr/local/bin/play_artist_track - Shell script frontend for playing a specified track by artist in my Roon library
• /usr/local/bin/play_composer - Shell script frontend for playing a specified compoer in my Roon library
• /usr/local/bin/play_composer_album - Shell script frontend for playing a specified album by composer in my Roon library
• /usr/local/bin/play_genre_album - Shell script frontend for playing a specified album in genre in my Roon library
• /usr/local/bin/play_genre_artist - Shell script frontend for playing a specified artist in genre in my Roon library
• /usr/local/bin/play_genre - Shell script frontend to play a specified genre
• /usr/local/bin/play_playlist - Shell script frontend to play a specified playlist
• /usr/local/bin/play_radio - Shell script frontend for playing Live Radio in a Roon zone
• /usr/local/bin/play_tag - Shell script frontend to play a specified tag
• /usr/local/bin/list_albums - Search and list the available Albums in your Roon Library
• /usr/local/bin/list_artists - Search and list the available Artists in your Roon Library
• /usr/local/bin/list_artist_albums - Search and list the available Albums by Artist in your Roon Library
• /usr/local/bin/list_artist_tracks - Search and list the available Tracks by Artist in your Roon Library
• /usr/local/bin/list_composer_albums - Search and list the available Albums by a Composer in your Roon Library
• /usr/local/bin/list_composers - Search and list the available Composers in your Roon Library
• /usr/local/bin/list_genre_albums - Search and list the available Albums in a genre in your Roon Library
• /usr/local/bin/list_genre_artists - Search and list the available Artists in a genre in your Roon Library
• /usr/local/bin/list_genres - Search and list the available Genres in your Roon Library
• /usr/local/bin/list_playlists - Search and list the available Roon Playlists
• /usr/local/bin/list_radio - Search and list the available Roon Live Radio channels
• /usr/local/bin/list_tags - Search and list the available Roon Library tags
• /usr/local/bin/list_zones - List the available Roon Zones
• /usr/local/bin/set_volume - Set the volume level of a Roon Zone
• /usr/local/bin/set_zone - Set the Roon Zone in which subsequent commands will run
• /usr/local/bin/set_zone_group - Set one of the Roon Zone groupings specified in roon_api.ini
• /usr/local/bin/zone_command - Shell script frontend for commands to be issued in the selected Roon Zone (e.g. play, pause, mute, unmute, next track, previous track)

Python API scripts

• /usr/local/Roon/api/ - Python scripts to call the Roon API with appropriate arguments
• /usr/local/Roon/api/get_core_ip.py - Python script to discover the Roon Core and retrieve its IP address
• /usr/local/Roon/api/list_albums.py - Python script to list albums in the Roon Library
• /usr/local/Roon/api/list_artists.py - Python script to list artists in the Roon Library
• /usr/local/Roon/api/list_genres.py - Python script to list genres in the Roon Library
• /usr/local/Roon/api/list_playlists.py - Python script to list playlists in the Roon Library
• /usr/local/Roon/api/list_radio.py - Python script to list Live Radio channels in the Roon Library
• /usr/local/Roon/api/list_tags.py - Python script to list tags in the Roon Library
• /usr/local/Roon/api/list_zones.py - Python script to list Roon zones
• /usr/local/Roon/api/play_album.py - Python script to play specified album
• /usr/local/Roon/api/play_artist.py - Python script to play specified artist
• /usr/local/Roon/api/play_genre.py - Python script to play specified genre
• /usr/local/Roon/api/play_playlist.py - Python script to play specified playlist
• /usr/local/Roon/api/play_radio.py - Python script to play Roon Live Radio
• /usr/local/Roon/api/play_tag.py - Python script to play specified tag
• /usr/local/Roon/api/zone_command.py - Python script to execute specified command in selected zone
• /usr/local/Roon/api/zone_group.py - Python script to group zones

Configuration files

The roon command and the Python scripts it executes utilize two configuration files.

• /usr/local/Roon/etc/roon_api.ini - Python script initialization file
• /usr/local/Roon/etc/pyroonconf - Auto generated shell variables used by the RoonCommandLine commands

License, copyright, installation scripts, patches, and usage

• LICENSE - Apache License version 2.0
• NOTICE - Copyright notice
• Install - Installation script for Linux systems, Debian format install
• Uninstall - Removal script for Linux systems, Debian format uninstall
• macInstall - Installation script for Mac OS
• macUninstall - Removal script for Mac OS
• usage.txt - Frontend “roon” script usage documentation
• patches/ - Patches to the Python Roon API to extend its capabilities