[emby] Initial contribution #13340

volfan6415 · 2022-08-31T19:44:13Z

This request picks up on the initial contribution from [WIP][emby] Initial Contribution by volfan6415 · Pull Request #7575 · openhab/openhab-addons (github.com) but updates the binding for support in openhab3 as well as other code clean up and improvements.

This binding interfaces openHAB with a running instance of EMBY Media Server (https://emby.media/). EMBY is a PLEX alternative and the binding provides many of the same features for users of EMBY as the PLEX binding does for uses of PLEX.
I have used the version of the binding which was previously submitted for over two years now (albeit in openHAB 2.X as the binding was not compatible until now with openHAB 3)(and as referenced in this thread [New Binding] EMBY Server Binding - Alpha - Add-ons / Bindings - openHAB Community I believe others in the community have been using it for awhile now as well. It has worked well for the users that have tested it for me.

I have made the necessary updates to make the binding operate in openHAB 3 and now feel that this binding is ready to be incorporated. The core works well. While there are certainly features that can be added over time the binding in its current state more than covers the basics of what someone using openHAB would want to get from EMBY. It allows for interaction with the EMBY server to get currently playing devices/media which can then be used inside of openHAB as triggers for automations and the like.
I would like to flag that there will need to be clarification on is the author signing. In developing this binding I started with the KODI binding code, as EMBY provides a similar websocket api. While I did make extensive changes to work with the API provided by EMBY, there is definitively a structure left from the KODI binding and there are some methods and classes where the only real change was method/class names. Unfortunately in making these changes did not keep the author tags on the classes and now have all of the classes showing me as the original contribution. It is not my intention to not give credit where credit is due, and so will need some guidance on what edits need to be made to the author tags in the file to rectify this situation.

I know there are significant updates which need to be made to the readme and I will be working on those put wanted to start this pull request so i could get some comments and suggestions on the underlying code before i spend too much time on the readme as that may very well change.

Signed-off-by: Zachary Christiansen <[email protected]>

openhab-bot · 2022-08-31T19:45:05Z

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

https://community.openhab.org/t/new-binding-emby-server-binding-alpha/54010/117

Signed-off-by: Zachary Christiansen <[email protected]>

lsiepel · 2022-12-20T21:08:34Z

If you can fix the merge conflict, i can do a first review.

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

Signed-off-by: Zachary Christiansen <[email protected]>

volfan6415 · 2023-01-06T03:41:21Z

@lsiepel ok so i think i have fixed the merge conflict

Co-authored-by: Wouter Born <[email protected]>

lsiepel · 2023-01-16T14:58:32Z

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

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>


This needs to be adapted to the new addon.xml, the PR to adapt the developer docs is not merged yet, so if you need more details, the corresponding 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.

lsiepel

Partial review.
There are some SAT errors and i think the log levels need to be adjusted. See: https://www.openhab.org/docs/developer/guidelines.html#f-logging

lsiepel · 2023-01-27T17:27:10Z

...by/src/main/java/org/openhab/binding/emby/internal/discovery/EmbyBridgeDiscoveryService.java

+                c.send(sendPacket);
+                logger.trace(">>> Request packet sent to: {} ({})", REQUEST_MSG, REQUEST_PORT);
+            } catch (Exception e) {
+            }


Intentionally not logging anything?

lsiepel · 2023-01-27T17:27:47Z

...by/src/main/java/org/openhab/binding/emby/internal/discovery/EmbyBridgeDiscoveryService.java

+                                REQUEST_PORT);
+                        c.send(sendPacket);
+                    } catch (Exception e) {
+                    }


Intentionally not logging anything?

lsiepel · 2023-01-27T17:29:59Z

...by/src/main/java/org/openhab/binding/emby/internal/discovery/EmbyBridgeDiscoveryService.java

+        } catch (IOException ex) {
+            logger.debug("The exception was: {}", ex.getMessage());
+        } finally {
+        }


Don't you want to close the port / clear resource in this finally block?

lsiepel · 2023-01-27T17:35:55Z

....binding.emby/src/main/java/org/openhab/binding/emby/internal/handler/EmbyBridgeHandler.java

+        if (obj instanceof Number) {
+            return ((Number) obj).intValue();
+        } else if (obj instanceof String) {
+            return Integer.parseInt(obj.toString());


As the key is not checked, don't you want to catch the NumberFormatException?

lsiepel · 2023-01-27T17:37:13Z

....binding.emby/src/main/java/org/openhab/binding/emby/internal/handler/EmbyBridgeHandler.java

+                        updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
+                                "Connection could not be established");
+                    }
+                }, 360000, 360000, TimeUnit.MILLISECONDS);


Very minor codestyle, make it a binding constant

lsiepel · 2023-01-27T17:52:24Z

....binding.emby/src/main/java/org/openhab/binding/emby/internal/protocol/EmbyClientSocket.java

+            ScheduledExecutorService setScheduler, int setBufferSize, WebSocketClient sharedWebSocketClient) {
+        eventHandler = setEventHandler;
+        uri = setUri;
+        // client = new WebSocketClient();


remove comment

lsiepel · 2023-01-27T17:52:38Z

....binding.emby/src/main/java/org/openhab/binding/emby/internal/protocol/EmbyClientSocket.java

+     */
+    public synchronized void open() throws Exception {
+        if (isConnected()) {
+            logger.warn("connect: connection is already open");


reduce to debug

lsiepel · 2023-01-27T17:55:38Z

....binding.emby/src/main/java/org/openhab/binding/emby/internal/protocol/EmbyClientSocket.java

+    public class EmbyWebSocketListener {
+        @OnWebSocketConnect
+        public void onConnect(Session wssession) {
+            logger.info("EMBY client socket is Connected to emby server");


As the thing would go online, it allready signals the correct connection. So please reduce to debug

lsiepel · 2023-01-27T17:57:08Z

....binding.emby/src/main/java/org/openhab/binding/emby/internal/protocol/EmbyClientSocket.java

+                    try {
+                        eventHandler.onConnectionOpened();
+                    } catch (Exception e) {
+                        logger.error("Error handling onConnectionOpened(): {}", e.getMessage(), e);


reduce to debug. if the binding cannot recover the thing should be set to offline and provided with errordetails.

lsiepel · 2023-01-27T17:58:48Z

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

@@ -0,0 +1,21 @@
+# FIXME: please substitute the xx with a proper locale, ie. de


Please run mvn i18n:generate-default-translations

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

bundles/org.openhab.binding.emby/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 · 2023-07-24T12:05:24Z

@volfan6415 last commit is 6 months old. Are you able to finish the binding?

lsiepel · 2024-04-29T11:19:58Z

ping @volfan6415 do you plan to finish this PR?

lsiepel · 2024-09-06T22:15:16Z

Does not look like this PR will get to the finish line. @volfan6415 please re-open (or comment) on this PR if you want to continue. Due to no responses i close this PR for now.

initial commit after setup of dev envirmonent and binding shell

87efc89

Signed-off-by: Zachary Christiansen <[email protected]>

volfan6415 requested a review from a team as a code owner August 31, 2022 19:44

volfan6415 force-pushed the embydev branch from 1506e96 to 78f9ade Compare August 31, 2022 19:55

wborn added the new binding If someone has started to work on a binding. For a new binding PR. label Aug 31, 2022

volfan6415 added 13 commits August 31, 2022 21:56

initial commit after adding binding shell to dev environment

c539d5b

Signed-off-by: Zachary Christiansen <[email protected]>

ported over original code from 3.0 verision of binding

bf0cc9a

Signed-off-by: Zachary Christiansen <[email protected]>

inital working binding for openhab 3.0

6f90f7d

Signed-off-by: Zachary Christiansen <[email protected]>

add change to emby handler to reestablish connection on socket close

302dac0

Signed-off-by: Zachary Christiansen <[email protected]>

changes to cleanup code in prep. for pull request

ddd99ef

Signed-off-by: Zachary Christiansen <[email protected]>

changes/updates to logging levels

b1db922

Signed-off-by: Zachary Christiansen <[email protected]>

updates to logging levels

43f79a2

Signed-off-by: Zachary Christiansen <[email protected]>

mvn spotless changes

c882b87

Signed-off-by: Zachary Christiansen <[email protected]>

change binding to use shared websocket client

a0e8bf4

Signed-off-by: Zachary Christiansen <[email protected]>

changes to pom.xml to apply formatting

b1a1ecb

Signed-off-by: Zachary Christiansen <[email protected]>

Formatting updates

a46bfc5

Signed-off-by: Zachary Christiansen <[email protected]>

updates to logging

46dc760

Signed-off-by: Zachary Christiansen <[email protected]>

fixed mvn issues

30aa049

Signed-off-by: Zachary Christiansen <[email protected]>

volfan6415 force-pushed the embydev branch from d1c5daa to 30aa049 Compare August 31, 2022 21:57

volfan6415 added 6 commits August 31, 2022 22:37

corrections to header text

9cf681c

Signed-off-by: Zachary Christiansen <[email protected]>

fix code style errors

06d6d09

Signed-off-by: Zachary Christiansen <[email protected]>

updates to fix binding re-establishing connection on connection close

5a86e2d

Signed-off-by: Zachary Christiansen <[email protected]>

updates to fix configuration checking on EmbyBridgeConfiguration

3b6e7e3

Signed-off-by: Zachary Christiansen <[email protected]>

changes to make the binding more stable on websocket close

8d9bf7b

Signed-off-by: Zachary Christiansen <[email protected]>

changes to make the binding more stable on websocket close

894ba04

Signed-off-by: Zachary Christiansen <[email protected]>

wborn reviewed Dec 29, 2022

View reviewed changes

bundles/org.openhab.binding.emby/pom.xml Outdated Show resolved Hide resolved

cleanup of comments

2cd71a1

Signed-off-by: Zachary Christiansen <[email protected]>

Merge branch 'main' into embydev

23397a4

Update bundles/org.openhab.binding.emby/pom.xml

4425603

Co-authored-by: Wouter Born <[email protected]>

lsiepel reviewed Jan 16, 2023

View reviewed changes

lsiepel requested changes Jan 27, 2023

View reviewed changes

lsiepel added the awaiting feedback Awaiting feedback from the pull request author label Mar 11, 2023

wborn reviewed Jul 24, 2023

View reviewed changes

lsiepel added the stale As soon as a PR is marked stale, it can be removed 6 months later. label Jul 9, 2024

lsiepel closed this Sep 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[emby] Initial contribution #13340

[emby] Initial contribution #13340

volfan6415 commented Aug 31, 2022

openhab-bot commented Aug 31, 2022

lsiepel commented Dec 20, 2022

volfan6415 commented Jan 6, 2023 •

edited

Loading

lsiepel Jan 16, 2023

lsiepel left a comment

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

lsiepel Jan 27, 2023

wborn Jul 24, 2023 •

edited

Loading

lsiepel commented Jul 24, 2023

lsiepel commented Apr 29, 2024

lsiepel commented Sep 6, 2024

		@@ -0,0 +1,21 @@
		# FIXME: please substitute the xx with a proper locale, ie. de

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

[emby] Initial contribution #13340

[emby] Initial contribution #13340

Conversation

volfan6415 commented Aug 31, 2022

openhab-bot commented Aug 31, 2022

lsiepel commented Dec 20, 2022

volfan6415 commented Jan 6, 2023 • edited Loading

Choose a reason for hiding this comment

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

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

wborn Jul 24, 2023 • edited Loading

Choose a reason for hiding this comment

lsiepel commented Jul 24, 2023

lsiepel commented Apr 29, 2024

lsiepel commented Sep 6, 2024

volfan6415 commented Jan 6, 2023 •

edited

Loading

wborn Jul 24, 2023 •

edited

Loading