Sonos Gateway
Contents

1.Description

The "Sonos" environment requires (per project) the following nodes:
The environment settings are made in the gateway. The control of the Sonos boxes takes place via the Sonos player components.

With one player node each, it is possible to select and control playlists created with the Sonos app for a Sonos box or a group of boxes.
The use of these nodes generates at least two accessible endpoints (URLs) on the HomeServer/FacilityServer. The URL can be used to configure which playlists can be used in the player. Each playlist to be used used is also assigned a unique sequence number, which sets a song order that can be changed by the user.
The other URLs control the players, i.e. there is one URL per player component used.
Important
Note that with this node, all inputs can only be assigned their initial values or fixed values. It is not possible to connect communication objects to these inputs!
Note
It is strongly recommended to leave all input values at the default settings.

If default values are to be used for all inputs, the initialisation value (indicated by a green background in the GLE) must be changed to a fixed value (indicated by a yellow background in the GLE) for all inputs (with the exception of: Input 2). This is necessary because the project cannot be transferred until at least one input is assigned to each node.

Double-click on an input and confirm the suggested value. The input is now displayed with a yellow background, which means that a fixed value is set and the input is detected as "allocated".

2.Inputs

No.NameInitialisationDescription
1Port HTTP-Server18080
This port provides access to the Sonos environment configuration page for configuring the selection and order of presets.
The address for this page is:

HTTP://[HS-IP-ADR]:[dieser Port]/playlist.html

Default value: "18080"
Example (HS/FS with IP address 192.168.0.11 and default value):

HTTP://192.168.0.11:18080/playlist.html

For more information on the configuration page, see here.
Important
Must be specified as a fixed value/initialisation value in the input!
2Port intern0
The port specified here is used by the QuadClient and must not be changed.

Default value: 0
Warning
Leave initialisation value 0 set to the default value! You must not specify a fixed value!
3URL path"/sonos/"
The sub-path entered here (on the HS/FS) is required for the QuadClient and should not be changed.

Default value: "/sonos/"

Example (for the default value): HTTPS://[HS-IP-ADR]/sonos/
Important
This path must start with a "/" (slash) and end with a "/" (slash)!
This should also be noted when using the address in a browser.
Must be specified as a fixed value/initialisation value in the input!
4Display text Unsaved list"Unsaved list"
If text is entered here, the text will be displayed instead of the default "UNSAVED LIST" text in the respective error field in the 18172 Sonos player nodes at the output Last error (text).

Default value: "" (leads to the display of the text "UNSAVED LIST").
Important
Must be specified as a fixed value/initialisation value in the input!
5Display text Empty list"Empty list"
If text is entered here, the text will be displayed instead of the default "EMPTY LIST" text in the respective error field in the 18172 Sonos player nodes at the output Last error (text).

Default value: "" (leads to the display of the text "EMPTY LIST").
Important
Must be specified as a fixed value/initialisation value in the input!

3.Outputs

No.NameInitialisationSBCDescription
1Sonos Player0s
Must be connected to the "Sonos gateway" input for all 18172 Sonos gateway nodes used.
2Status0s
Displays status codes:
0 - Node is not ready for operation
1 - During initialisation of the node
2 - Node is ready for operation
3Changing the configuration0s
Sends a 1 if a change is made on the configuration page (HTTP://[HS-IP-ADR]:[dieser Port]/playlist.html).
s = send, sbc = send by change

4.Other

Recalculation during start:Yes
Module is retentive:Yes
Internal designation:18171
Category:Sonos

5.Similar functions

Sonos Player