Sonos for Home Assistant (built-in integration)

About

Sonos is a built-in integration that controls Sonos speakers locally from Home Assistant. Home Assistant finds the speakers on the network and offers to add them, and the integration is then set up in the UI. Besides media player control, it adds number controls for audio delay, balance, bass, treble, surround levels and subwoofer gain and crossover frequency. Switches cover settings such as crossfade, loudness, night sound, speech enhancement, touch controls and the status light, and a sensor reports the audio input format and power source. Actions can take and restore a snapshot of a media player, set or clear a timer, update an alarm, and read or change the playback queue. New devices appear without repeating setup, and repair notices flag networking problems such as failed subscriptions or disabled UPnP.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Found by itself Home Assistant spots it on the network and offers to add it.
Adds new devices New devices show up without setting it up again.
Bronze quality Home Assistant's own rating of its code and setup experience.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Media
Switches
Sensors

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Entities

Binary sensorsMicrophone
ButtonsCancel announcement
NumbersAudio delay, Balance, Bass, Music surround level, Sub crossover frequency, Sub gain, Surround level, Treble
SelectsSpeech enhancement
SensorsAudio input format, Power source
SwitchesTouch controls, Crossfade, Speech enhancement, Loudness, Night sound, Status light, Subwoofer enabled, Surround enabled, Surround music full volume, TV autoplay, Ungroup on autoplay

Actions

Clear timerClears a Sonos timer.
Get queueReturns the contents of the queue.
Play queueStarts playing the queue from the first item.Fields: Queue position
Remove from queueRemoves an item from the queue.Fields: Queue position
RestoreRestores a snapshot of a media player.Fields: With group
Set timerSets a Sonos timer.Fields: Sleep Time
SnapshotTakes a snapshot of a media player.Fields: With group
Update alarmUpdates an alarm with new time and volume settings.Fields: Alarm ID, Alarm enabled, Include linked zones, Time, Volume

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Networking error: subscriptions failed, Networking error: UPnP disabled