Link Search Menu Expand Document
Sonos

DevicePropertiesService

Modify device properties, like led status and stereo pairs

The DevicePropertiesService is available on these models: v1-S1 / v1-S5 / v1-S9.

const SonosDevice = require('@svrooij/sonos').SonosDevice
const sonos = new SonosDevice('192.168.x.x')
sonos.DevicePropertiesService.OneOfTheMethodsBelow({...})

All actions that require input expect an object with the specified parameters, even if it only requires one parameter.

  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. SeparateStereoPair
  19. SetAutoplayLinkedZones
  20. SetAutoplayRoomUUID
  21. SetAutoplayVolume
  22. SetButtonLockState
  23. SetLEDState
  24. SetUseAutoplayVolume
  25. SetZoneAttributes
  26. DevicePropertiesService event

AddBondedZones 

const result = await sonos.DevicePropertiesService.AddBondedZones({ ChannelMapSet:... });

Input object:

property type description
ChannelMapSet string  

This actions returns a boolean whether or not the requests succeeded.

AddHTSatellite 

const result = await sonos.DevicePropertiesService.AddHTSatellite({ HTSatChanMapSet:... });

Input object:

property type description
HTSatChanMapSet string  

This actions returns a boolean whether or not the requests succeeded.

CreateStereoPair

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

const result = await sonos.DevicePropertiesService.CreateStereoPair({ ChannelMapSet:... });

Input object:

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

This actions returns a boolean whether or not the requests succeeded.

Remarks No all speakers support StereoPairs

EnterConfigMode 

const result = await sonos.DevicePropertiesService.EnterConfigMode({ Mode:..., Options:... });

Input object:

property type description
Mode string  
Options string  

Output object:

property type description
State string  

ExitConfigMode 

const result = await sonos.DevicePropertiesService.ExitConfigMode({ Options:... });

Input object:

property type description
Options string  

This actions returns a boolean whether or not the requests succeeded.

GetAutoplayLinkedZones 

const result = await sonos.DevicePropertiesService.GetAutoplayLinkedZones({ Source:... });

Input object:

property type description
Source string  

Output object:

property type description
IncludeLinkedZones boolean  

GetAutoplayRoomUUID 

const result = await sonos.DevicePropertiesService.GetAutoplayRoomUUID({ Source:... });

Input object:

property type description
Source string  

Output object:

property type description
RoomUUID string  

GetAutoplayVolume 

const result = await sonos.DevicePropertiesService.GetAutoplayVolume({ Source:... });

Input object:

property type description
Source string  

Output object:

property type description
CurrentVolume number  

GetButtonLockState 

const result = await sonos.DevicePropertiesService.GetButtonLockState();

Output object:

property type description
CurrentButtonLockState string Possible values: On / Off

GetButtonState 

const result = await sonos.DevicePropertiesService.GetButtonState();

Output object:

property type description
State string  

GetHouseholdID 

const result = await sonos.DevicePropertiesService.GetHouseholdID();

Output object:

property type description
CurrentHouseholdID string  

GetLEDState 

const result = await sonos.DevicePropertiesService.GetLEDState();

Output object:

property type description
CurrentLEDState string Possible values: On / Off

GetUseAutoplayVolume 

const result = await sonos.DevicePropertiesService.GetUseAutoplayVolume({ Source:... });

Input object:

property type description
Source string  

Output object:

property type description
UseVolume boolean  

GetZoneAttributes 

const result = await sonos.DevicePropertiesService.GetZoneAttributes();

Output object:

property type description
CurrentZoneName string  
CurrentIcon string  
CurrentConfiguration string  

GetZoneInfo 

const result = await sonos.DevicePropertiesService.GetZoneInfo();

Output object:

property type description
SerialNumber string  
SoftwareVersion string  
DisplaySoftwareVersion string  
HardwareVersion string  
IPAddress string  
MACAddress string  
CopyrightInfo string  
ExtraInfo string  
HTAudioIn number  
Flags number  

RemoveBondedZones 

const result = await sonos.DevicePropertiesService.RemoveBondedZones({ ChannelMapSet:..., KeepGrouped:... });

Input object:

property type description
ChannelMapSet string  
KeepGrouped boolean  

This actions returns a boolean whether or not the requests succeeded.

RemoveHTSatellite 

const result = await sonos.DevicePropertiesService.RemoveHTSatellite({ SatRoomUUID:... });

Input object:

property type description
SatRoomUUID string  

This actions returns a boolean whether or not the requests succeeded.

SeparateStereoPair

Separate a stereo pair

const result = await sonos.DevicePropertiesService.SeparateStereoPair({ ChannelMapSet:... });

Input object:

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

This actions returns a boolean whether or not the requests succeeded.

Remarks No all speakers support StereoPairs

SetAutoplayLinkedZones 

const result = await sonos.DevicePropertiesService.SetAutoplayLinkedZones({ IncludeLinkedZones:..., Source:... });

Input object:

property type description
IncludeLinkedZones boolean  
Source string  

This actions returns a boolean whether or not the requests succeeded.

SetAutoplayRoomUUID 

const result = await sonos.DevicePropertiesService.SetAutoplayRoomUUID({ RoomUUID:..., Source:... });

Input object:

property type description
RoomUUID string  
Source string  

This actions returns a boolean whether or not the requests succeeded.

SetAutoplayVolume 

const result = await sonos.DevicePropertiesService.SetAutoplayVolume({ Volume:..., Source:... });

Input object:

property type description
Volume number  
Source string  

This actions returns a boolean whether or not the requests succeeded.

SetButtonLockState 

const result = await sonos.DevicePropertiesService.SetButtonLockState({ DesiredButtonLockState:... });

Input object:

property type description
DesiredButtonLockState string Allowed values: On / Off

This actions returns a boolean whether or not the requests succeeded.

SetLEDState 

const result = await sonos.DevicePropertiesService.SetLEDState({ DesiredLEDState:... });

Input object:

property type description
DesiredLEDState string Allowed values: On / Off

This actions returns a boolean whether or not the requests succeeded.

SetUseAutoplayVolume 

const result = await sonos.DevicePropertiesService.SetUseAutoplayVolume({ UseVolume:..., Source:... });

Input object:

property type description
UseVolume boolean  
Source string  

This actions returns a boolean whether or not the requests succeeded.

SetZoneAttributes 

const result = await sonos.DevicePropertiesService.SetZoneAttributes({ DesiredZoneName:..., DesiredIcon:..., DesiredConfiguration:... });

Input object:

property type description
DesiredZoneName string  
DesiredIcon string  
DesiredConfiguration string  

This actions returns a boolean whether or not the requests succeeded.

DevicePropertiesService event 

const SonosDevice = require('@svrooij/sonos').SonosDevice
const sonos = new SonosDevice('192.168.x.x')
sonos.DevicePropertiesService.Events('serviceEvent', (data) => {
  console.log(data);
});

The DevicePropertiesService emits events with these properties. Not all properties are emitted every time.

parameter type possible values
AirPlayEnabled boolean  
AutoplayIncludeLinkedZones boolean  
AutoplayRoomUUID string  
AutoplaySource string  
AutoplayUseVolume boolean  
AutoplayVolume number  
AvailableRoomCalibration string  
BehindWifiExtender number  
ButtonLockState string On / Off
ChannelFreq number  
ChannelMapSet string  
ConfigMode string  
Configuration string  
CopyrightInfo string  
DisplaySoftwareVersion string  
ExtraInfo string  
Flags number  
HardwareVersion string  
HasConfiguredSSID boolean  
HdmiCecAvailable boolean  
HouseholdID string  
HTAudioIn number  
HTBondedZoneCommitState number  
HTFreq number  
HTSatChanMapSet string  
Icon string  
Invisible boolean  
IPAddress string  
IsIdle boolean  
IsZoneBridge boolean  
KeepGrouped boolean  
LastChangedPlayState string  
LEDState string On / Off
MACAddress string  
MicEnabled number  
MoreInfo string  
Orientation number  
RoomCalibrationState number  
SatRoomUUID string  
SecureRegState number  
SerialNumber string  
SettingsReplicationState string  
SoftwareVersion string  
SupportsAudioClip boolean  
SupportsAudioIn boolean  
TVConfigurationError boolean  
VoiceConfigState number  
WifiEnabled boolean  
WirelessLeafOnly boolean  
WirelessMode number  
ZoneName string  

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