Skip to content

Installation Instructions

Jump to bottom
Todd Lucas edited this page Feb 12, 2025 · 10 revisions

Requirements

The following requirements must be met prior to installing the SpotifyPlus Card.

Limitations

The following limitations are imposed if you choose to install the SpotifyPlus Card.

  • A Spotify Premium level membership is required in order to control the Spotify Player (e.g. pause, resume, volume changes, etc) as well as retrieve player queue info.

    A Spotify Free level membership will work fine if you want to retrieve data, display device details, set / reset / check favorites, etc. Any changes to the Spotify Player must be made using a Spotify client (e.g. mobile, desktop, etc).

  • Limited control of Chromecast devices. Chromecast devices are currently not fully supported by the SpotifyPlus integration. You can perform player functions (e.g. pause, resume, next track, etc) if the device is the currently active player, but you can’t wake up a device or initiate play of tracks / context.

How To Install

The easiest way to install the card is via the Home Assistant Community Store (or HACS for short). Check out the HACS Install Documentation page for more information on how to install HACS in your Home Assistant environment.

Don't have HACS, or do not want to use HACS? No problem! You can also install the card manually by copying files from the GitHub project.

Both installation types are covered below.

HACS Installation (recommended)

  • On your Home Assistant sidebar menu, go to HACS > Frontend
  • Click on the 3-dot overflow menu in the upper right, and select custom repositories item.
  • Copy / paste https://github.com/thlucas1/spotifyplus_card in the Repository textbox and select Dashboard for the category entry.
  • Click on Add to add the custom repository.
  • You can then click on the SpotifyPlus Card repository entry (you may need to filter your list first to find the new entry).
  • Click on download to start the download. It will install the card to your /config/www/community/spotifyplus_card directory.
  • Go back on your dashboard and click on the icon at the right top corner then on Edit dashboard.
  • You can now click on Add card in the bottom right corner and search for "Custom: SpotifyPlus Card".

Manual Installation

  • using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  • change directory to the www folder; if you don't have this directory, then create it.
  • download the spotifyplus_card.js file from the GitHub repository into your <config>/www folder.
  • on your dashboard click on the icon at the right top corner then on Edit dashboard.
  • click again on that icon and then on Manage resources.
  • click on Add resource.
  • copy and paste this: /local/spotifyplus_card.js?v=1.0.12 (change version number to match what was downloaded).
  • click on JavaScript Module then Create.
  • go back and refresh your page.
  • you can now click on Add card in the bottom right corner and search for "Custom: SpotifyPlus Card".
  • after any update of the file you will have to edit /local/spotifyplus_card.js?v=1 and change the version (e.g. v=1) to any higher number (e.g. v=1.2).
Clone this wiki locally