Home ▸ Integrations ▸

Sonos

The sonos integration allows you to control your Sonos wireless speakers from Home Assistant. It also works with IKEA Symfonisk speakers.

Configuration

To add the Sonos integration to your Home Assistant instance, use this My button:

Sonos can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.

Manual configuration steps

If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:

Browse to your Home Assistant instance.
Go to Settings > Devices & Services.
In the bottom right corner, select the Add Integration button.
From the list, select Sonos.
Follow the instructions on screen to complete the setup.

Feature controls & sensors

Speaker-level controls are exposed as number or switch entities. Additionally, various sensor and binary_sensor entities are provided.

Controllable features

All devices: Alarms, Bass, Treble, Loudness, Crossfade, Status Light, Touch Controls
Home theater devices: Audio Delay (“Lip Sync”), Night Sound, Speech Enhancement, Surround Enabled, Surround Music Full Volume (“Full/Ambient”), Surround Level (“TV Level”), Music Surround Level
When paired with a sub: Subwoofer Enabled, Subwoofer Gain, Subwoofer Crossover Frequency (Sonos Amp only)

Sensors

Each Sonos system: Sonos Favorites
Devices with battery: Battery level, Power state
Home theater devices: Audio Input Format
Voice-enabled devices: Microphone Enabled

Battery support notes

Battery sensors are fully supported for the Sonos Roam and Sonos Move devices on S2 firmware. Sonos Move speakers still on S1 firmware are supported but may update infrequently.

For each speaker with a battery, a sensor showing the current battery charge level and a binary_sensor showing the power state of the speaker are created. The binary_sensor reports if the speaker is currently powered by an external source and its power_source attribute shows which specific source is providing the current power. This source attribute can be one of BATTERY, SONOS_CHARGING_RING if using wireless charging, or USB_POWER if charging via USB cable. Note that the Roam will report SONOS_CHARGING_RING even when using a generic Qi charger.

Note

The battery sensors rely on working change events or updates will be delayed. S1 battery sensors require working events to report any data. See more details in Advanced use.

Alarm support notes

The Sonos integration adds one switch for each alarm set in the Sonos app. The alarm switches are detected, deleted and assigned automatically and come with several attributes that help to monitor Sonos alarms.

Microphone support notes

The microphone can only be enabled/disabled from physical buttons on the Sonos device and cannot be controlled from Home Assistant. A binary_sensor reports its current state.

Sonos Favorites support notes

The favorites sensor provides the names and media_content_id values for each of the favorites saved to My Sonos in the native Sonos app. This sensor is intended for users that need to access the favorites in a custom template. For most users, accessing favorites by using the Media Browser functionality and “Play media” script/automation action is recommended.

When calling the media_player.play_media action, the media_content_type must be set to “favorite_item_id” and the media_content_id must be set to just the key portion of the favorite item.

Example action using the item id:

action: media_player.play_media
target:
  entity_id: media_player.sonos_speaker1
data:
  media_content_type: "favorite_item_id"
  media_content_id: "FV:2/31"

Example using the Sonos playlist name:

action: media_player.play_media
target:
  entity_id: media_player.sonos_speaker1
data:
  media_content_type: playlist
  media_content_id: stevie_wonder

Example templates:

# Get all favorite names as a list (old behavior)
{{ state_attr("sensor.sonos_favorites", "items").values() | list }}

# Pick a specific favorite name by position
{{ (state_attr("sensor.sonos_favorites", "items").values() | list)[3] }}

# Pick a random item's `media_content_id`
{{ state_attr("sensor.sonos_favorites", "items") | list | random }}

# Loop through and grab name & media_content_id
{% for media_id, name in state_attr("sensor.sonos_favorites", "items").items() %}
  {{ name, media_id }}
{% endfor %}

Tip

The Sonos favorites sensor (sensor.sonos_favorites) is disabled by default. It can be found and enabled from the entities associated with the Sonos integration on your Devices & services page.

Playing media

Sonos accepts a variety of media_content_id formats in the media_player.play_media action, but most commonly as URIs. For example, both Spotify and Tidal share links can be provided as-is. Playback of music hosted on a Plex server is possible. Direct HTTP/HTTPS links to local or remote media files can also be used if the Sonos device can reach the URI directly, but specific media encoding support may vary.

Music services which require an account (e.g., Spotify) must first be configured using the Sonos app.

Playing TTS (text-to-speech) or audio files as alerts (e.g., a doorbell or alarm) is possible by setting the announce argument to true. Using announce will play the provided media URL as an overlay, gently lowering the current music volume and automatically restoring to the original level when finished. An optional volume argument can also be provided in the extra dictionary to play the alert at a specific volume level. Note that older Sonos hardware or legacy firmware versions (“S1”) may not fully support these features. Additionally, see Network Requirements for use in restricted networking environments.

An optional enqueue argument can be added to the action. If replace or not provided then the queue will be replaced and the item will be replaced. If add the item will be appended to the queue. If next the item will be added into the queue to play next. If play, the item will be added into the queue and played immediately.

Examples:

Below is an example action that plays an audio file from a web server on the local network (like the Home Assistant built-in webserver) using the announce feature and its associated (optional) volume parameter:

action: media_player.play_media
target:
  entity_id: media_player.sonos
data:
  announce: true
  media_content_type: "music"
  media_content_id: "http://192.168.1.50:8123/local/sound_files/doorbell-front.mp3"
  extra:
    volume: 20

The standard tts.<source>_say actions do not accept the volume parameter directly. To set the volume for a TTS announcement, you can use a TTS Media Source URL with the standard media_player.play_media action:

action: media_player.play_media
target:
  entity_id: media_player.sonos
data:
  announce: true
  media_content_id: >
    media-source://tts/cloud?message="I am very loud"
  media_content_type: "music"
  extra:
    volume: 80

Sonos can also play music or playlists from Spotify. Both Spotify URIs and URLs can be used directly. An example action using a playlist URI:

action: media_player.play_media
target:
  entity_id: media_player.sonos
data:
  media_content_type: "playlist"
  media_content_id: "spotify:playlist:abcdefghij0123456789XY"
  enqueue: true

An example action using a Spotify URL:

action: media_player.play_media
target:
  entity_id: media_player.sonos
data:
  media_content_type: "music"
  media_content_id: "https://open.spotify.com/album/abcdefghij0123456789YZ"

Run a Plex Media Server in your home? The Sonos integration can work with that as well. This example plays music directly from your Plex server:

action: media_player.play_media
target:
  entity_id: media_player.sonos
data:
  media_content_type: "music"
  media_content_id: >
    plex://{ "library_name": "Music", "artist_name": "M83", "album_name": "Hurry Up, We're Dreaming" }

Sonos Music Library

If you have configured a Sonos music library; you can play music from it.

Play all albums by the Beatles.

action: media_player.play_media
target:
  entity_id: media_player.sonos
data:
  media_content_type: album
  media_content_id: A:ALBUMARTIST/Beatles

Play a specific album:

action: media_player.play_media
target:
  entity_id: media_player.sonos
data:
  media_content_type: album
  media_content_id: A:ALBUM/The Wall
  enqueue: replace

Or add a specific album by a specific artist to the queue. This is useful in case you have multiple albums with the same name.

action: media_player.play_media
target:
  entity_id: media_player.sonos      
data:
  media_content_type: album
  media_content_id: A:ALBUMARTIST/Neil Young/Greatest Hits
  enqueue: add

Play all albums by a composer.

action: media_player.play_media
target:
  entity_id: media_player.porch
data:
  media_content_type: composer
  media_content_id: A:COMPOSER/Carlos Santana
  enqueue: play

Play all albums by a genre.

action: media_player.play_media
target:
  entity_id: media_player.porch
data:
  media_content_type: genre
  media_content_id: "A:GENRE/Classic%20Rock/"
  enqueue: play

Play an imported playlist by using its title.

action: media_player.play_media
target:
  entity_id: media_player.porch
data:
  media_content_type: playlist
  media_content_id: S:/MyPlaylist
  enqueue: play

Actions

The Sonos integration makes various custom actions available in addition to the standard media player actions.

Action sonos.snapshot

Take a snapshot of what is currently playing on one or more speakers. This action, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards.

Note

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 announcements.

Data attribute	Optional	Description
`entity_id`	yes	The speakers to snapshot. To target all Sonos devices, use `all`.
`with_group`	yes	Should we also snapshot the group layout and the state of other speakers in the group, defaults to true.

Action sonos.restore

Restore a previously taken snapshot of one or more speakers.

Note

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

Note

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

Data attribute	Optional	Description
`entity_id`	yes	String or list of `entity_id`s that should have their snapshot restored. To target all Sonos devices, use `all`.
`with_group`	yes	Should we also restore the group layout and the state of other speakers in the group, defaults to true.

Action 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.

Data attribute	Optional	Description
`entity_id`	yes	String or list of `entity_id`s 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).

Action sonos.clear_sleep_timer

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

Data attribute	Optional	Description
`entity_id`	no	String or list of `entity_id`s that will have their timers cleared. Must be a coordinator speaker.

Action sonos.update_alarm

Update an existing Sonos alarm.

Data attribute	Optional	Description
`entity_id`	yes	String or list of `entity_id`s 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.

Action sonos.play_queue

Starts playing the Sonos queue.

Force start playing the queue, allows switching from another stream (such as radio) to playing the queue.

Data attribute	Optional	Description
`entity_id`	yes	String or list of `entity_id`s that will start playing. It must be the coordinator if targeting a group.
`queue_position`	yes	Position of the song in the queue to start playing from, starts at 0.

Action sonos.get_queue

Returns the media_players queue.

Data attribute	Optional	Description
`entity_id`	no	media_player entity id.

This example script does the following: get the queue, loop through in reverse order, and remove media containing the words “holiday”.

  - action: sonos.get_queue
    target:
      entity_id: media_player.living_room
    response_variable: queue
  - variables:
      queue_len: '{{ queue["media_player.living_room"] | length }}'
  - repeat:
      sequence:
        - variables:
            title: '{{ queue["media_player.living_room"][queue_len - repeat.index]["media_title"].lower() }}'
            album: '{{ queue["media_player.living_room"][queue_len - repeat.index]["media_album_name"].lower() }}'
            position: '{{ queue_len - repeat.index }}'
        - if:
            - '{{ "holiday" in title or "holiday" in album }}'
          then:
            - action: sonos.remove_from_queue
              target:
                entity_id: media_player.living_room
              data:
                queue_position: '{{position}}'
      until:
        - condition: template
          value_template: '{{queue_len == repeat.index}}'

Action sonos.remove_from_queue

Removes an item from the queue.

Data attribute	Optional	Description
`entity_id`	yes	String or list of `entity_id`s that will remove an item from the queue. It must be the coordinator if targeting a group.
`queue_position`	yes	Position in the queue to remove.

# Example automation to remove just played song from queue
alias: "Remove last played song from queue"
triggers:
  - trigger: state
    entity_id: media_player.kitchen
  - trigger: state
    entity_id: media_player.bathroom
  - trigger: state
    entity_id: media_player.move
conditions:
  - condition: and
    conditions:
      # Coordinator
      - condition: template
        value_template: >
          {{ state_attr( trigger.entity_id , 'group_members')[0] ==  trigger.entity_id }}
      # Going from queue to queue
      - condition: template
        value_template: >
          {{ 'queue_position' in trigger.from_state.attributes and 'queue_position' in trigger.to_state.attributes }}
      # Moving forward
      - condition: template
        value_template: >
          {{ trigger.from_state.attributes.queue_position < trigger.to_state.attributes.queue_position }}
actions:
  - action: sonos.remove_from_queue
    target:
      entity_id: >
        {{ trigger.entity_id }}
    data:
      queue_position: >
        {{ trigger.from_state.attributes.queue_position }}

Network requirements

To work optimally, the Sonos devices must be able to connect back to the Home Assistant host on TCP port 1400. This will allow the push-based updates to work properly. If this port is blocked or otherwise unreachable from the Sonos devices, the integration will fall back to a polling mode which is slower to update and much less efficient. The integration will alert the user if this problem is detected.

Playing audio using the announce option or TTS requires TCP port 1443 on each Sonos device to be reachable from the Home Assistant host.

See Advanced use below for additional configuration options which may be needed to address this issue in setups with more complex network topologies.

Advanced use

For advanced uses, there are some manual configuration options available. These are usually only needed if you have a complex network setup where Home Assistant and Sonos are not on the same subnet.

You can disable auto-discovery by specifying the Sonos IP addresses:

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

If your Home Assistant instance has multiple IP addresses, you can select the specific IP address that should be used for Sonos auto-discovery with the Network integration. This should only be necessary if the Sonos speakers are on a network segment not reachable from the default interface.

The Sonos speakers will attempt to connect back to Home Assistant to deliver change events. By default, Home Assistant will listen on port 1400 but will try the next 100 ports above 1400 if it is in use. You can change the IP address that Home Assistant advertises to Sonos speakers. This can help in NAT scenarios such as when not using the Docker option --net=host:

# Example configuration.yaml entry modifying the advertised host address
sonos:
  media_player:
    advertise_addr: 192.0.2.1

Help us improve our documentation

Suggest an edit to this page, or provide/view feedback for this page.

Edit Provide feedback View pending feedback