Skip to content

Installation Instructions

Jump to bottom
Todd Lucas edited this page Dec 17, 2024 · 11 revisions

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.

Limitations

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

  • 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, 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.

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

All configuration of the integration is done in the UI; check out the Device Configuration Options wiki page for more details.

Clone this wiki locally