Add support for the Unitymedia Horizon HD Recorder #14275

benleb · 2018-05-03T19:51:59Z

Description:

A new platform for the Unitymedia Horizon HD Recorder sold by Unitymedia in Germany. The channel list is hardcoded currently but I already reached out to Unitymedia to get a parseable list. As this list doesn't change often, I think that's not a problem. Also working on an async version of this but as this involves the underlying library (einder), this takes some time.

Related issue (if applicable): -

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#5303

Example entry for `configuration.yaml` (if applicable):

media_player:
  - platform: horizon
    host: 192.168.0.127

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

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

Documentation added/updated in home-assistant.github.io

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

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

syssi · 2018-05-22T11:48:16Z

homeassistant/components/media_player/horizon.py

+    from einder import Client, keys
+    from einder.exceptions import AuthenticationError
+
+    host = config.get(CONF_HOST)


Please access the config (host, name, port) directly (config[CONF_HOST]) if it's safe.

syssi · 2018-05-22T11:49:55Z

homeassistant/components/media_player/horizon.py

+        client = Client(host, port=port)
+    except (AuthenticationError, OSError) as msg:
+        _LOGGER.error("Connection to %s at %s failed: %s", name, host, msg)
+        return False


You could raise a PlatformNotReady exception if there is a chance (OSError?) for recovery. The AuthenticationError should return False.

Nothing is checking this return value. Either just return or raise PlatformNotReady as recommended above.

syssi · 2018-05-22T11:53:06Z

homeassistant/components/media_player/horizon.py

+        self._name = name
+        self._state = False
+        self._keys = keys
+        self._source_list = {1: 'Das Erste HD', 2: 'ZDF HD', 3: 'RTL HD',


I'm not happy about using the source_list as channel list. I've seen this multiple times now. This is just my personal feeling.

I don't think this dictionary of channels belongs in home assistant code. Why do we need it? Looks like we send the channel ID and not the channel name anyway. This could be moved to the documentation, and instead of using source select to select channel, just use play media service.

MartinHjelmare · 2018-05-25T07:38:31Z

homeassistant/components/media_player/horizon.py

+        self._name = name
+        self._state = False
+        self._keys = keys
+        self._source_list = {1: 'Das Erste HD', 2: 'ZDF HD', 3: 'RTL HD',


I don't think this dictionary of channels belongs in home assistant code. Why do we need it? Looks like we send the channel ID and not the channel name anyway. This could be moved to the documentation, and instead of using source select to select channel, just use play media service.

MartinHjelmare · 2018-05-25T07:41:45Z

homeassistant/components/media_player/horizon.py

+
+    def play_media(self, media_type, media_id, **kwargs):
+        """Play media / switch to channel."""
+        if MEDIA_TYPE_CHANNEL == media_type and isinstance(int(media_id), int):


Why do we need the type check after the copy to integer?

MartinHjelmare · 2018-05-25T07:44:05Z

homeassistant/components/media_player/horizon.py

+                      in self._source_list.items()
+                      if v == source]
+
+        if digits is not None:


When can this happen?

MartinHjelmare · 2018-05-25T07:45:56Z

homeassistant/components/media_player/horizon.py

+    def _select_channel(self, channel):
+        """Select a channel (taken from einder library, thx)."""
+        for i in str(channel):
+            key = int(i) + 0xe300


This looks like too much protocol specific code. It should probably be part of the interface library.

MartinHjelmare · 2018-05-25T07:48:33Z

homeassistant/components/media_player/horizon.py

+            self._client.authorize()
+        except (AuthenticationError, OSError) as msg:
+            _LOGGER.error("Connection to %s failed: %s", self._name, msg)
+            return False


Nothing is checking this return value.

MartinHjelmare · 2018-05-25T07:49:37Z

homeassistant/components/media_player/horizon.py

+        client = Client(host, port=port)
+    except (AuthenticationError, OSError) as msg:
+        _LOGGER.error("Connection to %s at %s failed: %s", name, host, msg)
+        return False


Nothing is checking this return value. Either just return or raise PlatformNotReady as recommended above.

MartinHjelmare · 2018-05-25T07:51:29Z

homeassistant/components/media_player/horizon.py

+        return self._name
+
+    @property
+    def client(self):


Remove this. It's not needed and not used.

MartinHjelmare · 2018-05-25T07:52:52Z

homeassistant/components/media_player/horizon.py

+        return self._state
+
+    @property
+    def keys(self):


Same as above.

Requested changes by Martin

benleb · 2018-06-02T13:29:24Z

I will look at this in the next 1-2 weekends :) Thanks for the comments/tips!

benleb · 2018-06-09T14:48:34Z

@syssi & @MartinHjelmare thanks for your reviews, all mentioned things should be fixed now.

MartinHjelmare · 2018-06-10T10:14:31Z

homeassistant/components/media_player/horizon.py

+})
+
+
+# pylint: disable=unused-argument


This is already globally disabled.

MartinHjelmare · 2018-06-10T10:16:02Z

homeassistant/components/media_player/horizon.py

+        """Initialize the remote."""
+        self._client = client
+        self._name = name
+        self._state = False


Initialize unknown state as None.

MartinHjelmare · 2018-06-10T10:19:48Z

homeassistant/components/media_player/horizon.py

+            except OSError as msg:
+                # occurs if horizon box is offline
+                _LOGGER.error("Reconnect to %s failed: %s", self._name, msg)
+                raise PlatformNotReady


We're not inside setup_platform anymore here, so raising PlatformNotReady doesn't work. Probably just return.

…ablished

…setup_platform

benleb · 2018-06-10T13:04:44Z

thanks for your reviews and your help @MartinHjelmare!! Wont make these mistakes again in my next PR ;)

MartinHjelmare

Nice!

MartinHjelmare · 2018-06-10T13:13:49Z

Can be merged when build passes.

) * added new platform for the Unitymedia Horizon HD Recorder * improve connection handling of the horizon platform * remove unneeded parameters and fix spelling in the horizon platform * abort or raise exception if connection to the device could not be established * remove channel/source list and SELECT_SOURCE feature * remove useless type check after cast and use a try block instead * abort or raise exception if reconnect to device fails * remove protocol specific code and restructure sending logic accordingly * fix indentation to be pep8 complaint * remove unused methods/properties * fix unnecessary pylint commands and use a return to abert outside of setup_platform * directly access config values

homeassistant added cla-signed new-platform platform: media_player.horizon labels May 3, 2018

benleb mentioned this pull request May 3, 2018

added new platform for the Unitymedia Horizon HD Recorder home-assistant/home-assistant.io#5303

Merged

2 tasks

homeassistant added the cla-signed label May 4, 2018

fabaff changed the title ~~added new platform for the Unitymedia Horizon HD Recorder~~ Add support for the Unitymedia Horizon HD Recorder May 10, 2018

syssi reviewed May 22, 2018

View reviewed changes

syssi previously approved these changes May 22, 2018

View reviewed changes

MartinHjelmare reviewed May 25, 2018

View reviewed changes

homeassistant added the cla-signed label Jun 9, 2018

ghost added the in progress label Jun 9, 2018

homeassistant added the cla-signed label Jun 9, 2018

MartinHjelmare reviewed Jun 10, 2018

View reviewed changes

homeassistant added cla-signed labels Jun 10, 2018

benleb added 10 commits June 10, 2018 14:56

added new platform for the Unitymedia Horizon HD Recorder

1664dca

improve connection handling of the horizon platform

8439be2

remove unneeded parameters and fix spelling in the horizon platform

249a394

abort or raise exception if connection to the device could not be est…

9b8796f

…ablished

remove channel/source list and SELECT_SOURCE feature

dd1d0ec

remove useless type check after cast and use a try block instead

2a5de29

abort or raise exception if reconnect to device fails

f1065f0

remove protocol specific code and restructure sending logic accordingly

5bbbbd7

fix indentation to be pep8 complaint

26caf92

remove unused methods/properties

0b8f041

fix unnecessary pylint commands and use a return to abert outside of …

4c0a81d

…setup_platform

homeassistant added the cla-signed label Jun 10, 2018

directly access config values

09477e1

homeassistant added the cla-signed label Jun 10, 2018

MartinHjelmare approved these changes Jun 10, 2018

View reviewed changes

MartinHjelmare added the almost-done label Jun 10, 2018

syssi approved these changes Jun 10, 2018

View reviewed changes

syssi merged commit 1da3003 into home-assistant:dev Jun 10, 2018

ghost removed the in progress label Jun 10, 2018

benleb deleted the add-horizon-platform branch June 10, 2018 13:45

balloob mentioned this pull request Jun 22, 2018

0.72 #15088

Merged

home-assistant locked and limited conversation to collaborators Dec 10, 2018

ghost added integration: horizon and removed platform: media_player.horizon labels Mar 21, 2019

Uh oh!

Add support for the Unitymedia Horizon HD Recorder #14275

Add support for the Unitymedia Horizon HD Recorder #14275

Uh oh!

Conversation

benleb commented May 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

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!

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!

benleb commented Jun 2, 2018

Uh oh!

benleb commented Jun 9, 2018

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!

benleb commented Jun 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare commented Jun 10, 2018

Uh oh!

Uh oh!

benleb commented May 3, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

benleb commented Jun 10, 2018 •

edited

Loading