[ClementineRemote] Initial contribution #14110

StephanRichter · 2022-12-29T17:16:03Z

ClementineRemote Binding

This new binding allows controlling Clementine Player from OpenHAB.

The binding is located @ bundles/org.openhab.binding.clementineremote.

Description

Connection between Handler and Clementine Player is done via Google Protocol Buffers.
The protobuf definition file is included in the folder proto.

Based on this definition file, a class ClementineRemote.java has been generated in the package bundles/org.openhab.binding.clementineremote/src/main/java/de/qspool/clementineremote/backend/pb via the command

bundles/org.openhab.binding.clementineremote$> protoc --java_out=src/main/java/ proto/remotecontrolmessages.proto

OpenHAB version

As per request from Maintainer, this commit is now based on lastest 4.0.0 main.

Static Code Analysis

All code in org/openhab/binding/clementineremote should conform to the requirements given in the Coding Guidelines.

However the code in de/qspool/clementineremote/backend/pb does not! As this class is script-generated, I think it should be excluded from code analysis.
There already is a thread for discussion of that topic.

This is a squash commit to tidy up experiments. Signed-off-by: Stephan Richter <github@srsoftware.de>

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

lsiepel

Thanks, did a basic review. Didn't look at the ...lementineremote/src/main/java/de/qspool/clementineremote/backend/pb/ClementineRemote.java 36k lines :-) and two other files, Maybe look at that later.

There also has to come a solution for the auto-generated files as the current build fails due to these files.

note: im not an addons maintainer

bundles/pom.xml

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

bundles/org.openhab.binding.clementineremote/README.md

lsiepel · 2023-01-02T23:41:42Z

bundles/org.openhab.binding.clementineremote/NOTICE

+
+* Project home: https://www.openhab.org
+
+== Declared Project Licenses


No license expert here, just want to mention that i see a different license for the auto generated files like: /src/main/java/de/qspool/clementineremote/backend/pb/ClementineRemote.java

The dependency on com.google.protobuf might need to be mentioned, but as said, i'm no expert here.

I've updated the NOTICE file in a recent commit. But I'm no expert in these things. Again, I would be grateful for any suggestion how to improve this text.

@jlaur can you advice?

Please add this to the end of this file

== Third-party Content protobuf-java * License: BSD License * Project: https://developers.google.com/protocol-buffers * Source: https://github.com/protocolbuffers/protobuf

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

StephanRichter · 2023-01-08T11:29:39Z

I fixed all suggestions by lsiepel – with on exception:

I did not change the channel type of playback-control to the predefined system.media-control, as that does not seem to support STOP command.

bundles/org.openhab.binding.clementineremote/README.md

lsiepel · 2023-01-08T13:32:56Z

I fixed all suggestions by lsiepel – with on exception:

I did not change the channel type of playback-control to the predefined system.media-control, as that does not seem to support STOP command.

Great, some small issues left. Maybe look at some other binding regarding the player / media control. Don't have a real opinion on it, juist know there is a dedicated control for such tasks.

I leave this now for a real maintainer to review. :-)

lsiepel

Have also commented on some parts that could improve in the handler, one of the files
i skipped earlier.

...ote/src/main/java/org/openhab/binding/clementineremote/internal/ClementineRemoteHandler.java

J-N-K · 2023-01-16T13:53:04Z

bundles/org.openhab.binding.clementineremote/src/main/resources/OH-INF/binding/binding.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<binding:binding id="clementineremote" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:binding="https://openhab.org/schemas/binding/v1.0.0"
+	xsi:schemaLocation="https://openhab.org/schemas/binding/v1.0.0 https://openhab.org/schemas/binding-1.0.0.xsd">
+
+	<name>Clementine Remote Control</name>
+	<description>This is a binding to remotely control Clementine Player instances.</description>
+
+</binding:binding>


Please convert to the new addon.xml.

This addon.xml is not yet common knowledge and the PR to adapt the developer docs is not merged yet, so if you need more details, the corrosponding issue is here: openhab/openhab-core#2058
But you can also update your branch and look at another binding's addon.xml and adapt it to this initial contribution.

Details are documented here: https://next.openhab.org/docs/developer/addons/addon.html#add-on-definitions

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

…Channels Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

This is a squash commit to tidy up experiments. Signed-off-by: Stephan Richter <github@srsoftware.de>

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

...enhab.binding.clementineremote/src/main/resources/OH-INF/i18n/clementineremote_de.properties

lsiepel

Thanks for making the improvements. There are some builds warnings left (Potential null pointer access). Hopefully @jlaur can advice how to exclude the 3rd party generated file from SAT analysis. as it is currently cluttering the build log.

...ote/src/main/java/org/openhab/binding/clementineremote/internal/ClementineRemoteHandler.java

...c/main/java/org/openhab/binding/clementineremote/internal/ClementineRemoteConfiguration.java

...ote/src/main/java/org/openhab/binding/clementineremote/internal/ClementineRemoteHandler.java

…c channel (for all channels). Refactored connection methods, implemented failover by using sheduler Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

StephanRichter · 2023-03-06T23:16:21Z

Hm, any progress here? Did I miss something when fixing the denoted issues?

jlaur · 2023-03-19T21:27:53Z

bundles/org.openhab.binding.http/Widget.md

This was probably added by mistake, can you remove it?

ping @StephanRichter

Currently, I'm a bit short in time. I will look into this later.

jlaur · 2023-03-19T21:46:28Z

bundles/org.openhab.binding.clementineremote/proto/remotecontrolmessages.proto

This file should probably be moved to bundles/org.openhab.binding.clementineremote/src/3rdparty/proto/remotecontrolmessages.proto since it belongs to a different namespace with a difference license.

jlaur · 2023-03-19T21:48:09Z

...g.clementineremote/src/main/java/de/qspool/clementineremote/backend/pb/ClementineRemote.java

This file should probably be moved to bundles/org.openhab.binding.clementineremote/src/3rdparty/java/backend/pb/ClementineRemote.java since it belongs to a different namespace with a difference license.

wborn · 2023-07-24T09:50:06Z

bundles/org.openhab.binding.clementineremote/pom.xml

+  <parent>
+    <groupId>org.openhab.addons.bundles</groupId>
+    <artifactId>org.openhab.addons.reactor.bundles</artifactId>
+    <version>4.0.0-SNAPSHOT</version>


Suggested change

<version>4.0.0-SNAPSHOT</version>

<version>4.3.0-SNAPSHOT</version>

lsiepel · 2024-09-09T19:51:00Z

@StephanRichter there has been some time without any updated / commits to this PR. Do you think you will be able to finish this or did you abandon this PR? At some time we will close this PR due to inactivity.

StephanRichter · 2024-09-29T18:55:35Z

Sorry for the late answer. I'm currently completely overloaded and have no spare time to invest here. The code is working (I use it on a daily base) – if anyone can make editions to fulfill your requirements: feel free to do so.
I tried to implement all requirements requested so far, with no success. I give up.

lsiepel · 2024-10-02T17:18:54Z

Thank you for your reply. While this PR is not that far from being merged, i hope you finish it somewhere in the future. But as you said to give up at this moment i think it is better to close it here. Obvious the code remains available in your branch, so whenever you or another contributer want to move this forward the code can be re-used.

openhab-bot and others added 2 commits June 26, 2022 21:01

Preparation for tag creation (Tag name: '3.3.0').

8eb6f87

Added new _Clementine Remote_ binding.

c4f2cab

This is a squash commit to tidy up experiments. Signed-off-by: Stephan Richter <github@srsoftware.de>

StephanRichter requested a review from a team as a code owner December 29, 2022 17:16

jlaur changed the title ~~[ClementineRemote] new binding!~~ [ClementineRemote] Initial contribution Dec 29, 2022

jlaur added the new binding If someone has started to work on a binding. For a new binding PR. label Dec 29, 2022

back-ported code from ClementineRemote (4.0.0) branch

012c368

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

lsiepel requested changes Jan 2, 2023

View reviewed changes

Stephan Richter added 6 commits January 6, 2023 08:48

restored pom.xml (i.e. removed blank lines)

6aaa528

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

bugfix in thing-types.xml

3dfed03

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

removed comments as requested

dcbad4d

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

working on suggestions fro Isiepel

a08102e

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

fixing issues as requestef from maintainer

8e150fb

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

fixed READMED, NOTICE and added dev link to ClementineRemoteHandler.java

32a5718

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

StephanRichter force-pushed the ClementineRemote branch from d0f01b4 to ba03039 Compare January 8, 2023 11:55

lsiepel reviewed Jan 8, 2023

View reviewed changes

bundles/org.openhab.binding.clementineremote/README.md Outdated Show resolved Hide resolved

lsiepel requested changes Jan 8, 2023

View reviewed changes

J-N-K reviewed Jan 16, 2023

View reviewed changes

Stephan Richter and others added 11 commits February 7, 2023 21:05

made enum values (ClementineRemoteHandler) uppercase

c004b1a

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

now handling refresh command

de9c5d2

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

fixed verbosity level

870462b

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

added @nullable

9d22d6d

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

added dedicated methods updatePlayerStateChannels and updateTrackInfo…

9c8093f

…Channels Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

squashed all changes into on commit - this time signing it off

1ec99c4

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

improved README

2fd1a21

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

dropped german translation

1ddd5d6

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Preparation for tag creation (Tag name: '3.3.0').

915635f

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Added new _Clementine Remote_ binding.

a1901ea

This is a squash commit to tidy up experiments. Signed-off-by: Stephan Richter <github@srsoftware.de>

fixing issues as requestef from maintainer

e3d1648

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

StephanRichter force-pushed the ClementineRemote branch from 8331fa3 to e3d1648 Compare February 7, 2023 22:29

fixed class header comments

9b14165

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

lsiepel reviewed Feb 8, 2023

View reviewed changes

...enhab.binding.clementineremote/src/main/resources/OH-INF/i18n/clementineremote_de.properties Outdated Show resolved Hide resolved

lsiepel requested changes Feb 8, 2023

View reviewed changes

Stephan Richter added 14 commits February 8, 2023 23:50

Refactored update handling: now reacting to refreshCommand on specifi…

88a2496

…c channel (for all channels). Refactored connection methods, implemented failover by using sheduler Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Merge branch 'ClementineRemote-3.3.0' into ClementineRemote

0573a48

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

removed clementineremote_de.properties

6b8e6c9

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

worked on Nullable handles

26cbb88

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

worked on Nullable handles

99735f3

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

formatting introduced by spotless:apply

cae3084

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Merge branch 'ClementineRemote-3.3.0' into ClementineRemote

fc177d3

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

fixing possible null pointer access

8c08d5c

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

handling null pointer access

dcc79f8

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

improved behaviour on disconnect

38d4b93

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

dropped state channel (was redundant to playback channel)

dbc91a7

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Merge branch 'ClementineRemote-3.3.0' into ClementineRemote

d9312b8

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

updated README: added demo.things

a83eeb9

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Merge branch 'ClementineRemote-3.3.0' into ClementineRemote

2f26ad4

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

jlaur reviewed Mar 19, 2023

View reviewed changes

jlaur added the awaiting feedback Awaiting feedback from the pull request author label Apr 23, 2023

wborn reviewed Jul 24, 2023

View reviewed changes

lsiepel closed this Oct 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ClementineRemote] Initial contribution #14110

[ClementineRemote] Initial contribution #14110

StephanRichter commented Dec 29, 2022

lsiepel left a comment •

edited

Loading

lsiepel Jan 2, 2023

StephanRichter Jan 8, 2023 •

edited

Loading

lsiepel Feb 8, 2023

lsiepel Apr 29, 2024

StephanRichter commented Jan 8, 2023 •

edited

Loading

lsiepel commented Jan 8, 2023

lsiepel left a comment

J-N-K Jan 16, 2023

lsiepel Jan 16, 2023

lsiepel Apr 29, 2024

lsiepel left a comment

StephanRichter commented Mar 6, 2023

jlaur Mar 19, 2023

lsiepel Apr 29, 2024

StephanRichter Apr 30, 2024

jlaur Mar 19, 2023

jlaur Mar 19, 2023

wborn Jul 24, 2023 •

edited

Loading

lsiepel commented Sep 9, 2024

StephanRichter commented Sep 29, 2024 •

edited

Loading

lsiepel commented Oct 2, 2024


		* Project home: https://www.openhab.org

		== Declared Project Licenses

	<version>4.0.0-SNAPSHOT</version>
	<version>4.3.0-SNAPSHOT</version>

[ClementineRemote] Initial contribution #14110

[ClementineRemote] Initial contribution #14110

Conversation

StephanRichter commented Dec 29, 2022

ClementineRemote Binding

Description

OpenHAB version

Static Code Analysis

lsiepel left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephanRichter Jan 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephanRichter commented Jan 8, 2023 • edited Loading

lsiepel commented Jan 8, 2023

lsiepel 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

lsiepel left a comment

Choose a reason for hiding this comment

StephanRichter commented Mar 6, 2023

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

wborn Jul 24, 2023 • edited Loading

Choose a reason for hiding this comment

lsiepel commented Sep 9, 2024

StephanRichter commented Sep 29, 2024 • edited Loading

lsiepel commented Oct 2, 2024

lsiepel left a comment •

edited

Loading

StephanRichter Jan 8, 2023 •

edited

Loading

StephanRichter commented Jan 8, 2023 •

edited

Loading

wborn Jul 24, 2023 •

edited

Loading

StephanRichter commented Sep 29, 2024 •

edited

Loading