jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-15 13:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sonos add tests (#683)

Browse Source 
* Converting pre-existing docs to more useful format

* Adding missing services, fixing inconsistencies with earlier ones

* Ensuring all setup options are documented for Sonos, also clarifying discovery options

* Further clarifying discovery options and entity_id requirements
This commit is contained in:
Scott O'Neil 2016-07-29 11:57:44 -05:00 committed by Fabian Affolter
parent f451055999
commit fd2b64a0f7
1 changed files with 57 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
source/_components/media_player.sonos.markdown
View File

@ -13,27 +13,75 @@ featured: true
ha_release: 0.7.3
---
The `sonos` platform allows you to control your [Sonos](http://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant.
The `sonos` platform allows you to control your [Sonos](http://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant. By default it supports auto-discovery provided by Home Assistant, and you don't need to add anything to your `configuration.yaml`. Alternatively, there are some manual configuration options, listed as follows:
To add your Sonos components to your installation, add the following to your `configuration.yaml` file. It will perform auto-discovery of your connected speakers.
To add your Sonos components to your installation, add the following to your `configuration.yaml` file. It will perform Sonos auto-discovery of your connected speakers.
```yaml
# Example configuration.yaml entry
# Example configuration.yaml entry using Sonos discovery
media_player:
platform: sonos
```
You can also specify hosts to connect to if they cannot be found with auto-discovery.
If you have multiple network devices, you can provide the IP address of the device that should be used for Sonos auto-discovery.
```yaml
# Example configuration.yaml entry
# Example configuration.yaml entry using Sonos discovery on a specific interface
media_player:
platform: sonos
hosts: IP
interface_addr: 192.0.2.1
```
### {% linkable_title Service %}
You can also specify one or more hosts to connect to if they cannot be found with Sonos auto-discovery.
There are two extra services exposed that will allow you to take a snapshot of what is currently playing and restore it afterwards. This is useful if you want to play a doorbell or notification sound and resume playback afterwards.
```yaml
# Example configuration.yaml entry with manually specified addresses
media_player:
platform: sonos
hosts: 192.0.2.25
```
or, for multiple hosts:
```yaml
# Example configuration.yaml entry with manually specified addresses
media_player:
platform: sonos
hosts:
- 192.0.2.25
- 192.0.2.26
- 192.0.2.27
```
### {% linkable_title Service `sonos_snapshot` %}
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 `entity_id` is provided, all speakers are snapshotted.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of coordinator speakers.
### {% linkable_title Service `sonos_restore` %}
Restore a previosly taken snapshot of one or more speakers. If no `entity_id` is provided, all speakers are restored.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of coordinator speakers.
### {% linkable_title Service `sonos_group_players` %}
Group all players together under a single coordinator.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of a single `entity_id` that will become the coordinator speaker.
### {% linkable_title Service `sonos_unjoin` %}
Remove one or more speakers from a group of speakers. If no `entity_id` is provided, all speakers are unjoined.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will be separated from their coordinator speaker.
The services are called `sonos_snapshot` and `snapshot_restore`.