Spotify Connect - Community Hass.io Add-on for Home Assistant
Switch branches/tags
Clone or download

README.md

Community Hass.io Add-ons: Spotify Connect

GitHub Release Project Stage License

GitLab CI Project Maintenance GitHub Activity

Bountysource Discord Community Forum

Buy me a coffee

Support my work on Patreon

Play Spotify music on your Home Assistant device.

The Spotify Connect Hass.io add-on

About

The Hass.io Spotify Connect add-on allows you to use your device, running Home Assistant, to play your Spotify music. This add-on uses the Spotify Connect protocol, which makes it a device that can be controlled by all the official clients.

For example; Running Hass.io on a Raspberry Pi with this add-on installed will allow you to play your Spotify music on the Pi. So all you'll have to do is hook up your sound system to the Pi and start booming!

Installation

IMPORTANT: This add-on requires a Spotify Premium account!

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

  1. Add our Hass.io add-ons repository to your Hass.io instance.
  2. Install the "Spotify Connect" add-on.
  3. Put in your Spotify account details into the username/password options.
  4. Click the Save button to store your credentials.
  5. Select your audio output device and hit Save on that as well.
  6. Start the "Spotify Connect" add-on.
  7. Check the logs of the "Spotify Connect" to see if everything went well.
  8. Ready to go!

NOTE: Do not add this repository to Hass.io, please use: https://github.com/hassio-addons/repository.

Docker status

Supports armhf Architecture Supports aarch64 Architecture Supports amd64 Architecture Supports i386 Architecture

Docker Layers Docker Pulls

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

{
  "log_level": "info",
  "username": "frenck@example.com",
  "password": "MySpotifyPassword",
  "name": "Hass.io",
  "bitrate": 320
}

Note: This is just an example, don't copy and paste it! Create your own!

Option: log_level

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

  • trace: Show every detail, like all called internal functions.
  • debug: Shows detailed debug information.
  • info: Normal (usually) interesting events.
  • warning: Exceptional occurrences that are not errors.
  • error: Runtime errors that do not require immediate action.
  • fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to info, which is the recommended setting unless you are troubleshooting.

Setting the log_level to debug will also turn on debug mode on the Spotify service.

Option: username

The username you use to login to your Spotify Premium account.

Note: This option support secrets, e.g., !secret spotify_username.

Option: password

The password you use to login to your Spotify Premium account.

Note: This option support secrets, e.g., !secret spotify_password.

Option: name

The name of your device (the Spotify Connect target), as shown on the official Spotify clients.

Note: _May only contain letters, numbers, hyphens (-) and dots (.)

Option: bitrate

The bitrate Spotify should use. The higher, the better the sound quality, however, the add-on consumes more data.

Valid values: 96, 160 (default) or 320.

Known issues and limitations

  • This add-on does support ARM-based devices, nevertheless, they must at least be an ARMv7 device. (Raspberry Pi 1 and Zero is not supported).
  • This add-on requires a Spotify Premium account.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

We have got some Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2018 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.