diff --git a/README.md b/README.md index 4f8a21b9..b90cbdac 100644 --- a/README.md +++ b/README.md @@ -1070,10 +1070,10 @@ SOFTWARE. [ssh-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [ssh-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [ssh-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-spotify]: https://github.com/hassio-addons/addon-spotify-connect/tree/v0.8.0 -[addon-doc-spotify]: https://github.com/hassio-addons/addon-spotify-connect/blob/v0.8.0/README.md +[addon-spotify]: https://github.com/hassio-addons/addon-spotify-connect/tree/v0.8.1 +[addon-doc-spotify]: https://github.com/hassio-addons/addon-spotify-connect/blob/v0.8.1/README.md [spotify-issue]: https://github.com/hassio-addons/addon-spotify-connect/issues -[spotify-version-shield]: https://img.shields.io/badge/version-v0.8.0-blue.svg +[spotify-version-shield]: https://img.shields.io/badge/version-v0.8.1-blue.svg [spotify-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/spotify-amd64.svg [spotify-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [spotify-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/spotify/CHANGELOG.md b/spotify/CHANGELOG.md index 0c09c67c..c50059bc 100644 --- a/spotify/CHANGELOG.md +++ b/spotify/CHANGELOG.md @@ -1,29 +1,18 @@ [Full Changelog][changelog] -This add-on no longer needs a username and password, you can remove it and it will enable discovery mode, which allows anybody on your network (even with different Spotify account) to use the add-on 🤘 +### 🔨 Changes -However, if you'd like to lock it into your Spotify account, feel free to leave or put the username and password in the configuration. That still works and will disable the discovery mode. +- 🔨 Implement OCI image specification on labels +- ⬆ Upgrades cargo to 0.42.0-0ubuntu1~18.04.1 +- ⬆ Upgrades git to 1:2.17.1-1ubuntu0.7 +- ⬆ Upgrades libasound2 to 1.1.3-5ubuntu0.5 +- ⬆ Upgrades rustc to 1.41.0+dfsg1+llvm-0ubuntu1~18.04.1 +- ⬆ Upgrades Spotifyd to v0.2.24 +- ⬆ Upgrades add-on base image to v5.2.1 +- ✏ Split add-on documentation +- ⬆ Upgrades libssl-dev to 1.1.1-1ubuntu2.1~18.04.6 -The add-on has some upgrades to prepare for the new Home Assistant Audio handling that is expected soon. - -### :hammer: Changes - -- :books: Update add-on documentation to use new YAML configuration format -- :hammer: Re-branding -- :hammer: Update add-on config with new password & list features -- :arrow_up: Upgrades add-on base image to v5.0.1 -- :arrow_up: Upgrades cargo to 0.40.0-3ubuntu1~18.04.1 -- :arrow_up: Upgrades rustc to 1.39.0+dfsg1+llvm-3ubuntu1~18.04.1 -- :sparkles: Adds libasound2-plugins -- :pencil2: Replace some Hass.io occurances -- :arrow_up: Upgrades Spotifyd to v0.2.23 -- :hammer: Put add-on on the host network -- :hammer: Refactor add-on configuration -- :books: Update add-on instructions -- :hammer: Update community forum links -- :art: Updated screenshot - -[changelog]: https://github.com/hassio-addons/addon-spotify-connect/compare/v0.7.1...v0.8.0 +[changelog]: https://github.com/hassio-addons/addon-spotify-connect/compare/v0.8.0...v0.8.1 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: diff --git a/spotify/DOCS.md b/spotify/DOCS.md new file mode 100644 index 00000000..046edaf0 --- /dev/null +++ b/spotify/DOCS.md @@ -0,0 +1,164 @@ +# Home Assistant Community Add-on: Spotify Connect + +The Home Assistant 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 Home Assistant 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 + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Search for the "Spotify Connect" add-on in the Supervisor add-on store + and install it. +1. Select your audio output device and hit `Save` on that as well. +1. Start the "Spotify Connect" add-on. +1. Check the logs of the "Spotify Connect" to see if everything went well. +1. Ready to go! + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +name: HomeAssistant +bitrate: 320 +username: frenck@example.com +password: MySpotifyPassword +``` + +**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: `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`. + +### Option: `username` + +**IMPORTANT**: _This requires a Spotify Premium account!_ + +The username you use to login to your Spotify Premium account. Setting +this will bind the add-on to your account exclusively. + +This can be helpful when experiencing discovery issues on your network or +to disallow guests on your network to use the add-on. + +### Option: `password` + +The password you use to login to your Spotify Premium account. + +## 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][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], 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: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2018-2020 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. + +[contributors]: https://github.com/hassio-addons/addon-spotify-connect/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-spotify-connect/61210?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-spotify-connect/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-spotify-connect/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/spotify/README.md b/spotify/README.md index adb508a6..f00804ca 100644 --- a/spotify/README.md +++ b/spotify/README.md @@ -21,13 +21,10 @@ For example; Running Home Assistant on a Raspberry Pi with this add-on installed will allow you to play your Spotify music via the Pi. So all you'll have to do is hook up your sound system to the Pi! -[Click here for the full documentation][docs] - ![Spotify Connect][screenshot] [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-spotify-connect/blob/v0.8.0/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-spotify-connect/61210?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -36,6 +33,6 @@ you'll have to do is hook up your sound system to the Pi! [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-v0.8.0-blue.svg -[release]: https://github.com/hassio-addons/addon-spotify-connect/tree/v0.8.0 +[release-shield]: https://img.shields.io/badge/version-v0.8.1-blue.svg +[release]: https://github.com/hassio-addons/addon-spotify-connect/tree/v0.8.1 [screenshot]: https://github.com/hassio-addons/addon-spotify-connect/raw/master/images/screenshot.png \ No newline at end of file diff --git a/spotify/config.json b/spotify/config.json index c126b43b..44806e2e 100644 --- a/spotify/config.json +++ b/spotify/config.json @@ -1,6 +1,6 @@ { "name": "Spotify Connect", - "version": "0.8.0", + "version": "0.8.1", "slug": "spotify", "description": "Play Spotify music on your Home Assistant device", "url": "https://github.com/hassio-addons/addon-spotify-connect",