Skip to content

feat: add VIS Sonos Control widget - #359

Open
kosmix1980 wants to merge 30 commits into
ioBroker:masterfrom
kosmix1980:cursor/vis-widget-no-build-93d4
Open

feat: add VIS Sonos Control widget#359
kosmix1980 wants to merge 30 commits into
ioBroker:masterfrom
kosmix1980:cursor/vis-widget-no-build-93d4

Conversation

@kosmix1980

@kosmix1980 kosmix1980 commented Sep 4, 2026

Copy link
Copy Markdown

Summary

This PR adds a VIS widget Sonos Control (data-vis-set="sonos"). One widget can switch rooms, control playback, form groups, and start favorites, playlists, queue tracks, recent tracks and sources (including TV HDMI).

The adapter version stays 4.0.3. Changelog entries are under ### **WORK IN PROGRESS** so the release script can set the next version. Compiled build/ is not committed (same as today; CI / prepublishOnly still compiles).

Widget

  • Bind the widget to the instance object, e.g. sonos.0 — not a single play state.
  • Suggested size: 900 × 520.
  • After install, vis / vis-2 are restarted (common.restartAdapters). Reload the VIS editor with Ctrl+F5.
  • Rooms are chips at the top. Group membership is toggled with checkboxes. Now-playing and transport follow the group coordinator.
  • Library buttons under the rooms (Favorites, Playlists, Queue, Recent, Sources) open a slightly transparent sheet below the buttons. Search filters the open list. Playable items and click-outside close the sheet; folders stay open.
  • Volume, mute, night sound and speech enhancement apply to the selected room.
  • The last selected room is remembered per widget (localStorage).

Sources

  • TuneIn, music library, network shares, line-in
  • Spotify and other music services via SMAPI search
  • YouTube Music catalog search; play sends a sid=284 URI to the speaker (the official YTM account on the player). There is no YouTube stream extraction or proxy. If a title does not start, save it as a favorite in the Sonos app.
  • TV HDMI (x-sonos-htastream:{UUID}:spdif) is the first source item and plays on the selected room (Arc, Beam, Playbar, Playbase, Ray, Amp).

TV HDMI

  • Now-playing title is TV. Artist is the audio format (e.g. Stereo PCM via HTAudioIn); empty when there is no signal.
  • Seek, play/pause, prev/next, shuffle and repeat are hidden. Mute stays. Night sound and speech enhancement are shown.
  • Play is not sent after SetAVTransportURI (that call returns HTTP 500 on HDMI).
  • When the TV signal stops, the format field is cleared (silent HTAudioIn codes).

Adapter / states

New or used per-room states for the widget:

State Purpose
playlist_list / playlist_list_array Sonos playlists
recent_tracks Last tracks of that room
media_browse / media_browse_result Content directory / SMAPI browse
media_play Play a browsed item (uri, metadata, favorite, playlist, tv)
play_uri Play a URI
night_mode / speech_enhancement Home-theater HDMI

widgets/ is included in the npm package files.

Docs

README section VIS widget with install steps and screenshots.

Notes for reviewers

  • Existing HTML states (favorites_list_html, queue_html) are unchanged.
  • I can split this if you prefer the widget UI and the browse/play backend as separate PRs.

cursoragent and others added 30 commits September 4, 2026 15:56
@cursoragent @kosmix1980
Add VIS Sonos Control widget for rooms, groups and playlists
f523c00 
Ship a classic VIS widget with the adapter so one control can switch
rooms, manage groups, and start favorites, playlists and queue tracks.
Playlist names are now also exposed as adapter states for the widget.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Include compiled start file so GitHub installs can launch
6bdac6d 
ioBroker starts the adapter from build/main.js. That folder was
gitignored, so a GitHub install had no start file.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Fix blank VIS widget by inlining assets and not blocking on getStates
e1eb918 
Classic VIS often has no global $, and waiting for a wildcard getStates
left the widget empty. Render immediately, discover players via
getObjectView, and ship CSS/JS inside sonos.html.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Show group now-playing on member rooms and add a Recent tab
a565afd 
Grouped rooms were displaying the last local title (often paused) because
Sonos only emits transport-state on the coordinator. The widget now reads
playback from the group master, the adapter copies that track onto members,
and each room keeps a recent-tracks list in a new Zuletzt tab.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Route grouped transport to the master and keep standalone rooms local
cb8e581 
Play, pause, next, prev and seek go to the group coordinator only when
the selected room is actually a member. A room that is not in a group
keeps controlling itself. Volume stays per room. Elapsed time is now
copied onto group members so the progress bar keeps moving.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Animate the VIS progress bar locally while a track is playing
c567315 
The seek bar only moved when VIS forwarded adapter elapsed updates, which
often never arrived. The widget now advances the bar every 500 ms from the
last known position and resyncs when Sonos reports a new elapsed time.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Bump adapter version to 4.1.0
7897aa9 
ioBroker Admin can now show this fork as 4.1.0 instead of 4.0.3.
The VIS widget also displays 4.1.0 next to the SONOS label.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Color grouped room names the same and bump to 4.1.1
a765d26 
Rooms in one group share a name color. A room that is not in a group
stays white. Admin and the widget show version 4.1.1.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Show the group master brighter than its members
f76aa4c 
The coordinator keeps the full group color and a slightly lighter chip.
Other rooms in the same group use a darker shade of that color.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Add a Sources tab for TuneIn, library, shares and line-in
9e0b45b 
The widget browses the Sonos content directory. YouTube and other music
services are listed by name only; their catalogs need the Sonos app, so
play them via favorites. Version 4.2.0.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Add Spotify as a VIS widget source
8d4870c 
Spotify always appears under Quellen. Opening it lists matching Sonos
favorites and playlists so they can be started from that folder.
Version 4.2.1.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Add SMAPI catalog browse for Spotify and other services
4d2433d 
The VIS Sources tab talks to music services over SMAPI: browse, search
and play. Tokens come from the speaker when readable, otherwise App-Link
sign-in. Version 4.3.0.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Fix SMAPI catalog and title search
3614be8 
Parse namespaced SMAPI/UPnP XML so Spotify folders and search results
are not dropped. Add a Search button and App-Link when the catalog is
empty. YouTube Music has no SOAP catalog. Version 4.3.1.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Restore the Sources tab folders instead of emptySources
386b091 
Show TuneIn, Spotify, library, shares and line-in when the browse
path is empty, reload root if a stale service result is left over,
and translate the emptySources label.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Add YouTube Music as a source with local search
342c354 
Google's YouTube Music endpoint rejects third-party SMAPI calls.
List YTM like Spotify, match sid 284, and search favorites,
playlists and recently played tracks from the Sonos app.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Try YouTube Music catalog search via InnerTube
4aaf4b4 
Search lists public YTM songs. Play sends a sid=284 SMAPI URI
to the speaker so it can resolve the track. No stream proxy.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Add TV HDMI as a selectable source in the VIS widget
c3c38f5 
Arc, Beam, Playbar, Playbase, Ray and Amp switch via x-sonos-htastream
on the selected room, same as the Sonos app TV input.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Show TV HDMI as now-playing instead of an empty title
a07e353 
Sonos leaves track metadata blank for the HDMI input, so the widget
fell through to Nichts spielt. Map x-sonos-htastream to TV / HDMI.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Hide the progress bar while TV HDMI is playing
a0f8796 
The HDMI input has no track duration, so the seek bar is omitted
when the widget detects TV as the current source.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Show HDMI audio format and a TV cover while watching TV
f37002d 
Sonos reports the compression as stream content (Stereo PCM, Dolby…).
Now-playing keeps the title TV, shows that format, and uses a television
cover instead of the vinyl No Cover placeholder.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Keep io-package news at 20 entries
544a415 
Drop the oldest changelog item so package tests stay within the limit.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Add night sound and speech enhancement on TV HDMI
45e9743 
Also read the HDMI audio format from HTAudioIn (Stereo PCM, Dolby…)
and remember the last selected room across page reloads.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Hide HDMI play/pause and put TV first in Sources
73211ec 
On TV HDMI the transport row now shows mute only. TV HDMI is the first
item in Quellen so it is visible without scrolling.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Avoid Play on TV HDMI and log which command failed
f1c2c5f 
SetAVTransportURI starts HDMI; a following Play often returns HTTP 500.
Transport commands are ignored while TV is selected. Errors now include
the state name and room so the next 500 is identifiable.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Clear HDMI compression when the TV signal stops
b33d227 
HTAudioIn is polled while TV is selected. Codes for no signal (0, 21, 22,
silent PCM) clear current_artist instead of keeping the last format.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Open library lists in a popup below the top buttons
e20eadd 
Favorites, playlists, queue, recent and sources are pill buttons under
the rooms. A click opens a covering sheet with search; playing a title
or clicking outside closes it.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Make the library popup slightly transparent
4d55d1c 
The sheet over the player uses a translucent background so cover and
now-playing remain faintly visible underneath.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Reset version to 4.0.3 and stop tracking build/
86dc1a8 
Match the official adapter for an upstream PR: keep 4.0.3, put the
widget work under WORK IN PROGRESS, and gitignore compiled output again.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Add VIS widget screenshots to the README
f02f41d 
Document the player, library sheet, sources and TV HDMI views
and drop the outdated note that this branch ships build/.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
@cursoragent @kosmix1980
Mark this branch as the upstream variant without build/
4dcaedf 
Point GitHub installs at cursor/vis-sonos-widget-93d4, which ships
the compiled adapter so the start file is present.

Co-authored-by: kosmix1980 <kosmix1980@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kosmix1980 @cursoragent