deebot-client 4.2.0__tar.gz → 4.3.0__tar.gz

{deebot-client-4.2.0/deebot_client.egg-info → deebot-client-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: deebot-client
-Version: 4.2.0
+Version: 4.3.0
 Summary: Deebot client library in python 3
 Author-email: Robert Resch <robert@resch.dev>
 License: GPL-3.0
@@ -18,7 +18,7 @@ Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: aiohttp~=3.9
-Requires-Dist: aiomqtt<2.0,>=1.0.0
+Requires-Dist: aiomqtt<3.0,>=2.0.0
 Requires-Dist: cachetools<6.0,>=5.0.0
 Requires-Dist: defusedxml
 Requires-Dist: numpy<2.0,>=1.23.2

{deebot-client-4.2.0 → deebot-client-4.3.0}/deebot_client/mqtt_client.py

@@ -145,7 +145,7 @@ class MqttClient:
             username=credentials.user_id,
             password=credentials.token,
             logger=_CLIENT_LOGGER,
-            client_id=client_id,
+            identifier=client_id,
             tls_context=self._config.ssl_context,
         )
 
@@ -166,9 +166,8 @@ class MqttClient:
                                 await client.subscribe(topic)
 
                         async def listen() -> None:
-                            async with client.messages() as messages:
-                                async for message in messages:
-                                    self._handle_message(message)
+                            async for message in client.messages:
+                                self._handle_message(message)
 
                         tasks = [
                             asyncio.create_task(listen()),

deebot-client-4.3.0/deebot_client/util/continents.py

@@ -0,0 +1,264 @@
+"""Continents module."""
+
+
+def get_continent(country: str | None) -> str:
+    """Return the continent for the given country or ww."""
+    if not country:
+        return "ww"
+    return COUNTRIES_TO_CONTINENTS.get(country.upper(), "ww")
+
+
+# Copied from https://github.com/mrbungle64/ecovacs-deebot.js/blob/master/countries.json on 11.01.2024
+COUNTRIES_TO_CONTINENTS = {
+    "AD": "eu",
+    "AE": "as",
+    "AF": "as",
+    "AG": "na",
+    "AI": "na",
+    "AL": "eu",
+    "AM": "as",
+    "AO": "ww",
+    "AQ": "ww",
+    "AR": "ww",
+    "AS": "ww",
+    "AT": "eu",
+    "AU": "ww",
+    "AW": "na",
+    "AX": "eu",
+    "AZ": "as",
+    "BA": "eu",
+    "BB": "na",
+    "BD": "as",
+    "BE": "eu",
+    "BF": "ww",
+    "BG": "eu",
+    "BH": "as",
+    "BI": "ww",
+    "BJ": "ww",
+    "BL": "na",
+    "BM": "na",
+    "BN": "as",
+    "BO": "ww",
+    "BQ": "na",
+    "BR": "ww",
+    "BS": "na",
+    "BT": "as",
+    "BV": "ww",
+    "BW": "ww",
+    "BY": "eu",
+    "BZ": "na",
+    "CA": "na",
+    "CC": "as",
+    "CD": "ww",
+    "CF": "ww",
+    "CG": "ww",
+    "CH": "eu",
+    "CI": "ww",
+    "CK": "ww",
+    "CL": "ww",
+    "CM": "ww",
+    "CN": "ww",
+    "CO": "ww",
+    "CR": "na",
+    "CU": "na",
+    "CV": "ww",
+    "CW": "na",
+    "CX": "as",
+    "CY": "eu",
+    "CZ": "eu",
+    "DE": "eu",
+    "DJ": "ww",
+    "DK": "eu",
+    "DM": "na",
+    "DO": "na",
+    "DZ": "ww",
+    "EC": "ww",
+    "EE": "eu",
+    "EG": "ww",
+    "EH": "ww",
+    "ER": "ww",
+    "ES": "eu",
+    "ET": "ww",
+    "FI": "eu",
+    "FJ": "ww",
+    "FK": "ww",
+    "FM": "ww",
+    "FO": "eu",
+    "FR": "eu",
+    "GA": "ww",
+    "GB": "eu",
+    "GD": "na",
+    "GE": "as",
+    "GF": "ww",
+    "GG": "eu",
+    "GH": "ww",
+    "GI": "eu",
+    "GL": "na",
+    "GM": "ww",
+    "GN": "ww",
+    "GP": "na",
+    "GQ": "ww",
+    "GR": "eu",
+    "GS": "ww",
+    "GT": "na",
+    "GU": "ww",
+    "GW": "ww",
+    "GY": "ww",
+    "HK": "as",
+    "HM": "ww",
+    "HN": "na",
+    "HR": "eu",
+    "HT": "na",
+    "HU": "eu",
+    "ID": "as",
+    "IE": "eu",
+    "IL": "as",
+    "IM": "eu",
+    "IN": "as",
+    "IO": "as",
+    "IQ": "as",
+    "IR": "as",
+    "IS": "eu",
+    "IT": "eu",
+    "JE": "eu",
+    "JM": "na",
+    "JO": "as",
+    "JP": "as",
+    "KE": "ww",
+    "KG": "as",
+    "KH": "as",
+    "KI": "ww",
+    "KM": "ww",
+    "KN": "na",
+    "KP": "as",
+    "KR": "as",
+    "KW": "as",
+    "KY": "na",
+    "KZ": "as",
+    "LA": "as",
+    "LB": "as",
+    "LC": "na",
+    "LI": "eu",
+    "LK": "as",
+    "LR": "ww",
+    "LS": "ww",
+    "LT": "eu",
+    "LU": "eu",
+    "LV": "eu",
+    "LY": "ww",
+    "MA": "ww",
+    "MC": "eu",
+    "MD": "eu",
+    "ME": "eu",
+    "MF": "na",
+    "MG": "ww",
+    "MH": "ww",
+    "MK": "eu",
+    "ML": "ww",
+    "MM": "as",
+    "MN": "as",
+    "MO": "as",
+    "MP": "ww",
+    "MQ": "na",
+    "MR": "ww",
+    "MS": "na",
+    "MT": "eu",
+    "MU": "ww",
+    "MV": "as",
+    "MW": "ww",
+    "MX": "na",
+    "MY": "as",
+    "MZ": "ww",
+    "na": "ww",
+    "NC": "ww",
+    "NE": "ww",
+    "NF": "ww",
+    "NG": "ww",
+    "NI": "na",
+    "NL": "eu",
+    "NO": "eu",
+    "NP": "as",
+    "NR": "ww",
+    "NU": "ww",
+    "NZ": "ww",
+    "OM": "as",
+    "PA": "na",
+    "PE": "ww",
+    "PF": "ww",
+    "PG": "ww",
+    "PH": "as",
+    "PK": "as",
+    "PL": "eu",
+    "PM": "na",
+    "PN": "ww",
+    "PR": "na",
+    "PS": "as",
+    "PT": "eu",
+    "PW": "ww",
+    "PY": "ww",
+    "QA": "as",
+    "RE": "ww",
+    "RO": "eu",
+    "RS": "eu",
+    "RU": "eu",
+    "RW": "ww",
+    "SA": "as",
+    "SB": "ww",
+    "SC": "ww",
+    "SD": "ww",
+    "SE": "eu",
+    "SG": "as",
+    "SH": "ww",
+    "SI": "eu",
+    "SJ": "eu",
+    "SK": "eu",
+    "SL": "ww",
+    "SM": "eu",
+    "SN": "ww",
+    "SO": "ww",
+    "SR": "ww",
+    "SS": "ww",
+    "ST": "ww",
+    "SV": "na",
+    "SX": "na",
+    "SY": "as",
+    "SZ": "ww",
+    "TC": "na",
+    "TD": "ww",
+    "TF": "ww",
+    "TG": "ww",
+    "TH": "as",
+    "TJ": "as",
+    "TK": "ww",
+    "TL": "ww",
+    "TM": "as",
+    "TN": "ww",
+    "TO": "ww",
+    "TR": "as",
+    "TT": "na",
+    "TV": "ww",
+    "TW": "as",
+    "TZ": "ww",
+    "UA": "eu",
+    "UG": "ww",
+    "UK": "eu",
+    "UM": "ww",
+    "US": "na",
+    "UY": "ww",
+    "UZ": "as",
+    "VA": "eu",
+    "VC": "na",
+    "VE": "ww",
+    "VG": "na",
+    "VI": "na",
+    "VN": "as",
+    "VU": "ww",
+    "WF": "ww",
+    "WS": "ww",
+    "XK": "eu",
+    "YE": "as",
+    "YT": "ww",
+    "ZA": "ww",
+    "ZM": "ww",
+    "ZW": "ww",
+}

{deebot-client-4.2.0 → deebot-client-4.3.0/deebot_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: deebot-client
-Version: 4.2.0
+Version: 4.3.0
 Summary: Deebot client library in python 3
 Author-email: Robert Resch <robert@resch.dev>
 License: GPL-3.0
@@ -18,7 +18,7 @@ Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: aiohttp~=3.9
-Requires-Dist: aiomqtt<2.0,>=1.0.0
+Requires-Dist: aiomqtt<3.0,>=2.0.0
 Requires-Dist: cachetools<6.0,>=5.0.0
 Requires-Dist: defusedxml
 Requires-Dist: numpy<2.0,>=1.23.2

{deebot-client-4.2.0 → deebot-client-4.3.0}/deebot_client.egg-info/SOURCES.txt

@@ -112,12 +112,14 @@ scripts/check_getLogger.sh
 scripts/run-in-env.sh
 tests/__init__.py
 tests/conftest.py
+tests/mqtt_util.py
 tests/test_authentication.py
 tests/test_command.py
 tests/test_device.py
 tests/test_event_bus.py
 tests/test_map.py
 tests/test_mqtt_client.py
+tests/test_mqtt_client_reconnect.py
 tests/commands/__init__.py
 tests/commands/json/__init__.py
 tests/commands/json/test_advanced_mode.py

{deebot-client-4.2.0 → deebot-client-4.3.0}/deebot_client.egg-info/requires.txt

@@ -1,5 +1,5 @@
 aiohttp~=3.9
-aiomqtt<2.0,>=1.0.0
+aiomqtt<3.0,>=2.0.0
 cachetools<6.0,>=5.0.0
 defusedxml
 numpy<2.0,>=1.23.2

{deebot-client-4.2.0 → deebot-client-4.3.0}/requirements.txt

@@ -1,5 +1,5 @@
 aiohttp~=3.9
-aiomqtt>=1.0.0,<2.0
+aiomqtt>=2.0.0,<3.0
 cachetools>=5.0.0,<6.0
 defusedxml
 numpy>=1.23.2,<2.0

{deebot-client-4.2.0 → deebot-client-4.3.0}/tests/conftest.py

@@ -99,7 +99,7 @@ async def test_mqtt_client(
     async with Client(
         hostname=mqtt_config.hostname,
         port=mqtt_config.port,
-        client_id="Test-helper",
+        identifier="Test-helper",
         tls_context=mqtt_config.ssl_context,
     ) as client:
         yield client

deebot-client-4.3.0/tests/mqtt_util.py

@@ -0,0 +1,41 @@
+"""Utilities for testing MQTT."""
+import asyncio
+from collections.abc import Callable
+import datetime
+import json
+from unittest.mock import MagicMock, Mock
+
+from aiomqtt import Client
+
+from deebot_client.event_bus import EventBus
+from deebot_client.models import DeviceInfo
+from deebot_client.mqtt_client import MqttClient, SubscriberInfo
+
+
+async def verify_subscribe(
+    test_client: Client, device_info: DeviceInfo, mock: Mock, *, expected_called: bool
+) -> None:
+    command = "test"
+    data = json.dumps({"test": str(datetime.datetime.now())}).encode("utf-8")
+    topic = f"iot/atr/{command}/{device_info.did}/{device_info.get_class}/{device_info.resource}/j"
+    await test_client.publish(topic, data)
+
+    await asyncio.sleep(0.1)
+    if expected_called:
+        mock.assert_called_with(command, data)
+    else:
+        mock.assert_not_called()
+
+    mock.reset_mock()
+
+
+async def subscribe(
+    mqtt_client: MqttClient, device_info: DeviceInfo
+) -> tuple[Mock, Mock, Callable[[], None]]:
+    events = Mock(spec=EventBus)
+    callback = MagicMock()
+    unsubscribe = await mqtt_client.subscribe(
+        SubscriberInfo(device_info, events, callback)
+    )
+    await asyncio.sleep(0.1)
+    return (events, callback, unsubscribe)

{deebot-client-4.2.0 → deebot-client-4.3.0}/tests/test_mqtt_client.py

@@ -1,5 +1,4 @@
 import asyncio
-from collections.abc import Callable
 import datetime
 import json
 import logging
@@ -16,43 +15,11 @@ from deebot_client.authentication import Authenticator
 from deebot_client.commands.json.battery import GetBattery
 from deebot_client.commands.json.volume import SetVolume
 from deebot_client.const import DataType
-from deebot_client.event_bus import EventBus
 from deebot_client.exceptions import AuthenticationError
 from deebot_client.models import Configuration, DeviceInfo
-from deebot_client.mqtt_client import MqttClient, MqttConfiguration, SubscriberInfo
+from deebot_client.mqtt_client import MqttClient, MqttConfiguration
 
-from .fixtures.mqtt_server import MqttServer
-
-_WAITING_AFTER_RESTART = 30
-
-
-async def _verify_subscribe(
-    test_client: Client, device_info: DeviceInfo, mock: Mock, *, expected_called: bool
-) -> None:
-    command = "test"
-    data = json.dumps({"test": str(datetime.datetime.now())}).encode("utf-8")
-    topic = f"iot/atr/{command}/{device_info.did}/{device_info.get_class}/{device_info.resource}/j"
-    await test_client.publish(topic, data)
-
-    await asyncio.sleep(0.1)
-    if expected_called:
-        mock.assert_called_with(command, data)
-    else:
-        mock.assert_not_called()
-
-    mock.reset_mock()
-
-
-async def _subscribe(
-    mqtt_client: MqttClient, device_info: DeviceInfo
-) -> tuple[Mock, Mock, Callable[[], None]]:
-    events = Mock(spec=EventBus)
-    callback = MagicMock()
-    unsubscribe = await mqtt_client.subscribe(
-        SubscriberInfo(device_info, events, callback)
-    )
-    await asyncio.sleep(0.1)
-    return (events, callback, unsubscribe)
+from .mqtt_util import subscribe, verify_subscribe
 
 
 async def test_last_message_received_at(
@@ -75,63 +42,6 @@ async def test_last_message_received_at(
         assert mqtt_client.last_message_received_at == expected
 
 
-@pytest.mark.skip(reason="Wait for sbtinstruments/aiomqtt#232 be merged")
-@pytest.mark.timeout(_WAITING_AFTER_RESTART + 10)
-async def test_client_reconnect_on_broker_error(
-    mqtt_client: MqttClient,
-    mqtt_server: MqttServer,
-    device_info: DeviceInfo,
-    mqtt_config: MqttConfiguration,
-    caplog: pytest.LogCaptureFixture,
-) -> None:
-    (_, callback, _) = await _subscribe(mqtt_client, device_info)
-    async with Client(
-        hostname=mqtt_config.hostname,
-        port=mqtt_config.port,
-        client_id="Test-helper",
-        tls_context=mqtt_config.ssl_context,
-    ) as client:
-        # test client cannot be used as we restart the broker in this test
-        await _verify_subscribe(client, device_info, callback, expected_called=True)
-
-    caplog.clear()
-    mqtt_server.stop()
-    await asyncio.sleep(0.1)
-
-    assert (
-        "deebot_client.mqtt_client",
-        logging.WARNING,
-        "Connection lost; Reconnecting in 5 seconds ...",
-    ) in caplog.record_tuples
-    caplog.clear()
-
-    mqtt_server.run()
-
-    expected_log_tuple = (
-        "deebot_client.mqtt_client",
-        logging.DEBUG,
-        "All mqtt tasks created",
-    )
-    for i in range(_WAITING_AFTER_RESTART):
-        print(f"Wait for success reconnect... {i}/{_WAITING_AFTER_RESTART}")
-        if expected_log_tuple in caplog.record_tuples:
-            async with Client(
-                hostname=mqtt_config.hostname,
-                port=mqtt_config.port,
-                client_id="Test-helper",
-                tls_context=mqtt_config.ssl_context,
-            ) as client:
-                # test client cannot be used as we restart the broker in this test
-                await _verify_subscribe(
-                    client, device_info, callback, expected_called=True
-                )
-            return
-
-        await asyncio.sleep(1)
-
-    pytest.fail("Reconnect failed")
-
-
 _test_MqttConfiguration_data = [
     ("cn", None, "mq.ecouser.net"),
     ("cn", "localhost", "localhost"),
@@ -182,16 +92,16 @@ def test_MqttConfiguration_hostname_none(config: Configuration) -> None:
 async def test_client_bot_subscription(
     mqtt_client: MqttClient, device_info: DeviceInfo, test_mqtt_client: Client
 ) -> None:
-    (_, callback, unsubscribe) = await _subscribe(mqtt_client, device_info)
+    (_, callback, unsubscribe) = await subscribe(mqtt_client, device_info)
 
-    await _verify_subscribe(
+    await verify_subscribe(
         test_mqtt_client, device_info, callback, expected_called=True
     )
 
     unsubscribe()
     await asyncio.sleep(0.1)
 
-    await _verify_subscribe(
+    await verify_subscribe(
         test_mqtt_client, device_info, callback, expected_called=False
     )
 
@@ -199,21 +109,21 @@ async def test_client_bot_subscription(
 async def test_client_reconnect_manual(
     mqtt_client: MqttClient, device_info: DeviceInfo, test_mqtt_client: Client
 ) -> None:
-    (_, callback, _) = await _subscribe(mqtt_client, device_info)
+    (_, callback, _) = await subscribe(mqtt_client, device_info)
 
-    await _verify_subscribe(
+    await verify_subscribe(
         test_mqtt_client, device_info, callback, expected_called=True
     )
 
     await mqtt_client.disconnect()
-    await _verify_subscribe(
+    await verify_subscribe(
         test_mqtt_client, device_info, callback, expected_called=False
     )
 
     await mqtt_client.connect()
     await asyncio.sleep(0.1)
 
-    await _verify_subscribe(
+    await verify_subscribe(
         test_mqtt_client, device_info, callback, expected_called=True
     )
 
@@ -244,7 +154,7 @@ async def test_p2p_success(
     test_mqtt_client: Client,
 ) -> None:
     """Test p2p workflow on SetVolume."""
-    (events, _, _) = await _subscribe(mqtt_client, device_info)
+    (events, _, _) = await subscribe(mqtt_client, device_info)
     assert len(mqtt_client._received_p2p_commands) == 0
 
     command_object = Mock(spec=SetVolume)
@@ -293,7 +203,7 @@ async def test_p2p_not_supported(
     caplog: pytest.LogCaptureFixture,
 ) -> None:
     """Test that unsupported command will be logged."""
-    await _subscribe(mqtt_client, device_info)
+    await subscribe(mqtt_client, device_info)
     command_name: str = GetBattery.name
 
     await _publish_p2p(
@@ -344,7 +254,7 @@ async def test_p2p_to_late(
     """Test p2p when response comes in to late."""
     # reduce ttl to 1 seconds
     mqtt_client._received_p2p_commands = TTLCache(maxsize=60 * 60, ttl=1)
-    await _subscribe(mqtt_client, device_info)
+    await subscribe(mqtt_client, device_info)
     assert len(mqtt_client._received_p2p_commands) == 0
 
     command_object = Mock(spec=SetVolume)
@@ -393,7 +303,7 @@ async def test_p2p_parse_error(
     caplog: pytest.LogCaptureFixture,
 ) -> None:
     """Test p2p parse error."""
-    await _subscribe(mqtt_client, device_info)
+    await subscribe(mqtt_client, device_info)
 
     command_object = Mock(spec=SetVolume)
     command_name = SetVolume.name

deebot-client-4.3.0/tests/test_mqtt_client_reconnect.py

@@ -0,0 +1,79 @@
+import asyncio
+from collections.abc import Generator
+import logging
+
+from aiomqtt import Client
+import pytest
+
+from deebot_client.models import DeviceInfo
+from deebot_client.mqtt_client import MqttClient, MqttConfiguration
+
+from .fixtures.mqtt_server import MqttServer
+from .mqtt_util import subscribe, verify_subscribe
+
+_WAITING_AFTER_RESTART = 30
+
+
+@pytest.fixture
+def mqtt_server() -> Generator[MqttServer, None, None]:
+    server = MqttServer()
+    server.config.options["ports"] = {"1883/tcp": 54321}
+    server.run()
+    yield server
+    server.stop()
+
+
+@pytest.mark.timeout(_WAITING_AFTER_RESTART + 10)
+async def test_client_reconnect_on_broker_error(
+    mqtt_client: MqttClient,
+    mqtt_server: MqttServer,
+    device_info: DeviceInfo,
+    mqtt_config: MqttConfiguration,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    (_, callback, _) = await subscribe(mqtt_client, device_info)
+    async with Client(
+        hostname=mqtt_config.hostname,
+        port=mqtt_config.port,
+        identifier="Test-helper",
+        tls_context=mqtt_config.ssl_context,
+    ) as client:
+        # test client cannot be used as we restart the broker in this test
+        await verify_subscribe(client, device_info, callback, expected_called=True)
+
+    caplog.clear()
+    mqtt_server.stop()
+    await asyncio.sleep(0.1)
+
+    assert (
+        "deebot_client.mqtt_client",
+        logging.WARNING,
+        "Connection lost; Reconnecting in 5 seconds ...",
+    ) in caplog.record_tuples
+    caplog.clear()
+
+    mqtt_server.run()
+
+    expected_log_tuple = (
+        "deebot_client.mqtt_client",
+        logging.DEBUG,
+        "All mqtt tasks created",
+    )
+    for i in range(_WAITING_AFTER_RESTART):
+        print(f"Wait for success reconnect... {i}/{_WAITING_AFTER_RESTART}")
+        if expected_log_tuple in caplog.record_tuples:
+            async with Client(
+                hostname=mqtt_config.hostname,
+                port=mqtt_config.port,
+                identifier="Test-helper",
+                tls_context=mqtt_config.ssl_context,
+            ) as client:
+                # test client cannot be used as we restart the broker in this test
+                await verify_subscribe(
+                    client, device_info, callback, expected_called=True
+                )
+            return
+
+        await asyncio.sleep(1)
+
+    pytest.fail("Reconnect failed")