Merge branch 'main' into cli-session

Author: allenporter

.github/workflows/ci.yml

@@ -75,7 +75,7 @@ jobs:
         persist-credentials: false
     - name: Python Semantic Release
       id: release
-      uses: python-semantic-release/python-semantic-release@v9.21.0
+      uses: python-semantic-release/python-semantic-release@v10.1.0
       with:
         github_token: ${{ secrets.GH_TOKEN }}
 

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-roborock"
-version = "2.19.0"
+version = "2.20.0"
 description = "A package to control Roborock vacuums."
 authors = ["humbertogontijo <humbertogontijo@users.noreply.github.com>"]
 license = "GPL-3.0-only"

pyproject.toml

@@ -85,7 +85,7 @@ def should_keepalive(self) -> bool:
 
     async def validate_connection(self) -> None:
         if not self.should_keepalive():
-            self._logger.info("Resetting Roborock connection due to kepalive timeout")
+            self._logger.info("Resetting Roborock connection due to keepalive timeout")
             await self.async_disconnect()
         await self.async_connect()
 

roborock/api.py

@@ -267,6 +267,17 @@ class RoborockFanSpeedQRevoCurv(RoborockFanPowerCode):
     smart_mode = 110
 
 
+class RoborockFanSpeedQRevoMaxV(RoborockFanPowerCode):
+    off = 105
+    quiet = 101
+    balanced = 102
+    turbo = 103
+    max = 104
+    custom = 106
+    max_plus = 108
+    smart_mode = 110
+
+
 class RoborockFanSpeedP10(RoborockFanPowerCode):
     off = 105
     quiet = 101
@@ -275,6 +286,7 @@ class RoborockFanSpeedP10(RoborockFanPowerCode):
     max = 104
     custom = 106
     max_plus = 108
+    smart_mode = 110
 
 
 class RoborockFanSpeedS8MaxVUltra(RoborockFanPowerCode):
@@ -316,6 +328,7 @@ class RoborockMopModeS8ProUltra(RoborockMopModeCode):
     deep_plus = 303
     fast = 304
     custom = 302
+    smart_mode = 306
 
 
 class RoborockMopModeS8MaxVUltra(RoborockMopModeCode):
@@ -337,6 +350,15 @@ class RoborockMopModeQRevoMaster(RoborockMopModeCode):
     smart_mode = 306
 
 
+class RoborockMopModeQRevoMaxV(RoborockMopModeCode):
+    standard = 300
+    deep = 301
+    custom = 302
+    deep_plus = 303
+    fast = 304
+    smart_mode = 306
+
+
 class RoborockMopIntensityCode(RoborockEnum):
     """Describes the mop intensity of the vacuum cleaner."""
 
@@ -383,6 +405,16 @@ class RoborockMopIntensityQRevoCurv(RoborockMopIntensityCode):
     smart_mode = 209
 
 
+class RoborockMopIntensityQRevoMaxV(RoborockMopIntensityCode):
+    off = 200
+    low = 201
+    medium = 202
+    high = 203
+    custom = 204
+    custom_water_flow = 207
+    smart_mode = 209
+
+
 class RoborockMopIntensityP10(RoborockMopIntensityCode):
     """Describes the mop intensity of the vacuum cleaner."""
 
@@ -392,6 +424,7 @@ class RoborockMopIntensityP10(RoborockMopIntensityCode):
     high = 203
     custom = 204
     custom_water_flow = 207
+    smart_mode = 209
 
 
 class RoborockMopIntensityS8MaxVUltra(RoborockMopIntensityCode):

roborock/code_mappings.py

@@ -22,6 +22,7 @@
     RoborockFanSpeedQ7Max,
     RoborockFanSpeedQRevoCurv,
     RoborockFanSpeedQRevoMaster,
+    RoborockFanSpeedQRevoMaxV,
     RoborockFanSpeedS6Pure,
     RoborockFanSpeedS7,
     RoborockFanSpeedS7MaxV,
@@ -33,13 +34,15 @@
     RoborockMopIntensityQ7Max,
     RoborockMopIntensityQRevoCurv,
     RoborockMopIntensityQRevoMaster,
+    RoborockMopIntensityQRevoMaxV,
     RoborockMopIntensityS5Max,
     RoborockMopIntensityS6MaxV,
     RoborockMopIntensityS7,
     RoborockMopIntensityS8MaxVUltra,
     RoborockMopModeCode,
     RoborockMopModeQRevoCurv,
     RoborockMopModeQRevoMaster,
+    RoborockMopModeQRevoMaxV,
     RoborockMopModeS7,
     RoborockMopModeS8MaxVUltra,
     RoborockMopModeS8ProUltra,
@@ -599,6 +602,13 @@ class QRevoCurvStatus(Status):
     mop_mode: RoborockMopModeQRevoCurv | None = None
 
 
+@dataclass
+class QRevoMaxVStatus(Status):
+    fan_power: RoborockFanSpeedQRevoMaxV | None = None
+    water_box_mode: RoborockMopIntensityQRevoMaxV | None = None
+    mop_mode: RoborockMopModeQRevoMaxV | None = None
+
+
 @dataclass
 class S6MaxVStatus(Status):
     fan_power: RoborockFanSpeedS7MaxV | None = None
@@ -672,7 +682,7 @@ class S8MaxvUltraStatus(Status):
     # but i am currently unable to do my typical reverse engineering/ get any data from users on this,
     # so this will be here in the mean time.
     ROBOROCK_QREVO_S: P10Status,
-    ROBOROCK_QREVO_MAXV: P10Status,
+    ROBOROCK_QREVO_MAXV: QRevoMaxVStatus,
     ROBOROCK_QREVO_PRO: P10Status,
     ROBOROCK_S8_MAXV_ULTRA: S8MaxvUltraStatus,
 }

roborock/containers.py

@@ -160,7 +160,7 @@ async def _mqtt_client(self, params: MqttParams) -> aiomqtt.Client:
                 async with self._client_lock:
                     self._client = client
                     for topic in self._listeners:
-                        _LOGGER.debug("Re-establising subscription to topic %s", topic)
+                        _LOGGER.debug("Re-establishing subscription to topic %s", topic)
                         # TODO: If this fails it will break the whole connection. Make
                         # this retry again in the background with backoff.
                         await client.subscribe(topic)

roborock/mqtt/roborock_session.py

@@ -90,39 +90,6 @@ def _get_header_client_id(self):
         md5.update(self._device_identifier.encode())
         return base64.b64encode(md5.digest()).decode()
 
-    def _process_extra_hawk_values(self, values: dict | None) -> str:
-        if values is None:
-            return ""
-        else:
-            sorted_keys = sorted(values.keys())
-            result = []
-            for key in sorted_keys:
-                value = values.get(key)
-                result.append(f"{key}={value}")
-            return hashlib.md5("&".join(result).encode()).hexdigest()
-
-    def _get_hawk_authentication(
-        self, rriot: RRiot, url: str, formdata: dict | None = None, params: dict | None = None
-    ) -> str:
-        timestamp = math.floor(time.time())
-        nonce = secrets.token_urlsafe(6)
-        formdata_str = self._process_extra_hawk_values(formdata)
-        params_str = self._process_extra_hawk_values(params)
-
-        prestr = ":".join(
-            [
-                rriot.u,
-                rriot.s,
-                nonce,
-                str(timestamp),
-                hashlib.md5(url.encode()).hexdigest(),
-                params_str,
-                formdata_str,
-            ]
-        )
-        mac = base64.b64encode(hmac.new(rriot.h.encode(), prestr.encode(), hashlib.sha256).digest()).decode()
-        return f'Hawk id="{rriot.u}",s="{rriot.s}",ts="{timestamp}",nonce="{nonce}",mac="{mac}"'
-
     async def nc_prepare(self, user_data: UserData, timezone: str) -> dict:
         """This gets a few critical parameters for adding a device to your account."""
         if (
@@ -144,7 +111,7 @@ async def nc_prepare(self, user_data: UserData, timezone: str) -> dict:
             "post",
             "/nc/prepare",
             headers={
-                "Authorization": self._get_hawk_authentication(
+                "Authorization": _get_hawk_authentication(
                     user_data.rriot, "/nc/prepare", {"hid": hid, "tzid": timezone}
                 ),
             },
@@ -177,7 +144,7 @@ async def add_device(self, user_data: UserData, s: str, t: str) -> dict:
             "GET",
             "/user/devices/newadd",
             headers={
-                "Authorization": self._get_hawk_authentication(
+                "Authorization": _get_hawk_authentication(
                     user_data.rriot, "/user/devices/newadd", params={"s": s, "t": t}
                 ),
             },
@@ -337,7 +304,7 @@ async def get_home_data(self, user_data: UserData) -> HomeData:
             rriot.r.a,
             self.session,
             {
-                "Authorization": self._get_hawk_authentication(rriot, f"/user/homes/{str(home_id)}"),
+                "Authorization": _get_hawk_authentication(rriot, f"/user/homes/{str(home_id)}"),
             },
         )
         home_response = await home_request.request("get", "/user/homes/" + str(home_id))
@@ -366,7 +333,7 @@ async def get_home_data_v2(self, user_data: UserData) -> HomeData:
             rriot.r.a,
             self.session,
             {
-                "Authorization": self._get_hawk_authentication(rriot, "/v2/user/homes/" + str(home_id)),
+                "Authorization": _get_hawk_authentication(rriot, "/v2/user/homes/" + str(home_id)),
             },
         )
         home_response = await home_request.request("get", "/v2/user/homes/" + str(home_id))
@@ -393,7 +360,7 @@ async def get_home_data_v3(self, user_data: UserData) -> HomeData:
             rriot.r.a,
             self.session,
             {
-                "Authorization": self._get_hawk_authentication(rriot, "/v3/user/homes/" + str(home_id)),
+                "Authorization": _get_hawk_authentication(rriot, "/v3/user/homes/" + str(home_id)),
             },
         )
         home_response = await home_request.request("get", "/v3/user/homes/" + str(home_id))
@@ -416,7 +383,7 @@ async def get_rooms(self, user_data: UserData, home_id: int | None = None) -> li
             rriot.r.a,
             self.session,
             {
-                "Authorization": self._get_hawk_authentication(rriot, "/v2/user/homes/" + str(home_id)),
+                "Authorization": _get_hawk_authentication(rriot, "/v2/user/homes/" + str(home_id)),
             },
         )
         room_response = await room_request.request("get", f"/user/homes/{str(home_id)}/rooms" + str(home_id))
@@ -441,7 +408,7 @@ async def get_scenes(self, user_data: UserData, device_id: str) -> list[HomeData
             rriot.r.a,
             self.session,
             {
-                "Authorization": self._get_hawk_authentication(rriot, f"/user/scene/device/{str(device_id)}"),
+                "Authorization": _get_hawk_authentication(rriot, f"/user/scene/device/{str(device_id)}"),
             },
         )
         scenes_response = await scenes_request.request("get", f"/user/scene/device/{str(device_id)}")
@@ -463,7 +430,7 @@ async def execute_scene(self, user_data: UserData, scene_id: int) -> None:
             rriot.r.a,
             self.session,
             {
-                "Authorization": self._get_hawk_authentication(rriot, f"/user/scene/{str(scene_id)}/execute"),
+                "Authorization": _get_hawk_authentication(rriot, f"/user/scene/{str(scene_id)}/execute"),
             },
         )
         execute_scene_response = await execute_scene_request.request("POST", f"/user/scene/{str(scene_id)}/execute")
@@ -546,3 +513,36 @@ async def request(self, method: str, url: str, params=None, data=None, headers=N
         finally:
             if close_session:
                 await session.close()
+
+
+def _process_extra_hawk_values(values: dict | None) -> str:
+    if values is None:
+        return ""
+    else:
+        sorted_keys = sorted(values.keys())
+        result = []
+        for key in sorted_keys:
+            value = values.get(key)
+            result.append(f"{key}={value}")
+        return hashlib.md5("&".join(result).encode()).hexdigest()
+
+
+def _get_hawk_authentication(rriot: RRiot, url: str, formdata: dict | None = None, params: dict | None = None) -> str:
+    timestamp = math.floor(time.time())
+    nonce = secrets.token_urlsafe(6)
+    formdata_str = _process_extra_hawk_values(formdata)
+    params_str = _process_extra_hawk_values(params)
+
+    prestr = ":".join(
+        [
+            rriot.u,
+            rriot.s,
+            nonce,
+            str(timestamp),
+            hashlib.md5(url.encode()).hexdigest(),
+            params_str,
+            formdata_str,
+        ]
+    )
+    mac = base64.b64encode(hmac.new(rriot.h.encode(), prestr.encode(), hashlib.sha256).digest()).decode()
+    return f'Hawk id="{rriot.u}",s="{rriot.s}",ts="{timestamp}",nonce="{nonce}",mac="{mac}"'

roborock/web_api.py

@@ -111,7 +111,7 @@ def gen_publish(
     properties = prop_finalise(properties)
     rl += len(properties)
     # This will break if len(properties) > 127
-    pack_format = pack_format + "%ds" % (len(properties))
+    pack_format = f"{pack_format}{len(properties)}s"
 
     if payload is not None:
         # payload = payload.encode("utf-8")

tests/mqtt_packet.py

@@ -21,7 +21,7 @@ def test_start_date_lower_than_now_lower_than_end_date():
 
 
 # start_date > now > end_date
-def test_start_date_greater_than_now_greater_tat_end_date():
+def test_start_date_greater_than_now_greater_than_end_date():
     start, end = parse_time_to_datetime(
         (datetime.datetime.now() + datetime.timedelta(hours=1)).time(),
         (datetime.datetime.now() + datetime.timedelta(hours=2)).time(),