Site updated at 2016-08-22 08:21:42 UTC

This commit is contained in:
Travis CI 2016-08-22 08:21:43 +00:00
parent f9d65cbe57
commit 4acb07bf8e
559 changed files with 18878 additions and 21688 deletions

View file

@ -89,57 +89,49 @@
<hr class="divider">
<p>The <code>sonos</code> platform allows you to control your <a href="http://www.sonos.com">Sonos</a> HiFi wireless speakers and audio components from Home Assistant. By default it supports auto-discovery provided by Home Assistant, and you dont need to add anything to your <code>configuration.yaml</code>. Alternatively, there are some manual configuration options, listed as follows:</p>
<p>The <code class="highlighter-rouge">sonos</code> platform allows you to control your <a href="http://www.sonos.com">Sonos</a> HiFi wireless speakers and audio components from Home Assistant. By default it supports auto-discovery provided by Home Assistant, and you dont need to add anything to your <code class="highlighter-rouge">configuration.yaml</code>. Alternatively, there are some manual configuration options, listed as follows:</p>
<p>To add your Sonos components to your installation, add the following to your <code>configuration.yaml</code> file. It will perform Sonos auto-discovery of your connected speakers.</p>
<p>To add your Sonos components to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file. It will perform Sonos auto-discovery of your connected speakers.</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry using Sonos discovery</span>
<span class="key">media_player</span>:
<span class="key">platform</span>: <span class="string"><span class="content">sonos</span></span>
</pre></div>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry using Sonos discovery</span>
<span class="s">media_player</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">sonos</span>
</code></pre>
</div>
<p>If you have multiple network devices, you can provide the IP address of the device that should be used for Sonos auto-discovery.</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry using Sonos discovery on a specific interface</span>
<span class="key">media_player</span>:
<span class="key">platform</span>: <span class="string"><span class="content">sonos</span></span>
<span class="key">interface_addr</span>: <span class="string"><span class="content">192.0.2.1</span></span>
</pre></div>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry using Sonos discovery on a specific interface</span>
<span class="s">media_player</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">sonos</span>
<span class="s">interface_addr</span><span class="pi">:</span> <span class="s">192.0.2.1</span>
</code></pre>
</div>
<p>You can also specify one or more hosts to connect to if they cannot be found with Sonos auto-discovery.</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry with manually specified addresses</span>
<span class="key">media_player</span>:
<span class="key">platform</span>: <span class="string"><span class="content">sonos</span></span>
<span class="key">hosts</span>: <span class="string"><span class="content">192.0.2.25</span></span>
</pre></div>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry with manually specified addresses</span>
<span class="s">media_player</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">sonos</span>
<span class="s">hosts</span><span class="pi">:</span> <span class="s">192.0.2.25</span>
</code></pre>
</div>
<p>or, for multiple hosts:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry with manually specified addresses</span>
<span class="key">media_player</span>:
<span class="key">platform</span>: <span class="string"><span class="content">sonos</span></span>
<span class="key">hosts</span>:
- <span class="string"><span class="content">192.0.2.25</span></span>
- <span class="string"><span class="content">192.0.2.26</span></span>
- <span class="string"><span class="content">192.0.2.27</span></span>
</pre></div>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry with manually specified addresses</span>
<span class="s">media_player</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">sonos</span>
<span class="s">hosts</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">192.0.2.25</span>
<span class="pi">-</span> <span class="s">192.0.2.26</span>
<span class="pi">-</span> <span class="s">192.0.2.27</span>
</code></pre>
</div>
<h3><a class="title-link" name="service-sonos_snapshot" href="#service-sonos_snapshot"></a> Service <code>sonos_snapshot</code></h3>
<h3><a class="title-link" name="service-sonos_snapshot" href="#service-sonos_snapshot"></a> Service <code class="highlighter-rouge">sonos_snapshot</code></h3>
<p>Take a snapshot of what is currently playing on one or more speakers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards. If no <code>entity_id</code> is provided, all speakers are snapshotted.</p>
<p>Take a snapshot of what is currently playing on one or more speakers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards. If no <code class="highlighter-rouge">entity_id</code> is provided, all speakers are snapshotted.</p>
<table>
<thead>
@ -151,16 +143,16 @@
</thead>
<tbody>
<tr>
<td><code>entity_id</code></td>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>no</td>
<td>String or list of strings that point at <code>entity_id</code>s of coordinator speakers.</td>
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of coordinator speakers.</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="service-sonos_restore" href="#service-sonos_restore"></a> Service <code>sonos_restore</code></h3>
<h3><a class="title-link" name="service-sonos_restore" href="#service-sonos_restore"></a> Service <code class="highlighter-rouge">sonos_restore</code></h3>
<p>Restore a previosly taken snapshot of one or more speakers. If no <code>entity_id</code> is provided, all speakers are restored.</p>
<p>Restore a previosly taken snapshot of one or more speakers. If no <code class="highlighter-rouge">entity_id</code> is provided, all speakers are restored.</p>
<table>
<thead>
@ -172,14 +164,14 @@
</thead>
<tbody>
<tr>
<td><code>entity_id</code></td>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>no</td>
<td>String or list of strings that point at <code>entity_id</code>s of coordinator speakers.</td>
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of coordinator speakers.</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="service-sonos_group_players" href="#service-sonos_group_players"></a> Service <code>sonos_group_players</code></h3>
<h3><a class="title-link" name="service-sonos_group_players" href="#service-sonos_group_players"></a> Service <code class="highlighter-rouge">sonos_group_players</code></h3>
<p>Group all players together under a single coordinator.</p>
@ -193,16 +185,16 @@
</thead>
<tbody>
<tr>
<td><code>entity_id</code></td>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>no</td>
<td>String or list of a single <code>entity_id</code> that will become the coordinator speaker.</td>
<td>String or list of a single <code class="highlighter-rouge">entity_id</code> that will become the coordinator speaker.</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="service-sonos_unjoin" href="#service-sonos_unjoin"></a> Service <code>sonos_unjoin</code></h3>
<h3><a class="title-link" name="service-sonos_unjoin" href="#service-sonos_unjoin"></a> Service <code class="highlighter-rouge">sonos_unjoin</code></h3>
<p>Remove one or more speakers from a group of speakers. If no <code>entity_id</code> is provided, all speakers are unjoined.</p>
<p>Remove one or more speakers from a group of speakers. If no <code class="highlighter-rouge">entity_id</code> is provided, all speakers are unjoined.</p>
<table>
<thead>
@ -214,9 +206,9 @@
</thead>
<tbody>
<tr>
<td><code>entity_id</code></td>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>no</td>
<td>String or list of <code>entity_id</code>s that will be separated from their coordinator speaker.</td>
<td>String or list of <code class="highlighter-rouge">entity_id</code>s that will be separated from their coordinator speaker.</td>
</tr>
</tbody>
</table>