Installation Instructions - thlucas1/homeassistantcomponent_spotifyplus GitHub Wiki

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

If you do not want to use HACS, you can also install the integration manually by copying files from the GitHub project.

Both installation types are covered below.

Requirements

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

  • A Spotify Premium account is recommended, but not required; Free accounts will work, but are limited just as they are in the Spotify official apps (see limitations for more details).
  • Home Assistant 2024.10+ release.

HACS Installation Instructions

  • go to HACS main menu.
  • click on the 3-dot overflow menu in the upper right, and select custom repositories item.
  • copy / paste https://github.com/thlucas1/homeassistantcomponent_spotifyplus in the Repository textbox, and select Integration for the category entry.
  • click on Add to add the custom repository, and close the custom repositories dialog.
  • you can then click on the SpotifyPlus 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 spotifyplus integration to your config/custom_components directory.
  • restart Home Assistant to apply the changes; I would also suggest clearing your browser cache prior to restart.
  • proceed to the Device Configuration Options wiki page for steps on how to configure the integration.

Manual Installation

  • using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  • if you do not have a custom_components directory (folder) there, you need to create it.
  • in the custom_components directory (folder) create a new folder called spotifyplus.
  • download all of the files from the custom_components/spotifyplus/ directory (folder) in this repository.
  • place the files you downloaded in the new directory (folder) you created.
  • restart Home Assistant; I would also suggest clearing your browser cache prior to restart.
  • in the Home Assistant UI go to "Configuration" -> "Integrations" click "+" and search for "SpotifyPlus"

Configuration

Most configuration of the integration is done in the UI, but not ALL of it; check out the Device Configuration Options wiki page for more details.

Extra Steps for Sonos Users

There are a couple of extra SpotifyPlus configuration steps for Sonos environments. Sonos devices are considered "restricted" by Spotify Connect, so they require more powerful authorization tokens to transfer playback / start playback of media.

Check out the following wiki docs for more information:

Extra Steps for Chromecast Users

There is an extra SpotifyPlus configuration step for Chromecast environments, which enables HA to transfer playback to idle Chromecast devices as well as support multiple Spotify user accounts.

Check out the following wiki docs for more information:

Extra Steps for Spotify FREE Accounts

It is recommended that you use the Spotify Web Player Cookie Credentials SP_DC, SP_KEY integration configuration options UI to configure support for Spotify Connect player control.