snapcastr 0.2.0

webinterface to control a snapcast server

snapcastr

Snapcastr is a webinterface to control a snapcast server.

It is written in python with flask, wtforms and python-snapcast

• python 3
• flask
• wtforms
• python-snapcast

getting started

install requirements

use your package manager, e.g. apt or pacman and install

• python3
• poetry

install

get source

$ git clone https://github.com/xkonni/snapcastr

install locally

$ cd snapcastr
$ poetry install

install system-wide

$ cd snapcastr
$ poetry build
$ sudo pip3 install dist/snapcastr-0.1.0.tar.gz

run/debug

run

show help

$ snapcastrd -h

usage: snapcastrd [-h] [--host host] [--port port] [--sc_host sc_host] [-c CONFIG] [-d]

snapcastr

optional arguments:
  -h, --help            show this help message and exit
  --host host           webinterface host
  --port port, -p port  webinterface port
  --sc_host sc_host, -s sc_host
                        snapcast host
  -c CONFIG, --config CONFIG
                        config file
  -d, --debug           debug mode

run the application

• when installed locally

$ cd snapcastr
$ poetry run snapcastrd --sc_host=address_of_your_snapserver

• when installed system-wide

$ snapcastrd --sc_host=address_of_your_snapserver

The address_of_your_snapserver might be 127.0.0.1 or localhost, if you are running snapcastr on the same machine as your snapserver. Snapcastr doesn't need to run with super user privileges (so you don't need to run it with sudo).

Be aware that the last used configuration is saved in $HOME/.config/snapcastr.json.

debug

to debug the application

• when installed locally

$ cd snapcastr
$ poetry run snapcastrd -d [other-options]

• when installed system-wide

$ snapcastrd -d [other-options]

use

Open http://localhost:5011 in your browser.

features

main screen

• View general status, number of clients, streams, groups of clients

clients

• View connected clients and change their volume

groups

• View the groups and the stream being played by each group

streams

• View the status of the various streams available

roadmap, in no particular order

clients

• rename
• remove old

groups

• rename
• remove
• add

streams

• rename