Epson projector support #14841

pszafer · 2018-06-06T12:48:40Z

Description:

I created epson projector support.
It is based on Android app (packet sniffing) from epson.
Tested with Epson EH-TW5350

Made new PR to get rid of mistakes I made trying to catch up with reality.
Old PR: #13416

Related issue (if applicable): fixes #

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

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

- platform: epson
  host: 192.168.1.2
  name: Epson Projector

Checklist:

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

Tests passed but needed to change test_feedreader.py date time from 5 to 6.
datetime(2018, 4, 30, 6, 10, 0)

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 or updated 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

LGTM. Please resolve the merge conflict!

pszafer · 2018-06-09T08:43:30Z

Merge conflict resolved.

MartinHjelmare · 2018-06-09T08:30:55Z

homeassistant/components/media_player/epson.py

+class EpsonProjector(MediaPlayerDevice):
+    """Representation of Epson Projector Device."""
+
+    def __init__(self, hass, name, host, port, encryption):


Don't pass in hass. It will be set on the entity when it has been added to home assistant.

MartinHjelmare · 2018-06-09T08:32:22Z

homeassistant/components/media_player/epson.py

+    except (aiohttp.client_exceptions.ClientConnectorError,
+            asyncio.TimeoutError):
+        raise PlatformNotReady
+    if epson:


Remove this check. It doesn't add anything.

MartinHjelmare · 2018-06-09T08:34:47Z

homeassistant/components/media_player/epson.py

+            devices = hass.data[DATA_EPSON]
+        for device in devices:
+            if service.service == ATTR_CMODE:
+                cmode = service.data.get(ATTR_CMODE).lower()


The string cast to lowercase should be moved to the service schema.

MartinHjelmare · 2018-06-09T08:37:19Z

homeassistant/components/media_player/epson.py

+                    await device.select_cmode(cmode)
+            await device.update()
+    hass.services.async_register(
+        DOMAIN, ATTR_CMODE, async_service_handler,


The service name should be prefixed with the platform name. The constant that holds the service name should start with SERVICE_.

MartinHjelmare · 2018-06-09T08:37:42Z

homeassistant/components/media_player/epson.py

+
+    def __init__(self, hass, name, host, port, encryption):
+        """Initialize entity to control Epson projector."""
+        self._hass = hass


Remove this.

MartinHjelmare · 2018-06-09T08:45:24Z

homeassistant/components/media_player/epson.py

+        return self._source
+
+    @property
+    def cmode(self):


This doesn't seem to be used and is not needed. The instance can access the attribute directly.

If I delete methods source_list and source, then select source option is not showing up in web ui.

Don't remove those. Comments in reviews are directed at the line at the end of the code box shown. In this case that's line 181. So I was only referring to the cmode property.

MartinHjelmare · 2018-06-09T08:47:40Z

homeassistant/components/media_player/epson.py

+        """Set color mode in Epson."""
+        from epson_projector.const import (CMODE_LIST_SET)
+        if cmode in CMODE_LIST_SET:
+            return await self._projector.send_command(CMODE_LIST_SET[cmode])


Nothing is checking this return value. It also makes the return value inconsistent since the call is done inside a check. Just remove the return.

MartinHjelmare · 2018-06-09T08:49:35Z

homeassistant/components/media_player/epson.py

+        for device in devices:
+            if service.service == ATTR_CMODE:
+                cmode = service.data.get(ATTR_CMODE).lower()
+                if cmode in CMODE_LIST_SET:


This should be made part of the service validation schema. Make a custom validator that checks that the passed cmode is in the cmode list set.

Caveat is that the service schema cannot be defined as a constant at the module level anymore but has to be moved inside the setup platform function to allow access to the imported CMODE_LIST_SET.

MartinHjelmare · 2018-06-09T08:50:04Z

homeassistant/components/media_player/epson.py

+    async def select_cmode(self, cmode):
+        """Set color mode in Epson."""
+        from epson_projector.const import (CMODE_LIST_SET)
+        if cmode in CMODE_LIST_SET:


This can be removed after updating the service schema.

MartinHjelmare · 2018-06-09T08:54:30Z

homeassistant/components/media_player/epson.py

+        _LOGGER.debug("select source")
+        from epson_projector.const import INV_SOURCES
+        selected_source = INV_SOURCES[source]
+        return await self._projector.send_command(selected_source)


Remove return here and from all the following methods.

Requested changes of Martin

pszafer · 2018-06-11T20:55:06Z

All requested changes are done.

MartinHjelmare · 2018-06-12T05:38:56Z

homeassistant/components/media_player/epson.py

+    vol.Optional(CONF_SSL, default=False): cv.boolean
+})
+
+SERVICE_ATTR_CMODE = 'epson_cmode'


I think we should name this epson_set_cmode or epson_select_cmode.

SERVICE_SELECT_CMODE = 'epson_select_cmode'

MartinHjelmare · 2018-06-12T05:40:39Z

homeassistant/components/media_player/epson.py

+        for device in devices:
+            if service.service == SERVICE_ATTR_CMODE:
+                cmode = service.data.get(SERVICE_ATTR_CMODE)
+                if cmode in CMODE_LIST_SET:


This check can now be removed since the service validation schema is checking this.

MartinHjelmare · 2018-06-12T05:41:13Z

homeassistant/components/media_player/epson.py

+
+
+async def async_setup_platform(
+        hass,


Please fill out the line as far as possible. That's more in line with home assistant style.

MartinHjelmare · 2018-06-12T05:41:37Z

homeassistant/components/media_player/epson.py

+    epson = EpsonProjector(
+        async_get_clientsession(hass, verify_ssl=False),
+        name, host,
+        config.get(CONF_PORT), config.get(CONF_SSL))


MartinHjelmare · 2018-06-12T05:41:54Z

homeassistant/components/media_player/epson.py

+        name, host,
+        config.get(CONF_PORT), config.get(CONF_SSL))
+    await epson.update()
+    if epson:


Remove this.

MartinHjelmare · 2018-06-12T05:46:47Z

homeassistant/components/media_player/epson.py

+            if cmode and cmode in CMODE_LIST:
+                self._cmode = CMODE_LIST.get(cmode, self._cmode)
+            source = await self._projector.get_property(SOURCE)
+            if source and source in SOURCE_LIST:


Same as above.

MartinHjelmare · 2018-06-12T05:48:14Z

homeassistant/components/media_player/epson.py

+
+    async def async_select_source(self, source):
+        """Select input source."""
+        _LOGGER.debug("select source")


Remove this. All service calls are already logged at info level by the core.

MartinHjelmare · 2018-06-12T05:48:47Z

homeassistant/components/media_player/epson.py

+
+    async def async_volume_up(self):
+        """Increase volume."""
+        _LOGGER.debug("volume up")


Remove this.

MartinHjelmare · 2018-06-12T05:49:45Z

homeassistant/components/media_player/epson.py

+        """Return device specific state attributes."""
+        attributes = {}
+        if self._cmode is not None:
+            attributes[SERVICE_ATTR_CMODE] = self._cmode


Use ATTR_CMODE as key.

MartinHjelmare · 2018-06-12T05:50:23Z

homeassistant/components/media_player/services.yaml

@@ -422,3 +422,13 @@ blackbird_set_all_zones:
    source:
      description: Name of source to switch to.
      example: 'Source 1'
+
+epson_cmode:


Update this after updating the service name.

MartinHjelmare · 2018-06-12T05:55:11Z

homeassistant/components/media_player/epson.py

+            devices = hass.data[DATA_EPSON]
+        for device in devices:
+            if service.service == SERVICE_ATTR_CMODE:
+                cmode = service.data.get(SERVICE_ATTR_CMODE)


Use ATTR_CMODE for the service data key.

pszafer · 2018-06-12T18:30:38Z

All reviewed changes done.

MartinHjelmare · 2018-06-12T18:55:52Z

homeassistant/components/media_player/epson.py

+    vol.Optional(CONF_SSL, default=False): cv.boolean
+})
+
+SERVICE_ATTR_CMODE = 'epson_select_cmode'


Please rename the constant to SERVICE_SELECT_CMODE.

pszafer · 2018-06-12T19:52:58Z

done

Added description of cmode to services.yaml

change name of cmode service

* Epson projector support. Version based on external library * Epson projector support. Version based on external library * modified epson according to MartinHjelmare review. Added description of cmode to services.yaml * renamed EPSON_SCHEMA to epson_schema * removed method of getting cmode property * removed unnecessary checks change name of cmode service * renamed SERVICE_ATTR_CMODE to SERVICE_SELECT_CMODE

homeassistant added new-platform platform: media_player.epson cla-signed labels Jun 6, 2018

pszafer mentioned this pull request Jun 6, 2018

Documentation for Epson projector support in HA home-assistant/home-assistant.io#5005

Merged

2 tasks

syssi previously approved these changes Jun 9, 2018

View reviewed changes

homeassistant added the cla-signed label Jun 9, 2018

ghost added the in progress label Jun 9, 2018

MartinHjelmare requested changes Jun 9, 2018

View reviewed changes

homeassistant added the cla-signed label Jun 11, 2018

MartinHjelmare reviewed Jun 12, 2018

View reviewed changes

homeassistant added the cla-signed label Jun 12, 2018

MartinHjelmare reviewed Jun 12, 2018

View reviewed changes

pszafer added 7 commits June 12, 2018 21:55

Epson projector support. Version based on external library

0bc187e

Epson projector support. Version based on external library

1a25bf0

modified epson according to MartinHjelmare review.

77f74a9

Added description of cmode to services.yaml

renamed EPSON_SCHEMA to epson_schema

3a057e6

removed method of getting cmode property

f0249e2

removed unnecessary checks

2556537

change name of cmode service

renamed SERVICE_ATTR_CMODE to SERVICE_SELECT_CMODE

84378f3

homeassistant added the cla-signed label Jun 12, 2018

MartinHjelmare approved these changes Jun 13, 2018

View reviewed changes

MartinHjelmare merged commit 2ac23c8 into home-assistant:dev Jun 13, 2018

ghost removed the in progress label Jun 13, 2018

balloob mentioned this pull request Jun 22, 2018

0.72 #15088

Merged

willzone1 mentioned this pull request Nov 7, 2018

Epson projector Error on device update! #18253

Closed

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

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

Uh oh!

Epson projector support #14841

Epson projector support #14841

Uh oh!

Conversation

pszafer commented Jun 6, 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!

syssi left a comment

Choose a reason for hiding this comment

Uh oh!

pszafer 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!

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!

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

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!

pszafer commented Jun 11, 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!

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!

pszafer commented Jun 12, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pszafer commented Jun 12, 2018

Uh oh!

Uh oh!

pszafer commented Jun 6, 2018 •

edited

Loading

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

MartinHjelmare Jun 9, 2018 •

edited

Loading