Add option to LinkPlay to disregard HA hostname and use IP instead #137089

ozonejunkieau · 2025-02-01T13:50:26Z

Proposed change

Digging into the issue related to LinkPlay devices not supporting TTS, it appears the root cause of this is that the devices "ignore" URLs relating to local network resources. From the debugging that I've done (documented in the related issue), overriding this behaviour has not yet been possible through device configuration.

This PR adds in an option to the integraton that overwrites the generated URL's with the local HA IP address instead. By doing this, TTS works on these devices with no further issues. It doesn't feel elegant, but it does work. Due to the nature of the fix I wanted to invite comment before I finalised testing etc, as if this method can't reach the development standards of the project I'll just leave it until someone can find a better method to get this working.

TODO: At present I have been unable to find any documentation on how to change the displayed text adjacent to a boolean option. I would greatly appreciate some pointers on where to find the documentation for this! The tests also require updating at this time.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes Linkplay speakers do not support tts #123993
This PR is related to issue:
Link to documentation pull request:
Link to developer documentation pull request:
Link to frontend pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

…nstead of configured name, fixing TTS.

home-assistant

Hi @ozonejunkieau

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

home-assistant · 2025-02-01T13:50:32Z

Hey there @Velleman, mind taking a look at this pull request as it has been labeled with an integration (linkplay) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of linkplay can trigger bot actions by commenting:

@home-assistant close Closes the pull request.
@home-assistant rename Awesome new title Renames the pull request.
@home-assistant reopen Reopen the pull request.
@home-assistant unassign linkplay Removes the current integration label and assignees on the pull request, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

silamon

Thank you for your deep analysis and contribution trying to address it. I've left some first comments in this review to get started. Some basic test coverage for the option flow will be required to get this merged on the end.

The implementation of the LinkPlay protocol is generic is some form, but the implementation may differ from device to device depending on the manufacturer. Multiple companies have adjusted the firmware, making it hard to know what devices (and the firmwares) are actually affected by this bug.

I'm still thinking if it's required to present this as an option (flow), if the affected devices can be listed, it should be possible to handle all this based on the model ids.

silamon · 2025-02-02T10:20:03Z

homeassistant/components/linkplay/__init__.py

+    # Register update listener to update config entry when options are updated.
+    hass_data = dict(entry.data)
+    unsub_options_update_listener = entry.add_update_listener(options_update_listener)
+    # Store a reference to the unsubscribe function to cleanup if an entry is unloaded.
+    hass_data["unsub_options_update_listener"] = unsub_options_update_listener
+    hass.data[DOMAIN][entry.entry_id] = hass_data
+


You can replace this code with

entry.async_on_unload(entry.add_update_listener(async_update_options))

Add this code after initializing the platforms, so it only unloads after successful setup.

silamon · 2025-02-02T10:25:02Z

homeassistant/components/linkplay/media_player.py

+        # Modify the the url if required to use IP address instead of hostname.
+        # This is required for compatibility with some devices.
+        if self._use_ip_url:
+            parsed_url = yarl.URL(url)
+            # Update the parsed URL with the local ip
+            url = parsed_url.with_host(self.hass.config.api.local_ip)


Given your analysis in the issue thread, I assume this is only required when you want to play a local(-only) url that isn't externally exposed?

How does this work for music coming from a streaming provider? When the toggle is enabled, it will replace dns always with it's ip address?

On first reading through the code I was under the impression that this function was only called with HA URL's. Upone re-reading I can see that this isn't a valid assumption, so I'll update the code to handle this case and update the PR.

You can use this utility method:

core/homeassistant/helpers/network.py

Line 67 in 9e04f61

def is_hass_url(hass: HomeAssistant, url: str) -> bool:

Thanks for that, I'm still getting my head around how the options flow testing should work, will try and spend some time in the next couple of days and get that added.

silamon · 2025-02-02T10:27:22Z

homeassistant/components/linkplay/utils.py

@@ -25,10 +25,12 @@
 MODELS_ARYLIC_A50: Final[str] = "A50"
 MODELS_ARYLIC_A50S: Final[str] = "A50+"
 MODELS_ARYLIC_UP2STREAM_AMP: Final[str] = "Up2Stream Amp 2.0"
+MODELS_ARYLIC_UP2STREAM_AMP_2P1: Final[str] = "Up2Stream Amp 2.1"


Can you open a preliminary pull request to add these models? Pull requests are as small as possible and should only address one change at a time.

Thanks, I've just submitted a separate PR with these.

silamon · 2025-02-02T10:36:44Z

homeassistant/components/linkplay/strings.json

+  "selector": {
+    "sensor_select": {
+      "options": {
+        "use_ip_url": "Force IP in Home Assistant generated URLs to work around bugs in using local domain names with some devices."
+      }
+    }
+  },


Use the option flow translation section to let them show up. Something like this:

Suggested change

"selector": {

"sensor_select": {

"options": {

"use_ip_url": "Force IP in Home Assistant generated URLs to work around bugs in using local domain names with some devices."

}

}

},

"options": {

"step": {

"init": {

"title": "LinkPlay options",

"data": {

"use_ip_url": "Force IP in Home Assistant generated URLs to work around bugs in using local domain names with some devices."

}

}

}

},

silamon · 2025-02-02T10:56:41Z

Have you tested if it worked for your devices with any of the custom components available? Some people mentioned that it works with the custom components in the issue thread and they have always been a good source for this core integration from the start.

ozonejunkieau · 2025-02-10T12:00:54Z

Have you tested if it worked for your devices with any of the custom components available? Some people mentioned that it works with the custom components in the issue thread and they have always been a good source for this core integration from the start.

From reading online, I was under the impression that the previous custom components had been deprecated in favour of the built in component?

I haven't tested with the custom components, I figured that working with the core integration was likely a more reliable path?

silamon · 2025-02-10T12:06:19Z

Have you tested if it worked for your devices with any of the custom components available? Some people mentioned that it works with the custom components in the issue thread and they have always been a good source for this core integration from the start.

From reading online, I was under the impression that the previous custom components had been deprecated in favour of the built in component?

I haven't tested with the custom components, I figured that working with the core integration was likely a more reliable path?

Thanks for answering. Having it fixed in core is definiately the way to go. It's fine if you didn't test any custom integrations, just asking to know. I've went through the code of multiple custom integrations and couldn't spot if they would fix this issue.

silamon

Thanks for taking the time to further improve. At this point, I'm not sure it would be accepted to introduce a option flow for this, we will need to wait until a core reviewer comes by to step in.

silamon · 2025-02-14T16:51:34Z

homeassistant/components/linkplay/__init__.py

+    # Register update listener to update config entry when options are updated.
+    entry.async_on_unload(entry.add_update_listener(options_update_listener))
+


This needs to be at the bottom of the function, to ensure it only unloads when it was successfully setup.

Add support for rewriting local media URLs to use the HA IP address i…

ca45b16

…nstead of configured name, fixing TTS.

home-assistant bot requested changes Feb 1, 2025

View reviewed changes

home-assistant bot added bugfix cla-needed integration: linkplay Quality Scale: No score labels Feb 1, 2025

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Feb 1, 2025

ozonejunkieau mentioned this pull request Feb 1, 2025

Linkplay speakers do not support tts #123993

Open

Merge branch 'dev' into dev

6076e33

silamon reviewed Feb 2, 2025

View reviewed changes

ozonejunkieau mentioned this pull request Feb 10, 2025

Update Linkplay constants for Arylic S10+ and Arylic Up2Stream Amp 2.1 #138198

Merged

19 tasks

Update with helpers, initial pass at tests.

0443351

silamon reviewed Feb 14, 2025

View reviewed changes

MartinHjelmare changed the title ~~Add option to LinkPlay to disregard HA hostname and use IP instead.~~ Add option to LinkPlay to disregard HA hostname and use IP instead Feb 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to LinkPlay to disregard HA hostname and use IP instead #137089

Add option to LinkPlay to disregard HA hostname and use IP instead #137089

ozonejunkieau commented Feb 1, 2025

home-assistant bot left a comment

home-assistant bot commented Feb 1, 2025

silamon left a comment

silamon Feb 2, 2025

silamon Feb 2, 2025

ozonejunkieau Feb 10, 2025

silamon Feb 10, 2025

ozonejunkieau Feb 10, 2025

silamon Feb 2, 2025

ozonejunkieau Feb 10, 2025

silamon Feb 2, 2025

silamon commented Feb 2, 2025

ozonejunkieau commented Feb 10, 2025

silamon commented Feb 10, 2025 •

edited

Loading

silamon left a comment

silamon Feb 14, 2025

		# Register update listener to update config entry when options are updated.
		entry.async_on_unload(entry.add_update_listener(options_update_listener))

Add option to LinkPlay to disregard HA hostname and use IP instead #137089

Are you sure you want to change the base?

Add option to LinkPlay to disregard HA hostname and use IP instead #137089

Conversation

ozonejunkieau commented Feb 1, 2025

Proposed change

Type of change

Additional information

Checklist

home-assistant bot left a comment

Choose a reason for hiding this comment

home-assistant bot commented Feb 1, 2025

silamon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

silamon commented Feb 2, 2025

ozonejunkieau commented Feb 10, 2025

silamon commented Feb 10, 2025 • edited Loading

silamon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

silamon commented Feb 10, 2025 •

edited

Loading