365 lines
18 KiB
HTML
365 lines
18 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>Spotify - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions on how to integrate Spotify into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/media_player.spotify/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Spotify">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/media_player.spotify/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions on how to integrate Spotify into Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
<meta name="twitter:title" content="Spotify">
|
||
<meta name="twitter:description" content="Instructions on how to integrate Spotify into Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<header>
|
||
<h1 class="title indent">
|
||
Spotify
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">spotify</code> media player platform allows you to control <a href="https://www.spotify.com/">Spotify</a> playback from Home Assistant.</p>
|
||
<h2><a class="title-link" name="prerequisites" href="#prerequisites"></a> Prerequisites</h2>
|
||
<ul>
|
||
<li>Spotify account.</li>
|
||
<li>Spotify Application, properly configured</li>
|
||
</ul>
|
||
<p class="note">
|
||
Controlling the Spotify component (pause, play, next, etc) requires a Premium account. If you do not have a Premium account, the component in the frontend will not show the controls.
|
||
</p>
|
||
<p>To create the required Spotify Application:</p>
|
||
<ul>
|
||
<li>Login to <a href="https://developer.spotify.com">Spotify Developer</a></li>
|
||
<li>Visit the <a href="https://developer.spotify.com/my-applications/#!/applications">My Applications</a> page</li>
|
||
<li>Select <strong>Create An App</strong>. Enter any name and description. Once your application is created, view it and copy your <strong>Client ID</strong> and <strong>Client Secret</strong>, which are used in the Home Assistant configuration file.</li>
|
||
<li>Add a <strong>Redirect URI</strong> in the following forms:</li>
|
||
</ul>
|
||
<p>No SSL: <code class="highlighter-rouge">http://<your_home_assistant_url_or_local_ip>:<port>/api/spotify</code></p>
|
||
<p>If using SSL: <code class="highlighter-rouge">https://<your_home_assistant_url_or_local_ip>:<port>/api/spotify</code></p>
|
||
<p>The URL is whatever you use to access Home Assistant from outside your network (including port if applicable).</p>
|
||
<ul>
|
||
<li>Click <strong>Save</strong> after adding the URI. You may also need to set the <code class="highlighter-rouge">base_url</code> attribute of the <a href="https://home-assistant.io/components/http/">HTTP Component</a>.</li>
|
||
</ul>
|
||
<h2><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h2>
|
||
<p>To add Spotify to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">media_player</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">spotify</span>
|
||
<span class="s">client_id</span><span class="pi">:</span> <span class="s"><your client id></span>
|
||
<span class="s">client_secret</span><span class="pi">:</span> <span class="s"><your client secret></span>
|
||
<span class="s">aliases</span><span class="pi">:</span>
|
||
<span class="s">abc123def456</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Living</span><span class="nv"> </span><span class="s">Room'</span>
|
||
<span class="s">9183abas000</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Bed</span><span class="nv"> </span><span class="s">Room'</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>client_id</strong> (<em>Required</em>): Client ID from your Spotify Application.</li>
|
||
<li><strong>client_secret</strong> (<em>Required</em>): Client Secret from your Spotify Application.</li>
|
||
<li><strong>cache_path</strong> (<em>Optional</em>): Path to cache authentication token (defaults to configuration directory).</li>
|
||
<li><strong>aliases</strong> (<em>Optional</em>): Dictionary of device ids to be aliased, handy for devices that Spotify cannot properly determine the device name of. New devices will be logged to the <code class="highlighter-rouge">info</code> channel for ease of aliasing.</li>
|
||
</ul>
|
||
<h2><a class="title-link" name="setup" href="#setup"></a> Setup</h2>
|
||
<p>After the prerequisites and configuration are complete, restart Home Assistant. A <strong>Spotify</strong> configurator element will be available. Follow the instructions to authorize Home Assistant to access your Spotify account. A Spotify media player will then appear. If Spotify prompts you to download a file after completing authorization, discard the download. It is not needed.</p>
|
||
<h2><a class="title-link" name="sources" href="#sources"></a> Sources</h2>
|
||
<p>The sources are based on if you have streamed to these devices before in Spotify. If you don’t have any sources, then simply stream from your phone to another device in your house, Bluetooth, echo, etc. Once you do the sources will show up in the developer console as a device to cast/stream to. Also know that the devices won’t show up in the dev-console as sources unless they are powered on as well.</p>
|
||
<h2><a class="title-link" name="uri-links-for-playlistsetc" href="#uri-links-for-playlistsetc"></a> URI Links For Playlists/Etc</h2>
|
||
<p>You can send playlists to spotify via the “media_content_type”: “playlist” and “media_content_id”: “spotify:user:spotify:playlist:37i9dQZF1DWSkkUxEhrBdF” which are a part of the media_player.play_media service, you can test this from the services control panel in the Home Assistant frontend.</p>
|
||
<p>In this example this is a URI link to the Reggae Infusions playlist, the link below from Spotify explains how to get this URI value to use for playlists in the Spotify component.</p>
|
||
<p>https://support.spotify.com/us/using_spotify/share_music/why-do-you-have-two-different-link-formats/</p>
|
||
</article>
|
||
</div>
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/media_player.spotify.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/spotify.png' />
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Cloud Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.43
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/media_player/spotify.py'>media_player/spotify.py</a>
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/media_player/'>the Media Player component</a>.
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Media Player</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/media_player.anthemav/'>Anthem A/V Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.apple_tv/'>Apple TV Media Player</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.bluesound/'>Bluesound</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.clementine/'>Clementine Music Player</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.denonavr/'>Denon AVR Network Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.denon/'>Denon Network Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.directv/'>DirecTV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.dunehd/'>DuneHD media players</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.emby/'>Emby</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.firetv/'>FireTV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.frontier_silicon/'>Frontier Silicon Internet Radios</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.cast/'>Google Cast</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.gpmdp/'>Google Play Music Desktop Player</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.gstreamer/'>Gstreamer</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.kodi/'>Kodi</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.lg_netcast/'>LG Netcast TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.webostv/'>LG webOS Smart TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.openhome/'>Linn / Openhome</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.squeezebox/'>Logitech Squeezebox</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.ue_smart_radio/'>Logitech UE Smart Radio</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.mpchc/'>MPC-HC</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_extractor/'>Media Extractor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.monoprice/'>Monoprice 6-Zone Amplifier</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.mpd/'>Music Player Daemon (MPD)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.nad/'>NAD</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.nadtcp/'>NAD tcp</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.onkyo/'>Onkyo</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.liveboxplaytv/'>Orange Livebox Play TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.panasonic_viera/'>Panasonic Viera TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.pandora/'>Pandora</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.philips_js/'>Philips TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.pioneer/'>Pioneer Network Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.plex/'>Plex</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.plex/'>Plex Activity Monitor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.roku/'>Roku</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.russound_rio/'>Russound RIO</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.russound_rnet/'>Russound RNET</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.samsungtv/'>Samsung Smart TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.aquostv/'>Sharp Aquos TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.snapcast/'>Snapcast</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.sonos/'>Sonos</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.braviatv/'>Sony Bravia TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.soundtouch/'>Soundtouch</a>
|
||
</li>
|
||
<li>
|
||
Spotify
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.universal/'>Universal</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.vlc/'>VLC</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.vizio/'>Vizio SmartCast TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.volumio/'>Volumio Media Player</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.yamaha_musiccast/'>Yamaha MusicCast Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.yamaha/'>Yamaha Network Receivers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.ziggo_mediabox_xl/'>Ziggo Mediabox XL</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.cmus/'>cmus</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/media_player.itunes/'>iTunes</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|