SqueezeboxRPC: Controller for Logitech media Server over RPC-protokol

This is an alternative Adapter that uses the JSON/RPC-protocol to get data and send commands to the Logitech Media Server/Lyrion Media Server (LMS) for controlling connected devices like

• native squeezebox,
• raspberry pi with additional audio module and small linux based firmwares like picoreplayer or max2play.
• WiiM Multiroom Audio (can talk to an LMS/Lyrion server)
• with plugins chromecast, airplay or UPnP/DLNA-Devices

The LMS-Server can manage/provide very big music collections on harddrives or NAS, connect to different streaming providers like Spotify, Deezer, Soundcloud, shoutcast, tunein, napster, pandora, tidal and more

Table of contents

• Features
• Installation
• Configuration
• Update
• Troubleshooting
• Provided states
  • Server
  • Favorites
  • Players
• Widgets
  • VIS 1 widget documentation
  • VIS 2 widget documentation
• SendTo commands
• Todo
• Changelog
• License

Features

• most of data that the LMS-Service provides is available in the adapter
• detailed information about the player status, song title, artist, album, artwork, playlist
• many control features to play, pause, stop, forward,
  rewind, repeat, shuffle, play favorite, jump to time
  (absolute and relative) , jump to playlist index (absolute and relative),
  power on/off and preset buttons
• all favorites and all sub levels from server
• many widgets for the iobroker-vis component are included to
  create own control user interfaces (select player,select favorites, manage syncgroups, buttons for play/pause,fwd,rew, repeat mode and shuffle mode selection)

Installation

• Install the package
• Create an instance
• Configure the Instance with the IP of the logitech/Lyrion media server and the port (normaly 9000)
• start/restart the instance

Configuration

Main settings

WebSocket mode requires the experimental LMS WebSocket plugin. It carries commands and notifications over the same connection, so the Telnet settings are ignored in this mode. The regular player polling remains enabled as a fallback for missing or incomplete notifications. HTTP(S) WebSocket URLs are converted to WS(S), and /ws is added automatically when only a root URL is configured.

Timer settings

Short refresh intervals increase the number of requests sent to the LMS.

Performance settings

Disable information that is not required to reduce LMS requests and adapter processing.

Announcement settings

For local announcement files, the LMS must be able to reach the configured ioBroker web URL. HTTP(S) announcement URLs are passed directly to the LMS and do not require this setting. FadeTools commands are sent only when the option is enabled. Without FadeTools, all volume values are set directly and verified with the LMS.

Debug settings

Debug and especially silly logging should normally remain disabled and be enabled only while diagnosing a problem.

Update

• After installation or update, it may sometimes be necessary
  to execute the following command if problems have arisen in vis-1

iobroker upload squeezeboxrpc

Trouble Shooting

SLIMP3 players

It has been reported that older SLIMP3 players may be unable to connect to the server while the adapter is searching for new servers. Disabling the search under ´Instance Configuration -> Performance Settings -> Search for other LMS servers´ should allow the player to connect.

Provided states

Server

additional a defined button to refresh the favorites

Favorites

For each favorite All attributes are read only

All sub levels (subdirectories) of favorite are available.

Players

for each player The mode shows if you can change the value. the taken action is described at the attribute

The playlist provide actual the following attributes if available in LMS. Somme attributes depends of the type of songs (stream/file/...) All attributes are read only

additional defined buttons:

The announcement settings define its volume and optional integration with the LMS FadeTools plugin. When enabled, the adapter sends fadeout stop, waits for the configured fade-out duration, and later resumes playback using fadein play. When disabled, the previous and announcement volumes are set directly. For local files, you must configure the base URL of an ioBroker web instance (for example http://192.168.1.10:8082). The LMS host must be able to reach that URL. Remote streams are restored without seeking because they generally do not support a playback position.

Remarks on Datapoints depending of the Setting TPE2 in LMS

Depending on the setting, different MP3 tags are delivered to the data points. The capitalized names are the names of the mp3 tags

It should also be noted that after a change in the LMS, the entire library must
be searched and indexed again, and a song must be stopped and restarted
before the LMS delivers other data.

Further API documentation

For more information visit the CLI-documentation:

https://github.com/oweitman/LMS-CLI-Documentation/blob/master/LMS-CLI.md

Widgets

The adapter includes matching widget sets for both visualization generations. Each widget reference contains its purpose, a preview image, all code-backed configuration options and relevant runtime notes:

• Complete VIS 1 widget documentation
• Complete VIS 2 widget documentation

Both widget sets use a Players widget as their central selection source. Configure that widget first, then select it in controls, value displays, Favorites, Playlist, PlaylistDetail, Browser and SyncGroup. VIS 2 references can work across different views.

.plentry {
    border: 1px #505050 groove;
    margin: 1px 0px;
    padding: 5px;
    background-color: #202020;
}
.plrefresh {
    padding: 5px;
}
.plentry:hover {
    background-color: #404040;
}
.plrefresh svg {
    color: #cccccc;
}
.plrefresh svg:hover {
    color: #ffffff;
    filter: drop-shadow(0px 0px 1px #87ceeb);
}

.plentry {
    border: 1px #b0b0b0 groove;
    margin: 1px 0px;
    padding: 5px;
    background-color: #c0c0c0;
}
.plrefresh {
    padding: 5px;
}
.plentry:hover {
    background-color: #e0e0e0;
}
.plrefresh svg {
    color: #444444;
}
.plrefresh svg:hover {
    color: #000000;
    filter: drop-shadow(0px 0px 1px #87ceeb);
}

SendTo commands

getPlayerNames

Returns the names of all players currently registered in the adapter. The returned names are the sanitized names used below squeezeboxrpc.<instance>.Players.

async function main() {
    const playerNames = await sendToAsync('squeezeboxrpc.0', 'getPlayerNames', {});
    console.log(JSON.stringify(playerNames));
}
main();

Example result:

["Living_room", "Kitchen"]

cmdGeneral

This command can be used to send any command to the LMS server to receive a response.

Example:

All Playlists:

async function main() {
    let data = await sendToAsync('squeezeboxrpc.0', 'cmdGeneral', {
        playerid: '',
        cmdArray: ['playlists', '0', '999', 'tags:us'],
    });
    console.log(JSON.stringify(data));
}
main();

All Favorites:

This command is used internally by the adapter to load the favorites.

async function main() {
    let data = await sendToAsync('squeezeboxrpc.0', 'cmdGeneral', {
        playerid: '',
        cmdArray: ['favorites', 'items', '0', '999', 'want_url:1', 'item_id:'],
    });
    console.log(JSON.stringify(data));
}
main();

Further options and detailed descriptions of the parameters are contained in the following CLI documentation:

CLI-Documentation

Development

vis-1

• start dev-server with dev-server watch --noStart
• start adapter with launch configuration "default Launch ioBroker Adapter"
• start watch script in widgets directory with npm run watch
• open vis-1 editor or runtime
• if you change something in the vis-1 widget wait some seconds to upload changes to dev-server
• in vis-1 reload the vis-1 page
• if something changed in squeeboxrpc.html you have to restart vis-1 adapter

vis-2

• for debugging vis-2 widget you have to run vis-2 in a second vis-2 window.
• to install and run follow instructions in https://github.com/ioBroker/ioBroker.vis-2#development-and-debugging
• start adapter with launch configuration "default Launch ioBroker Adapter"
• start vite dev server in directory src-widgets with npm run start
• in iobroker admin/objects tab, in expert mode, edit the object of system.adapter.squeezeboxrpc.0
• change common.visWidgets.vis2vis-squeezeboxrpc.url from vis2squeezeboxrpc/customWidgets.js to http://localhost:4173/customWidgets.js this is the address of the vite def server.
• open vis in edit or runtime with the launch configuration "vis2 edit 3000" or "vis2 runtime 3000"
• if you change something in the vis-2 widget code an auto reload is triggered or you press F5 in browser

final runtime test

• stop dev-server and your adapter in vscode
• create a production build and upload to dev-server with build with dev-server upload
• start iobroker with npm run start
• revert the change in system.adapter.squeezeboxrpc.0 to the original value
• open vis-1 or vis-2 in edit or runtime mode

additional test on a real iobroker server

• in root directory create a npm package file with npm pack
• in iobroker on the admin/adapter tab in expert mode press the cat button
• in the dialog, select tab from file
• select the created package file
• press install
• if something does not work, on shell start iobroker upload all

Todo

• add player controlled circle knob widget
• stop playing if favorite button is pressed again. dont implemented
• more testing/fixing
• more configuration to optionaly turn features on/off to improve memory and performance
• add playlist widget
• add browse widget to browse in LMS-Menu
• reduce dependencys to other packages (squeezenode)
• cmdGeneral für Server.
• add telnet communication to get push events from the server to optimize the polling
• implement a command state to place user individual commands (via json) for server and player
• implement more control features (select playlist pos to play,ffwd,frew, jump to a time position in song,repeat song,random song)
• add the playlist to playerdata as json array
• add artwork (station-logo/playlist-cover) for favorites
• implement more levels (subdirectories) of favorites
• autodiscover logitech media server

Changelog

3.0.1 (2026-09-08)

• fix little regressions

3.0.0 (2026-09-07)

• complete rework of the LMS API
• add experimental websocket support, only usable with LMS 9.2 build after 5.9.2026

2.0.2 (2026-09-07)

• fix io-package.json

2.0.1 (2026-09-05)

• fix package-lock
• fix tests

2.0.0 (2026-09-05)

• power/connected state fixed
• players button font size fixed
• bring back fade in/out for Announcement with additional LMS plugin

Older entries are in CHANGELOG_OLD.md.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2019-2026 oweitman