Skip to content

Initial QualityScale updates for Squeezebox doc #38407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 7, 2025
Merged

Initial QualityScale updates for Squeezebox doc #38407

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5b798e3
Initial QualityScale updates
peteS-UK Apr 6, 2025
292d504
lint
peteS-UK Apr 6, 2025
a50cfe2
lint
peteS-UK Apr 6, 2025
13416bb
Update squeezebox.markdown
peteS-UK Apr 6, 2025
2002492
indents
peteS-UK Apr 7, 2025
ad25e30
Update source/_integrations/squeezebox.markdown
c0ffeeca7 Apr 7, 2025
02d7e4f
Apply suggestions from code review
c0ffeeca7 Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions source/_integrations/squeezebox.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Squeezebox (Lyrion Music Server)
description: Instructions on how to integrate Squeezebox players and a Lyrion Music Server (LMS) into Home Assistant.
description: Instructions on how to integrate Squeezebox players and a Lyrion Music Server (LMS) into Home Assistant.
ha_category:
- Media player
ha_release: pre 0.7
Expand All @@ -26,16 +26,36 @@ This integration connects to an existing <abbr title="Lyrion Music Server">LMS</

The Squeezebox music player ecosystem, which can be controlled through this integration, includes hardware audio players from Logitech, including [Squeezebox 3rd Generation, Squeezebox Boom, Squeezebox Receiver, Transporter, Squeezebox2, Squeezebox and SLIMP3](https://lms-community.github.io/players-and-controllers/hardware-comparison/), and many software emulators like [Squeezelite, SqueezeSlave, SoftSqueeze and SqueezePlay](https://sourceforge.net/projects/lmsclients/files/).

## Prerequisites

1. One or more [Squeezebox compatible hardware or software players](https://lyrion.org/players-and-controllers/).
2. One or more [Lyrion Music Servers or Logitech Media Servers (LMS)](https://lyrion.org/getting-started) with the Squeezebox players connected to these servers.

{% include integrations/config_flow.md %}

{% note %}
This platform uses the web interface of the Lyrion Music Server (LMS) to send commands. The default port of the web interface is 9000. It is the same port that you use to access the LMS through your web browser.
{% endnote %}

{% note %}
The integration now supports Lyrion Music Servers behind an HTTPS reverse proxy. Please note that Lyrion Music Server natively only supports HTTP traffic. Unless you have configured a reverse proxy, do not select the `https` option. If you have configured a reverse proxy, remember to update the port number.
A single configuration entry for the integration adds all Squeezebox devices connected to one LMS to Home Assistant.
{% endnote %}

When the LMS cannot be discovered, it can be manually configured.

{% configuration_basic %}
Host:
description: "The host name or IP address (e.g., \"192.168.1.2\") of your LMS."
Port:
description: "The integration uses the web interface of the Lyrion Music Server (LMS) to send commands. The default port of the web interface is 9000. It is the same port that you use to access the LMS through your web browser."
Username:
description: "If you have selected \"Password Protection\" in your LMS Advanced Security, enter your Username here."
Password:
description: "If you have selected \"Password Protection\" in your LMS Advanced Security, enter your Password here."
Connect over HTTPS:
description: "The integration now supports Lyrion Music Servers behind an HTTPS reverse proxy. Please note that Lyrion Music Server natively only supports HTTP traffic. Unless you have configured a reverse proxy, do not select the \"Connect over HTTPS\" option. If you have configured a reverse proxy, remember to update the port number."
{% endconfiguration_basic %}

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:

```yaml
Expand All @@ -62,6 +82,12 @@ Volume step:
description: Amount to adjust the volume when turning volume up or down.
{% endconfiguration_basic %}

## Removing the integration

This integration follows standard integration removal. No extra steps are required.

{% include integrations/remove_device_service.md %}

## Announce

The Squeezebox media player entity supports the "announce" parameter in the `media_player.play_media` action. When media is played with announce:true, the current state of the media player is saved, the media is then played, and when playing is finished, the original state is restored. For example, if the media player is on and playing a track, once the announcement is finished, the track will resume playing at the same point it was paused by the announcement. If the media player was off, it will be turned off again after playing the announcement.
Expand Down Expand Up @@ -231,7 +257,7 @@ data:
command: mixer
parameters:
- volume
- "+5"
- '+5'
```

### Action `call_query`
Expand Down