Link Search Menu Expand Document

DeviceProperties service

Modify device properties, like LED status and stereo pairs

The DeviceProperties service is available on these models: Sonos One (S13) S2 / Sonos Beam (S14) S2 / Sonos Roam (S27) S2 / Sonos Play:3 (S3) S2 / Sonos Play:5 (S6) S2 / Sonos Sub (Sub) S2 / Sonos Play:1 (S1) S1 / Sonos Play:5 (S5) S1 / Sonos Playbar (S9) S1.

  1. Available actions
    1. AddBondedZones
    2. AddHTSatellite
    3. CreateStereoPair
    4. EnterConfigMode
    5. ExitConfigMode
    6. GetAutoplayLinkedZones
    7. GetAutoplayRoomUUID
    8. GetAutoplayVolume
    9. GetButtonLockState
    10. GetButtonState
    11. GetHouseholdID
    12. GetLEDState
    13. GetUseAutoplayVolume
    14. GetZoneAttributes
    15. GetZoneInfo
    16. RemoveBondedZones
    17. RemoveHTSatellite
    18. RoomDetectionStartChirping
    19. RoomDetectionStopChirping
    20. SeparateStereoPair
    21. SetAutoplayLinkedZones
    22. SetAutoplayRoomUUID
    23. SetAutoplayVolume
    24. SetButtonLockState
    25. SetLEDState
    26. SetUseAutoplayVolume
    27. SetZoneAttributes
  2. Events
    1. Subscribe to events
    2. Event variables

Service data

name value
Control URL http://192.168.x.x:1400/DeviceProperties/Control
Event subscription URL http://192.168.x.x:1400/DeviceProperties/Event
Discovery url http://192.168.x.x:1400/xml/DeviceProperties1.xml
Service ID urn:upnp-org:serviceId:DeviceProperties
Service type urn:schemas-upnp-org:service:DeviceProperties:1

Sample request

POST /DeviceProperties/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-upnp-org:service:DeviceProperties:1#{ActionName}"
Content-Type: text/xml; charset="utf-8"

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <s:Body>
    {ActionBodyHere}
  </s:Body>
</s:Envelope>

Available actions

AddBondedZones

Action body:

<u:AddBondedZones xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <ChannelMapSet>string</ChannelMapSet>
</u:AddBondedZones>

Inputs:

parameter type description
ChannelMapSet string  

AddHTSatellite

Action body:

<u:AddHTSatellite xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <HTSatChanMapSet>string</HTSatChanMapSet>
</u:AddHTSatellite>

Inputs:

parameter type description
HTSatChanMapSet string  

CreateStereoPair

Create a stereo pair (left, right speakers), right one becomes hidden

Action body:

<u:CreateStereoPair xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <ChannelMapSet>string</ChannelMapSet>
</u:CreateStereoPair>

Inputs:

parameter type description
ChannelMapSet string example: RINCON_B8E9375831C001400:LF,LF;RINCON_000E58FE3AEA01400:RF,RF

Remarks No all speakers support StereoPairs

EnterConfigMode

Action body:

<u:EnterConfigMode xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <Mode>string</Mode>
  <Options>string</Options>
</u:EnterConfigMode>

Inputs:

parameter type description
Mode string  
Options string  

Outputs:

parameter type description
State string  

ExitConfigMode

Action body:

<u:ExitConfigMode xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <Options>string</Options>
</u:ExitConfigMode>

Inputs:

parameter type description
Options string  

GetAutoplayLinkedZones

Action body:

<u:GetAutoplayLinkedZones xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <Source>string</Source>
</u:GetAutoplayLinkedZones>

Inputs:

parameter type description
Source string  

Outputs:

parameter type description
IncludeLinkedZones boolean 1 for true and 0 for false

GetAutoplayRoomUUID

Action body:

<u:GetAutoplayRoomUUID xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <Source>string</Source>
</u:GetAutoplayRoomUUID>

Inputs:

parameter type description
Source string  

Outputs:

parameter type description
RoomUUID string  

GetAutoplayVolume

Action body:

<u:GetAutoplayVolume xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <Source>string</Source>
</u:GetAutoplayVolume>

Inputs:

parameter type description
Source string  

Outputs:

parameter type description
CurrentVolume ui2  

GetButtonLockState

Get the current button lock state

Action body:

<u:GetButtonLockState xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
</u:GetButtonLockState>

No input arguments

Outputs:

parameter type description
CurrentButtonLockState string Possible values: On / Off

GetButtonState

Action body:

<u:GetButtonState xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
</u:GetButtonState>

No input arguments

Outputs:

parameter type description
State string  

GetHouseholdID

Action body:

<u:GetHouseholdID xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
</u:GetHouseholdID>

No input arguments

Outputs:

parameter type description
CurrentHouseholdID string  

GetLEDState

Get the current LED state

Action body:

<u:GetLEDState xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
</u:GetLEDState>

No input arguments

Outputs:

parameter type description
CurrentLEDState string Possible values: On / Off

GetUseAutoplayVolume

Action body:

<u:GetUseAutoplayVolume xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <Source>string</Source>
</u:GetUseAutoplayVolume>

Inputs:

parameter type description
Source string  

Outputs:

parameter type description
UseVolume boolean 1 for true and 0 for false

GetZoneAttributes

Action body:

<u:GetZoneAttributes xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
</u:GetZoneAttributes>

No input arguments

Outputs:

parameter type description
CurrentZoneName string  
CurrentIcon string  
CurrentConfiguration string  

GetZoneInfo

Get information about this specific speaker

Action body:

<u:GetZoneInfo xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
</u:GetZoneInfo>

No input arguments

Outputs:

parameter type description
SerialNumber string  
SoftwareVersion string  
DisplaySoftwareVersion string  
HardwareVersion string  
IPAddress string  
MACAddress string  
CopyrightInfo string  
ExtraInfo string  
HTAudioIn ui4 SPDIF input, 0 not connected / 2 stereo / 7 Dolby 2.0 / 18 dolby 5.1 / 21 not listening / 22 silence
Flags ui4  

RemoveBondedZones

Action body:

<u:RemoveBondedZones xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <ChannelMapSet>string</ChannelMapSet>
  <KeepGrouped>boolean</KeepGrouped>
</u:RemoveBondedZones>

Inputs:

parameter type description
ChannelMapSet string  
KeepGrouped boolean Allowed values: 1 (= true) / 0 (= false)

RemoveHTSatellite

Action body:

<u:RemoveHTSatellite xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <SatRoomUUID>string</SatRoomUUID>
</u:RemoveHTSatellite>

Inputs:

parameter type description
SatRoomUUID string  

RoomDetectionStartChirping

Action body:

<u:RoomDetectionStartChirping xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <Channel>ui2</Channel>
  <DurationMilliseconds>ui4</DurationMilliseconds>
</u:RoomDetectionStartChirping>

Inputs:

parameter type description
Channel ui2  
DurationMilliseconds ui4  

Outputs:

parameter type description
PlayId ui4  
ChirpIfPlayingSwappableAudio boolean 1 for true and 0 for false

RoomDetectionStopChirping

Action body:

<u:RoomDetectionStopChirping xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <PlayId>ui4</PlayId>
</u:RoomDetectionStopChirping>

Inputs:

parameter type description
PlayId ui4  

SeparateStereoPair

Separate a stereo pair

Action body:

<u:SeparateStereoPair xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <ChannelMapSet>string</ChannelMapSet>
</u:SeparateStereoPair>

Inputs:

parameter type description
ChannelMapSet string example: RINCON_B8E9375831C001400:LF,LF;RINCON_000E58FE3AEA01400:RF,RF

Remarks No all speakers support StereoPairs

SetAutoplayLinkedZones

Action body:

<u:SetAutoplayLinkedZones xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <IncludeLinkedZones>boolean</IncludeLinkedZones>
  <Source>string</Source>
</u:SetAutoplayLinkedZones>

Inputs:

parameter type description
IncludeLinkedZones boolean Allowed values: 1 (= true) / 0 (= false)
Source string  

SetAutoplayRoomUUID

Action body:

<u:SetAutoplayRoomUUID xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <RoomUUID>string</RoomUUID>
  <Source>string</Source>
</u:SetAutoplayRoomUUID>

Inputs:

parameter type description
RoomUUID string  
Source string  

SetAutoplayVolume

Action body:

<u:SetAutoplayVolume xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <Volume>ui2</Volume>
  <Source>string</Source>
</u:SetAutoplayVolume>

Inputs:

parameter type description
Volume ui2  
Source string  

SetButtonLockState

Set the button lock state

Action body:

<u:SetButtonLockState xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <DesiredButtonLockState>string</DesiredButtonLockState>
</u:SetButtonLockState>

Inputs:

parameter type description
DesiredButtonLockState string Allowed values: On / Off

SetLEDState

Set the LED state

Action body:

<u:SetLEDState xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <DesiredLEDState>string</DesiredLEDState>
</u:SetLEDState>

Inputs:

parameter type description
DesiredLEDState string Allowed values: On / Off

SetUseAutoplayVolume

Action body:

<u:SetUseAutoplayVolume xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <UseVolume>boolean</UseVolume>
  <Source>string</Source>
</u:SetUseAutoplayVolume>

Inputs:

parameter type description
UseVolume boolean Allowed values: 1 (= true) / 0 (= false)
Source string  

SetZoneAttributes

Action body:

<u:SetZoneAttributes xmlns:u="urn:schemas-upnp-org:service:DeviceProperties:1">
  <DesiredZoneName>string</DesiredZoneName>
  <DesiredIcon>string</DesiredIcon>
  <DesiredConfiguration>string</DesiredConfiguration>
</u:SetZoneAttributes>

Inputs:

parameter type description
DesiredZoneName string  
DesiredIcon string  
DesiredConfiguration string  

Events

The DevicePropertiesService has variables that might be emitted if you subscribe to events.

Subscribe to events

SUBSCRIBE /DeviceProperties/Event
Host: 192.168.x.x:1400
callback: <http://...>
NT: upnp:event
Timeout: Second-3600

Event variables

Variable Sends events* type possible values
AirPlayEnabled boolean 1 for true and 0 for false
AutoplayIncludeLinkedZones   boolean 1 for true and 0 for false
AutoplayRoomUUID   string  
AutoplaySource   string  
AutoplayUseVolume   boolean 1 for true and 0 for false
AutoplayVolume   ui2  
AvailableRoomCalibration string  
BehindWifiExtender ui4  
ButtonLockState   string On / Off
ChannelFreq ui4  
ChannelMapSet string  
ConfigMode string  
Configuration string  
CopyrightInfo   string  
DisplaySoftwareVersion   string  
ExtraInfo   string  
Flags   ui4  
HardwareVersion   string  
HasConfiguredSSID boolean 1 for true and 0 for false
HdmiCecAvailable boolean 1 for true and 0 for false
HouseholdID   string  
HTAudioIn   ui4  
HTBondedZoneCommitState ui4  
HTFreq ui4  
HTSatChanMapSet string  
Icon string  
Invisible boolean 1 for true and 0 for false
IPAddress   string  
IsIdle boolean 1 for true and 0 for false
IsZoneBridge boolean 1 for true and 0 for false
KeepGrouped   boolean 1 for true and 0 for false
LastChangedPlayState string  
LEDState   string On / Off
MACAddress   string  
MicEnabled ui4  
MoreInfo string  
Orientation i4  
RoomCalibrationState i4  
SatRoomUUID   string  
SecureRegState ui4  
SerialNumber   string  
SettingsReplicationState string  
SoftwareVersion   string  
SupportsAudioClip boolean 1 for true and 0 for false
SupportsAudioIn boolean 1 for true and 0 for false
TargetRoomName   string  
TVConfigurationError boolean 1 for true and 0 for false
VoiceConfigState ui4  
WifiEnabled boolean 1 for true and 0 for false
WirelessLeafOnly boolean 1 for true and 0 for false
WirelessMode ui4  
ZoneName string  

If the variable has a in the Sends events column, the service discovery specifies this variable emits events. Other properties might be send as a part of LastChange


This file is automatically generated with @svrooij/sonos-docs, do not edit manually.

Device Software generation Software version Discovery date
Sonos One (S13) S2 63.2-90210 2021-07-21T23:31:19.273Z
Sonos Beam (S14) S2 64.3-19080 2021-08-18T06:04:08.308Z
Sonos Roam (S27) S2 63.2-90210 2021-07-21T23:31:31.207Z
Sonos Play:3 (S3) S2 64.3-19080 2021-08-18T06:09:36.692Z
Sonos Play:5 (S6) S2 64.3-19080 2021-08-18T06:06:35.970Z
Sonos Sub (Sub) S2 63.2-90210 2021-07-21T23:31:40.304Z
Sonos Play:1 (S1) S1 57.6-88280 2021-07-21T14:51:41.469Z
Sonos Play:5 (S5) S1 57.6-88280 2021-07-21T14:51:44.187Z
Sonos Playbar (S9) S1 57.6-88280 2021-07-21T14:51:47.050Z