A set of scripts to display current and recent music information.
It uses either the Pimoroni wHAT e-ink display to display track information; or the Pimoroni HyperPixel 4.0 Square (Non Touch) High Res display to display full colour album art.
Works in real time with your local Sonos system. Also includes functionality to pull last played tracks and music history from last.fm.
No authentication required for either service.
Note: this replaces the now deprecated ink-music-stats repo.
Note: A Spotify developer account (Information here) is required to display the Spotify Code of the playing track
Raspberry Pi 3 or 4 are recommended. The Pi 3 A+ is a smaller form factor which fits behind the HyperPixel Square display nicely as long as no more than one USB port is needed for other projects.
Raspberry Pi Zero W can be used with some stipulations noted here.
Pimoroni HyperPixel 4.0 Square Non Touch
I have put together step-by-step basic instructions:
Note that before running go_sonos_highres.py you need to create your own copy of sonos_settings.py: there is an example file in this repo as sonos_settings.py.example
sudo apt install python3-tk
sudo apt install python3-pil
sudo apt install python3-pil.imagetk
pip3 install -r requirements.txt
Enabling webhook support in the node-sonos-http-api configuration is strongly recommended. Without this enabled, the script must repeatedly poll to check for updates.
Webhook support for node-sonos-http-api can be enabled by updating/creating the settings.json configuration file located in the base of the node-sonos-http-api/ directory:
{
"webhook": "http://localhost:8080/"
}
Note: This file does not exist by default and you may need to create it. Also note that the settings.js file is part of the node-sonos-http-api code and should not be modified.
The above configuration assumes that node-sonos-http-api is running on the same machine. If running on a different machine, replace localhost with the IP of the host running this script.
Thanks to a pull request from jjlawren the backlight of the Hyperpixel will turn off when music is not playing to save power & the environment.
If running Raspbian / Raspberry Pi OS, this should work out of the box. If running a different distribution, you'll need to run the following commands:
sudo pip3 install RPi.GPIO
sudo gpasswd -a pi gpio
To display a Spotify Code or use Spotify album art instead of that loaded on to your Sonos system for the playing song, you need to install spotipy (https://pypi.org/project/spotipy/) and setup a Spotify Developer account (Information here), as well as adding your Spotify API Client_ID and Spotify API client_SECRET into the sonos_settings.py file, you also need to set the show_spotify_code and/or show_spotify_albumart to True as below:
#Spotify API Details
spotify_client_id = ""
spotify_client_secret = ""
spotify_market = None
# Show a Spotify Code graphic for the currently playing song if playing from Spotify
show_spotify_code = True
#Overide the album art with that from Spotify if available
show_spotify_albumart = True
NOTE: You can localise the Spotify search to your country using the spotify_market setting in sonos_settings.py by changing None to one of the country codes recognised by the Spotify API (Information Here)
If the script fails to execute on startup following the addition of yopur Spotify API details and setting show_spotify_code and/or show_spotify_albumart to True, confirm if it is possible to manually execute the go_sonos_highres.py script using the following command from within the music-screen-api directory:
python3 go_sonos_highres.py
Open a command prompt:
sudo nano /etc/xdg/lxsession/LXDE-pi/autostart
Then it is necessary to stop executing go_sonos_highres.py script with sudo privileges by changing the following line at the end of the file that has opened:
from:
@sudo /usr/bin/python3 /home/pi/music-screen-api/go_sonos_highres.py
to:
@/usr/bin/python3 /home/pi/music-screen-api/go_sonos_highres.py
If this doesn't work, you may not have setup your Spotify API details correctly, you can use the spotipy_auth_search_test.py script to help diagnose your problem using the following command from within the music-screen-api directory:
python3 spotipy_auth_search_test.py
Enter an artist and song title when prompted to see if you can successfully search Spotify using spotipy
Depending on your user permissions, using the above instructions to autostart the go_sonos_highres.py script may lead to numerous warning messages in the log file as spotipy expects to have access to a .cache file in the directory the script was executed from. If this is the case the newly added music-screen-api-startup.sh script can be used instead:
The contents of music-screen-api-startup.sh is:
cd ~/music-screen-api
python3 go_sonos_highres.py
Open a command prompt:
sudo nano /etc/xdg/lxsession/LXDE-pi/autostart
It is then necessary to stop executing go_sonos_highres.py script directly by changing the following line at the end of the file that has opened:
from:
@/usr/bin/python3 /home/pi/music-screen-api/go_sonos_highres.py
or
@sudo /usr/bin/python3 /home/pi/music-screen-api/go_sonos_highres.py
to:
@sh ~/music-screen-api/music-screen-api-startup.sh
The script exposes some REST API endpoints to allow remote control and integration options.
| Method | Endpoint | Payload | Notes |
|---|---|---|---|
GET |
/state |
None | Provides current playing state in JSON format. |
POST |
/set-room |
room: name of room (str) |
Change actively monitored speaker/room. |
POST |
/show-detail |
detail: 0/1, true/false (bool, required)timeout: seconds (int, optional) |
Show/hide the detail view. Use timeout to revert to the full album view after a delay. Has no effect if paused/stopped. |
Examples:
curl http://<IP_OF_HOST>:8080/status
-> {"room": "Bedroom", "status": "PLAYING", "trackname": "Living For The City", "artist": "Stevie Wonder", "album": "Innervisions", "duration": 442, "webhook_active": true}
curl --data "room=Kitchen" http://<IP_OF_HOST>:8080/set-room
-> OK
curl --data "detail=true" --data "timeout=5" http://<IP_OF_HOST>:8080/show-detail
-> OK
A Pi Zero W can run both node-sonos-http-api and the full color album art version as long as webhooks have been properly enabled. It updates slightly slower (1-2 seconds) than a Pi 3/4.
Note: The e-ink version has not been updated to use webhooks which the HyperPixel version uses and requires the performance tweaks below.
The e-ink script can be got running with a Pi Zero, however you will want to note two things:
-
Save yourself a headache and ensure you're getting a Pi Zero WH (ie wireless and with headers pre-soldered)
-
It runs pretty poorly on a Pi Zero due to the processing requirements. Actually this script runs fine, but it can struggle to do this and the http-sonos-api consistently. If you are set on running on a Pi Zero then either have the sonos-api running on a different local machine (and redirect to that IP address in sonos_settings.py) or set the Pi_Zero flag in sonos_settings.py to True (this slows down the frequency of requests)
(Thanks to reddit user u/Burulambie for helping me troubleshoot this)
This script uses my "demaster" script to remove some of the nonsense from the end of track names which make them difficult to display (eg - Live at etc, (Remastered 2011), etc). This is highly recommended for displaying on a screen as otherwise it becomes unweildy to read the track names.
Two important points for you to note here:
-
If you want to turn this off then you can by opening sonossettings.py and changing demaster to False. This will then show the full track name as reported by Sonos.
-
Demaster makes use of an online API to efficiently reduce the track names and ensure that it is able to learn from previous amendments. This means that in default mode track names are sent to a remote server when they are played to get the shorter name. No personally identifying information is associated with this API request but if you're uncomfortable with this then rather than disabling demaster entirely then you can set it to run in offline only mode by setting the
demaster_query_cloudoption in yoursonos_settings.pytoFalse. This means that the local script will attempt to do some limited reduction of nonsense in track names, but you won't benefit from the latest algorithm to do this - but it's still a lot better than nothing if you're worried about privacy.