Содержание

1 iRidium for Sonos
2 Connection
3 Working in iRidium

iRidium for Sonos

A set of tools to create control interfaces using a driver for Sonos sound systems.

documentation was last updated on 13.10.2020
iRidium for Sonos is a set of tools (a driver is developed in iRidium for user convenience) with the help of which an interface can be created to control Hi-Fi system without scripts. A native driver is easy to work with.

Example: Sonos

Connection

To work with Sonos equipment in the project it is required to know the IP-address of the sound systems and enter it in the driver settings. Do the following:

1 Connect Sonos equipment, IP-address of equipment is assigned automatically via DHCP.

2 Download Sonos Controller software for Sonos and launch it. The network is automatically scanned and equipment is displayed in "Rooms" section.

3 Information about network settings of Sonos equipment can be entered in several ways:

3.1 For PC.

3.2 Mobile app.

3.3 Scanning local network with the help of special software, for example. Advanced Port Scanner.

As a result of scanning there will be a list of devices, select the required ones. Sonos systems are displayed in the "Manufacturer" section as Sonos,inc.

After IP-address is identified, pass on to settings in iRidium studio.

Working in iRidium

1 Create a project, select "Add driver". Select "Sonos" in the list that appears and add it.

You can read more about working with native drivers here

2 Fill in the fields in driver properties, required for work.

Driver Properties

Name - driver name, do not change it in a ready interface;
Driver Type - information about the type of the driver;
Protocol - protocol of data exchange - TCP;
Log Level - depth of logging;
Host - IP-address of equipment;
Port - connection port (by default -1443).

Commands

Each command contains the following parameters:

Name - name of command;
Type - type of command:
- Control - provides list of commands, actions to control equipment;
- Selection - provides list of commands, actions for navigation.

Control. Action.

Name	Description''	Value
Play	Play a track, pause.
Volume	Volume control.	0-100
Relative volume	Control of volume relative to the current value of the feedback channel “Volume”.	0-100
Mute	Sound off.	True or False
Next song	Play next track.
Previous song	Play previous track.
Seek	Rewind track.
Seek relative	Rewind track relativelly to the current position on the time-line.
Group volume	Command to control volume in a group (for several devices).	0-100
Group relative volume	Control of volume relative to the current value of the "Volume feedback channel" in a group (for several devices).	0-100
Group mute	Sounf off in a group (for several devices).	True or False
Update state	Update state of feedback channels.
Repeat	Repeat playlist.	True or False
Repeat one	Repeat current track.	True or False
Crossfade	Sound fading at the end of a current track and gradual volume increase at the beginning of the next track.	True or False
Shuffle	Play random track

Selection. Selected List

Name	Description	Value
Explore	Navigation command (realized with the help of Advanced List).
Explore back	Command to get back to the previous folder/page (realized with the help of Advanced List)
Explore root	Command to get back to the root page

Feedback Channels

For convenience feedback channels of a driver are divided into different categories depending on it purpose.

Control - фидбеки управления.

Name	Description	Value
Play	Current play status (play/pause).
Player name	Name of player.	Value
Group name	Name of group (united devices).	Value
Volume	Current volume.	0-100
Group Volume	Current group volume.	0-100
Mute	State of Mute parameter.	True or False
Group mute	State of group Mute parameter.	True or False
Error	Error.	Value
Playbackstate	Current state of player.	Play, Pause, Idle, etc.
Position milis	Current position on the time line (in milliseconds).	Value
Is coordinator	Feedback channel that shows the main device in a group	Value

Stream, Radio - feedback channels to get data from the stream.

Name	Description	Value
Container image	Display of image.
Current name	Name of radio station.	Value
Current show name	Name of radio show.	Value
Container type	Type of contents (in most cases “Track”).	Value
Container service	Name of service.	Value
Current stream info	Current track (performer + name of track).	Value

Indicators show a capability to use a command.

'Name	Description	Value
Can skip	Go to next track.	True or False
Can skip back	Go to previous track.	True or False
Can seek	Rewind track.	True or False
Can seek	Pause.	True or False
Can stop	Stop playing.	True or False
Can repeat	Repeat current playlist.	True or False
Can repeat one	Repeat current track.	True or False
Can crossfade	"Fading" of tracks effect.	True or False
Can shuffle	"Shuffle" effect.	True or False.

Modes - state of playing modes.

Name	Description	Value
Mode repeat	Repeat currect playlist.	True or False
Mode repeat one	Repeat current track.	True or False
Mode crossfade	"Fading" of tracks effect.	True or False
Mode shuffle	State of "shuffle" mode.	True or False

Current track info - information about the current track.

Name	Description	Value
Service	Name of service that is used to paly a track.	Value
Album	Album name of the current track.	Value
Type	Type of contents (in most cases - “Track”).	Value
Image	Image/cover of the current track.	Value
Artist	Singer/performer of the track.	Value
Name	Name of current track.	Value
Duration (ms)	Duration of track in millisecoonds.	Value
Time	Duration of track.	Format 00:00:00 (hours, minutes, seconds)
Time passed	Time from the track start.	Format 00:00:00 (hours, minutes, seconds)
Time remaining	Time remaing to the track end.	Format 00:00:00 (hours, minutes, seconds)

Next track info - information about the next track.

Name	Desciption	Value
Service	Name of service that is used to play the next track.	Value
Album	Album name of the next track.	Value
Type	Type of contents (in most cases - “Track”).	Value
Image	Image/cover of the next track.	Value
Artist	Singer/performer of the next track.	Value
Name	Name of the next track.	Value
Duration (ms)	Duration of track in milliseconds.	Value
Time	Duration of track.	Format 00:00:00 (hours, minutes, seconds)

Sending Commands in iRidium studio Interface and Getting Feedback Values

iRidium mobile team developed an interface in the style of Sonos control panel. You can edit it and reassign commands and feedback channels to each graphic item with the help of "Drag&Drop".

You can read more about interaction of graphic items and commands/feedback channels in this article.