Add MELCloud integration by vilppuvuorinen · Pull Request #30712 · home-assistant/core

vilppuvuorinen · 2020-01-12T19:16:05Z

Description:

This stuff is not supported nor in any way affiliated with Mitsubishi Electric.

Provides climate and sensor platforms for Mitsubishi Electric heat pumps connected to MELCloud service. Multiple platforms on one go is not the best option, but it does not make sense to remove them and commit them later either. This thing started as a custom_component.

Email and access token are stored to the ConfigEntry. The token can be updated by adding the integration again with the same email address. The config flow is aborted and the update is performed on the background. This is a bit unorthodox, but at least I like it better than storing the plain-text password.

Additional information

Link to documentation pull request: home-assistant/home-assistant.io#11930

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist

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

Documentation added/updated in home-assistant.io

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

The manifest file has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all.
Untested files have been added to .coveragerc.

vilppuvuorinen · 2020-01-13T10:48:27Z

@frenck Do I need to provide docs PR before any review is done? I can do the docs PR, but I don't want to commit time to doing that without knowing if this is something that can/will be merged.

frenck · 2020-01-13T11:15:18Z

Docs are required before being able to merge. I've added it to ensure we do not merge it accidentally without documentation.

rudizl · 2020-01-25T10:55:19Z

Excellent work, fingers crossed!

gdude2002 · 2020-01-27T21:18:24Z

I attempted to test this component on my own HA install, but it appears to assume that MELCloud is only used for HVAC/AC systems. When tested with my system (simply an air-to-water system), I noted that the component just presumed that I had an HVAC system. It also doesn't show any zones, and only the first sensor (the power one) reports anything.

Is this out of scope of this PR, or is this unintentional?

vilppuvuorinen · 2020-01-28T05:30:16Z

I think the air-to-water systems are out of scope, but the lack of filtering is not. I also noticed I'm not filtering out empty model numbers for that device info like I though I did.

I have some read-only stuff for air-to-water systems here, but it has just temperatures for now. I would need help with that because I'm doing this with a blackbox or record/replay type approach (just in case) and therefore I don't have access to the source code of the original application. Help would be appreaciated. Right now it would be awesome to have captures of /Device/Get response body and bodies of individual parameter updates requests (SetAta) done at least 1 minute apart. That data is awful to anonymize. You can find me on home-assistant Discord.

gdude2002 · 2020-01-28T11:18:17Z

While working with @vilppuvuorinen on Discord to get some testing data, I produced a Gist with some dumped data. To keep things together and to provide a resource for random internet wanderers, I'm linking it here.

Thanks for looking into this!

rytilahti · 2020-01-29T00:58:12Z

+        speed = self._api.device.fan_speed
+        if speed is None:
+            return None
+        return speed.replace("-", " ")


Maybe this replace belongs to the backend library?

There's a supposedly dynamic amount of fan speeds available in these devices. The backend lib doing this speed-%d mapping for them and this is just to turn that "constant-y" string to "human readable" variant. What I'm trying to say is that I think the replace belongs here, but it just sucks.

Would it be better to use the FAN_* fan mode constants here instead of sequentially numbered speeds? I should be possible at least, but I don't know if it has any benefits.

Sorry, I don't know about the details, but maybe using those constants will help when it comes to consistency (think: usage via voice controls)?

rytilahti · 2020-01-29T00:58:26Z

+
+    async def async_set_fan_mode(self, fan_mode: str) -> None:
+        """Set new target fan mode."""
+        await self._api.device.set({"fan_speed": fan_mode.replace(" ", "-")})


See above wrt. replace.

FAN_* built-in mode mappings could work here too.

MuppetOwl · 2020-01-30T11:06:50Z

Swing modes (vertical vane adjusting) is missing Auto, Top, MiddleTop, Middle, MiddleBottom, Bottom and Swing
Also Heat/cool should maybe be renamed to Auto? Like it was in o0Zz version and is also what its called in Melcloud.

rytilahti · 2020-01-30T13:25:13Z

+        speed = self._api.device.fan_speed
+        if speed is None:
+            return None
+        return speed.replace("-", " ")


Sorry, I don't know about the details, but maybe using those constants will help when it comes to consistency (think: usage via voice controls)?

vilppuvuorinen · 2020-01-30T18:10:47Z

@MuppetOwl I'll have to backtrack on my comments on the forum. HVAC_MODE_AUTO is described as "The device is set to a schedule, learned behavior, AI." and that's definitely not the case here. I'll stick with HVAC_MODE_HEAT_COOL.

rytilahti

This looks fine to me, I left a couple of comments on very minor issues, maybe someone else can also take a quick look before getting this merged?

rytilahti

Looks good to me, but considering the PRs merged by myself often get commented after the merge, I hope someone else will also take a quick look before we proceed with merging :-) (ping @MartinHjelmare ;-))

MartinHjelmare

Don't we want to set up a way to refresh the token automatically?

vilppuvuorinen · 2020-02-09T12:34:13Z

@MartinHjelmare Regarding the token update. I don't think it's possible to setup automatic token update without storing the password. There's a OAuth provider attached to the service, but that's aimed at Alexa integration and such. The response from customer service was hostile enough so that's definitely off the table.

I was hoping I could avoid storing the password. Should I just bite the bullet and store the password and implement token refresh? The tokens seem to be extremely long lived and therefore it is also difficult to assess how the expiry logic would work.

Regarding imports: Should I use relative imports for importing things from the homeassistant/components/melcloud directory?

I'll see about the other comments later today.

MartinHjelmare · 2020-02-09T13:30:11Z

Ok, let's keep the token handling like it is for now.

We have helpers for implementing an oauth flow in the config flow if you want to try that in the future. Maybe you've already read that?

https://developers.home-assistant.io/docs/en/config_entries_config_flow_handler.html#configuration-via-oauth2

Yes, intra-package imports should be relative.

* Provides a climate and sensor platforms. Multiple platforms on one go is not the best option, but it does not make sense to remove them and commit them later either. * Email and access token are stored to the ConfigEntry. The token can be updated by adding the integration again with the same email address. The config flow is aborted and the update is performed on the background.

Entry setup used half-baked naming from few experimentations back. The naming conventiens were unified to match the platforms. A redundant noneness check was also removed after evaluating the possible return values from the backend lib.

* Use config_validation strings. * Add CONF_EMAIL to config schema. The value is not strictly required when configuring through configuration.yaml, but having it there makes things more consistent. * Use dict[key] to access required properties. * Add DOMAIN in config check back to async_setup. This is required if an integration is configured throught config_flow.

* any -> Any * Better names for dict iterations * Proper dict access with mandatory/known keys * Remove unused 'name' argument * Remove unnecessary platform info from unique_ids * Remove redundant methods from climate platform * Remove redundant default value from dict get * Update ConfigFlow sub-classing * Define sensors in a dict instead of a list

vilppuvuorinen · 2020-02-09T20:45:52Z

That test failure does not make sense to me. As if pylint didn't see the usage at homeassistant/components/melcloud/config_flow.py:19.

Co-Authored-By: Martin Hjelmare <marhje52@gmail.com>

MartinHjelmare

Nice!

vilppuvuorinen · 2020-02-10T12:42:57Z

Should I squash the commits now?

MartinHjelmare · 2020-02-10T12:44:07Z

No, please don't do that. We'll squash when merging.

springstan

LGTM 🎉

rytilahti · 2020-02-10T21:08:48Z

Considering we have already three approvals, let's get this merged. Thanks @vilppuvuorinen! 🎉

homeassistant added the cla-signed label Jan 12, 2020

probot-home-assistant Bot added has-tests integration: melcloud new-integration labels Jan 12, 2020

frenck added the docs-missing label Jan 13, 2020

vilppuvuorinen changed the title ~~WIP: Add MELCloud integration~~ Add MELCloud integration Jan 14, 2020

vilppuvuorinen requested review from MartinHjelmare and fabaff January 16, 2020 15:41

rytilahti reviewed Jan 29, 2020

View reviewed changes

vilppuvuorinen requested a review from rytilahti January 29, 2020 21:17

rytilahti reviewed Jan 30, 2020

View reviewed changes

vilppuvuorinen mentioned this pull request Jan 30, 2020

Add documentation for MELCloud integration home-assistant/home-assistant.io#11930

Merged

7 tasks

vilppuvuorinen requested a review from rytilahti January 30, 2020 21:01

rytilahti reviewed Feb 4, 2020

View reviewed changes

Comment thread homeassistant/components/melcloud/__init__.py

Comment thread homeassistant/components/melcloud/__init__.py Outdated

Comment thread homeassistant/components/melcloud/__init__.py Outdated

Comment thread homeassistant/components/melcloud/climate.py Outdated

vilppuvuorinen requested a review from rytilahti February 8, 2020 19:31

rytilahti approved these changes Feb 8, 2020

View reviewed changes

springstan reviewed Feb 8, 2020

View reviewed changes

vilppuvuorinen requested a review from springstan February 9, 2020 08:54

MartinHjelmare requested changes Feb 9, 2020

View reviewed changes

Vilppu Vuorinen added 11 commits February 9, 2020 20:38

Fix async_setup_entry

edb9994

Entry setup used half-baked naming from few experimentations back. The naming conventiens were unified to match the platforms. A redundant noneness check was also removed after evaluating the possible return values from the backend lib.

Simplify empty model name check

d82ec65

Remove unused manifest properties

76ca68c

Remove redundant ClimateDevice property override

a80b1ee

Add __init__.py to coverage exclusion

a65b780

Use CONF_USERNAME instead of CONF_EMAIL

fdcfcff

Use asyncio.gather instead of asyncio.wait

819cbf9

Use _abort_if_unique_id_configured to update token

a00f9c6

Fix them tests

1acac8b

vilppuvuorinen force-pushed the integration-melcloud branch from ca414fd to 1acac8b Compare February 9, 2020 19:25

MartinHjelmare reviewed Feb 9, 2020

View reviewed changes

Comment thread homeassistant/components/melcloud/__init__.py Outdated

Comment thread homeassistant/components/melcloud/sensor.py Outdated

Comment thread homeassistant/components/melcloud/sensor.py Outdated

Comment thread tests/components/melcloud/test_config_flow.py Outdated

Vilppu Vuorinen added 4 commits February 9, 2020 21:47

Remove current state guards

9612ac4

Fix that gather call

ea9fa9c

Implement sensor definitions without str manipulation

1fcfe91

Use relative intra-package imports

d9a56c2

vilppuvuorinen requested a review from MartinHjelmare February 10, 2020 05:41

MartinHjelmare reviewed Feb 10, 2020

View reviewed changes

Comment thread homeassistant/components/melcloud/config_flow.py Outdated

Update homeassistant/components/melcloud/config_flow.py

f95dd32

Co-Authored-By: Martin Hjelmare <marhje52@gmail.com>

MartinHjelmare approved these changes Feb 10, 2020

View reviewed changes

MartinHjelmare removed the docs-missing label Feb 10, 2020

This comment has been minimized.

Sign in to view

springstan approved these changes Feb 10, 2020

View reviewed changes

rytilahti merged commit b78d156 into home-assistant:dev Feb 10, 2020

lock Bot locked and limited conversation to collaborators Feb 12, 2020

Uh oh!

Conversation

vilppuvuorinen commented Jan 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Additional information

Checklist:

Uh oh!

vilppuvuorinen commented Jan 13, 2020

Uh oh!

frenck commented Jan 13, 2020

Uh oh!

rudizl commented Jan 25, 2020

Uh oh!

gdude2002 commented Jan 27, 2020

Uh oh!

vilppuvuorinen commented Jan 28, 2020

Uh oh!

gdude2002 commented Jan 28, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rytilahti Jan 29, 2020

Choose a reason for hiding this comment

Uh oh!

vilppuvuorinen Jan 29, 2020

Choose a reason for hiding this comment

Uh oh!

rytilahti Jan 30, 2020

Choose a reason for hiding this comment

Uh oh!

rytilahti Jan 29, 2020

Choose a reason for hiding this comment

Uh oh!

vilppuvuorinen Jan 29, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MuppetOwl commented Jan 30, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rytilahti Jan 30, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vilppuvuorinen commented Jan 30, 2020

Uh oh!

rytilahti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rytilahti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vilppuvuorinen commented Jan 12, 2020 •

edited

Loading