Add support Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3) #1497

k402xxxcenxxx · 2022-08-14T15:11:29Z

Add support Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3)

codecov-commenter · 2022-08-14T15:17:12Z

Codecov Report

Merging #1497 (33d5905) into master (f4abd59) will increase coverage by 0.11%.
The diff coverage is 89.52%.

@@            Coverage Diff             @@
##           master    #1497      +/-   ##
==========================================
+ Coverage   80.82%   80.93%   +0.11%     
==========================================
  Files         151      153       +2     
  Lines       14798    14989     +191     
  Branches     1696     3678    +1982     
==========================================
+ Hits        11960    12131     +171     
- Misses       2591     2610      +19     
- Partials      247      248       +1

Impacted Files	Coverage Δ
miio/integrations/vacuum/mijia/pro2vacuum.py	`87.87% <87.87%> (ø)`
miio/integrations/vacuum/mijia/__init__.py	`100.00% <100.00%> (ø)`
...integrations/vacuum/mijia/tests/test_pro2vacuum.py	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

k402xxxcenxxx · 2022-08-26T16:54:44Z

Add support for basic actions:

Go Home
Start Cleaning
Stop Cleaning
Set fan speed
Get status

The code structure is based on miio\integrations\vacuum\mijia\g1vacuum.py.

Currently not sure the error code mapping, so leave the mapping empty

rytilahti · 2022-09-06T23:08:55Z

Sorry, I haven't had time to review this yet, one question I had was whether the implementation differs that much from the g1 to require a separate implementation file?

It is not really a big issue, especially with the upcoming introspectable interfaces (see #1495 and https://python-miio.readthedocs.io/en/latest/contributing.html#status-containers), but if the changes are minor we could avoid code duplication.

k402xxxcenxxx · 2022-09-08T06:30:33Z

Sorry, I haven't had time to review this yet, one question I had was whether the implementation differs that much from the g1 to require a separate implementation file?

It is not really a big issue, especially with the upcoming introspectable interfaces (see #1495 and https://python-miio.readthedocs.io/en/latest/contributing.html#status-containers), but if the changes are minor we could avoid code duplication.

That is a good question!

I have tried integrating ijai.vacuum.v3(pro2) into g1, but finally decided to create a new file.
They have some difference:

G1 has ChargingStatus but pro2 combines charging status with overall status.
G1 has find action but pro2 doesn't
G1 separates main/side brush to different SIID, but pro2 collects these states into sweeping state
pro2 has more map controls, but G1 only has map info

These differences suggest that they may not have been designed by the same product line. So I decided to split them into two files. But this is the first time I've written this kind of script, so I'm not super sure that my choices are correct. If you still suggest me to integrate them into one file after reading my rationale, I will try to do so.

Thanks again for your easy-to-use codebase!

rytilahti

Thanks for the PR @k402xxxcenxxx, I added some comments inline to improve it before it's ready to be merged!

miio/integrations/vacuum/mijia/pro2vacuum.py

rytilahti · 2022-09-08T17:26:59Z

miio/integrations/vacuum/mijia/pro2vacuum.py

+        """Response (MIoT format) of a Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3)
+
+        [
+            {'did': 'battery', 'siid': 3, 'piid': 1, 'code': 0, 'value': 100},


Could you please add tests for the property getters using the example payload to make sure the return values and their types are as expected? Just in case this gets refactored in the future :-)

Hi @rytilahti, I tried adding a state payload test. However, I'm not familiar with writing pytest. Can you help me review it first? Then I can write the following tests based on it.

I will check the test code first. I forget to run test before push.

miio/integrations/vacuum/mijia/pro2vacuum.py

rytilahti · 2022-09-08T21:06:36Z

I have tried integrating ijai.vacuum.v3(pro2) into g1, but finally decided to create a new file. They have some difference:

The reasoning sounds good to me, thanks for trying to integrate the implementations! No need to try to force different product lines under a single integration, especially considering the ongoing work to allow downstream users to programmatically find out about available information.

These differences suggest that they may not have been designed by the same product line. So I decided to split them into two files. But this is the first time I've written this kind of script, so I'm not super sure that my choices are correct. If you still suggest me to integrate them into one file after reading my rationale, I will try to do so.

Splitting the implementations sounds good to me. One of the reasons I have tried to "force" support for different devices has been to make the interfaces somewhat consistent. This was due to structural problems in this library that are now being worked on as mentioned in my other comment.

I'm glad that you think the code base was easy to work on, I hope it will become even easier in the future :-)

k402xxxcenxxx · 2022-09-14T02:57:42Z

@rytilahti thanks for reviewing. I will find time to improve it.

miio/integrations/vacuum/mijia/pro2vacuum.py

rytilahti

No need to define the unit for timedeltas for now, otherwise this is good to go, thanks!

rytilahti · 2022-09-24T22:18:23Z

miio/integrations/vacuum/mijia/pro2vacuum.py

+        return self.data["main_brush_life_level"]
+
+    @property
+    @sensor("Main Brush Life Time Left", unit="hr")


Suggested change

@sensor("Main Brush Life Time Left", unit="hr")

@sensor("Main Brush Life Time Left")

rytilahti · 2022-09-24T22:18:34Z

miio/integrations/vacuum/mijia/pro2vacuum.py

+        return self.data["side_brush_life_level"]
+
+    @property
+    @sensor("Side Brush Life Time Left", unit="hr")


Suggested change

@sensor("Side Brush Life Time Left", unit="hr")

@sensor("Side Brush Life Time Left")

rytilahti · 2022-09-24T22:18:48Z

miio/integrations/vacuum/mijia/pro2vacuum.py

+        return self.data["filter_life_level"]
+
+    @property
+    @sensor("Filter Life Time Left", unit="hr")


Suggested change

@sensor("Filter Life Time Left", unit="hr")

@sensor("Filter Life Time Left")

rytilahti · 2022-09-24T22:19:00Z

miio/integrations/vacuum/mijia/pro2vacuum.py

+        return self.data["mop_life_level"]
+
+    @property
+    @sensor("Mop Life Time Left", unit="hr")


Suggested change

@sensor("Mop Life Time Left", unit="hr")

@sensor("Mop Life Time Left")

rytilahti · 2022-09-24T22:19:19Z

miio/integrations/vacuum/mijia/pro2vacuum.py

+        return self.data["clean_area"]
+
+    @property
+    @sensor("Last Clean Time", unit="mins", icon="mdi:timer-sand")


Suggested change

@sensor("Last Clean Time", unit="mins", icon="mdi:timer-sand")

@sensor("Last Clean Time", icon="mdi:timer-sand")

rytilahti · 2022-09-24T22:21:35Z

miio/integrations/vacuum/mijia/pro2vacuum.py

+class RepeatState(Enum):
+    Off = False
+    On = True


I just briefly checked if all the booleans are defined as such and saw this. This is not used anywhere and should be removed now?

rytilahti

LGTM, thanks again! 👍

slecram · 2023-12-22T15:51:59Z

@rytilahti Hi! When there will be a new release of python-miio to support die mop 2 pro? I'd like to implement my robot into homeassistant, but this will only works with a new release.

rytilahti added new device miot labels Aug 14, 2022

This was referenced Aug 15, 2022

ijai.vacuum.v2 request #1273

Closed

Xiaomi Mi Mop-2 Lite ijai.vacuum.v10 is working! #1319

Closed

ijai.vacuum.v14 #1330

Closed

k402xxxcenxxx force-pushed the feature/pro2vacuum branch from 5352d80 to 03a3d3c Compare August 26, 2022 15:17

k402xxxcenxxx marked this pull request as ready for review August 26, 2022 16:54

rytilahti mentioned this pull request Sep 6, 2022

Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3) #1385

Closed

rytilahti requested changes Sep 8, 2022

View reviewed changes

rytilahti reviewed Sep 14, 2022

View reviewed changes

miio/integrations/vacuum/mijia/pro2vacuum.py Outdated Show resolved Hide resolved

rytilahti requested changes Sep 24, 2022

View reviewed changes

rytilahti reviewed Sep 24, 2022

View reviewed changes

k402xxxcenxxx added 11 commits October 4, 2022 16:24

Add: pro2 vacuum basic command. Fix title too short

7e23f7a

Fix: typo. add to support model

047acf4

Discard: changes in discovery

85a55ab

Add: main/side brush/filter/cur-lang status

4678eda

Fix: mappings

54d144c

Fix: status enum

df6fbeb

Fix: boolean for mop_state

a8a4034

Fix: sweep mode, sweep type, filter type and error code

52aad2f

Add: switch and sensors

cd041c8

Add: status payload test

055134e

Fix: status payload test

33d5905

k402xxxcenxxx force-pushed the feature/pro2vacuum branch from f451c5c to 33d5905 Compare October 4, 2022 08:25

k402xxxcenxxx added 4 commits October 4, 2022 16:47

Fix: No need to define the unit for timedeltas

18df180

Fix: unused enum

5eeeecb

Fix: state test patload

eb2bd18

Add: set fan speed test

cdaf6ca

rytilahti approved these changes Oct 6, 2022

View reviewed changes

rytilahti merged commit aa27188 into rytilahti:master Oct 6, 2022

This was referenced Dec 21, 2022

Xiaomi Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3) not listed home-assistant/core#84355

Closed

Xiaomi Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3) not listed home-assistant/core#84382

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3) #1497

Add support Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3) #1497

k402xxxcenxxx commented Aug 14, 2022 •

edited by rytilahti

Loading

codecov-commenter commented Aug 14, 2022 •

edited

Loading

k402xxxcenxxx commented Aug 26, 2022

rytilahti commented Sep 6, 2022

k402xxxcenxxx commented Sep 8, 2022

rytilahti left a comment

rytilahti Sep 8, 2022

k402xxxcenxxx Sep 24, 2022

k402xxxcenxxx Sep 24, 2022

rytilahti commented Sep 8, 2022

k402xxxcenxxx commented Sep 14, 2022

rytilahti left a comment

rytilahti Sep 24, 2022

rytilahti Sep 24, 2022

rytilahti Sep 24, 2022

rytilahti Sep 24, 2022

rytilahti Sep 24, 2022

rytilahti Sep 24, 2022 •

edited

Loading

rytilahti left a comment

slecram commented Dec 22, 2023 •

edited

Loading

	@sensor("Main Brush Life Time Left", unit="hr")
	@sensor("Main Brush Life Time Left")

	@sensor("Side Brush Life Time Left", unit="hr")
	@sensor("Side Brush Life Time Left")

	@sensor("Filter Life Time Left", unit="hr")
	@sensor("Filter Life Time Left")

	@sensor("Mop Life Time Left", unit="hr")
	@sensor("Mop Life Time Left")

	@sensor("Last Clean Time", unit="mins", icon="mdi:timer-sand")
	@sensor("Last Clean Time", icon="mdi:timer-sand")

Add support Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3) #1497

Add support Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3) #1497

Conversation

k402xxxcenxxx commented Aug 14, 2022 • edited by rytilahti Loading

codecov-commenter commented Aug 14, 2022 • edited Loading

Codecov Report

k402xxxcenxxx commented Aug 26, 2022

rytilahti commented Sep 6, 2022

k402xxxcenxxx commented Sep 8, 2022

rytilahti 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

rytilahti commented Sep 8, 2022

k402xxxcenxxx commented Sep 14, 2022

rytilahti 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

rytilahti Sep 24, 2022 • edited Loading

Choose a reason for hiding this comment

rytilahti left a comment

Choose a reason for hiding this comment

slecram commented Dec 22, 2023 • edited Loading

k402xxxcenxxx commented Aug 14, 2022 •

edited by rytilahti

Loading

codecov-commenter commented Aug 14, 2022 •

edited

Loading

rytilahti Sep 24, 2022 •

edited

Loading

slecram commented Dec 22, 2023 •

edited

Loading