[linkplay] Initial Contribution #19554

digitaldan · 2025-10-25T19:47:24Z

This integrates audio devices based on the LinkPlay platform. LinkPlay is a popular Wi-Fi audio module used by many manufacturers. This binding uses both UPnP communication for realtime events, meta data, etc.. and the LinkPlay HTTP API for control, group management, etc...

This is dependent on openhab/openhab-core#5095 which was just merged.

Signed-off-by: Dan Cunningham <[email protected]>

digitaldan · 2025-10-25T19:55:57Z

Yes, there is another Linkplay binding on the marketplace...... And no, i am not trying to make a habit of creating competing bindings out there ...... I promise 🤞

In this case i did try reaching out to Michael, but did not get a response. The existing binding has been untouched for a long time, and the author's github accounts looks like they have moved to another home automation system, so i don't think its a problem.

This version is fundamentally different in that is was built around UPnP for realtime updates, then i layered on the HTTP api when needed, so there's no polling and and it behaves very similar to the Linkplay/WiiM apps themselves. Also it has strong group support tailored for easy use in our UIs.

I have 4 WiiM streamers that have replaced my 4 aging Sonos Connect boxes i am using this with.

Signed-off-by: Dan Cunningham <[email protected]>

Copilot

Pull Request Overview

This PR introduces a new binding for LinkPlay-based Wi-Fi audio devices. LinkPlay is a popular audio module platform used by various manufacturers. The binding enables control of playback, volume, input sources, equalizer settings, and multi-room audio grouping through a combination of UPnP and HTTP API communications.

Key changes:

Adds complete LinkPlay binding with UPnP discovery support
Implements multi-room audio group management functionality
Provides AudioSink integration for audio streaming

Reviewed Changes

Copilot reviewed 52 out of 53 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
bundles/pom.xml	Adds linkplay module to build
bundles/org.openhab.binding.linkplay/pom.xml	Maven configuration for new binding
bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/thing/thing-types.xml	Channel and thing type definitions
bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/i18n/linkplay.properties	Internationalization strings
bundles/org.openhab.binding.linkplay/src/main/java/.../LinkPlayHandlerFactory.java	Factory for creating handlers and managing UPnP device registry
bundles/org.openhab.binding.linkplay/src/main/java/.../group/*.java	Multi-room group management service and interfaces
bundles/org.openhab.binding.linkplay/src/main/java/.../client/http/*.java	HTTP API client and DTOs for LinkPlay devices
bundles/org.openhab.binding.linkplay/src/main/java/.../client/upnp/*.java	UPnP communication, XML parsing, and command execution
bundles/org.openhab.binding.linkplay/src/main/java/.../discovery/*.java	UPnP discovery participant implementation
bundles/org.openhab.binding.linkplay/README.md	Complete binding documentation with examples
bom/openhab-addons/pom.xml	Adds binding to BOM dependencies
CODEOWNERS	Registers code owner for the binding

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

...linkplay/src/main/java/org/openhab/binding/linkplay/internal/group/LinkPlayGroupService.java

...ding.linkplay/src/main/java/org/openhab/binding/linkplay/internal/client/upnp/UpnpEntry.java

...play/src/main/java/org/openhab/binding/linkplay/internal/client/http/LinkPlayHTTPClient.java

....binding.linkplay/src/main/java/org/openhab/binding/linkplay/internal/LinkPlayAudioSink.java

Signed-off-by: Dan Cunningham <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 52 out of 53 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/thing/thing-types.xml

bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/i18n/linkplay.properties

...linkplay/src/main/java/org/openhab/binding/linkplay/internal/group/LinkPlayGroupService.java

...play/src/main/java/org/openhab/binding/linkplay/internal/client/http/LinkPlayHTTPClient.java

Signed-off-by: Dan Cunningham <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 54 out of 55 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-03T20:34:37Z

bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/thing/thing-types.xml

+	<channel-type id="outputHardwareMode">
+		<item-type>Number</item-type>
+		<label>Output Hardware Mode</label>
+		<description>Active audio output (SPDIF, AUX, COAX)</description>
+		<state>
+			<options>
+				<option value="1">SPDIF</option>
+				<option value="2">AUX</option>
+				<option value="3">COAX</option>
+			</options>
+		</state>
+	</channel-type>


The outputHardwareMode channel type in thing-types.xml uses Number type with numeric options (1, 2, 3), but the i18n file defines state options with string keys (SPDIF, AUX, COAX). This inconsistency will prevent the i18n labels from being applied. Either change the XML options to use string values matching the i18n keys, or update the i18n keys to match the numeric values.

Copilot · 2025-11-03T20:34:37Z

bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/i18n/linkplay.properties

+channel-type.linkplay.trackPosition.label = Track Position
+channel-type.linkplay.trackPosition.description = Current track position
+channel-type.linkplay.trackSource.label = Track Source
+channel-type.linkplay.trackSource.description = Current track source (Pandora, Spotify, etc..)


Corrected 'etc..' to 'etc.'.

Copilot · 2025-11-03T20:34:37Z

...g.linkplay/src/main/java/org/openhab/binding/linkplay/internal/client/http/dto/LoopMode.java

+    public static LoopMode fromCode(int code) {
+        for (LoopMode m : values()) {
+            if (m.code == code) {
+                return m;
+            }
+        }
+        return null;
+    }


The fromCode method can return null but lacks @nullable annotation on its return type. This could lead to NullPointerExceptions if callers don't check for null. Add @nullable annotation to the return type.

Signed-off-by: Dan Cunningham <[email protected]>

lsiepel

Thanks for adding this binding. Looked at 42/55 files, mainly dto's and metadata files. Handlers will be next.

lsiepel · 2025-11-15T11:48:32Z

...src/main/java/org/openhab/binding/linkplay/internal/client/http/LinkPlayConnectionUtils.java

+@NonNullByDefault
+public class LinkPlayConnectionUtils {
+
+    public static @Nullable Integer testConnection(HttpClient httpClient, String host) {


Please add javadoc to public utility methods

lsiepel · 2025-11-15T11:49:00Z

...src/main/java/org/openhab/binding/linkplay/internal/client/http/LinkPlayConnectionUtils.java

+            } catch (Exception ignored) {
+                // Continue to next port


What about interruptexception?

lsiepel · 2025-11-15T11:50:35Z

...ain/java/org/openhab/binding/linkplay/internal/client/http/adaptors/PlayerStatusAdapter.java

+                        + Character.digit(hex.charAt(i + 1), 16));
+            }
+            return new String(data, StandardCharsets.UTF_8);
+        } catch (Exception e) {


At this and other files a see the generic Exception is caught, it would be prefered to catch the specific exception at all of those places.

lsiepel · 2025-11-15T11:52:00Z

.../main/java/org/openhab/binding/linkplay/internal/client/upnp/LinkPlayUpnpDeviceListener.java

+ */
+@NonNullByDefault
+public interface LinkPlayUpnpDeviceListener {
+    void updateDeviceConfig(RemoteDevice device);


Please add javadoc to all interface methods

lsiepel · 2025-11-15T11:52:16Z

...ay/src/main/java/org/openhab/binding/linkplay/internal/client/upnp/LinkPlayUpnpRegistry.java

+    void addDeviceListener(String udn, LinkPlayUpnpDeviceListener listener);
+
+    void removeDeviceListener(String udn);


Please add javadoc to all interface methods.

lsiepel · 2025-11-15T11:54:38Z

bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/thing/thing-types.xml

+	<channel-type id="multiroomActive">
+		<item-type>Switch</item-type>
+		<label>Multi-room Active</label>
+		<description>Indicates if the device is part of a group</description>
+		<state readOnly="true"/>
+	</channel-type>


Applies to all channel types, please provide semantic tags. (Point+Property)

lsiepel · 2025-11-15T11:55:02Z

bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/thing/thing-types.xml

+	<thing-type id="player">
+		<label>LinkPlay Player</label>
+		<description>Represents a single LinkPlay-based audio player</description>
+		<channel-groups>


Can you add a semenatic equipment tag

lsiepel · 2025-11-15T11:55:57Z

bundles/org.openhab.binding.linkplay/src/main/resources/OH-INF/thing/thing-types.xml

+			<channel id="source" typeId="presetSource"/>
+			<channel id="pic-url" typeId="presetPicUrl"/>
+			<channel id="pic" typeId="presetPic"/>
+			<channel id="play" typeId="presetPlay"/>


Applies to all channel id's ( i think they are good) and channel type id's. Please stick to the naming co9nvention lower-case-hyphen

[linkplay] Initial Contrabution

01367ee

Signed-off-by: Dan Cunningham <[email protected]>

digitaldan requested a review from a team as a code owner October 25, 2025 19:47

Spotless

bea8883

Signed-off-by: Dan Cunningham <[email protected]>

lsiepel added the new binding If someone has started to work on a binding. For a new binding PR. label Oct 25, 2025

wborn requested a review from Copilot October 26, 2025 09:19

Copilot AI reviewed Oct 26, 2025

View reviewed changes

PR feedback

f2e4078

Signed-off-by: Dan Cunningham <[email protected]>

digitaldan requested a review from Copilot October 26, 2025 15:53

Copilot AI reviewed Oct 26, 2025

View reviewed changes

digitaldan added 5 commits October 26, 2025 09:19

PR feedback

d2f9cfc

Signed-off-by: Dan Cunningham <[email protected]>

Adds missing channels

9eb152d

Signed-off-by: Dan Cunningham <[email protected]>

clean up refresh

1384b95

Signed-off-by: Dan Cunningham <[email protected]>

Handle modes and inputs properly

e03c2a0

Signed-off-by: Dan Cunningham <[email protected]>

Fix player status duration/position, update missing channels

bd7f7ed

Signed-off-by: Dan Cunningham <[email protected]>

digitaldan requested a review from Copilot November 3, 2025 20:24

Copilot AI reviewed Nov 3, 2025

View reviewed changes

Update host on UPnP updates

8018dc3

Signed-off-by: Dan Cunningham <[email protected]>

lsiepel requested changes Nov 15, 2025

View reviewed changes

		void addDeviceListener(String udn, LinkPlayUpnpDeviceListener listener);

		void removeDeviceListener(String udn);

Uh oh!

[linkplay] Initial Contribution #19554

Are you sure you want to change the base?

[linkplay] Initial Contribution #19554

Uh oh!

Conversation

digitaldan commented Oct 25, 2025

Uh oh!

digitaldan commented Oct 25, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

lsiepel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants