iobroker.squeezeboxrpc v1.5.2

ioBroker Logitech Squeezebox Adapter over JSON/RPC-Protocol

Tests:

This is an alternative Adapter that uses the JSON/RPC-protocol to get data and send commands to the Logitech 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.
• 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

Why another Squeezebox adapter?

The existing adapter use telnet to access the LMS. The telnet has some disadvantages. The actual main web interface of the LMS also uses the rpc/json-protocol to get all needed informations or send commands to the server/players.

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 media server and the port (normaly 9000)
• start/restart the instance

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

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:

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

Player button bar

All players that are integrated into your Logitech Media Server can be selected\ using this widget. After selecting a squeezerpc.? instance, the available\ players are displayed in the widget.

Attributes

Favorites button bar

You can use this widget to select all of the favorites that have been\ created in your Logitech Media Server. After selecting the Player widget, the available favorites are displayed in the widget.

Play Button

The play button starts or stops the music on the selected player.\ To prepare, you must connect the button to the player widget.\ The button has its own graphics (SVG),\ alternatively you can also select your own graphics.

Attributes for Play button

Forward

The Forward widget allows you to skip forward in the current track.\ The button can be configured to skip forward by a specific amount\ of time if the player supports this feature.

Attributes for Forward button

Rewind

The Rewind widget allows you to jump back in the current track.\ Similar to the Forward widget, a time period can be set.

Attributes for Rewind button

Repeat

The Repeat widget allows you to activate or deactivate the repeat function\ for the current track or playlist if this function is supported by the player.

Attributes for Repeat button

Shuffle

The Shuffle widget enables or disables shuffle for the current playlist,\ if this feature is supported by the player.

Attributes for Shuffle button

Volume

The Volume widget displays the current volume level of the player and\ allows you to adjust the volume.

Attributes for Volume button

SyncGroup button bar

This widget can be used in conjunction with the player widget to control\ the synchronization of the players with each other. Most of the settings for the number of buttons, labels or images are taken\ over by the player widget. To prepare, you must connect the button to the player widget. After selecting a player in the player widget, the current synchronization\ is visible in the SyncGroup widget. The sync status is shown using the various adjustable colors. The player selected in the player widget cannot be selected in the SyncGroup widget. If a player is selected in the SyncGroup widget that is already in\ another group, it is automatically removed from this group.

Attributes for SyncGroup button

Playtime bar

The playtime bar visually shows the progress of the song currently being played,\ provided that a total running time (duration) is provided by the server.\ This is usually not the case with online streams. The width of the bar\ corresponds to 100% of the playing time of the song. By clicking on a point on\ the bar you can jump to the desired point in the song.\ To prepare, you must connect the button to the player widget.

Attributes for Playtime bar

String/character string

Display of player-specific character strings. To prepare, you must connect\ the button to the player widget.

Attributes for String

Number

Display of numbers with additional formatting options. To prepare,\ you must connect the button to the player widget.

Attributes for Number

Playlist

Display the playlist from the server. If you click on an entry the playlist is loaded and the player starts. The widged dosent refresh automaticly, you have to press the refreshh button.

Attributes for Playlist

The widget itself has very little formatting. For self formating there are some predefined css-classes:

The following CSS for the vis-css tab can serve as an example:

Dark-mode

.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);
}

Light-mode

.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-Befehle

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

Todo

• more testing/fixing
• reduce dependencys to other packages (squeezenode)
• more configuration to optionaly turn features on/off to improve memory and performance
• add playlist widget
• add browse widget to browse in LMS-Menu
• add player controlled circle knob widget
• stop playing if favorite button is pressed again.
• 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

1.5.2 (2024-12-16)

• fix spelling of iobroker upload squeezeboxrpc in readme
• fix playtime bar

1.5.1 (2024-11-29)

• improve documentation
• remove margin from plcontainer
• improve textoverflow with ellipsis
• adjust initial widgetsize of playlist widget
• repair attributes for playlist widget
• add light mode css for playlist widget

1.5.0 (2024-11-28)

• Switch to iobroker/eslint
• New widget playlist

1.4.0 (2024-11-27)

• fix some missing objects errors
• sanitize more playernames in syncgroups
• add sendTo Command "cmdGeneral"
• sanitize more the playername
• improve translation
• if trackartist is avail then write to artist if empty
• improve handling for artwork_url
• move widget documentation from html to markdown
• adjust responsive tab style
• improve attribute widgets
• change TPE2 handling once more
• jsonConfig add sizing options for differenz screen sizes
• test implementation of TPE2 handling. switch in settings
• add datapoints album_artist, track_artist, artistOriginal

1.3.17 (2024-10-23)

• add edit button to the vie index field of favorites widget

1.3.16 (2024-10-23)

• fixed icons of the favorites widget

1.3.15 (2024-08-09)

• due to a adapter checker issue i have to remove the release 1.3.13 from npm. but changes from 1.3.13 are included in 1.3.14

1.3.14 (2024-08-05)

• fix formatting

1.3.13 (2024-08-05)

• revert the fix for artist handling due to negative effect of spotify

1.3.12 (2024-08-05)

• improve cmdGoto handling by kairauer, close PR #74
• fix issues from adapter checker
• integrate squeezenode lib

1.3.11 (2024-08-05)

• update adapter structure and switch to jsonconfig

1.3.10

• getalbumartist as artist if setting of TPE2/TPE3 in LMS are changed"

1.3.9

• fix error with deleting favorites
• fix wrong type for datapoint

1.3.8

• fix forward button widget

1.3.7

• fix object creation of states in player modul

1.3.6

• fix object creation of states

1.3.5

• fix object creation for favorites

1.3.4

• fix object creation for favorites / * center widgets in sidebar

1.3.3

• repair imageproxy for image datapoints of favorites

1.3.2

• fix for Alarm contains only enabled Alarms

1.3.1

• fix problem with git dependency url

1.3.0

• fix problem wit setting own icon in player widget / * add infos about\ alarms to a player datapoint

1.2.1

• fix small issue in last version

1.2.0

• improve handling of imageproxy artwork

1.1.0

• make request of favorites configurable

1.0.1

• change setstate/createobject logic
• fix role and type for Mode-state
• update tests
• update dependency versions
• improve io-package.json

1.0.0

• prepare for stable repository

0.8.32

• the adapter function iobroker.deleteChannel didnt works as expected.\ It didnt delete the whole subtree of states. now i implement my own delete function

0.8.31

• change behaviour of deleting favorites

0.8.30

• change from the issue of the adapter checker

0.8.29

• optimize handling of player state power and connected

0.8.28

• add advanced signaling function with telnet and fix some more authorization\ issues with LMS

0.8.27

• initialization for the new calctype property if empty in volumebar

0.8.26

• more improvement and fixing at volumebar / remove playlist widget from\ master. not ready yet

0.8.25

• fixing css-settings on volumebar

0.8.24

• volumebar didnt get events between the segments, change clickevent and calculation

0.8.23

• adjust dependencies to remove vulnerabilities in dependend packages.\ also remove travis due of unresolvable build-failures for win+node10/12

0.8.22

• due to iobroker.controller 2.0 a command in the api changed (socket to vis.conn._socket)

0.8.21

• add command für playing urls

0.8.20

• remove node v6 test setting

0.8.19

• shorten news history

0.8.18 (2019-06-27)

• last minute changes.

0.8.17 (2019-06-26)

• add more widges: playtime bar, string, number, datetime, image.\ add button margin to player and favorite widget, improve editing of viewindex.\ do some refactoring.

0.8.16 (2019-06-24)

• resolve a cross browser issue for firefox. the style.\ font attribute is empty and you have to construct the font string by yourself

0.8.15 (2019-06-19)

• minor issue with not ready states

0.8.14 (2019-06-19)

• add syncgroups as new server-datapoint,add syncgroup widget,/ change some jquery event logic

0.8.13 (2019-06-16)

• rename widgetset from squeezeboxrpcwidgets to squeezeboxrpc

0.8.12 (2019-06-16)

• sync version with npm

0.8.11 (2019-06-15)

• try to integrate the widgets into the main adapter

0.8.10 (2019-05-15)

• another try to fix the EADDRINUSE error of the server discovery

0.8.9 (2019-05-15)

• try to fix the EADDRINUSE error of the server discovery

0.8.8 (2019-05-14)

• make discover configurable

0.8.7 (2019-05-11)

• more control features (select playlist pos to play,ffwd,frew,jump to/ a time position in song,repeat song,random song)

0.8.6 (2019-05-10)

• move some configuration options into seperate tabs

0.8.5 (2019-05-08)

• change serverdiscovery interval method, remove some double cmd lines,/ additional minor changes advised from eslint

0.8.4

• move some files to lib directory

0.8.3

• close port for discovery on unload

0.8.2

• sync version with npm

0.8.1

• set compact mode flag

0.8.0

• implementation of compact mode, change version to represent a realistic/ feature completness

0.0.9

• debug options are now configurable

0.0.8

• More playlist attributes + remove trailing and leading spaces from source

0.0.7

• Add the playlist to each player as json

0.0.6

• More config options

0.0.5

• All levels/subdirectories of favorites are now available in iobroker

0.0.4

• added the cmdPlayFavorite for each player

0.0.3

• repair the no-data symbols for buttons in vis

0.0.2

• added autodiscovery

0.0.1

• initial release

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-2024 oweitman