DeviceProperties service

Modify device properties, like LED status and stereo pairs

The DeviceProperties service is available on these models: v2-S1 / v2-S13 / v2-S14 / v2-S18 / v2-S21 / v2-S27 / v2-S3 / v2-S33 / v2-S38 / v2-S6 / v2-S9 / v2-Sub.

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. GetHTForwardState
13. GetLEDState
14. GetUseAutoplayVolume
15. GetZoneAttributes
16. GetZoneInfo
17. RemoveBondedZones
18. RemoveHTSatellite
19. RoomDetectionStartChirping
20. RoomDetectionStopChirping
21. SeparateStereoPair
22. SetAutoplayLinkedZones
23. SetAutoplayRoomUUID
24. SetAutoplayVolume
25. SetButtonLockState
26. SetLEDState
27. SetUseAutoplayVolume
28. SetZoneAttributes
29. DevicePropertiesService event

AddBondedZones

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

Input object:

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

AddHTSatellite

Adds satellites and/or a sub woofer to a (main) player. The satellites become hidden. The main player RINCON_* is mandatory. RR: right - rear, LF: left - front, SW: subwoofer

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

Input object:

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

Remarks Not all speakers support satellites or sub woofer. Satellites should be of same type (e.g. Play:1)

CreateStereoPair

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

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

Input object:

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

Remarks Not all speakers support StereoPairs

EnterConfigMode

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

Input object:

Output object:

ExitConfigMode

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

Input object:

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

GetAutoplayLinkedZones

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

Input object:

Output object:

GetAutoplayRoomUUID

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

Input object:

Output object:

GetAutoplayVolume

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

Input object:

Output object:

GetButtonLockState

Get the current button lock state

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

Output object:

GetButtonState

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

Output object:

GetHouseholdID

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

Output object:

GetHTForwardState

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

Output object:

GetLEDState

Get the current LED state

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

Output object:

GetUseAutoplayVolume

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

Input object:

Output object:

GetZoneAttributes

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

Output object:

GetZoneInfo

Get information about this specific speaker

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

Output object:

RemoveBondedZones

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

Input object:

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

RemoveHTSatellite

Removes a satellite or a sub woofer from (main) player. The satellite becomes visible.

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

Input object:

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

Remarks Not all speakers support satellites or sub woofer. Multiples RINCON_* are not allowed.

RoomDetectionStartChirping

const result = await sonos.DevicePropertiesService.RoomDetectionStartChirping({ Channel:..., DurationMilliseconds:..., ChirpIfPlayingSwappableAudio:... });

Input object:

Output object:

RoomDetectionStopChirping

const result = await sonos.DevicePropertiesService.RoomDetectionStopChirping({ PlayId:... });

Input object:

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:

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

Remarks Not all speakers support StereoPairs

SetAutoplayLinkedZones

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

Input object:

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

SetAutoplayRoomUUID

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

Input object:

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

SetAutoplayVolume

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

Input object:

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

SetButtonLockState

Set the button lock state

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

Input object:

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

SetLEDState

Set the LED state

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

Input object:

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

SetUseAutoplayVolume

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

Input object:

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

SetZoneAttributes

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

Input object:

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.

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