/homeassistantcomponent_spotifyplus

Home Assistant integration for Spotify Player control, services, and soundtouchplus integration support.

Primary LanguagePythonMIT LicenseMIT

SpotifyPlus

GitHub Release License docs hacs

Project Maintenance BuyMeCoffee

Home Assistant Integration to integrate with spotifyplus.
Extended support for the Spotify Connect media player for use in Home Assistant.

This integration will set up the following platforms.

Platform Description
media_player Media Player Entity.

Features

The following Home Assistant media_player Platform services are supplied by this integration.

  • BROWSE_MEDIA
  • MEDIA_ENQUEUE
  • NEXT_TRACK
  • PAUSE
  • PLAY
  • PLAY_MEDIA
  • PREVIOUS_TRACK
  • REPEAT_SET
  • SEEK
  • SELECT_SOURCE
  • SHUFFLE_SET
  • TURN_OFF
  • TURN_ON
  • VOLUME_MUTE
  • VOLUME_SET
  • VOLUME_STEP

The following custom services are also supplied by this integration.

  • Follow Artists
  • Follow Playlist
  • Follow Users
  • Get Album
  • Get Album Favorites
  • Get Album New Releases
  • Get Artist
  • Get Artists Albums
  • Get Artists Followed
  • Get Browse Categories
  • Get Category Playlists
  • Get Featured Playlists
  • Get Player Devices
  • Get Player Now Playing
  • Get Player Playback State
  • Get Player Queue Info
  • Get Player Recent Tracks
  • Get Playlist
  • Get Playlist Favorites
  • Get Show
  • Get Show Episodes
  • Get Show Favorites
  • Get Spotify Connect Devices
  • Get Track Favorites
  • Get Users Top Artists
  • Get Users Top Tracks
  • Player Activate Devices
  • Player Media Play Context
  • Player Media Play Track Favorites
  • Player Media Play Tracks
  • Player Resolve Device Id
  • Player Transfer Playback
  • Playlist Change
  • Playlist Cover Image Add
  • Playlist Create
  • Playlist Items Add
  • Playlist Items Clear
  • Playlist Items Remove
  • Remove Album Favorites
  • Remove Audiobook Favorites
  • Remove Episode Favorites
  • Remove Show Favorites
  • Remove Track Favorites
  • Save Album Favorites
  • Save Audiobook Favorites
  • Save Episode Favorites
  • Save Show Favorites
  • Save Track Favorites
  • Search Albums
  • Search Artists
  • Search Audiobooks
  • Search Episodes
  • Search Playlists
  • Search Shows
  • Search Tracks
  • Unfollow Artists
  • Unfollow Playlist
  • Unfollow Users
  • ZeroConf Device Connect
  • ZeroConf Device Disconnect
  • ZeroConf Device GetInformation
  • ZeroConf Discover Devices

Check out the Services Provided wiki page for detailed explanations and YAML examples of the custom services provided by this integration.

Check out the Media Player Service Enhancements wiki page for detailed explanations and YAML examples of the media player service enhancements provided by this integration.

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.
  • 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 HA to start using the component.

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 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.
  • In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "SpotifyPlus"

Configuration

All configuration of the integration is done in the UI.

Advanced Logging Support

The SmartInspectPython package (installed with this integration) can be used to easily debug the integration. Note that the standard Home Assistant logger is also supported, but does not provide as much information as the SmartInspect logger.

Check out the SmartInspect Logging Configuration wiki page for more information on how to configure and enable / disable advanced logging.

Reporting a Problem

Submit a Bug Report to bring the issue to my attention. I receive a notification when a new issue is opened, and will do my best to address it in a prompt and professional manner.

Request a New Feature

Do you have an idea for a new feature that could be added to the integration? Submit a Feature Request to get your idea into the queue. I receive a notification when a new request is opened, and will do my best to turn your idea into the latest and greatest feature.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines