[plex] Initial contribution #12135

aronbeurskens · 2022-01-27T18:25:51Z

New binding: Plex

Description

This adds a new binding for communication with Plex.
It allows multiple players to be added to OpenHab and provide information about what is currently playing on the play.

When using this binding one can:

Create pages with meta information about the media that is begin played
Create rules to automatically control lights when a movie is started / paused / stopped

Testing

Latest .jar file available add: https://github.com/aronbeurskens/openhab-addons/releases/tag/v0.13

openhab-bot · 2022-01-28T09:15:11Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/plex-binding-for-oh3-will-it-be-ported/111487/178

aronbeurskens · 2022-01-28T12:43:05Z

Can somebody help/point me solving the build failures? It seems to fail, but not on the plex part.
How can I reproduce this locally (what command to run) to debug what is causing the failed build?

lolodomo · 2022-01-28T12:48:18Z

Maybe due to the full copyright you added in comments in the file feature.xml?
Look at another binding how should look like this file.

aronbeurskens · 2022-01-28T13:02:49Z

Thanks, I will have a look. Is there any way to reproduce this locally, to avoid having to commit and wait each time...

lolodomo · 2022-01-28T13:05:45Z

Yes, by running mvn clean install at the root of your git repo.

aronbeurskens · 2022-01-30T12:40:49Z

Thank you @lolodomo . Managed to get it passing the build checks!

aronbeurskens · 2022-02-05T14:53:55Z

This is my first contribution / pr so I'm not quite familiar with the way of working. Do I need to do anything to get this merged?

aronbeurskens · 2022-12-30T17:57:49Z

Hi all, it has been a while, but letting you all know i am working on an update compatible for version 4.0

aronbeurskens · 2023-01-01T13:41:44Z

@fwolter thanks for the feedback. I've updated the PR as much as possible. Please have second look at it.

openhab-bot · 2023-01-03T19:21:28Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/plex-binding-for-oh3-stuck/136598/13

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

....binding.plex/src/main/java/org/openhab/binding/plex/internal/handler/PlexServerHandler.java

Signed-off-by: Aron Beurskens <[email protected]>

jlaur · 2023-03-21T12:56:07Z

I have added "awaiting feedback" because there is still an unresolved comment for quite some time: #12135 (comment)

fwolter

There are some checkstyle warnings left. You could take a look at target/code-analysis/report.html after building it with mvn clean install.

There are some compiler warnings about null access and dead code left. You could take a look at mvn clean install. To fix the null warnings, you need to store the field to a local variable and do the null check on that.

[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexApiConnector.java:[114,17] The method setupDefaultSecurity(com.thoughtworks.xstream.XStream) from the type com.thoughtworks.xstream.XStream is deprecated
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexApiConnector.java:[162,17] Redundant null check: The variable user cannot be null at this location
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexApiConnector.java:[166,20] Dead code
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexApiConnector.java:[226,16] Null type mismatch (type annotations): 'null' is not compatible to the free type variable 'T'
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexApiConnector.java:[284,28] The constructor org.eclipse.jetty.websocket.client.WebSocketClient(org.eclipse.jetty.util.ssl.SslContextFactory) is deprecated
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexApiConnector.java:[335,25] Potential null pointer access: this expression has a '@Nullable' type
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexApiConnector.java:[357,39] Potential null pointer access: this expression has a '@Nullable' type
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexServerHandler.java:[56,54] The value of the field org.openhab.binding.plex.internal.handler.PlexServerHandler.stateDescriptionProvider is not used
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexServerHandler.java:[159,44] Potential null pointer access: The variable tmpMeta may be null at this location
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexServerHandler.java:[268,35] Potential null pointer access: this expression has a '@Nullable' type
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexServerHandler.java:[301,36] Potential null pointer access: this expression has a '@Nullable' type
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexServerHandler.java:[302,13] Potential null pointer access: this expression has a '@Nullable' type
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\PlexHandlerFactory.java:[76,17] Potential null pointer access: this expression has a '@Nullable' type
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexPlayerHandler.java:[48,30] The value of the field org.openhab.binding.plex.internal.handler.PlexPlayerHandler.plexAPIConnector is not used
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexPlayerHandler.java:[70,49] Potential null pointer access: The method getBridge() may return null
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.plex\src\main\java\org\openhab\binding\plex\internal\handler\PlexPlayerHandler.java:[85,45] Potential null pointer access: this expression has a '@Nullable' type

[WARNING] Code Analysis Tool has found:
 0 error(s)!
 8 warning(s)
 11 info(s)
[WARNING] .binding.plex\README.md:[6]
The line before a Markdown list must be empty.
[WARNING] org.openhab.binding.plex.discovery.PlexDiscoveryService.java:[27]
First javadoc author should have "Initial contribution" contribution description.
[WARNING] org.openhab.binding.plex.discovery.PlexDiscoveryService.java:[29]
Classes/Interfaces/Enums should be annotated with @NonNullByDefault
[WARNING] org.openhab.binding.plex.internal.dto.MediaContainer.java:[23]
First javadoc author should have "Initial contribution" contribution description.
[WARNING] org.openhab.binding.plex.internal.handler.PlexApiConnector.java:[103]
Bei einem equals()-Vergleich sollten String-Literale auf der linken Seite stehen.
[WARNING] org.openhab.binding.plex.internal.handler.PlexPlayerHandler.java:[26]
Stern-Importe der Form '.*' sollten vermieden werden - org.openhab.core.thing.*.
[WARNING] org.openhab.binding.plex.internal.handler.PlexApiConnectorTest.java:[31]
First javadoc author should have "Initial contribution" contribution description.
[WARNING] org.openhab.binding.plex.internal.handler.PlexApiConnectorTest.java:[33]
Classes/Interfaces/Enums should be annotated with @NonNullByDefault

fwolter · 2023-03-28T09:34:53Z

....binding.plex/src/main/java/org/openhab/binding/plex/internal/handler/PlexPlayerHandler.java

+        PlexPlayerConfiguration config = getConfigAs(PlexPlayerConfiguration.class);
+        foundInSession = false;
+        playerID = config.playerID;
+        logger.warn("Initializing PLEX player : {}", playerID);


Suggested change

logger.warn("Initializing PLEX player : {}", playerID);

fwolter · 2023-03-28T09:35:49Z

....binding.plex/src/main/java/org/openhab/binding/plex/internal/handler/PlexServerHandler.java

+    private final Map<String, PlexPlayerHandler> playerHandlers = new ConcurrentHashMap<>();
+
+    private PlexServerConfiguration config = new PlexServerConfiguration();
+    // private @Nullable PlexServerHandler bridge;


Suggested change

// private @Nullable PlexServerHandler bridge;

fwolter · 2023-03-28T09:48:43Z

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

+	</channel-type>
+	<channel-type id="player">
+		<item-type>Player</item-type>
+		<label>Player Control Play/Pause/Next/Previous</label>


Labels are expected to be as short as possible. Guideline is 2-3 words with max 20-25 chars. See https://www.openhab.org/docs/developer/bindings/thing-xml.html#formatting-labels-and-descriptions

Suggested change

<label>Player Control Play/Pause/Next/Previous</label>

<label>Player Control</label>

mlobstein · 2023-06-07T04:26:16Z

How long does this remain in awaiting feedback status before being closed? Although I don't use plex, I wouldn't mind seeing this make it into the official distribution. I would be willing to finish the changes needed to get this done.

jlaur · 2023-06-07T06:17:26Z

How long does this remain in awaiting feedback status before being closed? Although I don't use plex, I wouldn't mind seeing this make it into the official distribution. I would be willing to finish the changes needed to get this done.

@aronbeurskens - would that be okay with you? And @fwolter, do you think you would be able to finish the review if @mlobstein would help resolving the last comments?

fwolter · 2023-06-07T06:25:00Z

Yes!

aronbeurskens · 2023-06-07T09:29:19Z

Of course, no problem. When merged its also easier for me to maintain

mlobstein · 2023-06-10T12:05:00Z

replaced by #15057

aronbeurskens requested a review from a team as a code owner January 27, 2022 18:25

aronbeurskens force-pushed the main branch from bb36656 to 875c964 Compare January 27, 2022 18:27

fwolter added the new binding If someone has started to work on a binding. For a new binding PR. label Jan 27, 2022

fwolter changed the title ~~New binding - added plex binding for openhab 3~~ [plex] Initial Contribution Jan 27, 2022

Hilbrand mentioned this pull request Jan 27, 2022

openHAB 1 addon compatibility overview with openHAB 3 #6179

Closed

Hilbrand added the oh1 migration Relates to migrating an openHAB 1 addon to openHAB 2 label Jan 27, 2022

aronbeurskens force-pushed the main branch 2 times, most recently from 5052031 to 0f652ac Compare January 28, 2022 08:25

aronbeurskens force-pushed the main branch from 8963532 to 8d9a5e9 Compare January 28, 2022 13:00

aronbeurskens force-pushed the main branch 3 times, most recently from 3686846 to c4c2e4c Compare January 30, 2022 12:14

aronbeurskens force-pushed the main branch from 288c00c to 290a303 Compare February 6, 2022 15:33

aronbeurskens requested review from andrewfg, andylintner, caffineehacker, cweitkamp, davidgraeff, jlaur, JochenHiller, kgoderis, lolodomo and mhilbush as code owners February 6, 2022 15:33

aronbeurskens force-pushed the main branch 2 times, most recently from 6bc2d8b to 75b50eb Compare December 25, 2022 12:34

aronbeurskens force-pushed the main branch 2 times, most recently from 5ea9694 to edf9baa Compare January 1, 2023 13:41

aronbeurskens requested review from fwolter and removed request for jlaur January 3, 2023 15:18

lsiepel reviewed Jan 16, 2023

View reviewed changes

bundles/org.openhab.binding.plex/src/main/resources/OH-INF/binding/binding.xml Outdated Show resolved Hide resolved

lsiepel removed the awaiting feedback label Jan 24, 2023

morph166955 requested changes Feb 5, 2023

View reviewed changes

....binding.plex/src/main/java/org/openhab/binding/plex/internal/handler/PlexServerHandler.java Outdated Show resolved Hide resolved

aronbeurskens force-pushed the main branch 2 times, most recently from 1775f74 to 808a603 Compare February 6, 2023 11:54

New binding - rebased and added plex binding for openhab 3

671d65a

Signed-off-by: Aron Beurskens <[email protected]>

aronbeurskens force-pushed the main branch from 808a603 to 671d65a Compare February 6, 2023 12:02

aronbeurskens requested review from jlaur and fwolter and removed request for fwolter and jlaur February 6, 2023 13:28

jlaur added the awaiting feedback label Mar 21, 2023

fwolter requested changes Mar 28, 2023

View reviewed changes

mlobstein mentioned this pull request Jun 7, 2023

[plex] Initial contribution #15057

Merged

mlobstein closed this Jun 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[plex] Initial contribution #12135

[plex] Initial contribution #12135

aronbeurskens commented Jan 27, 2022 •

edited

Loading

openhab-bot commented Jan 28, 2022

aronbeurskens commented Jan 28, 2022

lolodomo commented Jan 28, 2022 •

edited

Loading

aronbeurskens commented Jan 28, 2022

lolodomo commented Jan 28, 2022 •

edited

Loading

aronbeurskens commented Jan 30, 2022

aronbeurskens commented Feb 5, 2022

aronbeurskens commented Dec 30, 2022

aronbeurskens commented Jan 1, 2023

openhab-bot commented Jan 3, 2023

jlaur commented Mar 21, 2023

fwolter left a comment

fwolter Mar 28, 2023

fwolter Mar 28, 2023

fwolter Mar 28, 2023

mlobstein commented Jun 7, 2023

jlaur commented Jun 7, 2023

fwolter commented Jun 7, 2023

aronbeurskens commented Jun 7, 2023

mlobstein commented Jun 10, 2023

	<label>Player Control Play/Pause/Next/Previous</label>
	<label>Player Control</label>

[plex] Initial contribution #12135

[plex] Initial contribution #12135

Conversation

aronbeurskens commented Jan 27, 2022 • edited Loading

New binding: Plex

Description

Related links

Testing

openhab-bot commented Jan 28, 2022

aronbeurskens commented Jan 28, 2022

lolodomo commented Jan 28, 2022 • edited Loading

aronbeurskens commented Jan 28, 2022

lolodomo commented Jan 28, 2022 • edited Loading

aronbeurskens commented Jan 30, 2022

aronbeurskens commented Feb 5, 2022

aronbeurskens commented Dec 30, 2022

aronbeurskens commented Jan 1, 2023

openhab-bot commented Jan 3, 2023

jlaur commented Mar 21, 2023

fwolter left a comment

Choose a reason for hiding this comment

fwolter Mar 28, 2023

Choose a reason for hiding this comment

fwolter Mar 28, 2023

Choose a reason for hiding this comment

fwolter Mar 28, 2023

Choose a reason for hiding this comment

mlobstein commented Jun 7, 2023

jlaur commented Jun 7, 2023

fwolter commented Jun 7, 2023

aronbeurskens commented Jun 7, 2023

mlobstein commented Jun 10, 2023

aronbeurskens commented Jan 27, 2022 •

edited

Loading

lolodomo commented Jan 28, 2022 •

edited

Loading

lolodomo commented Jan 28, 2022 •

edited

Loading