giof71/upnp-scrobbler repository overview

⁠UPnP Scrobbler

A simple LAST.fm scrobbler for WiiM devices.
It can now also scrobble to subsonic servers.

⁠References

I started taking the code published in this post⁠ as the starting point.
It seems that I cannot get a valid link to the user profile on that board, but anyway the nickname is cc_rider.
A big thank you goes to him/her for the code he/she shared.
I then used pylast⁠, as suggested in that thread, for the actual operations on last.fm⁠.
I also use subsonic-connector⁠ for subsonic scrobbling.

⁠Links

⁠Task List

• Scrobbling from a WiiM device as a generic UPnP Renderer
• Scrobbling from a WiiM device when using Tidal Connect
• Scrobbling to gmrender-resurrect (Source⁠ and Docker image⁠) as a generic UPnP Renderer
• Scrobbling to mpd + upmpdcli in UPnP-AV mode
• Scrobbling to a subsonic server
• Enable "now playing" for subsonic
• Enable song matching for subsonic
• Allow multiple subsonic servers
• Scrobbling to listenbrainz
• Scrobbling to libre.fm

⁠Build

You can build the docker image by typing:

docker build . -t giof71/upnp-scrobbler

⁠Configuration

⁠Create your API key and secret

Open your browser at this⁠, follow the instruction and accurately store the generated values.
Those will be needed for the configuration.

⁠Environment Variables

⁠Running

The preferred way of running this application is through Docker.

⁠Configuration directory

When using docker, the base configuration directory is /config. When running outside of docker, the code looks for the default config directory using the platformdirs⁠ library.

⁠LAST.fm configuration file

LAST.FM related variables can be stored in a file inside the <config-directory> volume, exacly at <config-directory>/upnp-scrobbler/last.fm/last_fm_config.env. Example:

LAST_FM_API_KEY=xxxx
LAST_FM_SHARED_SECRET=xxxx
# optional
LAST_FM_USERNAME=xxxx
# optional
LAST_FM_PASSWORD=xxxx
# optional
LAST_FM_PASSWORD_HASH=xxxx

⁠Subsonic Configuration files

Subsonic related variables should be saved in files inside the <config-directory> volume, with files names like <config-directory>/upnp-scrobbler/subsonic/<subsonic_key>.server.env, and optionally <config-directory>/upnp-scrobbler/subsonic/<subsonic_key>.credentials.env (if you want to separate credentials).
Example file names:

lightweight-music-server.server.env
lightweight-music-server.credentials.env

Example of content for the mentioned files:

SUBSONIC_BASE_URL=https://your-subsonic-server.your-domain.com
# legacy auth
SUBSONIC_LEGACY_AUTH=true
# there is an alias available for variable name SUBSONIC_LEGACYAUTH (it's named this way in upmpdcli)
# SUBSONIC_LEGACYAUTH=true
# optional port, by default it will be `443` if the base url starts with `https`, otherwise `80`
SUBSONIC_PORT=443
# optional server path
# SUBSONIC_SERVER_PATH=server-path
# optional enable now playing, defaults to true
# SUBSONIC_ENABLE_NOW_PLAYING=false
# SUBSONIC_ENABLE_SONG_MATCH=true

and:

SUBSONIC_USERNAME=your-username
# there is an alias available for variable name SUBSONIC_USER (it's named this way in upmpdcli)
# SUBSONIC_USER=your-username
SUBSONIC_PASSWORD=your-password

You can collapse all the variables in one file for each subsonic configuration, but its name must be <subsonic_key>.server.env for each value given to subsonic_key.

The subsonic configuration variables are listed in the following table:

⁠LAST.fm authentication

If username and password (hash or plaintext) are not provided, the application will prompt you to authorize the app.
You will need to watch the logs, al least for the first run.
Please note that API key and secret are still required.

⁠Sample compose file

Here is a simple compose file, valid for a WiiM device:

---
version: "3"

services:
  scrobbler:
    image: giof71/upnp-scrobbler:latest
    container_name: wiim-scrobbler
    network_mode: host
    environment:
      - DEVICE_URL=http://192.168.1.7:49152/description.xml
      - LAST_FM_API_KEY=your-lastfm-api-key
      - LAST_FM_SHARED_SECRET=your-lastfm-api-secret
      - LAST_FM_USERNAME=your-lastfm-username
      - LAST_FM_PASSWORD_HASH=your-lastfm-md5-hashed-password
    restart: unless-stopped

It is advisable to put the variable values in a .env file in the same directory with this docker-compose.yaml file.
Start the container with the following:

docker-compose up -d

⁠Change history