Add a service for zoned cleaning for Xiaomi Miio vacuum #15932

tenfire · 2018-08-11T15:46:06Z

Added a service for zoned cleaning after some help from pnbruckner (thanks!). Tested with my Xiaomi Roborock 2.

Description:

Related issue (if applicable): fixes #

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.github.io#<home-assistant.github.io PR number goes here>

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

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 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.

homeassistant · 2018-08-11T15:46:07Z

Hi @tenfire,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2018-08-11T15:46:15Z

homeassistant/components/vacuum/xiaomi_miio.py

+                              y1: int = 25500,
+                              x2: int = 25500,
+                              y2: int = 25500,
+                              repetitions: int = 1):


continuation line over-indented for visual indent

houndci-bot · 2018-08-11T15:46:15Z

homeassistant/components/vacuum/xiaomi_miio.py

+                              x1: int = 25500,
+                              y1: int = 25500,
+                              x2: int = 25500,
+                              y2: int = 25500,


continuation line over-indented for visual indent

houndci-bot · 2018-08-11T15:46:16Z

homeassistant/components/vacuum/xiaomi_miio.py

+    def async_clean_zone(self,
+                              x1: int = 25500,
+                              y1: int = 25500,
+                              x2: int = 25500,


continuation line over-indented for visual indent

houndci-bot · 2018-08-11T15:46:16Z

homeassistant/components/vacuum/xiaomi_miio.py

+    @asyncio.coroutine
+    def async_clean_zone(self,
+                              x1: int = 25500,
+                              y1: int = 25500,


continuation line over-indented for visual indent

houndci-bot · 2018-08-11T15:46:16Z

homeassistant/components/vacuum/xiaomi_miio.py

@@ -318,6 +340,20 @@ def async_send_command(self, command, params=None, **kwargs):
            "Unable to send command to the vacuum: %s",
            self._vacuum.raw_command, command, params)

+    @asyncio.coroutine
+    def async_clean_zone(self,
+                              x1: int = 25500,


continuation line over-indented for visual indent

awarecan · 2018-08-11T21:21:38Z

Thanks for your contribution, please change your pull request's target to dev branch

rytilahti · 2018-08-11T21:48:15Z

homeassistant/components/vacuum/xiaomi_miio.py

+        params = [[x1, y1, x2, y2, repetitions]]
+        yield from self._try_command(
+            "Unable to start zoned cleaning: %s",
+            self._vacuum.raw_command,


The proper way to do this would be to fix the python-miio instead of using raw_command, see rytilahti/python-miio#311 . It could be also useful to add a service for "goto" for the purpose of emptying the bin :-)

https://github.com/rytilahti/python-miio/blob/master/miio/vacuum.py#L80

cnrd · 2018-08-12T21:19:03Z

We should probably also have some documentation that shows how the x1, x2, y1, and y2 coordinates relates to the real world, as I have personally seen the map change orientation on different runs of the vacuum. (Would changing the orientation of the map also change the coordinates, such that an automation to clean up the kitchen floor after I'm done cooking would make the vacuum clean a different area?) and how do we extract the correct x and y coordinates?

syssi · 2018-08-21T20:02:54Z

Please rebase your PR and use the new "goto" method of python-miio 0.4.1: https://github.com/rytilahti/python-miio/blob/master/miio/vacuum.py#L80

houndci-bot · 2018-08-22T17:12:50Z

homeassistant/components/vacuum/xiaomi_miio.py

+    @asyncio.coroutine
+    def async_goto(self,
+                    x: int = 25500,
+                    y: int = 25500):


continuation line over-indented for visual indent

houndci-bot · 2018-08-22T17:12:51Z

homeassistant/components/vacuum/xiaomi_miio.py

+
+    @asyncio.coroutine
+    def async_goto(self,
+                    x: int = 25500,


continuation line over-indented for visual indent

houndci-bot · 2018-08-22T17:12:51Z

homeassistant/components/vacuum/xiaomi_miio.py

+        """Clean a specific zone."""
+        zoneList = []
+        for zone in zones:
+            zoneList.append([int(zone["x1"]), int(zone["y1"]), int(zone["x2"]), int(zone["y2"]), int(zone["iterations"])])


line too long (122 > 79 characters)

houndci-bot · 2018-08-22T17:12:51Z

homeassistant/components/vacuum/xiaomi_miio.py

+                            y1: int = 25500,
+                            x2: int = 25500,
+                            y2: int = 25500,
+                            iterations: int = 1):


continuation line over-indented for visual indent

houndci-bot · 2018-08-22T17:12:51Z

homeassistant/components/vacuum/xiaomi_miio.py

+                            x1: int = 25500,
+                            y1: int = 25500,
+                            x2: int = 25500,
+                            y2: int = 25500,


continuation line over-indented for visual indent

houndci-bot · 2018-08-22T17:12:51Z

homeassistant/components/vacuum/xiaomi_miio.py

+    def async_clean_zone(self,
+                            x1: int = 25500,
+                            y1: int = 25500,
+                            x2: int = 25500,


continuation line over-indented for visual indent

houndci-bot · 2018-08-22T17:12:52Z

homeassistant/components/vacuum/xiaomi_miio.py

+    @asyncio.coroutine
+    def async_clean_zone(self,
+                            x1: int = 25500,
+                            y1: int = 25500,


continuation line over-indented for visual indent

houndci-bot · 2018-08-22T17:12:52Z

homeassistant/components/vacuum/xiaomi_miio.py

@@ -318,6 +371,38 @@ def async_send_command(self, command, params=None, **kwargs):
            "Unable to send command to the vacuum: %s",
            self._vacuum.raw_command, command, params)

+    @asyncio.coroutine
+    def async_clean_zone(self,
+                            x1: int = 25500,


continuation line over-indented for visual indent

tenfire · 2018-08-22T17:59:35Z

I have tested all three services with my roborock 2 and it seems to be working.
According to this the xiaomi is using x=25500, y=25500 as origin (docking station). I have found that it sometimes changes origin and orientation if you start the zoned cleanup when the vacuum isn't docked.
I created two separate services for zoned cleanup, the first one only support a single zone, but is easier to use (and probably more common), and the other one has support for a list of zones.

NOTE: From the docking station point of view facing away from the wall it is placed against the X-axis is positive towards the right and the Y-axis is positive forward.

cybe · 2018-08-22T18:07:52Z

@tenfire Do you know of any limit regarding the maximum number of zones to be cleaned per API call? If I recall correctly, the MiHome app has a limit of 5.

tenfire · 2018-08-22T18:24:24Z

@tenfire Do you know of any limit regarding the maximum number of zones to be cleaned per API call? If I recall correctly, the MiHome app has a limit of 5.

The app is limited to 3 iterations, but it worked with 5 using python-miio. I did not test with a higher number
EDIT
Did not read your question carefully enough, missed that you asked about number of zones and not number of iterations. I tried with more that 5 zones now. The vacuum still cleans the first 5 zones, but returns to the dock without cleaning the remaining zones.

cybe · 2018-08-24T04:06:57Z

Did not read your question carefully enough, missed that you asked about number of zones and not number of iterations. I tried with more that 5 zones now. The vacuum still cleans the first 5 zones, but returns to the dock without cleaning the remaining zones.

Thanks for testing and clearing that up :) So if I want to use more than 5 zones I need to wrap it in some kind of automation.

tamasv · 2018-09-13T08:06:36Z

I have found that it sometimes changes origin and orientation if you start the zoned cleanup when the vacuum isn't docked.

Yes, but you can "reset" the map and orientation with the following method.
1, call start ( cleaning )
2, let it run for ~20 sec
3, send back to dock
4, call stop
I'm using this for months now with my scripts for zoned cleanup and works like a charm.

balloob · 2018-09-21T11:45:55Z

homeassistant/components/vacuum/xiaomi_miio.py

+
+SERVICE_SCHEMA_CLEAN_ZONES = VACUUM_SERVICE_SCHEMA.extend({
+    vol.Required(ATTR_ZONE_ZONES):
+        vol.All(vol.Coerce(list)),


This should be more than just list. Also, use cv.ensure_list.

balloob · 2018-09-21T11:46:08Z

homeassistant/components/vacuum/xiaomi_miio.py

@@ -69,7 +80,41 @@
    vol.Optional(ATTR_RC_DURATION): cv.positive_int,
 })

+SERVICE_SCHEMA_CLEAN_ZONE = VACUUM_SERVICE_SCHEMA.extend({


This one should be removed, clean_zones should be able to handle the cleaning of 1 zone.

balloob · 2018-09-21T11:46:33Z

homeassistant/components/vacuum/xiaomi_miio.py

+        vol.All(vol.Coerce(list)),
+})
+
+SERVICE_SCHEMA_GOTO = VACUUM_SERVICE_SCHEMA.extend({


Please limit PRs to 1 service at a time.

balloob · 2018-09-21T11:46:55Z

homeassistant/components/vacuum/xiaomi_miio.py

+        """Clean a specific zone."""
+        zoneList = []
+        for zone in zones:
+            zoneList.append([int(zone["x1"]), int(zone["y1"]), int(zone["x2"]), int(zone["y2"]), int(zone["iterations"])])


Conversion of variables has to happen in voluptuous schema.

balloob · 2018-09-21T11:47:38Z

You will also need to fix the linting erros.

tenfire requested review from rytilahti and syssi as code owners August 11, 2018 15:46

homeassistant added cla-needed merging-to-master This PR is merging into the master branch and should probably change the branch to `dev`. platform: vacuum.xiaomi_miio labels Aug 11, 2018

ghost added the in progress label Aug 11, 2018

houndci-bot reviewed Aug 11, 2018

View reviewed changes

homeassistant added cla-signed and removed cla-needed labels Aug 11, 2018

rytilahti reviewed Aug 11, 2018

View reviewed changes

rytilahti changed the title ~~Added a service for zoned cleaning~~ vacuum.xiaomi_miio: Add a service for zoned cleaning Aug 11, 2018

tenfire changed the base branch from master to dev August 12, 2018 07:35

fabaff changed the title ~~vacuum.xiaomi_miio: Add a service for zoned cleaning~~ Add a service for zoned cleaning for Xiaomi Miio vacuum Aug 12, 2018

fabaff removed the merging-to-master This PR is merging into the master branch and should probably change the branch to `dev`. label Aug 13, 2018

frenck added the docs-missing label Aug 13, 2018

tenfire requested review from amelchio, andrey-git, bachya, cdce8p, Danielhiversen, kellerza, molobrakos, OverloadUT and a team as code owners August 22, 2018 17:11

tenfire requested a review from a team August 22, 2018 17:11

homeassistant added the cla-signed label Aug 22, 2018

houndci-bot reviewed Aug 22, 2018

View reviewed changes

Added a service for zoned cleaning for Xiaomi Miio vacuum

7522d28

tenfire force-pushed the patch-1 branch from 8a575c0 to 7522d28 Compare August 22, 2018 17:47

homeassistant added the cla-signed label Aug 22, 2018

balloob reviewed Sep 21, 2018

View reviewed changes

balloob self-assigned this Sep 21, 2018

pvizeli closed this Dec 7, 2018

ghost removed the in progress label Dec 7, 2018

ghost added integration: xiaomi_miio and removed platform: vacuum.xiaomi_miio labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a service for zoned cleaning for Xiaomi Miio vacuum #15932

Add a service for zoned cleaning for Xiaomi Miio vacuum #15932

tenfire commented Aug 11, 2018 •

edited

Loading

homeassistant commented Aug 11, 2018

houndci-bot Aug 11, 2018

houndci-bot Aug 11, 2018

houndci-bot Aug 11, 2018

houndci-bot Aug 11, 2018

houndci-bot Aug 11, 2018

awarecan commented Aug 11, 2018

rytilahti Aug 11, 2018

syssi Aug 21, 2018

cnrd commented Aug 12, 2018 •

edited

Loading

syssi commented Aug 21, 2018

houndci-bot Aug 22, 2018

houndci-bot Aug 22, 2018

houndci-bot Aug 22, 2018

houndci-bot Aug 22, 2018

houndci-bot Aug 22, 2018

houndci-bot Aug 22, 2018

houndci-bot Aug 22, 2018

houndci-bot Aug 22, 2018

tenfire commented Aug 22, 2018 •

edited

Loading

cybe commented Aug 22, 2018 •

edited

Loading

tenfire commented Aug 22, 2018 •

edited

Loading

cybe commented Aug 24, 2018

tamasv commented Sep 13, 2018

balloob Sep 21, 2018

balloob Sep 21, 2018 •

edited

Loading

balloob Sep 21, 2018

balloob Sep 21, 2018

balloob commented Sep 21, 2018

Add a service for zoned cleaning for Xiaomi Miio vacuum #15932

Add a service for zoned cleaning for Xiaomi Miio vacuum #15932

Conversation

tenfire commented Aug 11, 2018 • edited Loading

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

homeassistant commented Aug 11, 2018

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

awarecan commented Aug 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnrd commented Aug 12, 2018 • edited Loading

syssi commented Aug 21, 2018

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

tenfire commented Aug 22, 2018 • edited Loading

cybe commented Aug 22, 2018 • edited Loading

tenfire commented Aug 22, 2018 • edited Loading

cybe commented Aug 24, 2018

tamasv commented Sep 13, 2018

Choose a reason for hiding this comment

balloob Sep 21, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Sep 21, 2018

tenfire commented Aug 11, 2018 •

edited

Loading

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

cnrd commented Aug 12, 2018 •

edited

Loading

tenfire commented Aug 22, 2018 •

edited

Loading

cybe commented Aug 22, 2018 •

edited

Loading

tenfire commented Aug 22, 2018 •

edited

Loading

balloob Sep 21, 2018 •

edited

Loading