python-roborock 3.10.10__tar.gz → 3.11.1__tar.gz

{python_roborock-3.10.10 → python_roborock-3.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-roborock
-Version: 3.10.10
+Version: 3.11.1
 Summary: A package to control Roborock vacuums.
 Project-URL: Repository, https://github.com/humbertogontijo/python-roborock
 Project-URL: Documentation, https://python-roborock.readthedocs.io/

{python_roborock-3.10.10 → python_roborock-3.11.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "3.10.10"
+version = "3.11.1"
 description = "A package to control Roborock vacuums."
 authors = [{ name = "humbertogontijo", email = "humbertogontijo@users.noreply.github.com" }, {name="Lash-L"}, {name="allenporter"}]
 requires-python = ">=3.11, <4"

{python_roborock-3.10.10 → python_roborock-3.11.1}/roborock/data/v1/v1_code_mappings.py

@@ -123,6 +123,13 @@ class DustBagStatus(RoborockDssCodes):
     full = 34
 
 
+class CleanFluidStatus(RoborockDssCodes):
+    """Status of the cleaning fluid container."""
+
+    empty_not_installed = 1
+    okay = 2
+
+
 class RoborockErrorCode(RoborockEnum):
     none = 0
     lidar_blocked = 1

{python_roborock-3.10.10 → python_roborock-3.11.1}/roborock/data/v1/v1_containers.py

@@ -39,6 +39,7 @@ from roborock.exceptions import RoborockException
 
 from ..containers import RoborockBase, RoborockBaseTimer, _attr_repr
 from .v1_code_mappings import (
+    CleanFluidStatus,
     ClearWaterBoxStatus,
     DirtyWaterBoxStatus,
     DustBagStatus,
@@ -229,9 +230,12 @@ class Status(RoborockBase):
         return None
 
     @property
-    def clean_fluid_status(self) -> int | None:
+    def clean_fluid_status(self) -> CleanFluidStatus | None:
         if self.dss:
-            return (self.dss >> 10) & 3
+            value = (self.dss >> 10) & 3
+            if value == 0:
+                return None  # Feature not supported by this device
+            return CleanFluidStatus(value)
         return None
 
     @property

{python_roborock-3.10.10 → python_roborock-3.11.1}/roborock/mqtt/roborock_session.py

@@ -15,11 +15,11 @@ from collections.abc import Callable
 from contextlib import asynccontextmanager
 
 import aiomqtt
-from aiomqtt import MqttError, TLSParameters
+from aiomqtt import MqttCodeError, MqttError, TLSParameters
 
 from roborock.callbacks import CallbackMap
 
-from .session import MqttParams, MqttSession, MqttSessionException
+from .session import MqttParams, MqttSession, MqttSessionException, MqttSessionUnauthorized
 
 _LOGGER = logging.getLogger(__name__)
 _MQTT_LOGGER = logging.getLogger(f"{__name__}.aiomqtt")
@@ -33,6 +33,16 @@ MAX_BACKOFF_INTERVAL = datetime.timedelta(minutes=30)
 BACKOFF_MULTIPLIER = 1.5
 
 
+class MqttReasonCode:
+    """MQTT Reason Codes used by Roborock devices.
+
+    This is a subset of paho.mqtt.reasoncodes.ReasonCode where we would like
+    different error handling behavior.
+    """
+
+    RC_ERROR_UNAUTHORIZED = 135
+
+
 class RoborockMqttSession(MqttSession):
     """An MQTT session for sending and receiving messages.
 
@@ -83,6 +93,10 @@ class RoborockMqttSession(MqttSession):
         self._reconnect_task = loop.create_task(self._run_reconnect_loop(start_future))
         try:
             await start_future
+        except MqttCodeError as err:
+            if err.rc == MqttReasonCode.RC_ERROR_UNAUTHORIZED:
+                raise MqttSessionUnauthorized(f"Authorization error starting MQTT session: {err}") from err
+            raise MqttSessionException(f"Error starting MQTT session: {err}") from err
         except MqttError as err:
             raise MqttSessionException(f"Error starting MQTT session: {err}") from err
         except Exception as err:

{python_roborock-3.10.10 → python_roborock-3.11.1}/roborock/mqtt/session.py

@@ -64,4 +64,17 @@ class MqttSession(ABC):
 
 
 class MqttSessionException(RoborockException):
-    """ "Raised when there is an error communicating with MQTT."""
+    """Raised when there is an error communicating with MQTT."""
+
+
+class MqttSessionUnauthorized(RoborockException):
+    """Raised when there is an authorization error communicating with MQTT.
+
+    This error may be raised in multiple scenarios so there is not a well
+    defined behavior for how the caller should behave. The two cases are:
+    - Rate limiting is in effect and the caller should retry after some time.
+    - The credentials are invalid and the caller needs to obtain new credentials
+
+    However, it is observed that obtaining new credentials may resolve the
+    issue in both cases.
+    """