Merge pull request #152 from txoof/I149_go-librespot

add support for go-librespot, fix logic v0.5.6
txoof · Mar 11, 2024 · 81fac69 · 81fac69
2 parents c7f7405 + 02fc0f9
commit 81fac69
Show file tree

Hide file tree

Showing 19 changed files with 1,171 additions and 887 deletions.
diff --git a/documentation/Plugins.md b/documentation/Plugins.md
@@ -11,22 +11,14 @@ All plugins are configured through the `paperpi.ini` files. For a single-user co
 
 
 
-[start: basic_clock]: #
 
-### [basic_clock](../paperpi/plugins/basic_clock/README.md)
 
+[start: basic_clock]: #
+### [basic_clock](../paperpi/plugins/basic_clock/README.md)
 ![basic_clock sample image](../paperpi/plugins/basic_clock/basic_clock.layout-L-sample.png)
 
 [end: basic_clock]: #
 
-
-[start: crypto]: #
-
-### crypto
-**NOTE: This plugin is not supported as of V0.5.5**
-
-[end: crypto]: #
-
 [start: dec_binary_clock]: #
 ### [dec_binary_clock](../paperpi/plugins/dec_binary_clock/README.md)
 ![dec_binary_clock sample image](../paperpi/plugins/dec_binary_clock/dec_binary_clock.layout-L-sample.png)
@@ -99,17 +91,32 @@ All plugins are configured through the `paperpi.ini` files. For a single-user co
 
 [end: system_info]: #
 
-[start: word_clock]: #
-### [word_clock](../paperpi/plugins/word_clock/README.md) <font color="red">R</font><font color="green">G</font><font color="blue">B</font>
-![word_clock sample image](../paperpi/plugins/word_clock/word_clock.layout-L-sample.png)
-
-[end: word_clock]: #
 [start: xkcd_comic]: #
 ### [xkcd_comic](../paperpi/plugins/xkcd_comic/README.md)
 ![xkcd_comic sample image](../paperpi/plugins/xkcd_comic/xkcd_comic.layout-L-sample.png)
 
 [end: xkcd_comic]: #
 
+[start: crypto]: #
+
+### crypto
+**NOTE: This plugin is not supported as of V0.5.5**
+
+[end: crypto]: #
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 [start: configuration]: #
 ## Configuration
 

diff --git a/paperpi/config/paperpi.ini b/paperpi/config/paperpi.ini
@@ -15,11 +15,16 @@ splash = True
 rotation = 0
 # mirror screen outuput - useful if output to screen appears backwards
 mirror = False
-# do not wipe screen when shutting down. True: leave image; False: wipe screen (default)
-no_wipe = False
+# Disable RGB color support for 7-color screens (Default: True)
+# This setting only affects 7 color screens and does not impact bi-color screens
+color = False
+# Disable screen wipe at shutdown (Default: True)
+# This setting will leave the last image on the screen at shutdown
+no_wipe = True
 # plugin timeout - amount of time in seconds to wait for a hung plugin to complete execution
 plugin_timeout = 30
 
+
 ##### PLUGINS #####
 # Each plugin must be configured. A plugin can be
 # included multiple times with different configurations
@@ -48,21 +53,26 @@ refresh_rate = 30
 min_display_time = 60
 max_priority = 2**15
 
-[xPlugin: System Info]
-# show basic facts about the system including IP, Hostname, CPU usage, temperature and storage
-# default layout
+[xPlugin: Basic Clock]
 layout = layout
-# the literal name of your module
-plugin = system_info
-# recommended display time
-min_display_time = 45
-# maximum priority in display loop
+plugin = basic_clock
+refresh_rate = 30
+min_display_time = 50
+max_priority = 2
+
+[xPlugin: decimal binary clock]
+layout = layout
+plugin = dec_bin_clock
+refresh_rate = 30
+min_display_time = 50
 max_priority = 2
-# storage units in decimal: [KB] KiloByte 10^3; [MB] MegaByte 10^6; [GB] GigaByte 10^12; [TB] TeraByte 10^12
-storage_unit = GB
-# colors for RGB screens
-text_color = BLUE
-bkground_color = WHITE
+
+[xPlugin: default fallback plugin]
+layout = layout
+plugin = default
+refresh_rate = 30
+min_display_time = 60
+max_priority = 2**15
 
 [xPlugin: A Demo Plugin]
 # this is a sample config users can use to help setup the plugin
@@ -79,36 +89,27 @@ your_name = Slartybartfast
 # your favorite color
 your_color = chartreuse
 
-[xPlugin: New Yorker Comic]
-layout = layout
-plugin = newyorker
-day_range = 5 # number of past days to choose from
-refresh_rate = 120
-min_display_time = 60
-max_priority = 2
-
-[xPlugin: Reddit Quotes]
+[xPlugin: Librespot]
 layout = layout
-plugin = reddit_quote
-refresh_rate = 100
-min_display_time = 50
-max_priority = 2
-# maximum length of quote (in characters) including spaces, a la Twitter
-max_length = 144
-# Text/background color [RED, ORANGE, YELLOW, GREEN, BLUE, BLACK WHITE] or random
-# bkground color is not supported in this plugin 
-# text_color = RED
-# bkground_color = random
+plugin = librespot_client
+refresh_rate = 10
+max_priority = 0
+min_display_time = 15
+# name of librespot player - use ("*"" to track any and all spotify players)
+player_name = LibreSpot-Spotify
+# time in seconds before plugin is removed from the display loop
+idle_timeout = 10
+# port to search for librespot (if unset, defaults to 24879)
+port = 24879
 
-[xPlugin: Word Clock]
+[xPlugin: LMS - Your Player Name]
 layout = layout
-plugin = word_clock
-refresh_rate = 125
-min_display_time = 255
-max_priority = 2
-# Text color [RED, ORANGE, YELLOW, GREEN, BLUE, BLACK WHITE] or random
-# text_color = random
-# bkground_color = random
+plugin = lms_client
+player_name = Your Player Name
+refresh_rate = 5
+min_display_time = 30
+max_priority = 0
+idle_timeout = 15
 
 [xPlugin: Weather Adis Ababa]
 layout = layout
@@ -125,39 +126,42 @@ email = you@host.diamond
 # bkground color is not supported in this plugin 
 # text_color = BLUE 
 
-[xPlugin: default fallback plugin]
-layout = layout
-plugin = default
-refresh_rate = 30
-min_display_time = 60
-max_priority = 2**15
-
-[xPlugin: XKCD Comic Plugin]
+[xPlugin: Moon Phase]
 # default layout
 layout = layout
-plugin = xkcd_comic
+plugin = moon_phase
+min_display_time = 30
+max_priority = 2
 refresh_rate = 1200
-min_display_time = 120
-# maximum x dimension of comic image
-max_x = 800
-# maximum y dimension of comic image
-max_y = 600
-# max attempts to find a suitable comic image
-# 0 do not rsize small comics / 1 maximize small comics to max_x, max_y
-resize = 0
-max_retries = 10
+# your email address for MET.no API access -- failure to specify may lead to a perma-ban
+email = you@host.diamond
+# Timezone locale name in Region/City format (see --run_plugin_func moon_phase.list_country_locales)
+# Use a known city in your timezone; this is critical for calculating the moonrise time
+location_name = Europe/Amsterdam
+# lat/lon of your physical location (optional) (see --run_plugin_func moon_phase.get_coord)
+lat = 52.3
+lon = 4.9
+
+[xPlugin: New Yorker Comic]
+layout = layout
+plugin = newyorker
+day_range = 5 # number of past days to choose from
+refresh_rate = 120
+min_display_time = 60
 max_priority = 2
 
-[xPlugin: Librespot]
+[xPlugin: Reddit Quotes]
 layout = layout
-plugin = librespot_client
-refresh_rate = 10
-max_priority = 0
-min_display_time = 15
-# name of librespot player
-player_name = SpoCon-Spotify
-# time in seconds before plugin is removed from the display loop
-idle_timeout = 10
+plugin = reddit_quote
+refresh_rate = 100
+min_display_time = 50
+max_priority = 2
+# maximum length of quote (in characters) including spaces, a la Twitter
+max_length = 144
+# Text/background color [RED, ORANGE, YELLOW, GREEN, BLUE, BLACK WHITE] or random
+# bkground color is not supported in this plugin 
+# text_color = RED
+# bkground_color = random
 
 [xPlugin: Slideshow]
 # default layout
@@ -176,60 +180,45 @@ order = random
 # frame style to use (see README)
 frame = black & silver: matted
 
-[xPlugin: LMS - Your Player Name]
-layout = layout
-plugin = lms_client
-player_name = Your Player Name
-refresh_rate = 5
-min_display_time = 30
-max_priority = 0
-idle_timeout = 15
-
-[xPlugin: decimal binary clock]
-layout = layout
-plugin = dec_bin_clock
-refresh_rate = 30
-min_display_time = 50
-max_priority = 2
-
-[xPlugin: Moon Phase]
+[xPlugin: System Info]
+# show basic facts about the system including IP, Hostname, CPU usage, temperature and storage
 # default layout
 layout = layout
-plugin = moon_phase
-min_display_time = 30
+# the literal name of your module
+plugin = system_info
+# recommended display time
+min_display_time = 45
+# maximum priority in display loop
 max_priority = 2
-refresh_rate = 1200
-# your email address for MET.no API access -- failure to specify may lead to a perma-ban
-email = you@host.diamond
-# Timezone locale name in Region/City format (see --run_plugin_func moon_phase.list_country_locales)
-# Use a known city in your timezone; this is critical for calculating the moonrise time
-location_name = Europe/Amsterdam
-# lat/lon of your physical location (optional) (see --run_plugin_func moon_phase.get_coord)
-lat = 52.3
-lon = 4.9
+# storage units in decimal: [KB] KiloByte 10^3; [MB] MegaByte 10^6; [GB] GigaByte 10^12; [TB] TeraByte 10^12
+storage_unit = GB
+# colors for RGB screens
+text_color = BLUE
+bkground_color = WHITE
 
-[xPlugin: Crypto Bitcoin v USD]
-plugin = crypto
+[xPlugin: Word Clock]
 layout = layout
-# fiat currency to use for comparison
-fiat = usd
-# crypto currency to track
-coin = bitcoin
-# days of data to display
-days = 14
-# interval to show on sparkline
-interval = hourly
-# rss news feed to display
-rss_feed = https://bitcoinmagazine.com/.rss/full/
-min_display_time = 60
-# refresh data every 5 minutes
-refresh_rate = 300
+plugin = word_clock
+refresh_rate = 125
+min_display_time = 255
 max_priority = 2
+# Text color [RED, ORANGE, YELLOW, GREEN, BLUE, BLACK WHITE] or random
+# text_color = random
+# bkground_color = random
 
-[xPlugin: Basic Clock]
+[xPlugin: XKCD Comic Plugin]
+# default layout
 layout = layout
-plugin = basic_clock
-refresh_rate = 30
-min_display_time = 50
+plugin = xkcd_comic
+refresh_rate = 1200
+min_display_time = 120
+# maximum x dimension of comic image
+max_x = 800
+# maximum y dimension of comic image
+max_y = 600
+# max attempts to find a suitable comic image
+# 0 do not rsize small comics / 1 maximize small comics to max_x, max_y
+resize = 0
+max_retries = 10
 max_priority = 2
 
diff --git a/paperpi/config/paperpi_base.ini b/paperpi/config/paperpi_base.ini
@@ -15,14 +15,15 @@ splash = True
 rotation = 0
 # mirror screen outuput - useful if output to screen appears backwards
 mirror = False
-
 # Disable RGB color support for 7-color screens (Default: True)
 # This setting only affects 7 color screens and does not impact bi-color screens
-# color = False
-$
+color = False
 # Disable screen wipe at shutdown (Default: True)
 # This setting will leave the last image on the screen at shutdown
-# no_wipe = True
+no_wipe = True
+# plugin timeout - amount of time in seconds to wait for a hung plugin to complete execution
+plugin_timeout = 30
+
 
 ##### PLUGINS #####
 # Each plugin must be configured. A plugin can be

diff --git a/paperpi/my_constants.py b/paperpi/my_constants.py
@@ -6,7 +6,7 @@
 APP_NAME = 'PaperPi'
 CONTACT='aaron.ciuffo@gmail.com'
 DEVEL_NAME = f'com.txoof.{APP_NAME.lower()}'
-VERSION='0.5.5.0 RGB'
+VERSION='0.5.6.0 RGB'
 URL = 'https://github.com/ txoof/PaperPi'