barry/spotiplayer-pi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add docs

Browse Source
This commit is contained in:
Alessandro 2025-01-10 16:17:09 +01:00
parent 7415f36795
commit d892f6ba04
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.org
View File

@ -2,10 +2,17 @@
Welcome welcome... Welcome welcome...
This is a personal project to display the current playing Spotify track on a small LCD screen connected to a Raspberry Pi. This is a personal project to display the current playing Spotify track on a small LCD screen connected to a Raspberry Pi.
** What it does ** What it does:
*** Project's scope *** Project's scope
This project aims to act as a view only display to showcase the current playing song on Spotify, it is built to support only one specific display and the Pi 5 hardware, no other platforms are intended to be supported soon.
*** Features & Functionality *** Features & Functionality
** Get Started This project uses the Spotify API to authenticate the user and pull live information about currently playing song, the information is then displayed in the screen.
*Features:*
- Track Display: displays the track name, artists and album cover.
- Dynamic Progress bar: displays the track progress dynamically, to reduce API calls the bar assumes the track continues playing in-between requests, to smoothly contine updating the bar every =refresh_interval=
- Standby Screen: displays current time and QR code, the QR code can be set by the user to connect to a Spotify Speaker.
- Easy Config: all the parameters needed by the app running can be set in =config.yaml=, including the API polling rate interval, the display refresh interval, Spotify's app credential and the color scheme. The colors of all the UI components are exposed and controllable in this configuration file.
** Get Started:
*** Hardware Requirements *** Hardware Requirements
*** Software Requirements *** Software Requirements
*** Install *** Install

14
spotiplayer_pi/config.yaml
View File

@ -1,12 +1,12 @@
refresh_token: "AQBGNOL-iocPZ_zxtr_sNXx4BZRaxPmg2Ea0cJGorcEu2IW2wSnLdkYDJpVDOuQQHWIQ-LjuNpBcY9PurPtdfPoT5ljXnGpso9CqX6n2alBXaYc767oKya_52qxqWPE0o7k" refresh_token: "AQBGNOL-iocPZ_zxtr_sNXx4BZRaxPmg2Ea0cJGorcEu2IW2wSnLdkYDJpVDOuQQHWIQ-LjuNpBcY9PurPtdfPoT5ljXnGpso9CqX6n2alBXaYc767oKya_52qxqWPE0o7k"
base_64: "ZTI5Mzg3NWI3YWQ5NDQzZDg1NDMxYzkwOTEyZTdiMWQ6MjlmNDEzZTJiOTRlNGU0NDlkOWRiYmU0NmM2OTY5MTY=" base_64: "ZTI5Mzg3NWI3YWQ5NDQzZDg1NDMxYzkwOTEyZTdiMWQ6MjlmNDEzZTJiOTRlNGU0NDlkOWRiYmU0NmM2OTY5MTY="
api_interval: 5 api_interval: 5 # (float) number of seconds in-between API requests
refresh_interval: 0.4 refresh_interval: 0.4 # (float) number of seconds in-between progress bar refreshes
# Set Color Theme
color_theme: color_theme:
text: [255, 255, 255] text: [255, 255, 255] # [R, G, B] All text components
bar_outline: [255, 255, 255] bar_outline: [255, 255, 255] # [R, G, B] Bar Outline
bar_inside: [30, 215, 96] bar_inside: [30, 215, 96] # [R, G, B] Bar in-fill
background: [25, 20, 20] background: [25, 20, 20] # [R, G, B] Background