Album Art Display on PIXOO64

Enhance your musical experience on the DIVOOM PIXOO64 screen with this powerful Appdaemon script for Home Assistant. It fetches and displays the album cover art of the currently playing track. By default, the album art will automatically be displayed on the Pixoo64 screen when a track is playing.

Examples

Key Features:

• Image Cropping: The script cuts out wide borders from album art to present the main object on the screen.
• Synchronized Lyrics Display: Displays synchronized lyrics of the song.
• Display Clock: Shows the current time.
• Artist and Track Title Display: Shows the artist and track title.
• Full Fallback Support: If album art doesn't exist or can't be fetched, the script provides fallback options. These fallbacks support API services like MusicBrainz, Spotify, Discogs, and Last.FM. If all else fails, the script creates a dedicated AI image using pollinations.ai, ensuring that 99% of the time, an image will be displayed on the Pixoo64 screen while music is playing.

The script is compatible with speaker systems such as Chromecast, AirPlay 2, and Sonos, and fully supports services like Spotify, Tidal, Apple Music, YouTube Music, MixCloud, TuneIn, Sonos Radio, and more!

More Features & Functional Advantages:

• Image Enhancer: Amplifies the color vibrancy of the image for a more striking display.
• Sensor Data Storage: Stores all extracted data in a dedicated sensor entity within Home Assistant for further automation possibilities.
• RTL Support: Displays the artist’s name or song title correctly in right-to-left languages.
• Title Normalization: Normalizes titles and artist names for easier integration with automations and consistent display. For instance, “Beyoncé” would be normalized to “Beyonce”.
• Light Dynamic Color Integration: Uses the dominant color from the album art to set the background color on any RGB light.

Fallback Image

When there's no image associated with the music file, or if the image can't be fetched, or while listening to radio stations, the fallback function activates. By default, the supported fallbacks are MusicBrainz and the AI Image generator, as neither requires an API key. However, these services are not 100% reliable, so it's recommended to use any of the APIs that this script supports (Spotify/Discogs/Last.fm). You can choose to use one, two, or all three. The fallback will first try to find the album art on Discogs; if it fails, it will try Spotify, then Last.fm. Regardless, 99.9% of the time when a track is played, the Pixoo64 will present artwork graphics.

Display Lyrics

For accessibility, when lyrics are available and displayed above the image, the image will appear 50% darker when text_background is True (apps.yaml). This feture is not support radio stations.

Prerequisites

1. DIVOOM PIXOO64
2. Home Assistant (with add-on functionality)
3. AppDaemon (Home Assistant add-on)

   Installation

   [!TIP] Create a Toggle Helper in Home Assistant. For example, input_boolean.pixoo64_album_art can be used to control when the script runs. This means that whenever the player starts a track, the album art will appear if the toggle is on. Establish this helper within the Home Assistant User Interface or YAML code. It’s best to do this prior to installation. Ensure that the helper sensor is created prior to executing the script for the first time.

4. Install AppDaemon from the Home Assistant add-on store.
5. On the AppDaemon Configuration page, install the pillow, python-bidi (optional) and unidecode (optional) Python packages.

[!IMPORTANT] Not installing the packadges may cause the script not work

# http://homeassistant.local:8123/hassio/addon/a0d7b954_appdaemon/config
system_packages: []
python_packages:
- pillow
- unidecode
- python-bidi
init_commands: []

Manual Download

1. Download the Python file from This Link.
2. Place the downloaded file inside the appdaemon/apps directory and proceed to the final step

   HACS Download

3. In Home Assistant: Navigate to Settings > Integrations > HACS > Configure and enable AppDaemon apps discovery & tracking. After enabling, return to the main HACS screen.
   • 

2. Navigate to the Custom Repositories page and add the following repository as AppDaemon: https://github.com/idodov/pixoo64-media-album-art/
3. Return to the main HACS screen and search for PIXOO64 Media Album Art. Click on Download

   [!IMPORTANT]
   In AppDaemon, make sure to specify the apps directory in /addon_configs/a0d7b954_appdaemon/appdaemon.yaml. Also, remember to transfer all files from /addon_configs/a0d7b954_appdaemon/apps/ to /homeassistant/appdaemon/apps/.

   #/addon_configs/a0d7b954_appdaemon/appdaemon.yaml
   ---
   appdaemon:
   app_dir: /homeassistant/appdaemon/apps/

   ---

   Final Step - Configuration

   Open /appdaemon/apps/apps.yaml and add this code: [!TIP] If you’re using the File Editor add-on, it’s set up by default to only allow file access to the main Home Assistant directory. However, the AppDaemon add-on files are located in the root directory. To access these files, follow these steps:

4. Go to Settings > Add-ons > File Editor > Configuration
5. Toggle off the Enforce Basepath option.
6. In the File Editor, click on the arrow next to the directory name (which will be ‘homeassistant’). This should give you access to the root directory where the AppDaemon add-on files are located.

# appdaemon/apps/apps.yaml
---
pixoo64_media_album_art:
    module: pixoo64_media_album_art
    class: Pixoo64_Media_Album_Art
    home_assistant:
        ha_url: "http://homeassistant.local:8123"  # Home Assistant URL
        media_player: "media_player.era300"        # Media player entity ID
        toggle: "input_boolean.pixoo64_album_art"  # Boolean sensor to control script execution (Optional)
        pixoo_sensor: "sensor.pixoo64_media_data"  # Sensor to store media data (Optional)
        light: "light.strip_stone"                 # RGB light entity ID (if any) (Optional)
        ai_fallback: turbo                         # Create alternative AI image when fallback - use model 'flex' or 'turbo'
        force_ai: False                            # Show only AI Images
        musicbrainz: True                          # Get fallback image from MusicBrainz 
        spotify_client_id: False                   # client_id key API KEY from developers.spotify.com
        spotify_client_secret: False               # client_id_secret API KEY
        last.fm: False                             # Last.fm API KEY from https://www.last.fm/api/account/create
        discogs: False                             # Discogs API KEY from https://www.discogs.com/settings/developers
    pixoo:
        url: "192.168.86.21"                       # Pixoo device URL
        full_control: True                         # Control display on/off with play/pause
        contrast: True                             # Apply 50% contrast filter
        clock: True                                # Show clock top corner
        clock_align: Right                         # Clock align - Left or Right
        tv_icon: True                              # Shows TV icon when playing sound from TV
        lyrics: False                              # Show lyrics if avalible. In this mode the show_text fetures will disabled
        show_text:
            enabled: False                         # Show media artist and title 
            clean_title: True                      # Remove "Remaster" labels, track number and file extentions from the title if any
            text_background: True                  # Change background color or better text display with image
            font: 2                                # Pixoo internal font type (0-7) for fallback text when there is no image
            color: False                           # Use alternative font color
        crop_borders:
            enabled: True                          # Crop image borders if present
            extra: True                            # Apply enhanced border crop

[!WARNING] Only save it once you’ve made the described changes to the settings.

[!NOTE]

light

The light feature is a built-in automation that sends a ‘turn on’ command with RGB values corresponding to the most dominant color in the image. If the image is black, white, or gray, the automation will select a soft random color.

crop_borders

Given the Pixoo screen’s 64x64 pixel size, it is highly recommended to utilize the crop feature. Many album cover arts come with borders, occasionally wide ones, which can distort the display of the cover art on the screen. To rectify this, the script ensures the removal of the picture frame border.	Original	Crop	Extra

---

You’re all set!

Make sure that input_boolean.pixoo64_album_art is turned on. The next time you play a track, the album cover art will be displayed, and all the usable picture data will be stored in a new sensor.

Fallback Image

When there's no image associated with the music file, or if the image can't be fetched, the fallback function will activate. By default, the supported fallbacks are MusicBrainz and the AI Image generator because neither requires an API key. However, these services are not 100% reliable, so it's recommended to use any of the APIs that this script supports (Spotify/Discogs/Last.fm). You can choose to use one, two, or all three. The fallback will first try to find the album art on Discogs, and if it fails, it will try Spotify, then Last.fm. No matter what, 99.9% of the time when a track is played, the Pixoo64 will present artwork graphics.

There are four types of fallbacks:

1. Getting the Album API: This is the most recommended option because servers are fast and reliable. You can choose one or more options. To use this method, you'll need keys (optional):

   • Spotify: the Client ID and the Client Secret.
   • Discogs: Personal API Key
   • Last.FM: API Key Instructions on how to obtain them are provided beyond this text.

2. Fetching Album Art from MusicBrainz: MusicBrainz is an open-source database containing URLs for album art. Although the database is extensive and includes many rare artworks and doesn't require API keys, it relies on very slow server connections. This means that often the album art may not be retrieved in a timely manner while the track is playing.

3. Generating Art with Special AI: In this scenario, the script will attempt to generate an alternative version of the album art using generative AI. This option will trigger only if the Spotify API fails (or is unavailable) and/or no album art is found, or there is a timeout from the MusicBrainz service. Be aware that as it is a free AI generative service, it may also be laggy or sometimes unavailable.

4. Fallback Text Display: If no image is available at all, text displaying the artist's name and the track title will be shown.

Guide to help you get your Spotify Client ID and Client Secret from the developer site:

1. Log in to Spotify Developer Dashboard: Go to the Spotify Developer Dashboard and log in with your Spotify account.

2. Create an App: Click on the "Create an App" button. You'll need to provide a name and a brief description for your app. These fields are mainly for display purposes, so you can keep them simple.

3. Choose Web API from the Which API/SDKs are you planning to use section and press SAVE.

4. Copy Client ID and Client Secret: Once your app is created, you'll be taken to the app overview page. At the Basic Information section you'll find your Client ID and Client Secret. Copy these values and store them on apps.yaml file under spotify_client_id and spotify_client_secret.

Guide to help you get your Discogs API key:

1. Log in to Discogs: Go to the Discogs website and log in with your account.

2. Create a Personal Key: Navigate to the Discogs API documentation and follow the instructions to create a new personal key. You don't need to create application.

Guide to help you get your Last.fm API key:

1. Log in to Last.fm: Go to the Last.fm website and log in with your account.

2. Create an Application: Navigate to the Last.fm API documentation and follow the instructions to create a new application. You'll need to provide a name and a brief description for your application.

3. Obtain API Key: Once your application is created, you'll be provided with an API key and a secret. Copy the API KEY.

That's it! You now have your API keys for Spotify, Discogs, and Last.fm, which you can use to authenticate your Pixoo64 with these services.

Sensor Attribues

The sensor sensor.pixoo64_media_data is a virtual entity created in Home Assistant. It’s designed to store useful picture data from the album cover art of the currently playing song. This includes the artist’s name, the title of the media and color information such as the color of the font and the background. This sensor allows for dynamic visual experiences and automation possibilities based on the music being played.

Here’s an examples of the sensor attributes:

artist: Björk & Trio Gudmundar Ingolfssonar
normalized_artist: Bjork & Trio Gudmundar Ingolfssonar
media_title: Það Sést Ekki Sætari Mey
normalized_title: Thad Sest Ekki Saetari Mey
font_color: "#00ff00"
font_color_alternative: "#37457a"
background_color_brightness: 173
background_color: "#c8ba85"
color_alternative_rgb:
  - 198
  - 185
  - 132
background_color_rgb:
  - 200
  - 186
  - 133
recommended_font_color_rgb:
  - 55
  - 69
  - 122
color_alternative: "#c6b984"

Arabic Title When Normalized (letters changed to English):

....
media_title: آمين
normalized_title: amyn
....

[!TIP] The following music services have been tested: Apple Music, Spotify, Tidal, YouTube Music, MixCloud, and Sonos Radio.

[!NOTE] While experimenting with the device, you may notice occasional freezes. These could potentially be due to power issues. To address this, it’s suggested to use a USB charger with an output of 3A for optimal performance. If you’re using a charger with a lower voltage (2A, which is the minimum required), it’s advisable to limit the screen brightness to no more than 90%.

Also, at times, an overloaded Wi-Fi network might result in the Pixoo64 responding slowly. Most often, rebooting the Wi-Fi network or the router rectifies this problem.

Disclaimer: This software is not an official product from Divoom. As a result, Divoom bears no responsibility for any damages or issues arising from the use of this script. Additionally, Divoom does not offer end-user support for this script. Please utilize it at your own risk.