Sonos virtual object configuration
TutorialNOTE!
The described virtual object is available for GATE HTTP INT-211-E-01 with firmware 1.3.1 or higher!
The described virtual object is available for GATE HTTP INT-211-E-01 with firmware 1.3.1 or higher!
The Sonos object is used to integrate Sonos speaker with the Grenton system using the GATE module.
Before integrating Sonos speakers with the system, the speaker should be configured in the local network using dedicated application and read its assigned IP address.
To connect Sonos speaker to system, create a new Sonos virtual object:
Set the parameters in the Embedded features tab:
- Host: e.g. 192.168.20.105 (speaker IP address)
- UpdatePeriod: 1000
After sending the configuration, the Status feature should take the value 1. This is information about the correct connection of the speaker to the system.
NOTE!
If more objects are used, there may be issues due to limited network and/or device bandwidth. In such a situation, as the number of created objects continues to increase, it is recommended to increase the value of the UpdatePeriod feature.
If more objects are used, there may be issues due to limited network and/or device bandwidth. In such a situation, as the number of created objects continues to increase, it is recommended to increase the value of the UpdatePeriod feature.
Configuration parameters
FEATURES
| Name | Description |
|---|---|
Host | Sonos IP Address |
UpdatePeriod | State update period |
Status | Communication status: 0 - no connection, 1 - connected |
ErrorCode | Last error code: 0 - no error, negative values - negative HTTP status codes, positive values - UPnP error codes |
Volume | Volume level ranging from 0% to 100% |
Mute | Mute state: 0 - Off, 1 - On |
Artist | Artist |
Title | Title |
State | Playback state: 0 - stopped, 1 - playing, 2 - paused, 3 - transitioning |
PlayMode | Playback mode: 0 - normal, 1 - repeat all, 2 - repeat one, 3 - shuffle, no repeat, 4 - shuffle, repeat all, 5 - shuffle, repeat one |
AlbumArt | Album art address |
Name | Speaker name |
CooridnatorName | Group coordinator name |
METHODS
| Name | Description |
|---|---|
SetUpdatePeriod | Sets the state update period |
SetVolume | Sets the volume level, ranging from 0% to 100% |
SetMute | Sets the mute state |
SetPlayMode | Sets the playback mode |
Play | Starts playback |
Pause | Pauses playback |
Stop | Stops playback |
Next | Switches to the next track |
Prev | Switches to the previous track |
VolumeUp | Increases the volume by a specified percentage |
VolumeDown | Decreases the volume by a specified percentage |
SwtichMute | Switches the mute state |
SwitchPlay | Switches the playback state between paused and playing |
LeaveGroup | Leaves the current speaker group, if any |
JoinGroup | Joins the speaker group, specified by the group coordinator name |
EVENTS
| Name | Description |
|---|---|
OnConnected | Event executed after successful speaker connection establishment |
OnDisconnected | Event executed after the speaker connection has been lost |
OnError | Event executed after an error has been detected |
OnChange | Event executed after a Mute, Volume, Title, Artist, State, PlayMode, AlbumArt or CoordinatorName change occurs |
OnMuteChange | Event executed after a Mute change occurs |
OnVolumeChange | Event executed after a Volume change occurs |
OnTitleChange | Event executed after a Title change occurs |
OnArtistChange | Event executed after an Artist change occurs |
OnStateChange | Event executed after a State change occurs |
OnPlayModeChange | Event executed after a PlayMode change occurs |
OnAlbumArtChange | Event executed after an AlbumArt change occurs |
OnCoordinatorNameChange | Event executed after a CoordinatorName change occurs |