Add initial support fo HomematicIP components #12761

worm-ee · 2018-02-27T21:45:23Z

Description:

Initial support fo HomematicIP components

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

homematicip:
  - name: 'Somewhere'
    accesspoint: !secret homematicip_accesspoint
    authtoken: !secret homematicip_authtoken

Checklist:

The code change is tested and works locally.

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:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
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.

homeassistant · 2018-02-27T21:45:23Z

Hello @mxworm,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

c88280245b5e61cef2d4639d65792b82485cfd73 - This commit has something that looks like an email address (mattias@welponer.net). Maybe try linking that to GitHub?.

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
```
git commit --amend --author="Author Name <email@address.com>"
```
  (substituting Author Name and email@address.com for your actual information) to set the authorship information.
- If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
  1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
  2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

pvizeli · 2018-02-28T07:02:24Z

cc @danielperna84, maybe @balloob

I think the name suggestion is wrong. Maybe homematicip_rest or homematicip_accesspoint. The homematic component access directly to driver they use xmlrpc. The AccessPoint use the same driver but don't allow to access directly to his driver. Maybe iq3 allow in future to access directly to his internal xmlrpc like (o)ccu2 and you can also use homematic component and user they use (O)CCU2 have also access to homematicip device and don't can use this for access. Anyway, mabye we need rename homematic to homematic_xmlrpc?

My personal: this interface is not public from EQ3. Buy a raspberrypi3 and HomeMaticIP USB stick from ELV and use the hass.io add-on or other implementation for this and you need never care about any firmware updates they change things on interface. CCU2 from EQ3 work also.

worm-ee · 2018-02-28T07:11:55Z

Hi, I have added my email address to GitHub.

Ciao Mattias

danielperna84 · 2018-02-28T16:18:53Z

Anyway, mabye we need rename homematic to homematic_xmlrpc?

I would vote against that. homematic is intuitive and will be what most people will use anyways. To me it seems ok to call this new component homematicip.

Also I do see a value in this component. People who once started out with the IP access point and now want to have a look how it works with HA should be able to do that. A reverse engineered approach though may break as soon as eq3 breaks it with some firmware update.
So as long as eq3 doesn't open up the API I see this as an experimental custom component. We could link to that from the Homematic documentation for people who are in search for a solution if the just have the IP access point.

balloob · 2018-02-28T19:10:11Z

homeassistant/components/sensor/homematicip.py

+            last = self._device.lastStatusUpdate
+            if last is not None:
+                attr.update({ATTR_LASTSTATUS_UPDATE:
+                             last.strftime('%d-%m-%Y %H:%M:%S')})


last.isoformat()

balloob · 2018-02-28T19:18:10Z

Shouldn't this be integrated into pyhomematic? It's just another channel that gives the same information right?

danielperna84 · 2018-02-28T20:18:14Z

Shouldn't this be integrated into pyhomematic? It's just another channel that gives the same information right?

No, this targets a different hub-device that's not accessable via the same API. pyhomematic (for usage with the classic Homematic hub) uses XML-RPC to set states and has a XML-RPC server thread to receive the state changes (local push in HA-terms).
The IP access point (the new hub with cloud integration, but without official local API) this component is about uses (as far as I know) REST to set states and allows to receive state changes via a websocket connection. So the relation between these two would be more comparable to the Hue bridge and the Tradfri bridge. Doing similar stuff, but the implementation is rather different.

worm-ee · 2018-02-28T20:34:20Z

Hi, yes I agree... all data is going to the HMIP cloud servers and then back to the access point. But a least there is a bit of direct communication between the different devices.
But "homematicip_rest" might be the proper name.

By the way: how do I have to import the homematicip module?

implemented at the moment but not passing tox
-- snip --
from homeassistant.helpers.discovery import load_platform
from homematicip.home import Home
REQUIREMENTS = ['homematicip==0.8']
_LOGGER = logging.getLogger(name)
-- snap --
passing tox but not pylint
-- snip --
def setup(hass, config):
"""Set up the HomematicIP component."""
from homematicip.home import Home
hass.data.setdefault(DOMAIN, {})
-- snap --

Thanks Mattias

balloob · 2018-02-28T20:55:44Z

@danielperna84 thanks for the explanation.

2 is the correct one. You just didn't run script/gen_requirements_all.py (see PR description)

I don't think that we should name the component after the interface that is being used to communicate. It should be named after the API name. One should be able to speak this API over the cloud or locally, it shouldn't matter what the name is. Even REST is an implementation detail (and a bad name as it uses websockets too?)

Do the new generation of homematic hubs have a name? or maybe the API?

worm-ee · 2018-03-01T20:28:25Z

Hi,

Can someone help me to understand what went wrong in the travis build?

Thanks Mattias

balloob · 2018-03-01T22:20:57Z

@mxworm just a flaky test, I restarted your build.

pvizeli · 2018-03-01T22:26:19Z

What is with homematic_cloud? So homematic call the local driver with xmlrpc and the homematic_cloud use the EQ3 cloud service. Maybe with more device as hmIP in future. homematic support also wired, rf and ip devices.

worm-ee · 2018-03-01T22:33:38Z

@pvizeli I would like to keep complexity low - there are already a lot of HMIP components :-)
If you want to rename the component I would go for homematicip_cloud.

balloob · 2018-03-01T23:10:33Z

Oh, heh. My bad, I didn't realize that Homematic IP is the product name. I'm fine with naming it just homematic_ip.py then. Sorry for the confusion. I thought you added IP because it communicated over IP.

worm-ee · 2018-03-02T17:05:41Z

@balloob I would keep the naming for the moment, whats next?

balloob · 2018-03-15T05:20:41Z

homeassistant/components/homematicip.py

+        async_dispatcher_connect(
+            self.hass, EVENT_DEVICE_CHANGED, self._device_changed)
+
+    @callback


FYI, this one is correctly async. The dispatcher will execute this method in an async context because of this decorator.

balloob · 2018-03-15T05:21:28Z

homeassistant/components/sensor/homematicip.py

+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up the HomematicIP sensors devices."""
+    # pylint: disable=import-error, no-name-in-module


These shouldn't have to be disabled since you updated requirements_all.txt

balloob · 2018-03-15T05:22:17Z

homeassistant/components/sensor/homematicip.py

+        """Initialize the access point sensor."""
+        self.hass = hass
+        self._home = home
+        async_dispatcher_connect(


Use sync version

pvizeli · 2018-03-15T15:47:11Z

I like homematicip_cloud. It represent what it is 👍

worm-ee · 2018-03-15T21:38:11Z

Hi folks, I would love to add some more components e.g binary_switches, climate and security for HomematicIP. But first I would like to clarify the name of the platform. homematicip_cloud is fine for me, if everyone involved agrees I will change the name.

balloob · 2018-03-16T02:19:27Z

Please do not add more types in this PR. Let's get this PR merged and then add more types in a follow up PR.

I am fine with homematicip_cloud 👍

worm-ee · 2018-03-16T06:18:31Z

Yes, I agree this PR is already a bit of a mess... sorry for that. Its my first PR on such a big project and my python is quite limited. Thanks for the support. I will rename as a last thing in this PR, next devices will be provided as separate PRs.

balloob · 2018-03-18T15:57:49Z

Awesome work! 🎉 Good to go!

When adding platforms to this component, please stick to 1 platform / PR. That will make reviewing and merging a lot faster.

MartinHjelmare

Left comments for a future PR.

MartinHjelmare · 2018-03-18T22:53:59Z

homeassistant/components/homematicip_cloud.py

+Support for HomematicIP components.
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/homematicip/


Please update the url to point at the new component name.

MartinHjelmare · 2018-03-18T22:54:43Z

homeassistant/components/homematicip_cloud.py

+from socket import timeout
+
+import voluptuous as vol
+from homeassistant.core import callback


Please add a blank line between 3rd party and homeassistant imports.

MartinHjelmare · 2018-03-18T22:55:24Z

homeassistant/components/homematicip_cloud.py

+
+DOMAIN = 'homematicip_cloud'
+
+CONF_NAME = 'name'


Import this from const.py.

MartinHjelmare · 2018-03-18T22:58:31Z

homeassistant/components/homematicip_cloud.py

+        authtoken = device.get(CONF_AUTHTOKEN)
+
+        home = Home()
+        if name.lower() == 'none':


When will this happen? Default name is an empty string in the config schema.

MartinHjelmare · 2018-03-18T23:06:08Z

homeassistant/components/sensor/homematicip_cloud.py

+Support for HomematicIP sensors.
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/homematicip/


Look at other platforms for the format of the url.

MartinHjelmare · 2018-03-18T23:10:42Z

homeassistant/components/sensor/homematicip_cloud.py

+        """Initialize the access point sensor."""
+        self.hass = hass
+        self._home = home
+        dispatcher_connect(


Move this to the coroutine method async_added_to_hass, to avoid a race where the callback is called before the entity has been added to home assistant.

MartinHjelmare · 2018-03-18T23:11:23Z

homeassistant/components/sensor/homematicip_cloud.py

+class HomematicipAccesspoint(Entity):
+    """Representation of an HomeMaticIP access point."""
+
+    def __init__(self, hass, home):


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

MartinHjelmare · 2018-03-18T23:12:42Z

homeassistant/components/homematicip_cloud.py

+class HomematicipGenericDevice(Entity):
+    """Representation of an HomematicIP generic device."""
+
+    def __init__(self, hass, home, device, signal=None):


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

signal parameter doesn't seem to be used.

MartinHjelmare · 2018-03-18T23:13:09Z

homeassistant/components/homematicip_cloud.py

+        self.hass = hass
+        self._home = home
+        self._device = device
+        async_dispatcher_connect(


Move this to the coroutine method async_added_to_hass.

sander76 · 2018-03-21T21:30:14Z

@mxworm @balloob @MartinHjelmare The homematic-rest-api also has a asyncio component. I created a custom hmip component using the asyncio capabilities with the intention of later creating a component out of it.

I paid a lot of attention making the websocket implementation robust as I experienced frequent connection drops making hass losing track of state changes rendering the component useless. This involved changing the websocket code on the library as well as on my custom component side. This has all been done on the asyncio part of the homematic-rest-api library.

Do you have any experience with the code which is just merged and the robustness of the websocket connection ?

I really think this needs some more attention...

For reference: Here is my custom component:
https://github.com/sander76/custom_components

balloob · 2018-03-21T22:25:49Z

FYI if you want a (in my opinion) good example of an asyncio aiohttp websocket connection with retry logic, check the Home Assistant Cloud code: https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/cloud/iot.py

sander76 · 2018-03-22T06:30:30Z

@ballob Thanks.
My retry logic was inspired by https://github.com/armills/aioautomatic

I faced issues with the heartbeat parameter in aiohttp. Hopefully with the new release that has changed.

My custom component is now running without any issues for 2 months now. It took a while to get there as the homematic webserver is/used to be notoriously unstable. (They are making great progress and as a whole the platform absolutely rocks).

Question remains what to do with this pull request?

Obviously I highly appreciate the effort made by @mxworm, but I am also sure this component will stop working after a while. That is bad for hass.

I am also reluctant to improve on this PR as I have my own implementation. Which is really different from this one.

worm-ee · 2018-03-22T09:45:35Z

@sander76
I have also a reconnect code, but not yet committed, but anyhow you implementation is async which might be better for home assistent.
I can also understand that you don't want to modify the PR. What about to team-up an I merge your code to this initial support? There is not much difference between you and my component code - you are also using a sort of general sensor class(Entity). I would keep you naming of the classes and proprieties.

Would this be way to go for?

@balloob
If Sander agrees I would start to merge after the merge of my cleanup PR.

Ciao

sander76 · 2018-03-22T12:07:10Z

@mxworm
You're more than welcome !
I am going to have a look balloob's suggestion on his websocket reconnection code...

sander76 · 2018-03-22T12:35:51Z

@mxworm Please let me know which repo you'll be using for making the changes. I will try to help where possible. Looking at the code from balloob my code can use a bit of improving too...

worm-ee · 2018-03-22T13:15:46Z

@sander76 OK, then I will use for the moment your last code from https://github.com/sander76/custom_components
I will be on vacation next week, lets see how far I get in the next days. Small updates on your web socket code we can do later as well.

I would like to implement climatic devices and groups as well. But first I would like to have a solid base for further development.

@balloob Would this be OK for you as well? I know its annoying to have a complete rewrite of the code after the first PR.

sander76 · 2018-03-22T13:22:33Z

@mxworm @balloob Would it be possible to reject this merge and start over ?

worm-ee · 2018-03-22T13:44:19Z

@balloob @sander76 I think its not necessary, there is only the platform and the sensor component so far. I will move my code to async to have a proper baseline and file the PR in the next days.

sander76 · 2018-03-22T15:07:27Z

@mxworm
Check out here:
https://github.com/sander76/custom_components/tree/changing_reconnect

First shot at balloobs suggestion. Much cleaner.
Thanks @balloob !

balloob · 2018-03-22T17:59:08Z

Let's not pull out this PR. It's fine for the PR to be released and the guts changed out in the next PR. Would be a non breaking change for users since the config options should not change.

sander76 · 2018-04-14T14:04:49Z

@mxworm Did you already make a start with moving to async ? Please let me know, I can help. If not, is it ok if I give it a go ?

worm-ee · 2018-04-14T16:56:38Z

@sander76 So far there is a PR pending with a async version, but just with sensors.
#13468

All components I have implemented you can find under:
https://github.com/mxworm/home-assistant/tree/add-homematicip_cloud-alarm_panel-component
I just waiting for the merge then I will add features splitter over several PR as requested from the team.

Add initial support fo HomematicIP components

c882802

homeassistant added cla-error integration: homematicip new-platform platform: sensor.homematicip labels Feb 27, 2018

balloob added the cla-recheck label Feb 28, 2018

homeassistant added cla-signed and removed cla-recheck labels Feb 28, 2018

balloob reviewed Feb 28, 2018

View reviewed changes

balloob removed the cla-error label Feb 28, 2018

Fix module import

6f97bd3

homeassistant added the cla-signed label Feb 28, 2018

Update reqirments file as well

ecc5e93

worm-ee requested a review from andrey-git as a code owner February 28, 2018 22:18

homeassistant added the cla-signed label Feb 28, 2018

Added HomematicIP files

545b679

balloob reviewed Mar 15, 2018

View reviewed changes

Fix dispatcher usage

a22aef0

Rename homematicip to homematicip_cloud

00b2a4c

balloob approved these changes Mar 18, 2018

View reviewed changes

balloob merged commit b45dad5 into home-assistant:dev Mar 18, 2018

MartinHjelmare reviewed Mar 18, 2018

View reviewed changes

worm-ee mentioned this pull request Mar 21, 2018

Home-Assistant support hahn-th/homematicip-rest-api#86

Closed

balloob mentioned this pull request Mar 30, 2018

0.66.0 #13554

Merged

home-assistant locked and limited conversation to collaborators Apr 15, 2018

ghost removed the platform: sensor.homematicip label Mar 21, 2019


		DOMAIN = 'homematicip_cloud'

		CONF_NAME = 'name'

Add initial support fo HomematicIP components #12761

Add initial support fo HomematicIP components #12761

Conversation

worm-ee commented Feb 27, 2018 • edited

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

homeassistant commented Feb 27, 2018

pvizeli commented Feb 28, 2018 • edited

worm-ee commented Feb 28, 2018

danielperna84 commented Feb 28, 2018

Choose a reason for hiding this comment

balloob commented Feb 28, 2018

danielperna84 commented Feb 28, 2018

worm-ee commented Feb 28, 2018

balloob commented Feb 28, 2018

worm-ee commented Mar 1, 2018

balloob commented Mar 1, 2018

pvizeli commented Mar 1, 2018

worm-ee commented Mar 1, 2018

balloob commented Mar 1, 2018

worm-ee commented Mar 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pvizeli commented Mar 15, 2018

worm-ee commented Mar 15, 2018 • edited

balloob commented Mar 16, 2018

worm-ee commented Mar 16, 2018 • edited

balloob commented Mar 18, 2018

MartinHjelmare 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

sander76 commented Mar 21, 2018

balloob commented Mar 21, 2018 • edited

sander76 commented Mar 22, 2018

worm-ee commented Mar 22, 2018

sander76 commented Mar 22, 2018

sander76 commented Mar 22, 2018

worm-ee commented Mar 22, 2018

sander76 commented Mar 22, 2018

worm-ee commented Mar 22, 2018

sander76 commented Mar 22, 2018

balloob commented Mar 22, 2018

sander76 commented Apr 14, 2018 • edited

worm-ee commented Apr 14, 2018

worm-ee commented Feb 27, 2018 •

edited

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

pvizeli commented Feb 28, 2018 •

edited

worm-ee commented Mar 15, 2018 •

edited

worm-ee commented Mar 16, 2018 •

edited

balloob commented Mar 21, 2018 •

edited

sander76 commented Apr 14, 2018 •

edited