home-assistant.io/source/_components/sonos.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, featured, ha_release, ha_iot_class, redirect_from

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	featured	ha_release	ha_iot_class	redirect_from
page	Sonos	Instructions on how to integrate Sonos devices into Home Assistant.	2015-09-12 13:00	true	false	true	true	sonos.png	Media Player	true	0.7.3	Local Polling	/components/media_player.sonos/

The sonos component allows you to control your Sonos 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.

If you don't have the discovery component enabled, you can configure the Sonos component by going to the integrations page inside the config panel.

{% linkable_title Services %}

Sonos makes various services available to allow configuring groups. They are currently registered under the media player component.

{% linkable_title Service media_player.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.

The queue is not snapshotted and must be left untouched until the restore. Using `media_player.play_media` is safe and can be used to play a notification sound, including [TTS](/components/tts/) announcements.

Service data attribute	Optional	Description
entity_id	yes	The speakers to snapshot.
with_group	yes	Should we also snapshot the group layout and the state of other speakers in the group.

{% linkable_title Service media_player.sonos_restore %}

Restore a previously taken snapshot of one or more speakers. If no entity_id is provided, all speakers are restored.

The playing queue is not snapshotted. Using `media_player.sonos_restore` on a speaker that has replaced its queue will restore the playing position, but in the new queue!

A cloud queue cannot be restarted. This includes queues started from within Spotify and queues controlled by Amazon Alexa.

Service data attribute	Optional	Description
entity_id	yes	String or list of entity_ids that should have their snapshot restored.
with_group	yes	Should we also restore the group layout and the state of other speakers in the group.

{% linkable_title Service media_player.sonos_join %}

Group players together under a single coordinator. This will make a new group or join to an existing group.

Service data attribute	Optional	Description
master	no	A single entity_id that will become/stay the coordinator speaker.
entity_id	no	String or list of entity_ids to join to the master.

{% linkable_title Service media_player.sonos_unjoin %}

Remove one or more speakers from their 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_ids to separate from their coordinator speaker.

{% linkable_title Service media_player.sonos_set_sleep_timer %}

Sets a timer that will turn off a speaker by tapering the volume down to 0 after a certain amount of time. Protip: If you set the sleep_time value to 0, then the speaker will immediately start tapering the volume down.

Service data attribute	Optional	Description
entity_id	no	String or list of entity_ids that will have their timers set.
sleep_time	no	Integer number of seconds that the speaker should wait until it starts tapering. Cannot exceed 86399 (one day).

{% linkable_title Service media_player.sonos_clear_sleep_timer %}

Clear the sleep timer on a speaker, if one is set.

Service data attribute	Optional	Description
entity_id	no	String or list of entity_ids that will have their timers cleared. Must be a coordinator speaker.

{% linkable_title Service media_player.sonos_update_alarm %}

Update an existing Sonos alarm.

Service data attribute	Optional	Description
entity_id	no	String or list of entity_ids that will have their timers cleared. Must be a coordinator speaker.
alarm_id	no	Integer that is used in Sonos to refer to your alarm.
time	yes	Time to set the alarm.
volume	yes	Float for volume level.
enabled	yes	Boolean for whether or not to enable this alarm.
include_linked_zones	yes	Boolean that defines if the alarm also plays on grouped players.

{% linkable_title Service media_player.sonos_set_option %}

Set Sonos speaker options.

Night Sound and Speech Enhancement modes are only supported when playing from the TV source of products like Sonos Playbar and Sonos Beam. Other speaker types will ignore these options.

Service data attribute	Optional	Description
entity_id	no	String or list of entity_ids that will have their options set.
night_sound	yes	Boolean to control Night Sound mode.
speech_enhance	yes	Boolean to control Speech Enhancement mode.

{% linkable_title Advanced use %}

For advanced uses, there are some manual configuration options available.

If you have multiple network devices, you can provide the IP address of the device that should be used for Sonos auto-discovery.

# Example configuration.yaml entry using Sonos discovery on a specific interface
sonos:
  media_player:
    interface_addr: 192.0.2.1

You can also specify one or more hosts to connect to if they cannot be found with Sonos auto-discovery.

# Example configuration.yaml entry with manually specified addresses
sonos:
  media_player:
    hosts: 192.0.2.25

or, for multiple hosts:

# Example configuration.yaml entry with manually specified addresses
sonos:
  media_player:
    hosts:
      - 192.0.2.25
      - 192.0.2.26
      - 192.0.2.27