Squeezebox (Logitech Media Server)
The Squeezebox integration allows you to control a Logitech Squeezebox music player from Home Assistant. This lets you control Squeezebox hardware like the Classic, Transporter, Duet, Boom, Radio and Touch and of software players like Squeezelite, SoftSqueeze, SqueezePlayer and SqueezeSlave.
Configuration
Adding Squeezebox (Logitech Media Server) to your Home Assistant instance can be done via the user interface, by using this My button:
Squeezebox (Logitech Media Server) can be auto-discovered by Home Assistant. If an instance was found, it will be shown as “Discovered”, which you can select to set it up right away.
If there wasn’t any discovered automatically, don’t worry! You can set up a manual integration entry:
-
Browse to your Home Assistant instance.
-
In the sidebar click on Settings.
-
From the configuration menu select: Devices & Services.
-
In the bottom right, click on the Add Integration button.
-
From the list, search and select “Squeezebox (Logitech Media Server)”.
-
Follow the instruction on screen to complete the set up.
The Logitech Transporter which have two digital inputs can be activated using a script. The following example turns on the Transporter and activates the toslink input interface:
# Turn on Transporter and activate toslink interface
transporter_toslink:
sequence:
- service: homeassistant.turn_on
target:
entity_id: media_player.transporter
- service: media_player.play_media
target:
entity_id: media_player.transporter
data:
media_content_id: "source:toslink"
media_content_type: "music"
Service call_method
Call a custom Squeezebox JSON-RPC API.
See documentation for this interface on http://HOST:PORT/html/docs/cli-api.html?player=
where HOST and PORT are the host name and port for your Logitech Media Server.
Service data attribute | Optional | Description |
---|---|---|
entity_id |
no | Name(s) of the Squeezebox entities where to run the API method. |
command |
no | Command to pass to Logitech Media Server (p0 in the CLI documentation). |
parameters |
yes | Array of additional parameters to pass to Logitech Media Server (p1, …, pN in the CLI documentation). |
This service can be used to integrate any Squeezebox action to an automation.
It can also be used to target a Squeezebox from IFTTT (or Dialogflow, Alexa…).
For example, to play an album from your collection, create an IFTTT applet like this:
- Trigger: Google Assistant, with sentence:
I want to listen to album $
- Action: JSON post query with such JSON body:
{ "entity_id": "media_player.squeezebox_radio", "command": "playlist", "parameters": ["loadtracks", "album.titlesearch="] }
This can work with title search and basically any thing. The same wouldn’t have worked by calling directly Squeezebox server as IFTTT cannot escape the text field.
Service call_query
Call a custom Squeezebox JSON-RPC API. The result of the query will be stored in the ‘query_result’ attribute of the player.
See documentation for this interface on http://HOST:PORT/html/docs/cli-api.html?player=
where HOST and PORT are the host name and port for your Logitech Media Server.
Service data attribute | Optional | Description |
---|---|---|
entity_id |
no | Name(s) of the Squeezebox entities where to run the API method. |
command |
no | Command to pass to Logitech Media Server (p0 in the CLI documentation). |
parameters |
yes | Array of additional parameters to pass to Logitech Media Server (p1, …, pN in the CLI documentation). |
This service can be used to integrate a Squeezebox query into an automation. For example, in a Python script, you can get a list of albums available by an artist like this:
hass.services.call("squeezebox", "call_query", { "entity_id": "media_player.kitchen", "command": "albums", "parameters": ["0", "20", "search:beatles", "tags:al"] })
To work with the results:
result = hass.states.get("media_player.kitchen").attributes['query_result']